1 \input texinfo @c -*-texinfo-*-
2 @c Copyright (C) 1988-2016 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-2016 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-2016 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.
2661 @vindex $_inferior@r{, convenience variable}
2662 The debugger convenience variable @samp{$_inferior} contains the
2663 number of the current inferior. You may find this useful in writing
2664 breakpoint conditional expressions, command scripts, and so forth.
2665 @xref{Convenience Vars,, Convenience Variables}, for general
2666 information on convenience variables.
2668 You can get multiple executables into a debugging session via the
2669 @code{add-inferior} and @w{@code{clone-inferior}} commands. On some
2670 systems @value{GDBN} can add inferiors to the debug session
2671 automatically by following calls to @code{fork} and @code{exec}. To
2672 remove inferiors from the debugging session use the
2673 @w{@code{remove-inferiors}} command.
2676 @kindex add-inferior
2677 @item add-inferior [ -copies @var{n} ] [ -exec @var{executable} ]
2678 Adds @var{n} inferiors to be run using @var{executable} as the
2679 executable; @var{n} defaults to 1. If no executable is specified,
2680 the inferiors begins empty, with no program. You can still assign or
2681 change the program assigned to the inferior at any time by using the
2682 @code{file} command with the executable name as its argument.
2684 @kindex clone-inferior
2685 @item clone-inferior [ -copies @var{n} ] [ @var{infno} ]
2686 Adds @var{n} inferiors ready to execute the same program as inferior
2687 @var{infno}; @var{n} defaults to 1, and @var{infno} defaults to the
2688 number of the current inferior. This is a convenient command when you
2689 want to run another instance of the inferior you are debugging.
2692 (@value{GDBP}) info inferiors
2693 Num Description Executable
2694 * 1 process 29964 helloworld
2695 (@value{GDBP}) clone-inferior
2698 (@value{GDBP}) info inferiors
2699 Num Description Executable
2701 * 1 process 29964 helloworld
2704 You can now simply switch focus to inferior 2 and run it.
2706 @kindex remove-inferiors
2707 @item remove-inferiors @var{infno}@dots{}
2708 Removes the inferior or inferiors @var{infno}@dots{}. It is not
2709 possible to remove an inferior that is running with this command. For
2710 those, use the @code{kill} or @code{detach} command first.
2714 To quit debugging one of the running inferiors that is not the current
2715 inferior, you can either detach from it by using the @w{@code{detach
2716 inferior}} command (allowing it to run independently), or kill it
2717 using the @w{@code{kill inferiors}} command:
2720 @kindex detach inferiors @var{infno}@dots{}
2721 @item detach inferior @var{infno}@dots{}
2722 Detach from the inferior or inferiors identified by @value{GDBN}
2723 inferior number(s) @var{infno}@dots{}. Note that the inferior's entry
2724 still stays on the list of inferiors shown by @code{info inferiors},
2725 but its Description will show @samp{<null>}.
2727 @kindex kill inferiors @var{infno}@dots{}
2728 @item kill inferiors @var{infno}@dots{}
2729 Kill the inferior or inferiors identified by @value{GDBN} inferior
2730 number(s) @var{infno}@dots{}. Note that the inferior's entry still
2731 stays on the list of inferiors shown by @code{info inferiors}, but its
2732 Description will show @samp{<null>}.
2735 After the successful completion of a command such as @code{detach},
2736 @code{detach inferiors}, @code{kill} or @code{kill inferiors}, or after
2737 a normal process exit, the inferior is still valid and listed with
2738 @code{info inferiors}, ready to be restarted.
2741 To be notified when inferiors are started or exit under @value{GDBN}'s
2742 control use @w{@code{set print inferior-events}}:
2745 @kindex set print inferior-events
2746 @cindex print messages on inferior start and exit
2747 @item set print inferior-events
2748 @itemx set print inferior-events on
2749 @itemx set print inferior-events off
2750 The @code{set print inferior-events} command allows you to enable or
2751 disable printing of messages when @value{GDBN} notices that new
2752 inferiors have started or that inferiors have exited or have been
2753 detached. By default, these messages will not be printed.
2755 @kindex show print inferior-events
2756 @item show print inferior-events
2757 Show whether messages will be printed when @value{GDBN} detects that
2758 inferiors have started, exited or have been detached.
2761 Many commands will work the same with multiple programs as with a
2762 single program: e.g., @code{print myglobal} will simply display the
2763 value of @code{myglobal} in the current inferior.
2766 Occasionaly, when debugging @value{GDBN} itself, it may be useful to
2767 get more info about the relationship of inferiors, programs, address
2768 spaces in a debug session. You can do that with the @w{@code{maint
2769 info program-spaces}} command.
2772 @kindex maint info program-spaces
2773 @item maint info program-spaces
2774 Print a list of all program spaces currently being managed by
2777 @value{GDBN} displays for each program space (in this order):
2781 the program space number assigned by @value{GDBN}
2784 the name of the executable loaded into the program space, with e.g.,
2785 the @code{file} command.
2790 An asterisk @samp{*} preceding the @value{GDBN} program space number
2791 indicates the current program space.
2793 In addition, below each program space line, @value{GDBN} prints extra
2794 information that isn't suitable to display in tabular form. For
2795 example, the list of inferiors bound to the program space.
2798 (@value{GDBP}) maint info program-spaces
2802 Bound inferiors: ID 1 (process 21561)
2805 Here we can see that no inferior is running the program @code{hello},
2806 while @code{process 21561} is running the program @code{goodbye}. On
2807 some targets, it is possible that multiple inferiors are bound to the
2808 same program space. The most common example is that of debugging both
2809 the parent and child processes of a @code{vfork} call. For example,
2812 (@value{GDBP}) maint info program-spaces
2815 Bound inferiors: ID 2 (process 18050), ID 1 (process 18045)
2818 Here, both inferior 2 and inferior 1 are running in the same program
2819 space as a result of inferior 1 having executed a @code{vfork} call.
2823 @section Debugging Programs with Multiple Threads
2825 @cindex threads of execution
2826 @cindex multiple threads
2827 @cindex switching threads
2828 In some operating systems, such as GNU/Linux and Solaris, a single program
2829 may have more than one @dfn{thread} of execution. The precise semantics
2830 of threads differ from one operating system to another, but in general
2831 the threads of a single program are akin to multiple processes---except
2832 that they share one address space (that is, they can all examine and
2833 modify the same variables). On the other hand, each thread has its own
2834 registers and execution stack, and perhaps private memory.
2836 @value{GDBN} provides these facilities for debugging multi-thread
2840 @item automatic notification of new threads
2841 @item @samp{thread @var{thread-id}}, a command to switch among threads
2842 @item @samp{info threads}, a command to inquire about existing threads
2843 @item @samp{thread apply [@var{thread-id-list}] [@var{all}] @var{args}},
2844 a command to apply a command to a list of threads
2845 @item thread-specific breakpoints
2846 @item @samp{set print thread-events}, which controls printing of
2847 messages on thread start and exit.
2848 @item @samp{set libthread-db-search-path @var{path}}, which lets
2849 the user specify which @code{libthread_db} to use if the default choice
2850 isn't compatible with the program.
2853 @cindex focus of debugging
2854 @cindex current thread
2855 The @value{GDBN} thread debugging facility allows you to observe all
2856 threads while your program runs---but whenever @value{GDBN} takes
2857 control, one thread in particular is always the focus of debugging.
2858 This thread is called the @dfn{current thread}. Debugging commands show
2859 program information from the perspective of the current thread.
2861 @cindex @code{New} @var{systag} message
2862 @cindex thread identifier (system)
2863 @c FIXME-implementors!! It would be more helpful if the [New...] message
2864 @c included GDB's numeric thread handle, so you could just go to that
2865 @c thread without first checking `info threads'.
2866 Whenever @value{GDBN} detects a new thread in your program, it displays
2867 the target system's identification for the thread with a message in the
2868 form @samp{[New @var{systag}]}, where @var{systag} is a thread identifier
2869 whose form varies depending on the particular system. For example, on
2870 @sc{gnu}/Linux, you might see
2873 [New Thread 0x41e02940 (LWP 25582)]
2877 when @value{GDBN} notices a new thread. In contrast, on other systems,
2878 the @var{systag} is simply something like @samp{process 368}, with no
2881 @c FIXME!! (1) Does the [New...] message appear even for the very first
2882 @c thread of a program, or does it only appear for the
2883 @c second---i.e.@: when it becomes obvious we have a multithread
2885 @c (2) *Is* there necessarily a first thread always? Or do some
2886 @c multithread systems permit starting a program with multiple
2887 @c threads ab initio?
2889 @anchor{thread numbers}
2890 @cindex thread number, per inferior
2891 @cindex thread identifier (GDB)
2892 For debugging purposes, @value{GDBN} associates its own thread number
2893 ---always a single integer---with each thread of an inferior. This
2894 number is unique between all threads of an inferior, but not unique
2895 between threads of different inferiors.
2897 @cindex qualified thread ID
2898 You can refer to a given thread in an inferior using the qualified
2899 @var{inferior-num}.@var{thread-num} syntax, also known as
2900 @dfn{qualified thread ID}, with @var{inferior-num} being the inferior
2901 number and @var{thread-num} being the thread number of the given
2902 inferior. For example, thread @code{2.3} refers to thread number 3 of
2903 inferior 2. If you omit @var{inferior-num} (e.g., @code{thread 3}),
2904 then @value{GDBN} infers you're referring to a thread of the current
2907 Until you create a second inferior, @value{GDBN} does not show the
2908 @var{inferior-num} part of thread IDs, even though you can always use
2909 the full @var{inferior-num}.@var{thread-num} form to refer to threads
2910 of inferior 1, the initial inferior.
2912 @anchor{thread ID lists}
2913 @cindex thread ID lists
2914 Some commands accept a space-separated @dfn{thread ID list} as
2915 argument. A list element can be:
2919 A thread ID as shown in the first field of the @samp{info threads}
2920 display, with or without an inferior qualifier. E.g., @samp{2.1} or
2924 A range of thread numbers, again with or without an inferior
2925 qualifier, as in @var{inf}.@var{thr1}-@var{thr2} or
2926 @var{thr1}-@var{thr2}. E.g., @samp{1.2-4} or @samp{2-4}.
2929 All threads of an inferior, specified with a star wildcard, with or
2930 without an inferior qualifier, as in @var{inf}.@code{*} (e.g.,
2931 @samp{1.*}) or @code{*}. The former refers to all threads of the
2932 given inferior, and the latter form without an inferior qualifier
2933 refers to all threads of the current inferior.
2937 For example, if the current inferior is 1, and inferior 7 has one
2938 thread with ID 7.1, the thread list @samp{1 2-3 4.5 6.7-9 7.*}
2939 includes threads 1 to 3 of inferior 1, thread 5 of inferior 4, threads
2940 7 to 9 of inferior 6 and all threads of inferior 7. That is, in
2941 expanded qualified form, the same as @samp{1.1 1.2 1.3 4.5 6.7 6.8 6.9
2945 @anchor{global thread numbers}
2946 @cindex global thread number
2947 @cindex global thread identifier (GDB)
2948 In addition to a @emph{per-inferior} number, each thread is also
2949 assigned a unique @emph{global} number, also known as @dfn{global
2950 thread ID}, a single integer. Unlike the thread number component of
2951 the thread ID, no two threads have the same global ID, even when
2952 you're debugging multiple inferiors.
2954 From @value{GDBN}'s perspective, a process always has at least one
2955 thread. In other words, @value{GDBN} assigns a thread number to the
2956 program's ``main thread'' even if the program is not multi-threaded.
2958 @vindex $_thread@r{, convenience variable}
2959 @vindex $_gthread@r{, convenience variable}
2960 The debugger convenience variables @samp{$_thread} and
2961 @samp{$_gthread} contain, respectively, the per-inferior thread number
2962 and the global thread number of the current thread. You may find this
2963 useful in writing breakpoint conditional expressions, command scripts,
2964 and so forth. @xref{Convenience Vars,, Convenience Variables}, for
2965 general information on convenience variables.
2967 If @value{GDBN} detects the program is multi-threaded, it augments the
2968 usual message about stopping at a breakpoint with the ID and name of
2969 the thread that hit the breakpoint.
2972 Thread 2 "client" hit Breakpoint 1, send_message () at client.c:68
2975 Likewise when the program receives a signal:
2978 Thread 1 "main" received signal SIGINT, Interrupt.
2982 @kindex info threads
2983 @item info threads @r{[}@var{thread-id-list}@r{]}
2985 Display information about one or more threads. With no arguments
2986 displays information about all threads. You can specify the list of
2987 threads that you want to display using the thread ID list syntax
2988 (@pxref{thread ID lists}).
2990 @value{GDBN} displays for each thread (in this order):
2994 the per-inferior thread number assigned by @value{GDBN}
2997 the global thread number assigned by @value{GDBN}, if the @samp{-gid}
2998 option was specified
3001 the target system's thread identifier (@var{systag})
3004 the thread's name, if one is known. A thread can either be named by
3005 the user (see @code{thread name}, below), or, in some cases, by the
3009 the current stack frame summary for that thread
3013 An asterisk @samp{*} to the left of the @value{GDBN} thread number
3014 indicates the current thread.
3018 @c end table here to get a little more width for example
3021 (@value{GDBP}) info threads
3023 * 1 process 35 thread 13 main (argc=1, argv=0x7ffffff8)
3024 2 process 35 thread 23 0x34e5 in sigpause ()
3025 3 process 35 thread 27 0x34e5 in sigpause ()
3029 If you're debugging multiple inferiors, @value{GDBN} displays thread
3030 IDs using the qualified @var{inferior-num}.@var{thread-num} format.
3031 Otherwise, only @var{thread-num} is shown.
3033 If you specify the @samp{-gid} option, @value{GDBN} displays a column
3034 indicating each thread's global thread ID:
3037 (@value{GDBP}) info threads
3038 Id GId Target Id Frame
3039 1.1 1 process 35 thread 13 main (argc=1, argv=0x7ffffff8)
3040 1.2 3 process 35 thread 23 0x34e5 in sigpause ()
3041 1.3 4 process 35 thread 27 0x34e5 in sigpause ()
3042 * 2.1 2 process 65 thread 1 main (argc=1, argv=0x7ffffff8)
3045 On Solaris, you can display more information about user threads with a
3046 Solaris-specific command:
3049 @item maint info sol-threads
3050 @kindex maint info sol-threads
3051 @cindex thread info (Solaris)
3052 Display info on Solaris user threads.
3056 @kindex thread @var{thread-id}
3057 @item thread @var{thread-id}
3058 Make thread ID @var{thread-id} the current thread. The command
3059 argument @var{thread-id} is the @value{GDBN} thread ID, as shown in
3060 the first field of the @samp{info threads} display, with or without an
3061 inferior qualifier (e.g., @samp{2.1} or @samp{1}).
3063 @value{GDBN} responds by displaying the system identifier of the
3064 thread you selected, and its current stack frame summary:
3067 (@value{GDBP}) thread 2
3068 [Switching to thread 2 (Thread 0xb7fdab70 (LWP 12747))]
3069 #0 some_function (ignore=0x0) at example.c:8
3070 8 printf ("hello\n");
3074 As with the @samp{[New @dots{}]} message, the form of the text after
3075 @samp{Switching to} depends on your system's conventions for identifying
3078 @kindex thread apply
3079 @cindex apply command to several threads
3080 @item thread apply [@var{thread-id-list} | all [-ascending]] @var{command}
3081 The @code{thread apply} command allows you to apply the named
3082 @var{command} to one or more threads. Specify the threads that you
3083 want affected using the thread ID list syntax (@pxref{thread ID
3084 lists}), or specify @code{all} to apply to all threads. To apply a
3085 command to all threads in descending order, type @kbd{thread apply all
3086 @var{command}}. To apply a command to all threads in ascending order,
3087 type @kbd{thread apply all -ascending @var{command}}.
3091 @cindex name a thread
3092 @item thread name [@var{name}]
3093 This command assigns a name to the current thread. If no argument is
3094 given, any existing user-specified name is removed. The thread name
3095 appears in the @samp{info threads} display.
3097 On some systems, such as @sc{gnu}/Linux, @value{GDBN} is able to
3098 determine the name of the thread as given by the OS. On these
3099 systems, a name specified with @samp{thread name} will override the
3100 system-give name, and removing the user-specified name will cause
3101 @value{GDBN} to once again display the system-specified name.
3104 @cindex search for a thread
3105 @item thread find [@var{regexp}]
3106 Search for and display thread ids whose name or @var{systag}
3107 matches the supplied regular expression.
3109 As well as being the complement to the @samp{thread name} command,
3110 this command also allows you to identify a thread by its target
3111 @var{systag}. For instance, on @sc{gnu}/Linux, the target @var{systag}
3115 (@value{GDBN}) thread find 26688
3116 Thread 4 has target id 'Thread 0x41e02940 (LWP 26688)'
3117 (@value{GDBN}) info thread 4
3119 4 Thread 0x41e02940 (LWP 26688) 0x00000031ca6cd372 in select ()
3122 @kindex set print thread-events
3123 @cindex print messages on thread start and exit
3124 @item set print thread-events
3125 @itemx set print thread-events on
3126 @itemx set print thread-events off
3127 The @code{set print thread-events} command allows you to enable or
3128 disable printing of messages when @value{GDBN} notices that new threads have
3129 started or that threads have exited. By default, these messages will
3130 be printed if detection of these events is supported by the target.
3131 Note that these messages cannot be disabled on all targets.
3133 @kindex show print thread-events
3134 @item show print thread-events
3135 Show whether messages will be printed when @value{GDBN} detects that threads
3136 have started and exited.
3139 @xref{Thread Stops,,Stopping and Starting Multi-thread Programs}, for
3140 more information about how @value{GDBN} behaves when you stop and start
3141 programs with multiple threads.
3143 @xref{Set Watchpoints,,Setting Watchpoints}, for information about
3144 watchpoints in programs with multiple threads.
3146 @anchor{set libthread-db-search-path}
3148 @kindex set libthread-db-search-path
3149 @cindex search path for @code{libthread_db}
3150 @item set libthread-db-search-path @r{[}@var{path}@r{]}
3151 If this variable is set, @var{path} is a colon-separated list of
3152 directories @value{GDBN} will use to search for @code{libthread_db}.
3153 If you omit @var{path}, @samp{libthread-db-search-path} will be reset to
3154 its default value (@code{$sdir:$pdir} on @sc{gnu}/Linux and Solaris systems).
3155 Internally, the default value comes from the @code{LIBTHREAD_DB_SEARCH_PATH}
3158 On @sc{gnu}/Linux and Solaris systems, @value{GDBN} uses a ``helper''
3159 @code{libthread_db} library to obtain information about threads in the
3160 inferior process. @value{GDBN} will use @samp{libthread-db-search-path}
3161 to find @code{libthread_db}. @value{GDBN} also consults first if inferior
3162 specific thread debugging library loading is enabled
3163 by @samp{set auto-load libthread-db} (@pxref{libthread_db.so.1 file}).
3165 A special entry @samp{$sdir} for @samp{libthread-db-search-path}
3166 refers to the default system directories that are
3167 normally searched for loading shared libraries. The @samp{$sdir} entry
3168 is the only kind not needing to be enabled by @samp{set auto-load libthread-db}
3169 (@pxref{libthread_db.so.1 file}).
3171 A special entry @samp{$pdir} for @samp{libthread-db-search-path}
3172 refers to the directory from which @code{libpthread}
3173 was loaded in the inferior process.
3175 For any @code{libthread_db} library @value{GDBN} finds in above directories,
3176 @value{GDBN} attempts to initialize it with the current inferior process.
3177 If this initialization fails (which could happen because of a version
3178 mismatch between @code{libthread_db} and @code{libpthread}), @value{GDBN}
3179 will unload @code{libthread_db}, and continue with the next directory.
3180 If none of @code{libthread_db} libraries initialize successfully,
3181 @value{GDBN} will issue a warning and thread debugging will be disabled.
3183 Setting @code{libthread-db-search-path} is currently implemented
3184 only on some platforms.
3186 @kindex show libthread-db-search-path
3187 @item show libthread-db-search-path
3188 Display current libthread_db search path.
3190 @kindex set debug libthread-db
3191 @kindex show debug libthread-db
3192 @cindex debugging @code{libthread_db}
3193 @item set debug libthread-db
3194 @itemx show debug libthread-db
3195 Turns on or off display of @code{libthread_db}-related events.
3196 Use @code{1} to enable, @code{0} to disable.
3200 @section Debugging Forks
3202 @cindex fork, debugging programs which call
3203 @cindex multiple processes
3204 @cindex processes, multiple
3205 On most systems, @value{GDBN} has no special support for debugging
3206 programs which create additional processes using the @code{fork}
3207 function. When a program forks, @value{GDBN} will continue to debug the
3208 parent process and the child process will run unimpeded. If you have
3209 set a breakpoint in any code which the child then executes, the child
3210 will get a @code{SIGTRAP} signal which (unless it catches the signal)
3211 will cause it to terminate.
3213 However, if you want to debug the child process there is a workaround
3214 which isn't too painful. Put a call to @code{sleep} in the code which
3215 the child process executes after the fork. It may be useful to sleep
3216 only if a certain environment variable is set, or a certain file exists,
3217 so that the delay need not occur when you don't want to run @value{GDBN}
3218 on the child. While the child is sleeping, use the @code{ps} program to
3219 get its process ID. Then tell @value{GDBN} (a new invocation of
3220 @value{GDBN} if you are also debugging the parent process) to attach to
3221 the child process (@pxref{Attach}). From that point on you can debug
3222 the child process just like any other process which you attached to.
3224 On some systems, @value{GDBN} provides support for debugging programs
3225 that create additional processes using the @code{fork} or @code{vfork}
3226 functions. On @sc{gnu}/Linux platforms, this feature is supported
3227 with kernel version 2.5.46 and later.
3229 The fork debugging commands are supported in native mode and when
3230 connected to @code{gdbserver} in either @code{target remote} mode or
3231 @code{target extended-remote} mode.
3233 By default, when a program forks, @value{GDBN} will continue to debug
3234 the parent process and the child process will run unimpeded.
3236 If you want to follow the child process instead of the parent process,
3237 use the command @w{@code{set follow-fork-mode}}.
3240 @kindex set follow-fork-mode
3241 @item set follow-fork-mode @var{mode}
3242 Set the debugger response to a program call of @code{fork} or
3243 @code{vfork}. A call to @code{fork} or @code{vfork} creates a new
3244 process. The @var{mode} argument can be:
3248 The original process is debugged after a fork. The child process runs
3249 unimpeded. This is the default.
3252 The new process is debugged after a fork. The parent process runs
3257 @kindex show follow-fork-mode
3258 @item show follow-fork-mode
3259 Display the current debugger response to a @code{fork} or @code{vfork} call.
3262 @cindex debugging multiple processes
3263 On Linux, if you want to debug both the parent and child processes, use the
3264 command @w{@code{set detach-on-fork}}.
3267 @kindex set detach-on-fork
3268 @item set detach-on-fork @var{mode}
3269 Tells gdb whether to detach one of the processes after a fork, or
3270 retain debugger control over them both.
3274 The child process (or parent process, depending on the value of
3275 @code{follow-fork-mode}) will be detached and allowed to run
3276 independently. This is the default.
3279 Both processes will be held under the control of @value{GDBN}.
3280 One process (child or parent, depending on the value of
3281 @code{follow-fork-mode}) is debugged as usual, while the other
3286 @kindex show detach-on-fork
3287 @item show detach-on-fork
3288 Show whether detach-on-fork mode is on/off.
3291 If you choose to set @samp{detach-on-fork} mode off, then @value{GDBN}
3292 will retain control of all forked processes (including nested forks).
3293 You can list the forked processes under the control of @value{GDBN} by
3294 using the @w{@code{info inferiors}} command, and switch from one fork
3295 to another by using the @code{inferior} command (@pxref{Inferiors and
3296 Programs, ,Debugging Multiple Inferiors and Programs}).
3298 To quit debugging one of the forked processes, you can either detach
3299 from it by using the @w{@code{detach inferiors}} command (allowing it
3300 to run independently), or kill it using the @w{@code{kill inferiors}}
3301 command. @xref{Inferiors and Programs, ,Debugging Multiple Inferiors
3304 If you ask to debug a child process and a @code{vfork} is followed by an
3305 @code{exec}, @value{GDBN} executes the new target up to the first
3306 breakpoint in the new target. If you have a breakpoint set on
3307 @code{main} in your original program, the breakpoint will also be set on
3308 the child process's @code{main}.
3310 On some systems, when a child process is spawned by @code{vfork}, you
3311 cannot debug the child or parent until an @code{exec} call completes.
3313 If you issue a @code{run} command to @value{GDBN} after an @code{exec}
3314 call executes, the new target restarts. To restart the parent
3315 process, use the @code{file} command with the parent executable name
3316 as its argument. By default, after an @code{exec} call executes,
3317 @value{GDBN} discards the symbols of the previous executable image.
3318 You can change this behaviour with the @w{@code{set follow-exec-mode}}
3322 @kindex set follow-exec-mode
3323 @item set follow-exec-mode @var{mode}
3325 Set debugger response to a program call of @code{exec}. An
3326 @code{exec} call replaces the program image of a process.
3328 @code{follow-exec-mode} can be:
3332 @value{GDBN} creates a new inferior and rebinds the process to this
3333 new inferior. The program the process was running before the
3334 @code{exec} call can be restarted afterwards by restarting the
3340 (@value{GDBP}) info inferiors
3342 Id Description Executable
3345 process 12020 is executing new program: prog2
3346 Program exited normally.
3347 (@value{GDBP}) info inferiors
3348 Id Description Executable
3354 @value{GDBN} keeps the process bound to the same inferior. The new
3355 executable image replaces the previous executable loaded in the
3356 inferior. Restarting the inferior after the @code{exec} call, with
3357 e.g., the @code{run} command, restarts the executable the process was
3358 running after the @code{exec} call. This is the default mode.
3363 (@value{GDBP}) info inferiors
3364 Id Description Executable
3367 process 12020 is executing new program: prog2
3368 Program exited normally.
3369 (@value{GDBP}) info inferiors
3370 Id Description Executable
3377 @code{follow-exec-mode} is supported in native mode and
3378 @code{target extended-remote} mode.
3380 You can use the @code{catch} command to make @value{GDBN} stop whenever
3381 a @code{fork}, @code{vfork}, or @code{exec} call is made. @xref{Set
3382 Catchpoints, ,Setting Catchpoints}.
3384 @node Checkpoint/Restart
3385 @section Setting a @emph{Bookmark} to Return to Later
3390 @cindex snapshot of a process
3391 @cindex rewind program state
3393 On certain operating systems@footnote{Currently, only
3394 @sc{gnu}/Linux.}, @value{GDBN} is able to save a @dfn{snapshot} of a
3395 program's state, called a @dfn{checkpoint}, and come back to it
3398 Returning to a checkpoint effectively undoes everything that has
3399 happened in the program since the @code{checkpoint} was saved. This
3400 includes changes in memory, registers, and even (within some limits)
3401 system state. Effectively, it is like going back in time to the
3402 moment when the checkpoint was saved.
3404 Thus, if you're stepping thru a program and you think you're
3405 getting close to the point where things go wrong, you can save
3406 a checkpoint. Then, if you accidentally go too far and miss
3407 the critical statement, instead of having to restart your program
3408 from the beginning, you can just go back to the checkpoint and
3409 start again from there.
3411 This can be especially useful if it takes a lot of time or
3412 steps to reach the point where you think the bug occurs.
3414 To use the @code{checkpoint}/@code{restart} method of debugging:
3419 Save a snapshot of the debugged program's current execution state.
3420 The @code{checkpoint} command takes no arguments, but each checkpoint
3421 is assigned a small integer id, similar to a breakpoint id.
3423 @kindex info checkpoints
3424 @item info checkpoints
3425 List the checkpoints that have been saved in the current debugging
3426 session. For each checkpoint, the following information will be
3433 @item Source line, or label
3436 @kindex restart @var{checkpoint-id}
3437 @item restart @var{checkpoint-id}
3438 Restore the program state that was saved as checkpoint number
3439 @var{checkpoint-id}. All program variables, registers, stack frames
3440 etc.@: will be returned to the values that they had when the checkpoint
3441 was saved. In essence, gdb will ``wind back the clock'' to the point
3442 in time when the checkpoint was saved.
3444 Note that breakpoints, @value{GDBN} variables, command history etc.
3445 are not affected by restoring a checkpoint. In general, a checkpoint
3446 only restores things that reside in the program being debugged, not in
3449 @kindex delete checkpoint @var{checkpoint-id}
3450 @item delete checkpoint @var{checkpoint-id}
3451 Delete the previously-saved checkpoint identified by @var{checkpoint-id}.
3455 Returning to a previously saved checkpoint will restore the user state
3456 of the program being debugged, plus a significant subset of the system
3457 (OS) state, including file pointers. It won't ``un-write'' data from
3458 a file, but it will rewind the file pointer to the previous location,
3459 so that the previously written data can be overwritten. For files
3460 opened in read mode, the pointer will also be restored so that the
3461 previously read data can be read again.
3463 Of course, characters that have been sent to a printer (or other
3464 external device) cannot be ``snatched back'', and characters received
3465 from eg.@: a serial device can be removed from internal program buffers,
3466 but they cannot be ``pushed back'' into the serial pipeline, ready to
3467 be received again. Similarly, the actual contents of files that have
3468 been changed cannot be restored (at this time).
3470 However, within those constraints, you actually can ``rewind'' your
3471 program to a previously saved point in time, and begin debugging it
3472 again --- and you can change the course of events so as to debug a
3473 different execution path this time.
3475 @cindex checkpoints and process id
3476 Finally, there is one bit of internal program state that will be
3477 different when you return to a checkpoint --- the program's process
3478 id. Each checkpoint will have a unique process id (or @var{pid}),
3479 and each will be different from the program's original @var{pid}.
3480 If your program has saved a local copy of its process id, this could
3481 potentially pose a problem.
3483 @subsection A Non-obvious Benefit of Using Checkpoints
3485 On some systems such as @sc{gnu}/Linux, address space randomization
3486 is performed on new processes for security reasons. This makes it
3487 difficult or impossible to set a breakpoint, or watchpoint, on an
3488 absolute address if you have to restart the program, since the
3489 absolute location of a symbol will change from one execution to the
3492 A checkpoint, however, is an @emph{identical} copy of a process.
3493 Therefore if you create a checkpoint at (eg.@:) the start of main,
3494 and simply return to that checkpoint instead of restarting the
3495 process, you can avoid the effects of address randomization and
3496 your symbols will all stay in the same place.
3499 @chapter Stopping and Continuing
3501 The principal purposes of using a debugger are so that you can stop your
3502 program before it terminates; or so that, if your program runs into
3503 trouble, you can investigate and find out why.
3505 Inside @value{GDBN}, your program may stop for any of several reasons,
3506 such as a signal, a breakpoint, or reaching a new line after a
3507 @value{GDBN} command such as @code{step}. You may then examine and
3508 change variables, set new breakpoints or remove old ones, and then
3509 continue execution. Usually, the messages shown by @value{GDBN} provide
3510 ample explanation of the status of your program---but you can also
3511 explicitly request this information at any time.
3514 @kindex info program
3516 Display information about the status of your program: whether it is
3517 running or not, what process it is, and why it stopped.
3521 * Breakpoints:: Breakpoints, watchpoints, and catchpoints
3522 * Continuing and Stepping:: Resuming execution
3523 * Skipping Over Functions and Files::
3524 Skipping over functions and files
3526 * Thread Stops:: Stopping and starting multi-thread programs
3530 @section Breakpoints, Watchpoints, and Catchpoints
3533 A @dfn{breakpoint} makes your program stop whenever a certain point in
3534 the program is reached. For each breakpoint, you can add conditions to
3535 control in finer detail whether your program stops. You can set
3536 breakpoints with the @code{break} command and its variants (@pxref{Set
3537 Breaks, ,Setting Breakpoints}), to specify the place where your program
3538 should stop by line number, function name or exact address in the
3541 On some systems, you can set breakpoints in shared libraries before
3542 the executable is run.
3545 @cindex data breakpoints
3546 @cindex memory tracing
3547 @cindex breakpoint on memory address
3548 @cindex breakpoint on variable modification
3549 A @dfn{watchpoint} is a special breakpoint that stops your program
3550 when the value of an expression changes. The expression may be a value
3551 of a variable, or it could involve values of one or more variables
3552 combined by operators, such as @samp{a + b}. This is sometimes called
3553 @dfn{data breakpoints}. You must use a different command to set
3554 watchpoints (@pxref{Set Watchpoints, ,Setting Watchpoints}), but aside
3555 from that, you can manage a watchpoint like any other breakpoint: you
3556 enable, disable, and delete both breakpoints and watchpoints using the
3559 You can arrange to have values from your program displayed automatically
3560 whenever @value{GDBN} stops at a breakpoint. @xref{Auto Display,,
3564 @cindex breakpoint on events
3565 A @dfn{catchpoint} is another special breakpoint that stops your program
3566 when a certain kind of event occurs, such as the throwing of a C@t{++}
3567 exception or the loading of a library. As with watchpoints, you use a
3568 different command to set a catchpoint (@pxref{Set Catchpoints, ,Setting
3569 Catchpoints}), but aside from that, you can manage a catchpoint like any
3570 other breakpoint. (To stop when your program receives a signal, use the
3571 @code{handle} command; see @ref{Signals, ,Signals}.)
3573 @cindex breakpoint numbers
3574 @cindex numbers for breakpoints
3575 @value{GDBN} assigns a number to each breakpoint, watchpoint, or
3576 catchpoint when you create it; these numbers are successive integers
3577 starting with one. In many of the commands for controlling various
3578 features of breakpoints you use the breakpoint number to say which
3579 breakpoint you want to change. Each breakpoint may be @dfn{enabled} or
3580 @dfn{disabled}; if disabled, it has no effect on your program until you
3583 @cindex breakpoint ranges
3584 @cindex ranges of breakpoints
3585 Some @value{GDBN} commands accept a range of breakpoints on which to
3586 operate. A breakpoint range is either a single breakpoint number, like
3587 @samp{5}, or two such numbers, in increasing order, separated by a
3588 hyphen, like @samp{5-7}. When a breakpoint range is given to a command,
3589 all breakpoints in that range are operated on.
3592 * Set Breaks:: Setting breakpoints
3593 * Set Watchpoints:: Setting watchpoints
3594 * Set Catchpoints:: Setting catchpoints
3595 * Delete Breaks:: Deleting breakpoints
3596 * Disabling:: Disabling breakpoints
3597 * Conditions:: Break conditions
3598 * Break Commands:: Breakpoint command lists
3599 * Dynamic Printf:: Dynamic printf
3600 * Save Breakpoints:: How to save breakpoints in a file
3601 * Static Probe Points:: Listing static probe points
3602 * Error in Breakpoints:: ``Cannot insert breakpoints''
3603 * Breakpoint-related Warnings:: ``Breakpoint address adjusted...''
3607 @subsection Setting Breakpoints
3609 @c FIXME LMB what does GDB do if no code on line of breakpt?
3610 @c consider in particular declaration with/without initialization.
3612 @c FIXME 2 is there stuff on this already? break at fun start, already init?
3615 @kindex b @r{(@code{break})}
3616 @vindex $bpnum@r{, convenience variable}
3617 @cindex latest breakpoint
3618 Breakpoints are set with the @code{break} command (abbreviated
3619 @code{b}). The debugger convenience variable @samp{$bpnum} records the
3620 number of the breakpoint you've set most recently; see @ref{Convenience
3621 Vars,, Convenience Variables}, for a discussion of what you can do with
3622 convenience variables.
3625 @item break @var{location}
3626 Set a breakpoint at the given @var{location}, which can specify a
3627 function name, a line number, or an address of an instruction.
3628 (@xref{Specify Location}, for a list of all the possible ways to
3629 specify a @var{location}.) The breakpoint will stop your program just
3630 before it executes any of the code in the specified @var{location}.
3632 When using source languages that permit overloading of symbols, such as
3633 C@t{++}, a function name may refer to more than one possible place to break.
3634 @xref{Ambiguous Expressions,,Ambiguous Expressions}, for a discussion of
3637 It is also possible to insert a breakpoint that will stop the program
3638 only if a specific thread (@pxref{Thread-Specific Breakpoints})
3639 or a specific task (@pxref{Ada Tasks}) hits that breakpoint.
3642 When called without any arguments, @code{break} sets a breakpoint at
3643 the next instruction to be executed in the selected stack frame
3644 (@pxref{Stack, ,Examining the Stack}). In any selected frame but the
3645 innermost, this makes your program stop as soon as control
3646 returns to that frame. This is similar to the effect of a
3647 @code{finish} command in the frame inside the selected frame---except
3648 that @code{finish} does not leave an active breakpoint. If you use
3649 @code{break} without an argument in the innermost frame, @value{GDBN} stops
3650 the next time it reaches the current location; this may be useful
3653 @value{GDBN} normally ignores breakpoints when it resumes execution, until at
3654 least one instruction has been executed. If it did not do this, you
3655 would be unable to proceed past a breakpoint without first disabling the
3656 breakpoint. This rule applies whether or not the breakpoint already
3657 existed when your program stopped.
3659 @item break @dots{} if @var{cond}
3660 Set a breakpoint with condition @var{cond}; evaluate the expression
3661 @var{cond} each time the breakpoint is reached, and stop only if the
3662 value is nonzero---that is, if @var{cond} evaluates as true.
3663 @samp{@dots{}} stands for one of the possible arguments described
3664 above (or no argument) specifying where to break. @xref{Conditions,
3665 ,Break Conditions}, for more information on breakpoint conditions.
3668 @item tbreak @var{args}
3669 Set a breakpoint enabled only for one stop. The @var{args} are the
3670 same as for the @code{break} command, and the breakpoint is set in the same
3671 way, but the breakpoint is automatically deleted after the first time your
3672 program stops there. @xref{Disabling, ,Disabling Breakpoints}.
3675 @cindex hardware breakpoints
3676 @item hbreak @var{args}
3677 Set a hardware-assisted breakpoint. The @var{args} are the same as for the
3678 @code{break} command and the breakpoint is set in the same way, but the
3679 breakpoint requires hardware support and some target hardware may not
3680 have this support. The main purpose of this is EPROM/ROM code
3681 debugging, so you can set a breakpoint at an instruction without
3682 changing the instruction. This can be used with the new trap-generation
3683 provided by SPARClite DSU and most x86-based targets. These targets
3684 will generate traps when a program accesses some data or instruction
3685 address that is assigned to the debug registers. However the hardware
3686 breakpoint registers can take a limited number of breakpoints. For
3687 example, on the DSU, only two data breakpoints can be set at a time, and
3688 @value{GDBN} will reject this command if more than two are used. Delete
3689 or disable unused hardware breakpoints before setting new ones
3690 (@pxref{Disabling, ,Disabling Breakpoints}).
3691 @xref{Conditions, ,Break Conditions}.
3692 For remote targets, you can restrict the number of hardware
3693 breakpoints @value{GDBN} will use, see @ref{set remote
3694 hardware-breakpoint-limit}.
3697 @item thbreak @var{args}
3698 Set a hardware-assisted breakpoint enabled only for one stop. The @var{args}
3699 are the same as for the @code{hbreak} command and the breakpoint is set in
3700 the same way. However, like the @code{tbreak} command,
3701 the breakpoint is automatically deleted after the
3702 first time your program stops there. Also, like the @code{hbreak}
3703 command, the breakpoint requires hardware support and some target hardware
3704 may not have this support. @xref{Disabling, ,Disabling Breakpoints}.
3705 See also @ref{Conditions, ,Break Conditions}.
3708 @cindex regular expression
3709 @cindex breakpoints at functions matching a regexp
3710 @cindex set breakpoints in many functions
3711 @item rbreak @var{regex}
3712 Set breakpoints on all functions matching the regular expression
3713 @var{regex}. This command sets an unconditional breakpoint on all
3714 matches, printing a list of all breakpoints it set. Once these
3715 breakpoints are set, they are treated just like the breakpoints set with
3716 the @code{break} command. You can delete them, disable them, or make
3717 them conditional the same way as any other breakpoint.
3719 The syntax of the regular expression is the standard one used with tools
3720 like @file{grep}. Note that this is different from the syntax used by
3721 shells, so for instance @code{foo*} matches all functions that include
3722 an @code{fo} followed by zero or more @code{o}s. There is an implicit
3723 @code{.*} leading and trailing the regular expression you supply, so to
3724 match only functions that begin with @code{foo}, use @code{^foo}.
3726 @cindex non-member C@t{++} functions, set breakpoint in
3727 When debugging C@t{++} programs, @code{rbreak} is useful for setting
3728 breakpoints on overloaded functions that are not members of any special
3731 @cindex set breakpoints on all functions
3732 The @code{rbreak} command can be used to set breakpoints in
3733 @strong{all} the functions in a program, like this:
3736 (@value{GDBP}) rbreak .
3739 @item rbreak @var{file}:@var{regex}
3740 If @code{rbreak} is called with a filename qualification, it limits
3741 the search for functions matching the given regular expression to the
3742 specified @var{file}. This can be used, for example, to set breakpoints on
3743 every function in a given file:
3746 (@value{GDBP}) rbreak file.c:.
3749 The colon separating the filename qualifier from the regex may
3750 optionally be surrounded by spaces.
3752 @kindex info breakpoints
3753 @cindex @code{$_} and @code{info breakpoints}
3754 @item info breakpoints @r{[}@var{n}@dots{}@r{]}
3755 @itemx info break @r{[}@var{n}@dots{}@r{]}
3756 Print a table of all breakpoints, watchpoints, and catchpoints set and
3757 not deleted. Optional argument @var{n} means print information only
3758 about the specified breakpoint(s) (or watchpoint(s) or catchpoint(s)).
3759 For each breakpoint, following columns are printed:
3762 @item Breakpoint Numbers
3764 Breakpoint, watchpoint, or catchpoint.
3766 Whether the breakpoint is marked to be disabled or deleted when hit.
3767 @item Enabled or Disabled
3768 Enabled breakpoints are marked with @samp{y}. @samp{n} marks breakpoints
3769 that are not enabled.
3771 Where the breakpoint is in your program, as a memory address. For a
3772 pending breakpoint whose address is not yet known, this field will
3773 contain @samp{<PENDING>}. Such breakpoint won't fire until a shared
3774 library that has the symbol or line referred by breakpoint is loaded.
3775 See below for details. A breakpoint with several locations will
3776 have @samp{<MULTIPLE>} in this field---see below for details.
3778 Where the breakpoint is in the source for your program, as a file and
3779 line number. For a pending breakpoint, the original string passed to
3780 the breakpoint command will be listed as it cannot be resolved until
3781 the appropriate shared library is loaded in the future.
3785 If a breakpoint is conditional, there are two evaluation modes: ``host'' and
3786 ``target''. If mode is ``host'', breakpoint condition evaluation is done by
3787 @value{GDBN} on the host's side. If it is ``target'', then the condition
3788 is evaluated by the target. The @code{info break} command shows
3789 the condition on the line following the affected breakpoint, together with
3790 its condition evaluation mode in between parentheses.
3792 Breakpoint commands, if any, are listed after that. A pending breakpoint is
3793 allowed to have a condition specified for it. The condition is not parsed for
3794 validity until a shared library is loaded that allows the pending
3795 breakpoint to resolve to a valid location.
3798 @code{info break} with a breakpoint
3799 number @var{n} as argument lists only that breakpoint. The
3800 convenience variable @code{$_} and the default examining-address for
3801 the @code{x} command are set to the address of the last breakpoint
3802 listed (@pxref{Memory, ,Examining Memory}).
3805 @code{info break} displays a count of the number of times the breakpoint
3806 has been hit. This is especially useful in conjunction with the
3807 @code{ignore} command. You can ignore a large number of breakpoint
3808 hits, look at the breakpoint info to see how many times the breakpoint
3809 was hit, and then run again, ignoring one less than that number. This
3810 will get you quickly to the last hit of that breakpoint.
3813 For a breakpoints with an enable count (xref) greater than 1,
3814 @code{info break} also displays that count.
3818 @value{GDBN} allows you to set any number of breakpoints at the same place in
3819 your program. There is nothing silly or meaningless about this. When
3820 the breakpoints are conditional, this is even useful
3821 (@pxref{Conditions, ,Break Conditions}).
3823 @cindex multiple locations, breakpoints
3824 @cindex breakpoints, multiple locations
3825 It is possible that a breakpoint corresponds to several locations
3826 in your program. Examples of this situation are:
3830 Multiple functions in the program may have the same name.
3833 For a C@t{++} constructor, the @value{NGCC} compiler generates several
3834 instances of the function body, used in different cases.
3837 For a C@t{++} template function, a given line in the function can
3838 correspond to any number of instantiations.
3841 For an inlined function, a given source line can correspond to
3842 several places where that function is inlined.
3845 In all those cases, @value{GDBN} will insert a breakpoint at all
3846 the relevant locations.
3848 A breakpoint with multiple locations is displayed in the breakpoint
3849 table using several rows---one header row, followed by one row for
3850 each breakpoint location. The header row has @samp{<MULTIPLE>} in the
3851 address column. The rows for individual locations contain the actual
3852 addresses for locations, and show the functions to which those
3853 locations belong. The number column for a location is of the form
3854 @var{breakpoint-number}.@var{location-number}.
3859 Num Type Disp Enb Address What
3860 1 breakpoint keep y <MULTIPLE>
3862 breakpoint already hit 1 time
3863 1.1 y 0x080486a2 in void foo<int>() at t.cc:8
3864 1.2 y 0x080486ca in void foo<double>() at t.cc:8
3867 Each location can be individually enabled or disabled by passing
3868 @var{breakpoint-number}.@var{location-number} as argument to the
3869 @code{enable} and @code{disable} commands. Note that you cannot
3870 delete the individual locations from the list, you can only delete the
3871 entire list of locations that belong to their parent breakpoint (with
3872 the @kbd{delete @var{num}} command, where @var{num} is the number of
3873 the parent breakpoint, 1 in the above example). Disabling or enabling
3874 the parent breakpoint (@pxref{Disabling}) affects all of the locations
3875 that belong to that breakpoint.
3877 @cindex pending breakpoints
3878 It's quite common to have a breakpoint inside a shared library.
3879 Shared libraries can be loaded and unloaded explicitly,
3880 and possibly repeatedly, as the program is executed. To support
3881 this use case, @value{GDBN} updates breakpoint locations whenever
3882 any shared library is loaded or unloaded. Typically, you would
3883 set a breakpoint in a shared library at the beginning of your
3884 debugging session, when the library is not loaded, and when the
3885 symbols from the library are not available. When you try to set
3886 breakpoint, @value{GDBN} will ask you if you want to set
3887 a so called @dfn{pending breakpoint}---breakpoint whose address
3888 is not yet resolved.
3890 After the program is run, whenever a new shared library is loaded,
3891 @value{GDBN} reevaluates all the breakpoints. When a newly loaded
3892 shared library contains the symbol or line referred to by some
3893 pending breakpoint, that breakpoint is resolved and becomes an
3894 ordinary breakpoint. When a library is unloaded, all breakpoints
3895 that refer to its symbols or source lines become pending again.
3897 This logic works for breakpoints with multiple locations, too. For
3898 example, if you have a breakpoint in a C@t{++} template function, and
3899 a newly loaded shared library has an instantiation of that template,
3900 a new location is added to the list of locations for the breakpoint.
3902 Except for having unresolved address, pending breakpoints do not
3903 differ from regular breakpoints. You can set conditions or commands,
3904 enable and disable them and perform other breakpoint operations.
3906 @value{GDBN} provides some additional commands for controlling what
3907 happens when the @samp{break} command cannot resolve breakpoint
3908 address specification to an address:
3910 @kindex set breakpoint pending
3911 @kindex show breakpoint pending
3913 @item set breakpoint pending auto
3914 This is the default behavior. When @value{GDBN} cannot find the breakpoint
3915 location, it queries you whether a pending breakpoint should be created.
3917 @item set breakpoint pending on
3918 This indicates that an unrecognized breakpoint location should automatically
3919 result in a pending breakpoint being created.
3921 @item set breakpoint pending off
3922 This indicates that pending breakpoints are not to be created. Any
3923 unrecognized breakpoint location results in an error. This setting does
3924 not affect any pending breakpoints previously created.
3926 @item show breakpoint pending
3927 Show the current behavior setting for creating pending breakpoints.
3930 The settings above only affect the @code{break} command and its
3931 variants. Once breakpoint is set, it will be automatically updated
3932 as shared libraries are loaded and unloaded.
3934 @cindex automatic hardware breakpoints
3935 For some targets, @value{GDBN} can automatically decide if hardware or
3936 software breakpoints should be used, depending on whether the
3937 breakpoint address is read-only or read-write. This applies to
3938 breakpoints set with the @code{break} command as well as to internal
3939 breakpoints set by commands like @code{next} and @code{finish}. For
3940 breakpoints set with @code{hbreak}, @value{GDBN} will always use hardware
3943 You can control this automatic behaviour with the following commands::
3945 @kindex set breakpoint auto-hw
3946 @kindex show breakpoint auto-hw
3948 @item set breakpoint auto-hw on
3949 This is the default behavior. When @value{GDBN} sets a breakpoint, it
3950 will try to use the target memory map to decide if software or hardware
3951 breakpoint must be used.
3953 @item set breakpoint auto-hw off
3954 This indicates @value{GDBN} should not automatically select breakpoint
3955 type. If the target provides a memory map, @value{GDBN} will warn when
3956 trying to set software breakpoint at a read-only address.
3959 @value{GDBN} normally implements breakpoints by replacing the program code
3960 at the breakpoint address with a special instruction, which, when
3961 executed, given control to the debugger. By default, the program
3962 code is so modified only when the program is resumed. As soon as
3963 the program stops, @value{GDBN} restores the original instructions. This
3964 behaviour guards against leaving breakpoints inserted in the
3965 target should gdb abrubptly disconnect. However, with slow remote
3966 targets, inserting and removing breakpoint can reduce the performance.
3967 This behavior can be controlled with the following commands::
3969 @kindex set breakpoint always-inserted
3970 @kindex show breakpoint always-inserted
3972 @item set breakpoint always-inserted off
3973 All breakpoints, including newly added by the user, are inserted in
3974 the target only when the target is resumed. All breakpoints are
3975 removed from the target when it stops. This is the default mode.
3977 @item set breakpoint always-inserted on
3978 Causes all breakpoints to be inserted in the target at all times. If
3979 the user adds a new breakpoint, or changes an existing breakpoint, the
3980 breakpoints in the target are updated immediately. A breakpoint is
3981 removed from the target only when breakpoint itself is deleted.
3984 @value{GDBN} handles conditional breakpoints by evaluating these conditions
3985 when a breakpoint breaks. If the condition is true, then the process being
3986 debugged stops, otherwise the process is resumed.
3988 If the target supports evaluating conditions on its end, @value{GDBN} may
3989 download the breakpoint, together with its conditions, to it.
3991 This feature can be controlled via the following commands:
3993 @kindex set breakpoint condition-evaluation
3994 @kindex show breakpoint condition-evaluation
3996 @item set breakpoint condition-evaluation host
3997 This option commands @value{GDBN} to evaluate the breakpoint
3998 conditions on the host's side. Unconditional breakpoints are sent to
3999 the target which in turn receives the triggers and reports them back to GDB
4000 for condition evaluation. This is the standard evaluation mode.
4002 @item set breakpoint condition-evaluation target
4003 This option commands @value{GDBN} to download breakpoint conditions
4004 to the target at the moment of their insertion. The target
4005 is responsible for evaluating the conditional expression and reporting
4006 breakpoint stop events back to @value{GDBN} whenever the condition
4007 is true. Due to limitations of target-side evaluation, some conditions
4008 cannot be evaluated there, e.g., conditions that depend on local data
4009 that is only known to the host. Examples include
4010 conditional expressions involving convenience variables, complex types
4011 that cannot be handled by the agent expression parser and expressions
4012 that are too long to be sent over to the target, specially when the
4013 target is a remote system. In these cases, the conditions will be
4014 evaluated by @value{GDBN}.
4016 @item set breakpoint condition-evaluation auto
4017 This is the default mode. If the target supports evaluating breakpoint
4018 conditions on its end, @value{GDBN} will download breakpoint conditions to
4019 the target (limitations mentioned previously apply). If the target does
4020 not support breakpoint condition evaluation, then @value{GDBN} will fallback
4021 to evaluating all these conditions on the host's side.
4025 @cindex negative breakpoint numbers
4026 @cindex internal @value{GDBN} breakpoints
4027 @value{GDBN} itself sometimes sets breakpoints in your program for
4028 special purposes, such as proper handling of @code{longjmp} (in C
4029 programs). These internal breakpoints are assigned negative numbers,
4030 starting with @code{-1}; @samp{info breakpoints} does not display them.
4031 You can see these breakpoints with the @value{GDBN} maintenance command
4032 @samp{maint info breakpoints} (@pxref{maint info breakpoints}).
4035 @node Set Watchpoints
4036 @subsection Setting Watchpoints
4038 @cindex setting watchpoints
4039 You can use a watchpoint to stop execution whenever the value of an
4040 expression changes, without having to predict a particular place where
4041 this may happen. (This is sometimes called a @dfn{data breakpoint}.)
4042 The expression may be as simple as the value of a single variable, or
4043 as complex as many variables combined by operators. Examples include:
4047 A reference to the value of a single variable.
4050 An address cast to an appropriate data type. For example,
4051 @samp{*(int *)0x12345678} will watch a 4-byte region at the specified
4052 address (assuming an @code{int} occupies 4 bytes).
4055 An arbitrarily complex expression, such as @samp{a*b + c/d}. The
4056 expression can use any operators valid in the program's native
4057 language (@pxref{Languages}).
4060 You can set a watchpoint on an expression even if the expression can
4061 not be evaluated yet. For instance, you can set a watchpoint on
4062 @samp{*global_ptr} before @samp{global_ptr} is initialized.
4063 @value{GDBN} will stop when your program sets @samp{global_ptr} and
4064 the expression produces a valid value. If the expression becomes
4065 valid in some other way than changing a variable (e.g.@: if the memory
4066 pointed to by @samp{*global_ptr} becomes readable as the result of a
4067 @code{malloc} call), @value{GDBN} may not stop until the next time
4068 the expression changes.
4070 @cindex software watchpoints
4071 @cindex hardware watchpoints
4072 Depending on your system, watchpoints may be implemented in software or
4073 hardware. @value{GDBN} does software watchpointing by single-stepping your
4074 program and testing the variable's value each time, which is hundreds of
4075 times slower than normal execution. (But this may still be worth it, to
4076 catch errors where you have no clue what part of your program is the
4079 On some systems, such as most PowerPC or x86-based targets,
4080 @value{GDBN} includes support for hardware watchpoints, which do not
4081 slow down the running of your program.
4085 @item watch @r{[}-l@r{|}-location@r{]} @var{expr} @r{[}thread @var{thread-id}@r{]} @r{[}mask @var{maskvalue}@r{]}
4086 Set a watchpoint for an expression. @value{GDBN} will break when the
4087 expression @var{expr} is written into by the program and its value
4088 changes. The simplest (and the most popular) use of this command is
4089 to watch the value of a single variable:
4092 (@value{GDBP}) watch foo
4095 If the command includes a @code{@r{[}thread @var{thread-id}@r{]}}
4096 argument, @value{GDBN} breaks only when the thread identified by
4097 @var{thread-id} changes the value of @var{expr}. If any other threads
4098 change the value of @var{expr}, @value{GDBN} will not break. Note
4099 that watchpoints restricted to a single thread in this way only work
4100 with Hardware Watchpoints.
4102 Ordinarily a watchpoint respects the scope of variables in @var{expr}
4103 (see below). The @code{-location} argument tells @value{GDBN} to
4104 instead watch the memory referred to by @var{expr}. In this case,
4105 @value{GDBN} will evaluate @var{expr}, take the address of the result,
4106 and watch the memory at that address. The type of the result is used
4107 to determine the size of the watched memory. If the expression's
4108 result does not have an address, then @value{GDBN} will print an
4111 The @code{@r{[}mask @var{maskvalue}@r{]}} argument allows creation
4112 of masked watchpoints, if the current architecture supports this
4113 feature (e.g., PowerPC Embedded architecture, see @ref{PowerPC
4114 Embedded}.) A @dfn{masked watchpoint} specifies a mask in addition
4115 to an address to watch. The mask specifies that some bits of an address
4116 (the bits which are reset in the mask) should be ignored when matching
4117 the address accessed by the inferior against the watchpoint address.
4118 Thus, a masked watchpoint watches many addresses simultaneously---those
4119 addresses whose unmasked bits are identical to the unmasked bits in the
4120 watchpoint address. The @code{mask} argument implies @code{-location}.
4124 (@value{GDBP}) watch foo mask 0xffff00ff
4125 (@value{GDBP}) watch *0xdeadbeef mask 0xffffff00
4129 @item rwatch @r{[}-l@r{|}-location@r{]} @var{expr} @r{[}thread @var{thread-id}@r{]} @r{[}mask @var{maskvalue}@r{]}
4130 Set a watchpoint that will break when the value of @var{expr} is read
4134 @item awatch @r{[}-l@r{|}-location@r{]} @var{expr} @r{[}thread @var{thread-id}@r{]} @r{[}mask @var{maskvalue}@r{]}
4135 Set a watchpoint that will break when @var{expr} is either read from
4136 or written into by the program.
4138 @kindex info watchpoints @r{[}@var{n}@dots{}@r{]}
4139 @item info watchpoints @r{[}@var{n}@dots{}@r{]}
4140 This command prints a list of watchpoints, using the same format as
4141 @code{info break} (@pxref{Set Breaks}).
4144 If you watch for a change in a numerically entered address you need to
4145 dereference it, as the address itself is just a constant number which will
4146 never change. @value{GDBN} refuses to create a watchpoint that watches
4147 a never-changing value:
4150 (@value{GDBP}) watch 0x600850
4151 Cannot watch constant value 0x600850.
4152 (@value{GDBP}) watch *(int *) 0x600850
4153 Watchpoint 1: *(int *) 6293584
4156 @value{GDBN} sets a @dfn{hardware watchpoint} if possible. Hardware
4157 watchpoints execute very quickly, and the debugger reports a change in
4158 value at the exact instruction where the change occurs. If @value{GDBN}
4159 cannot set a hardware watchpoint, it sets a software watchpoint, which
4160 executes more slowly and reports the change in value at the next
4161 @emph{statement}, not the instruction, after the change occurs.
4163 @cindex use only software watchpoints
4164 You can force @value{GDBN} to use only software watchpoints with the
4165 @kbd{set can-use-hw-watchpoints 0} command. With this variable set to
4166 zero, @value{GDBN} will never try to use hardware watchpoints, even if
4167 the underlying system supports them. (Note that hardware-assisted
4168 watchpoints that were set @emph{before} setting
4169 @code{can-use-hw-watchpoints} to zero will still use the hardware
4170 mechanism of watching expression values.)
4173 @item set can-use-hw-watchpoints
4174 @kindex set can-use-hw-watchpoints
4175 Set whether or not to use hardware watchpoints.
4177 @item show can-use-hw-watchpoints
4178 @kindex show can-use-hw-watchpoints
4179 Show the current mode of using hardware watchpoints.
4182 For remote targets, you can restrict the number of hardware
4183 watchpoints @value{GDBN} will use, see @ref{set remote
4184 hardware-breakpoint-limit}.
4186 When you issue the @code{watch} command, @value{GDBN} reports
4189 Hardware watchpoint @var{num}: @var{expr}
4193 if it was able to set a hardware watchpoint.
4195 Currently, the @code{awatch} and @code{rwatch} commands can only set
4196 hardware watchpoints, because accesses to data that don't change the
4197 value of the watched expression cannot be detected without examining
4198 every instruction as it is being executed, and @value{GDBN} does not do
4199 that currently. If @value{GDBN} finds that it is unable to set a
4200 hardware breakpoint with the @code{awatch} or @code{rwatch} command, it
4201 will print a message like this:
4204 Expression cannot be implemented with read/access watchpoint.
4207 Sometimes, @value{GDBN} cannot set a hardware watchpoint because the
4208 data type of the watched expression is wider than what a hardware
4209 watchpoint on the target machine can handle. For example, some systems
4210 can only watch regions that are up to 4 bytes wide; on such systems you
4211 cannot set hardware watchpoints for an expression that yields a
4212 double-precision floating-point number (which is typically 8 bytes
4213 wide). As a work-around, it might be possible to break the large region
4214 into a series of smaller ones and watch them with separate watchpoints.
4216 If you set too many hardware watchpoints, @value{GDBN} might be unable
4217 to insert all of them when you resume the execution of your program.
4218 Since the precise number of active watchpoints is unknown until such
4219 time as the program is about to be resumed, @value{GDBN} might not be
4220 able to warn you about this when you set the watchpoints, and the
4221 warning will be printed only when the program is resumed:
4224 Hardware watchpoint @var{num}: Could not insert watchpoint
4228 If this happens, delete or disable some of the watchpoints.
4230 Watching complex expressions that reference many variables can also
4231 exhaust the resources available for hardware-assisted watchpoints.
4232 That's because @value{GDBN} needs to watch every variable in the
4233 expression with separately allocated resources.
4235 If you call a function interactively using @code{print} or @code{call},
4236 any watchpoints you have set will be inactive until @value{GDBN} reaches another
4237 kind of breakpoint or the call completes.
4239 @value{GDBN} automatically deletes watchpoints that watch local
4240 (automatic) variables, or expressions that involve such variables, when
4241 they go out of scope, that is, when the execution leaves the block in
4242 which these variables were defined. In particular, when the program
4243 being debugged terminates, @emph{all} local variables go out of scope,
4244 and so only watchpoints that watch global variables remain set. If you
4245 rerun the program, you will need to set all such watchpoints again. One
4246 way of doing that would be to set a code breakpoint at the entry to the
4247 @code{main} function and when it breaks, set all the watchpoints.
4249 @cindex watchpoints and threads
4250 @cindex threads and watchpoints
4251 In multi-threaded programs, watchpoints will detect changes to the
4252 watched expression from every thread.
4255 @emph{Warning:} In multi-threaded programs, software watchpoints
4256 have only limited usefulness. If @value{GDBN} creates a software
4257 watchpoint, it can only watch the value of an expression @emph{in a
4258 single thread}. If you are confident that the expression can only
4259 change due to the current thread's activity (and if you are also
4260 confident that no other thread can become current), then you can use
4261 software watchpoints as usual. However, @value{GDBN} may not notice
4262 when a non-current thread's activity changes the expression. (Hardware
4263 watchpoints, in contrast, watch an expression in all threads.)
4266 @xref{set remote hardware-watchpoint-limit}.
4268 @node Set Catchpoints
4269 @subsection Setting Catchpoints
4270 @cindex catchpoints, setting
4271 @cindex exception handlers
4272 @cindex event handling
4274 You can use @dfn{catchpoints} to cause the debugger to stop for certain
4275 kinds of program events, such as C@t{++} exceptions or the loading of a
4276 shared library. Use the @code{catch} command to set a catchpoint.
4280 @item catch @var{event}
4281 Stop when @var{event} occurs. The @var{event} can be any of the following:
4284 @item throw @r{[}@var{regexp}@r{]}
4285 @itemx rethrow @r{[}@var{regexp}@r{]}
4286 @itemx catch @r{[}@var{regexp}@r{]}
4288 @kindex catch rethrow
4290 @cindex stop on C@t{++} exceptions
4291 The throwing, re-throwing, or catching of a C@t{++} exception.
4293 If @var{regexp} is given, then only exceptions whose type matches the
4294 regular expression will be caught.
4296 @vindex $_exception@r{, convenience variable}
4297 The convenience variable @code{$_exception} is available at an
4298 exception-related catchpoint, on some systems. This holds the
4299 exception being thrown.
4301 There are currently some limitations to C@t{++} exception handling in
4306 The support for these commands is system-dependent. Currently, only
4307 systems using the @samp{gnu-v3} C@t{++} ABI (@pxref{ABI}) are
4311 The regular expression feature and the @code{$_exception} convenience
4312 variable rely on the presence of some SDT probes in @code{libstdc++}.
4313 If these probes are not present, then these features cannot be used.
4314 These probes were first available in the GCC 4.8 release, but whether
4315 or not they are available in your GCC also depends on how it was
4319 The @code{$_exception} convenience variable is only valid at the
4320 instruction at which an exception-related catchpoint is set.
4323 When an exception-related catchpoint is hit, @value{GDBN} stops at a
4324 location in the system library which implements runtime exception
4325 support for C@t{++}, usually @code{libstdc++}. You can use @code{up}
4326 (@pxref{Selection}) to get to your code.
4329 If you call a function interactively, @value{GDBN} normally returns
4330 control to you when the function has finished executing. If the call
4331 raises an exception, however, the call may bypass the mechanism that
4332 returns control to you and cause your program either to abort or to
4333 simply continue running until it hits a breakpoint, catches a signal
4334 that @value{GDBN} is listening for, or exits. This is the case even if
4335 you set a catchpoint for the exception; catchpoints on exceptions are
4336 disabled within interactive calls. @xref{Calling}, for information on
4337 controlling this with @code{set unwind-on-terminating-exception}.
4340 You cannot raise an exception interactively.
4343 You cannot install an exception handler interactively.
4347 @kindex catch exception
4348 @cindex Ada exception catching
4349 @cindex catch Ada exceptions
4350 An Ada exception being raised. If an exception name is specified
4351 at the end of the command (eg @code{catch exception Program_Error}),
4352 the debugger will stop only when this specific exception is raised.
4353 Otherwise, the debugger stops execution when any Ada exception is raised.
4355 When inserting an exception catchpoint on a user-defined exception whose
4356 name is identical to one of the exceptions defined by the language, the
4357 fully qualified name must be used as the exception name. Otherwise,
4358 @value{GDBN} will assume that it should stop on the pre-defined exception
4359 rather than the user-defined one. For instance, assuming an exception
4360 called @code{Constraint_Error} is defined in package @code{Pck}, then
4361 the command to use to catch such exceptions is @kbd{catch exception
4362 Pck.Constraint_Error}.
4364 @item exception unhandled
4365 @kindex catch exception unhandled
4366 An exception that was raised but is not handled by the program.
4369 @kindex catch assert
4370 A failed Ada assertion.
4374 @cindex break on fork/exec
4375 A call to @code{exec}.
4378 @itemx syscall @r{[}@var{name} @r{|} @var{number}@r{]} @dots{}
4379 @kindex catch syscall
4380 @cindex break on a system call.
4381 A call to or return from a system call, a.k.a.@: @dfn{syscall}. A
4382 syscall is a mechanism for application programs to request a service
4383 from the operating system (OS) or one of the OS system services.
4384 @value{GDBN} can catch some or all of the syscalls issued by the
4385 debuggee, and show the related information for each syscall. If no
4386 argument is specified, calls to and returns from all system calls
4389 @var{name} can be any system call name that is valid for the
4390 underlying OS. Just what syscalls are valid depends on the OS. On
4391 GNU and Unix systems, you can find the full list of valid syscall
4392 names on @file{/usr/include/asm/unistd.h}.
4394 @c For MS-Windows, the syscall names and the corresponding numbers
4395 @c can be found, e.g., on this URL:
4396 @c http://www.metasploit.com/users/opcode/syscalls.html
4397 @c but we don't support Windows syscalls yet.
4399 Normally, @value{GDBN} knows in advance which syscalls are valid for
4400 each OS, so you can use the @value{GDBN} command-line completion
4401 facilities (@pxref{Completion,, command completion}) to list the
4404 You may also specify the system call numerically. A syscall's
4405 number is the value passed to the OS's syscall dispatcher to
4406 identify the requested service. When you specify the syscall by its
4407 name, @value{GDBN} uses its database of syscalls to convert the name
4408 into the corresponding numeric code, but using the number directly
4409 may be useful if @value{GDBN}'s database does not have the complete
4410 list of syscalls on your system (e.g., because @value{GDBN} lags
4411 behind the OS upgrades).
4413 The example below illustrates how this command works if you don't provide
4417 (@value{GDBP}) catch syscall
4418 Catchpoint 1 (syscall)
4420 Starting program: /tmp/catch-syscall
4422 Catchpoint 1 (call to syscall 'close'), \
4423 0xffffe424 in __kernel_vsyscall ()
4427 Catchpoint 1 (returned from syscall 'close'), \
4428 0xffffe424 in __kernel_vsyscall ()
4432 Here is an example of catching a system call by name:
4435 (@value{GDBP}) catch syscall chroot
4436 Catchpoint 1 (syscall 'chroot' [61])
4438 Starting program: /tmp/catch-syscall
4440 Catchpoint 1 (call to syscall 'chroot'), \
4441 0xffffe424 in __kernel_vsyscall ()
4445 Catchpoint 1 (returned from syscall 'chroot'), \
4446 0xffffe424 in __kernel_vsyscall ()
4450 An example of specifying a system call numerically. In the case
4451 below, the syscall number has a corresponding entry in the XML
4452 file, so @value{GDBN} finds its name and prints it:
4455 (@value{GDBP}) catch syscall 252
4456 Catchpoint 1 (syscall(s) 'exit_group')
4458 Starting program: /tmp/catch-syscall
4460 Catchpoint 1 (call to syscall 'exit_group'), \
4461 0xffffe424 in __kernel_vsyscall ()
4465 Program exited normally.
4469 However, there can be situations when there is no corresponding name
4470 in XML file for that syscall number. In this case, @value{GDBN} prints
4471 a warning message saying that it was not able to find the syscall name,
4472 but the catchpoint will be set anyway. See the example below:
4475 (@value{GDBP}) catch syscall 764
4476 warning: The number '764' does not represent a known syscall.
4477 Catchpoint 2 (syscall 764)
4481 If you configure @value{GDBN} using the @samp{--without-expat} option,
4482 it will not be able to display syscall names. Also, if your
4483 architecture does not have an XML file describing its system calls,
4484 you will not be able to see the syscall names. It is important to
4485 notice that these two features are used for accessing the syscall
4486 name database. In either case, you will see a warning like this:
4489 (@value{GDBP}) catch syscall
4490 warning: Could not open "syscalls/i386-linux.xml"
4491 warning: Could not load the syscall XML file 'syscalls/i386-linux.xml'.
4492 GDB will not be able to display syscall names.
4493 Catchpoint 1 (syscall)
4497 Of course, the file name will change depending on your architecture and system.
4499 Still using the example above, you can also try to catch a syscall by its
4500 number. In this case, you would see something like:
4503 (@value{GDBP}) catch syscall 252
4504 Catchpoint 1 (syscall(s) 252)
4507 Again, in this case @value{GDBN} would not be able to display syscall's names.
4511 A call to @code{fork}.
4515 A call to @code{vfork}.
4517 @item load @r{[}regexp@r{]}
4518 @itemx unload @r{[}regexp@r{]}
4520 @kindex catch unload
4521 The loading or unloading of a shared library. If @var{regexp} is
4522 given, then the catchpoint will stop only if the regular expression
4523 matches one of the affected libraries.
4525 @item signal @r{[}@var{signal}@dots{} @r{|} @samp{all}@r{]}
4526 @kindex catch signal
4527 The delivery of a signal.
4529 With no arguments, this catchpoint will catch any signal that is not
4530 used internally by @value{GDBN}, specifically, all signals except
4531 @samp{SIGTRAP} and @samp{SIGINT}.
4533 With the argument @samp{all}, all signals, including those used by
4534 @value{GDBN}, will be caught. This argument cannot be used with other
4537 Otherwise, the arguments are a list of signal names as given to
4538 @code{handle} (@pxref{Signals}). Only signals specified in this list
4541 One reason that @code{catch signal} can be more useful than
4542 @code{handle} is that you can attach commands and conditions to the
4545 When a signal is caught by a catchpoint, the signal's @code{stop} and
4546 @code{print} settings, as specified by @code{handle}, are ignored.
4547 However, whether the signal is still delivered to the inferior depends
4548 on the @code{pass} setting; this can be changed in the catchpoint's
4553 @item tcatch @var{event}
4555 Set a catchpoint that is enabled only for one stop. The catchpoint is
4556 automatically deleted after the first time the event is caught.
4560 Use the @code{info break} command to list the current catchpoints.
4564 @subsection Deleting Breakpoints
4566 @cindex clearing breakpoints, watchpoints, catchpoints
4567 @cindex deleting breakpoints, watchpoints, catchpoints
4568 It is often necessary to eliminate a breakpoint, watchpoint, or
4569 catchpoint once it has done its job and you no longer want your program
4570 to stop there. This is called @dfn{deleting} the breakpoint. A
4571 breakpoint that has been deleted no longer exists; it is forgotten.
4573 With the @code{clear} command you can delete breakpoints according to
4574 where they are in your program. With the @code{delete} command you can
4575 delete individual breakpoints, watchpoints, or catchpoints by specifying
4576 their breakpoint numbers.
4578 It is not necessary to delete a breakpoint to proceed past it. @value{GDBN}
4579 automatically ignores breakpoints on the first instruction to be executed
4580 when you continue execution without changing the execution address.
4585 Delete any breakpoints at the next instruction to be executed in the
4586 selected stack frame (@pxref{Selection, ,Selecting a Frame}). When
4587 the innermost frame is selected, this is a good way to delete a
4588 breakpoint where your program just stopped.
4590 @item clear @var{location}
4591 Delete any breakpoints set at the specified @var{location}.
4592 @xref{Specify Location}, for the various forms of @var{location}; the
4593 most useful ones are listed below:
4596 @item clear @var{function}
4597 @itemx clear @var{filename}:@var{function}
4598 Delete any breakpoints set at entry to the named @var{function}.
4600 @item clear @var{linenum}
4601 @itemx clear @var{filename}:@var{linenum}
4602 Delete any breakpoints set at or within the code of the specified
4603 @var{linenum} of the specified @var{filename}.
4606 @cindex delete breakpoints
4608 @kindex d @r{(@code{delete})}
4609 @item delete @r{[}breakpoints@r{]} @r{[}@var{range}@dots{}@r{]}
4610 Delete the breakpoints, watchpoints, or catchpoints of the breakpoint
4611 ranges specified as arguments. If no argument is specified, delete all
4612 breakpoints (@value{GDBN} asks confirmation, unless you have @code{set
4613 confirm off}). You can abbreviate this command as @code{d}.
4617 @subsection Disabling Breakpoints
4619 @cindex enable/disable a breakpoint
4620 Rather than deleting a breakpoint, watchpoint, or catchpoint, you might
4621 prefer to @dfn{disable} it. This makes the breakpoint inoperative as if
4622 it had been deleted, but remembers the information on the breakpoint so
4623 that you can @dfn{enable} it again later.
4625 You disable and enable breakpoints, watchpoints, and catchpoints with
4626 the @code{enable} and @code{disable} commands, optionally specifying
4627 one or more breakpoint numbers as arguments. Use @code{info break} to
4628 print a list of all breakpoints, watchpoints, and catchpoints if you
4629 do not know which numbers to use.
4631 Disabling and enabling a breakpoint that has multiple locations
4632 affects all of its locations.
4634 A breakpoint, watchpoint, or catchpoint can have any of several
4635 different states of enablement:
4639 Enabled. The breakpoint stops your program. A breakpoint set
4640 with the @code{break} command starts out in this state.
4642 Disabled. The breakpoint has no effect on your program.
4644 Enabled once. The breakpoint stops your program, but then becomes
4647 Enabled for a count. The breakpoint stops your program for the next
4648 N times, then becomes disabled.
4650 Enabled for deletion. The breakpoint stops your program, but
4651 immediately after it does so it is deleted permanently. A breakpoint
4652 set with the @code{tbreak} command starts out in this state.
4655 You can use the following commands to enable or disable breakpoints,
4656 watchpoints, and catchpoints:
4660 @kindex dis @r{(@code{disable})}
4661 @item disable @r{[}breakpoints@r{]} @r{[}@var{range}@dots{}@r{]}
4662 Disable the specified breakpoints---or all breakpoints, if none are
4663 listed. A disabled breakpoint has no effect but is not forgotten. All
4664 options such as ignore-counts, conditions and commands are remembered in
4665 case the breakpoint is enabled again later. You may abbreviate
4666 @code{disable} as @code{dis}.
4669 @item enable @r{[}breakpoints@r{]} @r{[}@var{range}@dots{}@r{]}
4670 Enable the specified breakpoints (or all defined breakpoints). They
4671 become effective once again in stopping your program.
4673 @item enable @r{[}breakpoints@r{]} once @var{range}@dots{}
4674 Enable the specified breakpoints temporarily. @value{GDBN} disables any
4675 of these breakpoints immediately after stopping your program.
4677 @item enable @r{[}breakpoints@r{]} count @var{count} @var{range}@dots{}
4678 Enable the specified breakpoints temporarily. @value{GDBN} records
4679 @var{count} with each of the specified breakpoints, and decrements a
4680 breakpoint's count when it is hit. When any count reaches 0,
4681 @value{GDBN} disables that breakpoint. If a breakpoint has an ignore
4682 count (@pxref{Conditions, ,Break Conditions}), that will be
4683 decremented to 0 before @var{count} is affected.
4685 @item enable @r{[}breakpoints@r{]} delete @var{range}@dots{}
4686 Enable the specified breakpoints to work once, then die. @value{GDBN}
4687 deletes any of these breakpoints as soon as your program stops there.
4688 Breakpoints set by the @code{tbreak} command start out in this state.
4691 @c FIXME: I think the following ``Except for [...] @code{tbreak}'' is
4692 @c confusing: tbreak is also initially enabled.
4693 Except for a breakpoint set with @code{tbreak} (@pxref{Set Breaks,
4694 ,Setting Breakpoints}), breakpoints that you set are initially enabled;
4695 subsequently, they become disabled or enabled only when you use one of
4696 the commands above. (The command @code{until} can set and delete a
4697 breakpoint of its own, but it does not change the state of your other
4698 breakpoints; see @ref{Continuing and Stepping, ,Continuing and
4702 @subsection Break Conditions
4703 @cindex conditional breakpoints
4704 @cindex breakpoint conditions
4706 @c FIXME what is scope of break condition expr? Context where wanted?
4707 @c in particular for a watchpoint?
4708 The simplest sort of breakpoint breaks every time your program reaches a
4709 specified place. You can also specify a @dfn{condition} for a
4710 breakpoint. A condition is just a Boolean expression in your
4711 programming language (@pxref{Expressions, ,Expressions}). A breakpoint with
4712 a condition evaluates the expression each time your program reaches it,
4713 and your program stops only if the condition is @emph{true}.
4715 This is the converse of using assertions for program validation; in that
4716 situation, you want to stop when the assertion is violated---that is,
4717 when the condition is false. In C, if you want to test an assertion expressed
4718 by the condition @var{assert}, you should set the condition
4719 @samp{! @var{assert}} on the appropriate breakpoint.
4721 Conditions are also accepted for watchpoints; you may not need them,
4722 since a watchpoint is inspecting the value of an expression anyhow---but
4723 it might be simpler, say, to just set a watchpoint on a variable name,
4724 and specify a condition that tests whether the new value is an interesting
4727 Break conditions can have side effects, and may even call functions in
4728 your program. This can be useful, for example, to activate functions
4729 that log program progress, or to use your own print functions to
4730 format special data structures. The effects are completely predictable
4731 unless there is another enabled breakpoint at the same address. (In
4732 that case, @value{GDBN} might see the other breakpoint first and stop your
4733 program without checking the condition of this one.) Note that
4734 breakpoint commands are usually more convenient and flexible than break
4736 purpose of performing side effects when a breakpoint is reached
4737 (@pxref{Break Commands, ,Breakpoint Command Lists}).
4739 Breakpoint conditions can also be evaluated on the target's side if
4740 the target supports it. Instead of evaluating the conditions locally,
4741 @value{GDBN} encodes the expression into an agent expression
4742 (@pxref{Agent Expressions}) suitable for execution on the target,
4743 independently of @value{GDBN}. Global variables become raw memory
4744 locations, locals become stack accesses, and so forth.
4746 In this case, @value{GDBN} will only be notified of a breakpoint trigger
4747 when its condition evaluates to true. This mechanism may provide faster
4748 response times depending on the performance characteristics of the target
4749 since it does not need to keep @value{GDBN} informed about
4750 every breakpoint trigger, even those with false conditions.
4752 Break conditions can be specified when a breakpoint is set, by using
4753 @samp{if} in the arguments to the @code{break} command. @xref{Set
4754 Breaks, ,Setting Breakpoints}. They can also be changed at any time
4755 with the @code{condition} command.
4757 You can also use the @code{if} keyword with the @code{watch} command.
4758 The @code{catch} command does not recognize the @code{if} keyword;
4759 @code{condition} is the only way to impose a further condition on a
4764 @item condition @var{bnum} @var{expression}
4765 Specify @var{expression} as the break condition for breakpoint,
4766 watchpoint, or catchpoint number @var{bnum}. After you set a condition,
4767 breakpoint @var{bnum} stops your program only if the value of
4768 @var{expression} is true (nonzero, in C). When you use
4769 @code{condition}, @value{GDBN} checks @var{expression} immediately for
4770 syntactic correctness, and to determine whether symbols in it have
4771 referents in the context of your breakpoint. If @var{expression} uses
4772 symbols not referenced in the context of the breakpoint, @value{GDBN}
4773 prints an error message:
4776 No symbol "foo" in current context.
4781 not actually evaluate @var{expression} at the time the @code{condition}
4782 command (or a command that sets a breakpoint with a condition, like
4783 @code{break if @dots{}}) is given, however. @xref{Expressions, ,Expressions}.
4785 @item condition @var{bnum}
4786 Remove the condition from breakpoint number @var{bnum}. It becomes
4787 an ordinary unconditional breakpoint.
4790 @cindex ignore count (of breakpoint)
4791 A special case of a breakpoint condition is to stop only when the
4792 breakpoint has been reached a certain number of times. This is so
4793 useful that there is a special way to do it, using the @dfn{ignore
4794 count} of the breakpoint. Every breakpoint has an ignore count, which
4795 is an integer. Most of the time, the ignore count is zero, and
4796 therefore has no effect. But if your program reaches a breakpoint whose
4797 ignore count is positive, then instead of stopping, it just decrements
4798 the ignore count by one and continues. As a result, if the ignore count
4799 value is @var{n}, the breakpoint does not stop the next @var{n} times
4800 your program reaches it.
4804 @item ignore @var{bnum} @var{count}
4805 Set the ignore count of breakpoint number @var{bnum} to @var{count}.
4806 The next @var{count} times the breakpoint is reached, your program's
4807 execution does not stop; other than to decrement the ignore count, @value{GDBN}
4810 To make the breakpoint stop the next time it is reached, specify
4813 When you use @code{continue} to resume execution of your program from a
4814 breakpoint, you can specify an ignore count directly as an argument to
4815 @code{continue}, rather than using @code{ignore}. @xref{Continuing and
4816 Stepping,,Continuing and Stepping}.
4818 If a breakpoint has a positive ignore count and a condition, the
4819 condition is not checked. Once the ignore count reaches zero,
4820 @value{GDBN} resumes checking the condition.
4822 You could achieve the effect of the ignore count with a condition such
4823 as @w{@samp{$foo-- <= 0}} using a debugger convenience variable that
4824 is decremented each time. @xref{Convenience Vars, ,Convenience
4828 Ignore counts apply to breakpoints, watchpoints, and catchpoints.
4831 @node Break Commands
4832 @subsection Breakpoint Command Lists
4834 @cindex breakpoint commands
4835 You can give any breakpoint (or watchpoint or catchpoint) a series of
4836 commands to execute when your program stops due to that breakpoint. For
4837 example, you might want to print the values of certain expressions, or
4838 enable other breakpoints.
4842 @kindex end@r{ (breakpoint commands)}
4843 @item commands @r{[}@var{range}@dots{}@r{]}
4844 @itemx @dots{} @var{command-list} @dots{}
4846 Specify a list of commands for the given breakpoints. The commands
4847 themselves appear on the following lines. Type a line containing just
4848 @code{end} to terminate the commands.
4850 To remove all commands from a breakpoint, type @code{commands} and
4851 follow it immediately with @code{end}; that is, give no commands.
4853 With no argument, @code{commands} refers to the last breakpoint,
4854 watchpoint, or catchpoint set (not to the breakpoint most recently
4855 encountered). If the most recent breakpoints were set with a single
4856 command, then the @code{commands} will apply to all the breakpoints
4857 set by that command. This applies to breakpoints set by
4858 @code{rbreak}, and also applies when a single @code{break} command
4859 creates multiple breakpoints (@pxref{Ambiguous Expressions,,Ambiguous
4863 Pressing @key{RET} as a means of repeating the last @value{GDBN} command is
4864 disabled within a @var{command-list}.
4866 You can use breakpoint commands to start your program up again. Simply
4867 use the @code{continue} command, or @code{step}, or any other command
4868 that resumes execution.
4870 Any other commands in the command list, after a command that resumes
4871 execution, are ignored. This is because any time you resume execution
4872 (even with a simple @code{next} or @code{step}), you may encounter
4873 another breakpoint---which could have its own command list, leading to
4874 ambiguities about which list to execute.
4877 If the first command you specify in a command list is @code{silent}, the
4878 usual message about stopping at a breakpoint is not printed. This may
4879 be desirable for breakpoints that are to print a specific message and
4880 then continue. If none of the remaining commands print anything, you
4881 see no sign that the breakpoint was reached. @code{silent} is
4882 meaningful only at the beginning of a breakpoint command list.
4884 The commands @code{echo}, @code{output}, and @code{printf} allow you to
4885 print precisely controlled output, and are often useful in silent
4886 breakpoints. @xref{Output, ,Commands for Controlled Output}.
4888 For example, here is how you could use breakpoint commands to print the
4889 value of @code{x} at entry to @code{foo} whenever @code{x} is positive.
4895 printf "x is %d\n",x
4900 One application for breakpoint commands is to compensate for one bug so
4901 you can test for another. Put a breakpoint just after the erroneous line
4902 of code, give it a condition to detect the case in which something
4903 erroneous has been done, and give it commands to assign correct values
4904 to any variables that need them. End with the @code{continue} command
4905 so that your program does not stop, and start with the @code{silent}
4906 command so that no output is produced. Here is an example:
4917 @node Dynamic Printf
4918 @subsection Dynamic Printf
4920 @cindex dynamic printf
4922 The dynamic printf command @code{dprintf} combines a breakpoint with
4923 formatted printing of your program's data to give you the effect of
4924 inserting @code{printf} calls into your program on-the-fly, without
4925 having to recompile it.
4927 In its most basic form, the output goes to the GDB console. However,
4928 you can set the variable @code{dprintf-style} for alternate handling.
4929 For instance, you can ask to format the output by calling your
4930 program's @code{printf} function. This has the advantage that the
4931 characters go to the program's output device, so they can recorded in
4932 redirects to files and so forth.
4934 If you are doing remote debugging with a stub or agent, you can also
4935 ask to have the printf handled by the remote agent. In addition to
4936 ensuring that the output goes to the remote program's device along
4937 with any other output the program might produce, you can also ask that
4938 the dprintf remain active even after disconnecting from the remote
4939 target. Using the stub/agent is also more efficient, as it can do
4940 everything without needing to communicate with @value{GDBN}.
4944 @item dprintf @var{location},@var{template},@var{expression}[,@var{expression}@dots{}]
4945 Whenever execution reaches @var{location}, print the values of one or
4946 more @var{expressions} under the control of the string @var{template}.
4947 To print several values, separate them with commas.
4949 @item set dprintf-style @var{style}
4950 Set the dprintf output to be handled in one of several different
4951 styles enumerated below. A change of style affects all existing
4952 dynamic printfs immediately. (If you need individual control over the
4953 print commands, simply define normal breakpoints with
4954 explicitly-supplied command lists.)
4957 @kindex dprintf-style gdb
4958 Handle the output using the @value{GDBN} @code{printf} command.
4961 @kindex dprintf-style call
4962 Handle the output by calling a function in your program (normally
4966 @kindex dprintf-style agent
4967 Have the remote debugging agent (such as @code{gdbserver}) handle
4968 the output itself. This style is only available for agents that
4969 support running commands on the target.
4971 @item set dprintf-function @var{function}
4972 Set the function to call if the dprintf style is @code{call}. By
4973 default its value is @code{printf}. You may set it to any expression.
4974 that @value{GDBN} can evaluate to a function, as per the @code{call}
4977 @item set dprintf-channel @var{channel}
4978 Set a ``channel'' for dprintf. If set to a non-empty value,
4979 @value{GDBN} will evaluate it as an expression and pass the result as
4980 a first argument to the @code{dprintf-function}, in the manner of
4981 @code{fprintf} and similar functions. Otherwise, the dprintf format
4982 string will be the first argument, in the manner of @code{printf}.
4984 As an example, if you wanted @code{dprintf} output to go to a logfile
4985 that is a standard I/O stream assigned to the variable @code{mylog},
4986 you could do the following:
4989 (gdb) set dprintf-style call
4990 (gdb) set dprintf-function fprintf
4991 (gdb) set dprintf-channel mylog
4992 (gdb) dprintf 25,"at line 25, glob=%d\n",glob
4993 Dprintf 1 at 0x123456: file main.c, line 25.
4995 1 dprintf keep y 0x00123456 in main at main.c:25
4996 call (void) fprintf (mylog,"at line 25, glob=%d\n",glob)
5001 Note that the @code{info break} displays the dynamic printf commands
5002 as normal breakpoint commands; you can thus easily see the effect of
5003 the variable settings.
5005 @item set disconnected-dprintf on
5006 @itemx set disconnected-dprintf off
5007 @kindex set disconnected-dprintf
5008 Choose whether @code{dprintf} commands should continue to run if
5009 @value{GDBN} has disconnected from the target. This only applies
5010 if the @code{dprintf-style} is @code{agent}.
5012 @item show disconnected-dprintf off
5013 @kindex show disconnected-dprintf
5014 Show the current choice for disconnected @code{dprintf}.
5018 @value{GDBN} does not check the validity of function and channel,
5019 relying on you to supply values that are meaningful for the contexts
5020 in which they are being used. For instance, the function and channel
5021 may be the values of local variables, but if that is the case, then
5022 all enabled dynamic prints must be at locations within the scope of
5023 those locals. If evaluation fails, @value{GDBN} will report an error.
5025 @node Save Breakpoints
5026 @subsection How to save breakpoints to a file
5028 To save breakpoint definitions to a file use the @w{@code{save
5029 breakpoints}} command.
5032 @kindex save breakpoints
5033 @cindex save breakpoints to a file for future sessions
5034 @item save breakpoints [@var{filename}]
5035 This command saves all current breakpoint definitions together with
5036 their commands and ignore counts, into a file @file{@var{filename}}
5037 suitable for use in a later debugging session. This includes all
5038 types of breakpoints (breakpoints, watchpoints, catchpoints,
5039 tracepoints). To read the saved breakpoint definitions, use the
5040 @code{source} command (@pxref{Command Files}). Note that watchpoints
5041 with expressions involving local variables may fail to be recreated
5042 because it may not be possible to access the context where the
5043 watchpoint is valid anymore. Because the saved breakpoint definitions
5044 are simply a sequence of @value{GDBN} commands that recreate the
5045 breakpoints, you can edit the file in your favorite editing program,
5046 and remove the breakpoint definitions you're not interested in, or
5047 that can no longer be recreated.
5050 @node Static Probe Points
5051 @subsection Static Probe Points
5053 @cindex static probe point, SystemTap
5054 @cindex static probe point, DTrace
5055 @value{GDBN} supports @dfn{SDT} probes in the code. @acronym{SDT} stands
5056 for Statically Defined Tracing, and the probes are designed to have a tiny
5057 runtime code and data footprint, and no dynamic relocations.
5059 Currently, the following types of probes are supported on
5060 ELF-compatible systems:
5064 @item @code{SystemTap} (@uref{http://sourceware.org/systemtap/})
5065 @acronym{SDT} probes@footnote{See
5066 @uref{http://sourceware.org/systemtap/wiki/AddingUserSpaceProbingToApps}
5067 for more information on how to add @code{SystemTap} @acronym{SDT}
5068 probes in your applications.}. @code{SystemTap} probes are usable
5069 from assembly, C and C@t{++} languages@footnote{See
5070 @uref{http://sourceware.org/systemtap/wiki/UserSpaceProbeImplementation}
5071 for a good reference on how the @acronym{SDT} probes are implemented.}.
5073 @item @code{DTrace} (@uref{http://oss.oracle.com/projects/DTrace})
5074 @acronym{USDT} probes. @code{DTrace} probes are usable from C and
5078 @cindex semaphores on static probe points
5079 Some @code{SystemTap} probes have an associated semaphore variable;
5080 for instance, this happens automatically if you defined your probe
5081 using a DTrace-style @file{.d} file. If your probe has a semaphore,
5082 @value{GDBN} will automatically enable it when you specify a
5083 breakpoint using the @samp{-probe-stap} notation. But, if you put a
5084 breakpoint at a probe's location by some other method (e.g.,
5085 @code{break file:line}), then @value{GDBN} will not automatically set
5086 the semaphore. @code{DTrace} probes do not support semaphores.
5088 You can examine the available static static probes using @code{info
5089 probes}, with optional arguments:
5093 @item info probes @r{[}@var{type}@r{]} @r{[}@var{provider} @r{[}@var{name} @r{[}@var{objfile}@r{]}@r{]}@r{]}
5094 If given, @var{type} is either @code{stap} for listing
5095 @code{SystemTap} probes or @code{dtrace} for listing @code{DTrace}
5096 probes. If omitted all probes are listed regardless of their types.
5098 If given, @var{provider} is a regular expression used to match against provider
5099 names when selecting which probes to list. If omitted, probes by all
5100 probes from all providers are listed.
5102 If given, @var{name} is a regular expression to match against probe names
5103 when selecting which probes to list. If omitted, probe names are not
5104 considered when deciding whether to display them.
5106 If given, @var{objfile} is a regular expression used to select which
5107 object files (executable or shared libraries) to examine. If not
5108 given, all object files are considered.
5110 @item info probes all
5111 List the available static probes, from all types.
5114 @cindex enabling and disabling probes
5115 Some probe points can be enabled and/or disabled. The effect of
5116 enabling or disabling a probe depends on the type of probe being
5117 handled. Some @code{DTrace} probes can be enabled or
5118 disabled, but @code{SystemTap} probes cannot be disabled.
5120 You can enable (or disable) one or more probes using the following
5121 commands, with optional arguments:
5124 @kindex enable probes
5125 @item enable probes @r{[}@var{provider} @r{[}@var{name} @r{[}@var{objfile}@r{]}@r{]}@r{]}
5126 If given, @var{provider} is a regular expression used to match against
5127 provider names when selecting which probes to enable. If omitted,
5128 all probes from all providers are enabled.
5130 If given, @var{name} is a regular expression to match against probe
5131 names when selecting which probes to enable. If omitted, probe names
5132 are not considered when deciding whether to enable them.
5134 If given, @var{objfile} is a regular expression used to select which
5135 object files (executable or shared libraries) to examine. If not
5136 given, all object files are considered.
5138 @kindex disable probes
5139 @item disable probes @r{[}@var{provider} @r{[}@var{name} @r{[}@var{objfile}@r{]}@r{]}@r{]}
5140 See the @code{enable probes} command above for a description of the
5141 optional arguments accepted by this command.
5144 @vindex $_probe_arg@r{, convenience variable}
5145 A probe may specify up to twelve arguments. These are available at the
5146 point at which the probe is defined---that is, when the current PC is
5147 at the probe's location. The arguments are available using the
5148 convenience variables (@pxref{Convenience Vars})
5149 @code{$_probe_arg0}@dots{}@code{$_probe_arg11}. In @code{SystemTap}
5150 probes each probe argument is an integer of the appropriate size;
5151 types are not preserved. In @code{DTrace} probes types are preserved
5152 provided that they are recognized as such by @value{GDBN}; otherwise
5153 the value of the probe argument will be a long integer. The
5154 convenience variable @code{$_probe_argc} holds the number of arguments
5155 at the current probe point.
5157 These variables are always available, but attempts to access them at
5158 any location other than a probe point will cause @value{GDBN} to give
5162 @c @ifclear BARETARGET
5163 @node Error in Breakpoints
5164 @subsection ``Cannot insert breakpoints''
5166 If you request too many active hardware-assisted breakpoints and
5167 watchpoints, you will see this error message:
5169 @c FIXME: the precise wording of this message may change; the relevant
5170 @c source change is not committed yet (Sep 3, 1999).
5172 Stopped; cannot insert breakpoints.
5173 You may have requested too many hardware breakpoints and watchpoints.
5177 This message is printed when you attempt to resume the program, since
5178 only then @value{GDBN} knows exactly how many hardware breakpoints and
5179 watchpoints it needs to insert.
5181 When this message is printed, you need to disable or remove some of the
5182 hardware-assisted breakpoints and watchpoints, and then continue.
5184 @node Breakpoint-related Warnings
5185 @subsection ``Breakpoint address adjusted...''
5186 @cindex breakpoint address adjusted
5188 Some processor architectures place constraints on the addresses at
5189 which breakpoints may be placed. For architectures thus constrained,
5190 @value{GDBN} will attempt to adjust the breakpoint's address to comply
5191 with the constraints dictated by the architecture.
5193 One example of such an architecture is the Fujitsu FR-V. The FR-V is
5194 a VLIW architecture in which a number of RISC-like instructions may be
5195 bundled together for parallel execution. The FR-V architecture
5196 constrains the location of a breakpoint instruction within such a
5197 bundle to the instruction with the lowest address. @value{GDBN}
5198 honors this constraint by adjusting a breakpoint's address to the
5199 first in the bundle.
5201 It is not uncommon for optimized code to have bundles which contain
5202 instructions from different source statements, thus it may happen that
5203 a breakpoint's address will be adjusted from one source statement to
5204 another. Since this adjustment may significantly alter @value{GDBN}'s
5205 breakpoint related behavior from what the user expects, a warning is
5206 printed when the breakpoint is first set and also when the breakpoint
5209 A warning like the one below is printed when setting a breakpoint
5210 that's been subject to address adjustment:
5213 warning: Breakpoint address adjusted from 0x00010414 to 0x00010410.
5216 Such warnings are printed both for user settable and @value{GDBN}'s
5217 internal breakpoints. If you see one of these warnings, you should
5218 verify that a breakpoint set at the adjusted address will have the
5219 desired affect. If not, the breakpoint in question may be removed and
5220 other breakpoints may be set which will have the desired behavior.
5221 E.g., it may be sufficient to place the breakpoint at a later
5222 instruction. A conditional breakpoint may also be useful in some
5223 cases to prevent the breakpoint from triggering too often.
5225 @value{GDBN} will also issue a warning when stopping at one of these
5226 adjusted breakpoints:
5229 warning: Breakpoint 1 address previously adjusted from 0x00010414
5233 When this warning is encountered, it may be too late to take remedial
5234 action except in cases where the breakpoint is hit earlier or more
5235 frequently than expected.
5237 @node Continuing and Stepping
5238 @section Continuing and Stepping
5242 @cindex resuming execution
5243 @dfn{Continuing} means resuming program execution until your program
5244 completes normally. In contrast, @dfn{stepping} means executing just
5245 one more ``step'' of your program, where ``step'' may mean either one
5246 line of source code, or one machine instruction (depending on what
5247 particular command you use). Either when continuing or when stepping,
5248 your program may stop even sooner, due to a breakpoint or a signal. (If
5249 it stops due to a signal, you may want to use @code{handle}, or use
5250 @samp{signal 0} to resume execution (@pxref{Signals, ,Signals}),
5251 or you may step into the signal's handler (@pxref{stepping and signal
5256 @kindex c @r{(@code{continue})}
5257 @kindex fg @r{(resume foreground execution)}
5258 @item continue @r{[}@var{ignore-count}@r{]}
5259 @itemx c @r{[}@var{ignore-count}@r{]}
5260 @itemx fg @r{[}@var{ignore-count}@r{]}
5261 Resume program execution, at the address where your program last stopped;
5262 any breakpoints set at that address are bypassed. The optional argument
5263 @var{ignore-count} allows you to specify a further number of times to
5264 ignore a breakpoint at this location; its effect is like that of
5265 @code{ignore} (@pxref{Conditions, ,Break Conditions}).
5267 The argument @var{ignore-count} is meaningful only when your program
5268 stopped due to a breakpoint. At other times, the argument to
5269 @code{continue} is ignored.
5271 The synonyms @code{c} and @code{fg} (for @dfn{foreground}, as the
5272 debugged program is deemed to be the foreground program) are provided
5273 purely for convenience, and have exactly the same behavior as
5277 To resume execution at a different place, you can use @code{return}
5278 (@pxref{Returning, ,Returning from a Function}) to go back to the
5279 calling function; or @code{jump} (@pxref{Jumping, ,Continuing at a
5280 Different Address}) to go to an arbitrary location in your program.
5282 A typical technique for using stepping is to set a breakpoint
5283 (@pxref{Breakpoints, ,Breakpoints; Watchpoints; and Catchpoints}) at the
5284 beginning of the function or the section of your program where a problem
5285 is believed to lie, run your program until it stops at that breakpoint,
5286 and then step through the suspect area, examining the variables that are
5287 interesting, until you see the problem happen.
5291 @kindex s @r{(@code{step})}
5293 Continue running your program until control reaches a different source
5294 line, then stop it and return control to @value{GDBN}. This command is
5295 abbreviated @code{s}.
5298 @c "without debugging information" is imprecise; actually "without line
5299 @c numbers in the debugging information". (gcc -g1 has debugging info but
5300 @c not line numbers). But it seems complex to try to make that
5301 @c distinction here.
5302 @emph{Warning:} If you use the @code{step} command while control is
5303 within a function that was compiled without debugging information,
5304 execution proceeds until control reaches a function that does have
5305 debugging information. Likewise, it will not step into a function which
5306 is compiled without debugging information. To step through functions
5307 without debugging information, use the @code{stepi} command, described
5311 The @code{step} command only stops at the first instruction of a source
5312 line. This prevents the multiple stops that could otherwise occur in
5313 @code{switch} statements, @code{for} loops, etc. @code{step} continues
5314 to stop if a function that has debugging information is called within
5315 the line. In other words, @code{step} @emph{steps inside} any functions
5316 called within the line.
5318 Also, the @code{step} command only enters a function if there is line
5319 number information for the function. Otherwise it acts like the
5320 @code{next} command. This avoids problems when using @code{cc -gl}
5321 on @acronym{MIPS} machines. Previously, @code{step} entered subroutines if there
5322 was any debugging information about the routine.
5324 @item step @var{count}
5325 Continue running as in @code{step}, but do so @var{count} times. If a
5326 breakpoint is reached, or a signal not related to stepping occurs before
5327 @var{count} steps, stepping stops right away.
5330 @kindex n @r{(@code{next})}
5331 @item next @r{[}@var{count}@r{]}
5332 Continue to the next source line in the current (innermost) stack frame.
5333 This is similar to @code{step}, but function calls that appear within
5334 the line of code are executed without stopping. Execution stops when
5335 control reaches a different line of code at the original stack level
5336 that was executing when you gave the @code{next} command. This command
5337 is abbreviated @code{n}.
5339 An argument @var{count} is a repeat count, as for @code{step}.
5342 @c FIX ME!! Do we delete this, or is there a way it fits in with
5343 @c the following paragraph? --- Vctoria
5345 @c @code{next} within a function that lacks debugging information acts like
5346 @c @code{step}, but any function calls appearing within the code of the
5347 @c function are executed without stopping.
5349 The @code{next} command only stops at the first instruction of a
5350 source line. This prevents multiple stops that could otherwise occur in
5351 @code{switch} statements, @code{for} loops, etc.
5353 @kindex set step-mode
5355 @cindex functions without line info, and stepping
5356 @cindex stepping into functions with no line info
5357 @itemx set step-mode on
5358 The @code{set step-mode on} command causes the @code{step} command to
5359 stop at the first instruction of a function which contains no debug line
5360 information rather than stepping over it.
5362 This is useful in cases where you may be interested in inspecting the
5363 machine instructions of a function which has no symbolic info and do not
5364 want @value{GDBN} to automatically skip over this function.
5366 @item set step-mode off
5367 Causes the @code{step} command to step over any functions which contains no
5368 debug information. This is the default.
5370 @item show step-mode
5371 Show whether @value{GDBN} will stop in or step over functions without
5372 source line debug information.
5375 @kindex fin @r{(@code{finish})}
5377 Continue running until just after function in the selected stack frame
5378 returns. Print the returned value (if any). This command can be
5379 abbreviated as @code{fin}.
5381 Contrast this with the @code{return} command (@pxref{Returning,
5382 ,Returning from a Function}).
5385 @kindex u @r{(@code{until})}
5386 @cindex run until specified location
5389 Continue running until a source line past the current line, in the
5390 current stack frame, is reached. This command is used to avoid single
5391 stepping through a loop more than once. It is like the @code{next}
5392 command, except that when @code{until} encounters a jump, it
5393 automatically continues execution until the program counter is greater
5394 than the address of the jump.
5396 This means that when you reach the end of a loop after single stepping
5397 though it, @code{until} makes your program continue execution until it
5398 exits the loop. In contrast, a @code{next} command at the end of a loop
5399 simply steps back to the beginning of the loop, which forces you to step
5400 through the next iteration.
5402 @code{until} always stops your program if it attempts to exit the current
5405 @code{until} may produce somewhat counterintuitive results if the order
5406 of machine code does not match the order of the source lines. For
5407 example, in the following excerpt from a debugging session, the @code{f}
5408 (@code{frame}) command shows that execution is stopped at line
5409 @code{206}; yet when we use @code{until}, we get to line @code{195}:
5413 #0 main (argc=4, argv=0xf7fffae8) at m4.c:206
5415 (@value{GDBP}) until
5416 195 for ( ; argc > 0; NEXTARG) @{
5419 This happened because, for execution efficiency, the compiler had
5420 generated code for the loop closure test at the end, rather than the
5421 start, of the loop---even though the test in a C @code{for}-loop is
5422 written before the body of the loop. The @code{until} command appeared
5423 to step back to the beginning of the loop when it advanced to this
5424 expression; however, it has not really gone to an earlier
5425 statement---not in terms of the actual machine code.
5427 @code{until} with no argument works by means of single
5428 instruction stepping, and hence is slower than @code{until} with an
5431 @item until @var{location}
5432 @itemx u @var{location}
5433 Continue running your program until either the specified @var{location} is
5434 reached, or the current stack frame returns. The location is any of
5435 the forms described in @ref{Specify Location}.
5436 This form of the command uses temporary breakpoints, and
5437 hence is quicker than @code{until} without an argument. The specified
5438 location is actually reached only if it is in the current frame. This
5439 implies that @code{until} can be used to skip over recursive function
5440 invocations. For instance in the code below, if the current location is
5441 line @code{96}, issuing @code{until 99} will execute the program up to
5442 line @code{99} in the same invocation of factorial, i.e., after the inner
5443 invocations have returned.
5446 94 int factorial (int value)
5448 96 if (value > 1) @{
5449 97 value *= factorial (value - 1);
5456 @kindex advance @var{location}
5457 @item advance @var{location}
5458 Continue running the program up to the given @var{location}. An argument is
5459 required, which should be of one of the forms described in
5460 @ref{Specify Location}.
5461 Execution will also stop upon exit from the current stack
5462 frame. This command is similar to @code{until}, but @code{advance} will
5463 not skip over recursive function calls, and the target location doesn't
5464 have to be in the same frame as the current one.
5468 @kindex si @r{(@code{stepi})}
5470 @itemx stepi @var{arg}
5472 Execute one machine instruction, then stop and return to the debugger.
5474 It is often useful to do @samp{display/i $pc} when stepping by machine
5475 instructions. This makes @value{GDBN} automatically display the next
5476 instruction to be executed, each time your program stops. @xref{Auto
5477 Display,, Automatic Display}.
5479 An argument is a repeat count, as in @code{step}.
5483 @kindex ni @r{(@code{nexti})}
5485 @itemx nexti @var{arg}
5487 Execute one machine instruction, but if it is a function call,
5488 proceed until the function returns.
5490 An argument is a repeat count, as in @code{next}.
5494 @anchor{range stepping}
5495 @cindex range stepping
5496 @cindex target-assisted range stepping
5497 By default, and if available, @value{GDBN} makes use of
5498 target-assisted @dfn{range stepping}. In other words, whenever you
5499 use a stepping command (e.g., @code{step}, @code{next}), @value{GDBN}
5500 tells the target to step the corresponding range of instruction
5501 addresses instead of issuing multiple single-steps. This speeds up
5502 line stepping, particularly for remote targets. Ideally, there should
5503 be no reason you would want to turn range stepping off. However, it's
5504 possible that a bug in the debug info, a bug in the remote stub (for
5505 remote targets), or even a bug in @value{GDBN} could make line
5506 stepping behave incorrectly when target-assisted range stepping is
5507 enabled. You can use the following command to turn off range stepping
5511 @kindex set range-stepping
5512 @kindex show range-stepping
5513 @item set range-stepping
5514 @itemx show range-stepping
5515 Control whether range stepping is enabled.
5517 If @code{on}, and the target supports it, @value{GDBN} tells the
5518 target to step a range of addresses itself, instead of issuing
5519 multiple single-steps. If @code{off}, @value{GDBN} always issues
5520 single-steps, even if range stepping is supported by the target. The
5521 default is @code{on}.
5525 @node Skipping Over Functions and Files
5526 @section Skipping Over Functions and Files
5527 @cindex skipping over functions and files
5529 The program you are debugging may contain some functions which are
5530 uninteresting to debug. The @code{skip} command lets you tell @value{GDBN} to
5531 skip a function, all functions in a file or a particular function in
5532 a particular file when stepping.
5534 For example, consider the following C function:
5545 Suppose you wish to step into the functions @code{foo} and @code{bar}, but you
5546 are not interested in stepping through @code{boring}. If you run @code{step}
5547 at line 103, you'll enter @code{boring()}, but if you run @code{next}, you'll
5548 step over both @code{foo} and @code{boring}!
5550 One solution is to @code{step} into @code{boring} and use the @code{finish}
5551 command to immediately exit it. But this can become tedious if @code{boring}
5552 is called from many places.
5554 A more flexible solution is to execute @kbd{skip boring}. This instructs
5555 @value{GDBN} never to step into @code{boring}. Now when you execute
5556 @code{step} at line 103, you'll step over @code{boring} and directly into
5559 Functions may be skipped by providing either a function name, linespec
5560 (@pxref{Specify Location}), regular expression that matches the function's
5561 name, file name or a @code{glob}-style pattern that matches the file name.
5563 On Posix systems the form of the regular expression is
5564 ``Extended Regular Expressions''. See for example @samp{man 7 regex}
5565 on @sc{gnu}/Linux systems. On non-Posix systems the form of the regular
5566 expression is whatever is provided by the @code{regcomp} function of
5567 the underlying system.
5568 See for example @samp{man 7 glob} on @sc{gnu}/Linux systems for a
5569 description of @code{glob}-style patterns.
5573 @item skip @r{[}@var{options}@r{]}
5574 The basic form of the @code{skip} command takes zero or more options
5575 that specify what to skip.
5576 The @var{options} argument is any useful combination of the following:
5579 @item -file @var{file}
5580 @itemx -fi @var{file}
5581 Functions in @var{file} will be skipped over when stepping.
5583 @item -gfile @var{file-glob-pattern}
5584 @itemx -gfi @var{file-glob-pattern}
5585 @cindex skipping over files via glob-style patterns
5586 Functions in files matching @var{file-glob-pattern} will be skipped
5590 (gdb) skip -gfi utils/*.c
5593 @item -function @var{linespec}
5594 @itemx -fu @var{linespec}
5595 Functions named by @var{linespec} or the function containing the line
5596 named by @var{linespec} will be skipped over when stepping.
5597 @xref{Specify Location}.
5599 @item -rfunction @var{regexp}
5600 @itemx -rfu @var{regexp}
5601 @cindex skipping over functions via regular expressions
5602 Functions whose name matches @var{regexp} will be skipped over when stepping.
5604 This form is useful for complex function names.
5605 For example, there is generally no need to step into C@t{++} @code{std::string}
5606 constructors or destructors. Plus with C@t{++} templates it can be hard to
5607 write out the full name of the function, and often it doesn't matter what
5608 the template arguments are. Specifying the function to be skipped as a
5609 regular expression makes this easier.
5612 (gdb) skip -rfu ^std::(allocator|basic_string)<.*>::~?\1 *\(
5615 If you want to skip every templated C@t{++} constructor and destructor
5616 in the @code{std} namespace you can do:
5619 (gdb) skip -rfu ^std::([a-zA-z0-9_]+)<.*>::~?\1 *\(
5623 If no options are specified, the function you're currently debugging
5626 @kindex skip function
5627 @item skip function @r{[}@var{linespec}@r{]}
5628 After running this command, the function named by @var{linespec} or the
5629 function containing the line named by @var{linespec} will be skipped over when
5630 stepping. @xref{Specify Location}.
5632 If you do not specify @var{linespec}, the function you're currently debugging
5635 (If you have a function called @code{file} that you want to skip, use
5636 @kbd{skip function file}.)
5639 @item skip file @r{[}@var{filename}@r{]}
5640 After running this command, any function whose source lives in @var{filename}
5641 will be skipped over when stepping.
5644 (gdb) skip file boring.c
5645 File boring.c will be skipped when stepping.
5648 If you do not specify @var{filename}, functions whose source lives in the file
5649 you're currently debugging will be skipped.
5652 Skips can be listed, deleted, disabled, and enabled, much like breakpoints.
5653 These are the commands for managing your list of skips:
5657 @item info skip @r{[}@var{range}@r{]}
5658 Print details about the specified skip(s). If @var{range} is not specified,
5659 print a table with details about all functions and files marked for skipping.
5660 @code{info skip} prints the following information about each skip:
5664 A number identifying this skip.
5665 @item Enabled or Disabled
5666 Enabled skips are marked with @samp{y}.
5667 Disabled skips are marked with @samp{n}.
5669 If the file name is a @samp{glob} pattern this is @samp{y}.
5670 Otherwise it is @samp{n}.
5672 The name or @samp{glob} pattern of the file to be skipped.
5673 If no file is specified this is @samp{<none>}.
5675 If the function name is a @samp{regular expression} this is @samp{y}.
5676 Otherwise it is @samp{n}.
5678 The name or regular expression of the function to skip.
5679 If no function is specified this is @samp{<none>}.
5683 @item skip delete @r{[}@var{range}@r{]}
5684 Delete the specified skip(s). If @var{range} is not specified, delete all
5688 @item skip enable @r{[}@var{range}@r{]}
5689 Enable the specified skip(s). If @var{range} is not specified, enable all
5692 @kindex skip disable
5693 @item skip disable @r{[}@var{range}@r{]}
5694 Disable the specified skip(s). If @var{range} is not specified, disable all
5703 A signal is an asynchronous event that can happen in a program. The
5704 operating system defines the possible kinds of signals, and gives each
5705 kind a name and a number. For example, in Unix @code{SIGINT} is the
5706 signal a program gets when you type an interrupt character (often @kbd{Ctrl-c});
5707 @code{SIGSEGV} is the signal a program gets from referencing a place in
5708 memory far away from all the areas in use; @code{SIGALRM} occurs when
5709 the alarm clock timer goes off (which happens only if your program has
5710 requested an alarm).
5712 @cindex fatal signals
5713 Some signals, including @code{SIGALRM}, are a normal part of the
5714 functioning of your program. Others, such as @code{SIGSEGV}, indicate
5715 errors; these signals are @dfn{fatal} (they kill your program immediately) if the
5716 program has not specified in advance some other way to handle the signal.
5717 @code{SIGINT} does not indicate an error in your program, but it is normally
5718 fatal so it can carry out the purpose of the interrupt: to kill the program.
5720 @value{GDBN} has the ability to detect any occurrence of a signal in your
5721 program. You can tell @value{GDBN} in advance what to do for each kind of
5724 @cindex handling signals
5725 Normally, @value{GDBN} is set up to let the non-erroneous signals like
5726 @code{SIGALRM} be silently passed to your program
5727 (so as not to interfere with their role in the program's functioning)
5728 but to stop your program immediately whenever an error signal happens.
5729 You can change these settings with the @code{handle} command.
5732 @kindex info signals
5736 Print a table of all the kinds of signals and how @value{GDBN} has been told to
5737 handle each one. You can use this to see the signal numbers of all
5738 the defined types of signals.
5740 @item info signals @var{sig}
5741 Similar, but print information only about the specified signal number.
5743 @code{info handle} is an alias for @code{info signals}.
5745 @item catch signal @r{[}@var{signal}@dots{} @r{|} @samp{all}@r{]}
5746 Set a catchpoint for the indicated signals. @xref{Set Catchpoints},
5747 for details about this command.
5750 @item handle @var{signal} @r{[}@var{keywords}@dots{}@r{]}
5751 Change the way @value{GDBN} handles signal @var{signal}. The @var{signal}
5752 can be the number of a signal or its name (with or without the
5753 @samp{SIG} at the beginning); a list of signal numbers of the form
5754 @samp{@var{low}-@var{high}}; or the word @samp{all}, meaning all the
5755 known signals. Optional arguments @var{keywords}, described below,
5756 say what change to make.
5760 The keywords allowed by the @code{handle} command can be abbreviated.
5761 Their full names are:
5765 @value{GDBN} should not stop your program when this signal happens. It may
5766 still print a message telling you that the signal has come in.
5769 @value{GDBN} should stop your program when this signal happens. This implies
5770 the @code{print} keyword as well.
5773 @value{GDBN} should print a message when this signal happens.
5776 @value{GDBN} should not mention the occurrence of the signal at all. This
5777 implies the @code{nostop} keyword as well.
5781 @value{GDBN} should allow your program to see this signal; your program
5782 can handle the signal, or else it may terminate if the signal is fatal
5783 and not handled. @code{pass} and @code{noignore} are synonyms.
5787 @value{GDBN} should not allow your program to see this signal.
5788 @code{nopass} and @code{ignore} are synonyms.
5792 When a signal stops your program, the signal is not visible to the
5794 continue. Your program sees the signal then, if @code{pass} is in
5795 effect for the signal in question @emph{at that time}. In other words,
5796 after @value{GDBN} reports a signal, you can use the @code{handle}
5797 command with @code{pass} or @code{nopass} to control whether your
5798 program sees that signal when you continue.
5800 The default is set to @code{nostop}, @code{noprint}, @code{pass} for
5801 non-erroneous signals such as @code{SIGALRM}, @code{SIGWINCH} and
5802 @code{SIGCHLD}, and to @code{stop}, @code{print}, @code{pass} for the
5805 You can also use the @code{signal} command to prevent your program from
5806 seeing a signal, or cause it to see a signal it normally would not see,
5807 or to give it any signal at any time. For example, if your program stopped
5808 due to some sort of memory reference error, you might store correct
5809 values into the erroneous variables and continue, hoping to see more
5810 execution; but your program would probably terminate immediately as
5811 a result of the fatal signal once it saw the signal. To prevent this,
5812 you can continue with @samp{signal 0}. @xref{Signaling, ,Giving your
5815 @cindex stepping and signal handlers
5816 @anchor{stepping and signal handlers}
5818 @value{GDBN} optimizes for stepping the mainline code. If a signal
5819 that has @code{handle nostop} and @code{handle pass} set arrives while
5820 a stepping command (e.g., @code{stepi}, @code{step}, @code{next}) is
5821 in progress, @value{GDBN} lets the signal handler run and then resumes
5822 stepping the mainline code once the signal handler returns. In other
5823 words, @value{GDBN} steps over the signal handler. This prevents
5824 signals that you've specified as not interesting (with @code{handle
5825 nostop}) from changing the focus of debugging unexpectedly. Note that
5826 the signal handler itself may still hit a breakpoint, stop for another
5827 signal that has @code{handle stop} in effect, or for any other event
5828 that normally results in stopping the stepping command sooner. Also
5829 note that @value{GDBN} still informs you that the program received a
5830 signal if @code{handle print} is set.
5832 @anchor{stepping into signal handlers}
5834 If you set @code{handle pass} for a signal, and your program sets up a
5835 handler for it, then issuing a stepping command, such as @code{step}
5836 or @code{stepi}, when your program is stopped due to the signal will
5837 step @emph{into} the signal handler (if the target supports that).
5839 Likewise, if you use the @code{queue-signal} command to queue a signal
5840 to be delivered to the current thread when execution of the thread
5841 resumes (@pxref{Signaling, ,Giving your Program a Signal}), then a
5842 stepping command will step into the signal handler.
5844 Here's an example, using @code{stepi} to step to the first instruction
5845 of @code{SIGUSR1}'s handler:
5848 (@value{GDBP}) handle SIGUSR1
5849 Signal Stop Print Pass to program Description
5850 SIGUSR1 Yes Yes Yes User defined signal 1
5854 Program received signal SIGUSR1, User defined signal 1.
5855 main () sigusr1.c:28
5858 sigusr1_handler () at sigusr1.c:9
5862 The same, but using @code{queue-signal} instead of waiting for the
5863 program to receive the signal first:
5868 (@value{GDBP}) queue-signal SIGUSR1
5870 sigusr1_handler () at sigusr1.c:9
5875 @cindex extra signal information
5876 @anchor{extra signal information}
5878 On some targets, @value{GDBN} can inspect extra signal information
5879 associated with the intercepted signal, before it is actually
5880 delivered to the program being debugged. This information is exported
5881 by the convenience variable @code{$_siginfo}, and consists of data
5882 that is passed by the kernel to the signal handler at the time of the
5883 receipt of a signal. The data type of the information itself is
5884 target dependent. You can see the data type using the @code{ptype
5885 $_siginfo} command. On Unix systems, it typically corresponds to the
5886 standard @code{siginfo_t} type, as defined in the @file{signal.h}
5889 Here's an example, on a @sc{gnu}/Linux system, printing the stray
5890 referenced address that raised a segmentation fault.
5894 (@value{GDBP}) continue
5895 Program received signal SIGSEGV, Segmentation fault.
5896 0x0000000000400766 in main ()
5898 (@value{GDBP}) ptype $_siginfo
5905 struct @{...@} _kill;
5906 struct @{...@} _timer;
5908 struct @{...@} _sigchld;
5909 struct @{...@} _sigfault;
5910 struct @{...@} _sigpoll;
5913 (@value{GDBP}) ptype $_siginfo._sifields._sigfault
5917 (@value{GDBP}) p $_siginfo._sifields._sigfault.si_addr
5918 $1 = (void *) 0x7ffff7ff7000
5922 Depending on target support, @code{$_siginfo} may also be writable.
5924 @cindex Intel MPX boundary violations
5925 @cindex boundary violations, Intel MPX
5926 On some targets, a @code{SIGSEGV} can be caused by a boundary
5927 violation, i.e., accessing an address outside of the allowed range.
5928 In those cases @value{GDBN} may displays additional information,
5929 depending on how @value{GDBN} has been told to handle the signal.
5930 With @code{handle stop SIGSEGV}, @value{GDBN} displays the violation
5931 kind: "Upper" or "Lower", the memory address accessed and the
5932 bounds, while with @code{handle nostop SIGSEGV} no additional
5933 information is displayed.
5935 The usual output of a segfault is:
5937 Program received signal SIGSEGV, Segmentation fault
5938 0x0000000000400d7c in upper () at i386-mpx-sigsegv.c:68
5939 68 value = *(p + len);
5942 While a bound violation is presented as:
5944 Program received signal SIGSEGV, Segmentation fault
5945 Upper bound violation while accessing address 0x7fffffffc3b3
5946 Bounds: [lower = 0x7fffffffc390, upper = 0x7fffffffc3a3]
5947 0x0000000000400d7c in upper () at i386-mpx-sigsegv.c:68
5948 68 value = *(p + len);
5952 @section Stopping and Starting Multi-thread Programs
5954 @cindex stopped threads
5955 @cindex threads, stopped
5957 @cindex continuing threads
5958 @cindex threads, continuing
5960 @value{GDBN} supports debugging programs with multiple threads
5961 (@pxref{Threads,, Debugging Programs with Multiple Threads}). There
5962 are two modes of controlling execution of your program within the
5963 debugger. In the default mode, referred to as @dfn{all-stop mode},
5964 when any thread in your program stops (for example, at a breakpoint
5965 or while being stepped), all other threads in the program are also stopped by
5966 @value{GDBN}. On some targets, @value{GDBN} also supports
5967 @dfn{non-stop mode}, in which other threads can continue to run freely while
5968 you examine the stopped thread in the debugger.
5971 * All-Stop Mode:: All threads stop when GDB takes control
5972 * Non-Stop Mode:: Other threads continue to execute
5973 * Background Execution:: Running your program asynchronously
5974 * Thread-Specific Breakpoints:: Controlling breakpoints
5975 * Interrupted System Calls:: GDB may interfere with system calls
5976 * Observer Mode:: GDB does not alter program behavior
5980 @subsection All-Stop Mode
5982 @cindex all-stop mode
5984 In all-stop mode, whenever your program stops under @value{GDBN} for any reason,
5985 @emph{all} threads of execution stop, not just the current thread. This
5986 allows you to examine the overall state of the program, including
5987 switching between threads, without worrying that things may change
5990 Conversely, whenever you restart the program, @emph{all} threads start
5991 executing. @emph{This is true even when single-stepping} with commands
5992 like @code{step} or @code{next}.
5994 In particular, @value{GDBN} cannot single-step all threads in lockstep.
5995 Since thread scheduling is up to your debugging target's operating
5996 system (not controlled by @value{GDBN}), other threads may
5997 execute more than one statement while the current thread completes a
5998 single step. Moreover, in general other threads stop in the middle of a
5999 statement, rather than at a clean statement boundary, when the program
6002 You might even find your program stopped in another thread after
6003 continuing or even single-stepping. This happens whenever some other
6004 thread runs into a breakpoint, a signal, or an exception before the
6005 first thread completes whatever you requested.
6007 @cindex automatic thread selection
6008 @cindex switching threads automatically
6009 @cindex threads, automatic switching
6010 Whenever @value{GDBN} stops your program, due to a breakpoint or a
6011 signal, it automatically selects the thread where that breakpoint or
6012 signal happened. @value{GDBN} alerts you to the context switch with a
6013 message such as @samp{[Switching to Thread @var{n}]} to identify the
6016 On some OSes, you can modify @value{GDBN}'s default behavior by
6017 locking the OS scheduler to allow only a single thread to run.
6020 @item set scheduler-locking @var{mode}
6021 @cindex scheduler locking mode
6022 @cindex lock scheduler
6023 Set the scheduler locking mode. It applies to normal execution,
6024 record mode, and replay mode. If it is @code{off}, then there is no
6025 locking and any thread may run at any time. If @code{on}, then only
6026 the current thread may run when the inferior is resumed. The
6027 @code{step} mode optimizes for single-stepping; it prevents other
6028 threads from preempting the current thread while you are stepping, so
6029 that the focus of debugging does not change unexpectedly. Other
6030 threads never get a chance to run when you step, and they are
6031 completely free to run when you use commands like @samp{continue},
6032 @samp{until}, or @samp{finish}. However, unless another thread hits a
6033 breakpoint during its timeslice, @value{GDBN} does not change the
6034 current thread away from the thread that you are debugging. The
6035 @code{replay} mode behaves like @code{off} in record mode and like
6036 @code{on} in replay mode.
6038 @item show scheduler-locking
6039 Display the current scheduler locking mode.
6042 @cindex resume threads of multiple processes simultaneously
6043 By default, when you issue one of the execution commands such as
6044 @code{continue}, @code{next} or @code{step}, @value{GDBN} allows only
6045 threads of the current inferior to run. For example, if @value{GDBN}
6046 is attached to two inferiors, each with two threads, the
6047 @code{continue} command resumes only the two threads of the current
6048 inferior. This is useful, for example, when you debug a program that
6049 forks and you want to hold the parent stopped (so that, for instance,
6050 it doesn't run to exit), while you debug the child. In other
6051 situations, you may not be interested in inspecting the current state
6052 of any of the processes @value{GDBN} is attached to, and you may want
6053 to resume them all until some breakpoint is hit. In the latter case,
6054 you can instruct @value{GDBN} to allow all threads of all the
6055 inferiors to run with the @w{@code{set schedule-multiple}} command.
6058 @kindex set schedule-multiple
6059 @item set schedule-multiple
6060 Set the mode for allowing threads of multiple processes to be resumed
6061 when an execution command is issued. When @code{on}, all threads of
6062 all processes are allowed to run. When @code{off}, only the threads
6063 of the current process are resumed. The default is @code{off}. The
6064 @code{scheduler-locking} mode takes precedence when set to @code{on},
6065 or while you are stepping and set to @code{step}.
6067 @item show schedule-multiple
6068 Display the current mode for resuming the execution of threads of
6073 @subsection Non-Stop Mode
6075 @cindex non-stop mode
6077 @c This section is really only a place-holder, and needs to be expanded
6078 @c with more details.
6080 For some multi-threaded targets, @value{GDBN} supports an optional
6081 mode of operation in which you can examine stopped program threads in
6082 the debugger while other threads continue to execute freely. This
6083 minimizes intrusion when debugging live systems, such as programs
6084 where some threads have real-time constraints or must continue to
6085 respond to external events. This is referred to as @dfn{non-stop} mode.
6087 In non-stop mode, when a thread stops to report a debugging event,
6088 @emph{only} that thread is stopped; @value{GDBN} does not stop other
6089 threads as well, in contrast to the all-stop mode behavior. Additionally,
6090 execution commands such as @code{continue} and @code{step} apply by default
6091 only to the current thread in non-stop mode, rather than all threads as
6092 in all-stop mode. This allows you to control threads explicitly in
6093 ways that are not possible in all-stop mode --- for example, stepping
6094 one thread while allowing others to run freely, stepping
6095 one thread while holding all others stopped, or stepping several threads
6096 independently and simultaneously.
6098 To enter non-stop mode, use this sequence of commands before you run
6099 or attach to your program:
6102 # If using the CLI, pagination breaks non-stop.
6105 # Finally, turn it on!
6109 You can use these commands to manipulate the non-stop mode setting:
6112 @kindex set non-stop
6113 @item set non-stop on
6114 Enable selection of non-stop mode.
6115 @item set non-stop off
6116 Disable selection of non-stop mode.
6117 @kindex show non-stop
6119 Show the current non-stop enablement setting.
6122 Note these commands only reflect whether non-stop mode is enabled,
6123 not whether the currently-executing program is being run in non-stop mode.
6124 In particular, the @code{set non-stop} preference is only consulted when
6125 @value{GDBN} starts or connects to the target program, and it is generally
6126 not possible to switch modes once debugging has started. Furthermore,
6127 since not all targets support non-stop mode, even when you have enabled
6128 non-stop mode, @value{GDBN} may still fall back to all-stop operation by
6131 In non-stop mode, all execution commands apply only to the current thread
6132 by default. That is, @code{continue} only continues one thread.
6133 To continue all threads, issue @code{continue -a} or @code{c -a}.
6135 You can use @value{GDBN}'s background execution commands
6136 (@pxref{Background Execution}) to run some threads in the background
6137 while you continue to examine or step others from @value{GDBN}.
6138 The MI execution commands (@pxref{GDB/MI Program Execution}) are
6139 always executed asynchronously in non-stop mode.
6141 Suspending execution is done with the @code{interrupt} command when
6142 running in the background, or @kbd{Ctrl-c} during foreground execution.
6143 In all-stop mode, this stops the whole process;
6144 but in non-stop mode the interrupt applies only to the current thread.
6145 To stop the whole program, use @code{interrupt -a}.
6147 Other execution commands do not currently support the @code{-a} option.
6149 In non-stop mode, when a thread stops, @value{GDBN} doesn't automatically make
6150 that thread current, as it does in all-stop mode. This is because the
6151 thread stop notifications are asynchronous with respect to @value{GDBN}'s
6152 command interpreter, and it would be confusing if @value{GDBN} unexpectedly
6153 changed to a different thread just as you entered a command to operate on the
6154 previously current thread.
6156 @node Background Execution
6157 @subsection Background Execution
6159 @cindex foreground execution
6160 @cindex background execution
6161 @cindex asynchronous execution
6162 @cindex execution, foreground, background and asynchronous
6164 @value{GDBN}'s execution commands have two variants: the normal
6165 foreground (synchronous) behavior, and a background
6166 (asynchronous) behavior. In foreground execution, @value{GDBN} waits for
6167 the program to report that some thread has stopped before prompting for
6168 another command. In background execution, @value{GDBN} immediately gives
6169 a command prompt so that you can issue other commands while your program runs.
6171 If the target doesn't support async mode, @value{GDBN} issues an error
6172 message if you attempt to use the background execution commands.
6174 To specify background execution, add a @code{&} to the command. For example,
6175 the background form of the @code{continue} command is @code{continue&}, or
6176 just @code{c&}. The execution commands that accept background execution
6182 @xref{Starting, , Starting your Program}.
6186 @xref{Attach, , Debugging an Already-running Process}.
6190 @xref{Continuing and Stepping, step}.
6194 @xref{Continuing and Stepping, stepi}.
6198 @xref{Continuing and Stepping, next}.
6202 @xref{Continuing and Stepping, nexti}.
6206 @xref{Continuing and Stepping, continue}.
6210 @xref{Continuing and Stepping, finish}.
6214 @xref{Continuing and Stepping, until}.
6218 Background execution is especially useful in conjunction with non-stop
6219 mode for debugging programs with multiple threads; see @ref{Non-Stop Mode}.
6220 However, you can also use these commands in the normal all-stop mode with
6221 the restriction that you cannot issue another execution command until the
6222 previous one finishes. Examples of commands that are valid in all-stop
6223 mode while the program is running include @code{help} and @code{info break}.
6225 You can interrupt your program while it is running in the background by
6226 using the @code{interrupt} command.
6233 Suspend execution of the running program. In all-stop mode,
6234 @code{interrupt} stops the whole process, but in non-stop mode, it stops
6235 only the current thread. To stop the whole program in non-stop mode,
6236 use @code{interrupt -a}.
6239 @node Thread-Specific Breakpoints
6240 @subsection Thread-Specific Breakpoints
6242 When your program has multiple threads (@pxref{Threads,, Debugging
6243 Programs with Multiple Threads}), you can choose whether to set
6244 breakpoints on all threads, or on a particular thread.
6247 @cindex breakpoints and threads
6248 @cindex thread breakpoints
6249 @kindex break @dots{} thread @var{thread-id}
6250 @item break @var{location} thread @var{thread-id}
6251 @itemx break @var{location} thread @var{thread-id} if @dots{}
6252 @var{location} specifies source lines; there are several ways of
6253 writing them (@pxref{Specify Location}), but the effect is always to
6254 specify some source line.
6256 Use the qualifier @samp{thread @var{thread-id}} with a breakpoint command
6257 to specify that you only want @value{GDBN} to stop the program when a
6258 particular thread reaches this breakpoint. The @var{thread-id} specifier
6259 is one of the thread identifiers assigned by @value{GDBN}, shown
6260 in the first column of the @samp{info threads} display.
6262 If you do not specify @samp{thread @var{thread-id}} when you set a
6263 breakpoint, the breakpoint applies to @emph{all} threads of your
6266 You can use the @code{thread} qualifier on conditional breakpoints as
6267 well; in this case, place @samp{thread @var{thread-id}} before or
6268 after the breakpoint condition, like this:
6271 (@value{GDBP}) break frik.c:13 thread 28 if bartab > lim
6276 Thread-specific breakpoints are automatically deleted when
6277 @value{GDBN} detects the corresponding thread is no longer in the
6278 thread list. For example:
6282 Thread-specific breakpoint 3 deleted - thread 28 no longer in the thread list.
6285 There are several ways for a thread to disappear, such as a regular
6286 thread exit, but also when you detach from the process with the
6287 @code{detach} command (@pxref{Attach, ,Debugging an Already-running
6288 Process}), or if @value{GDBN} loses the remote connection
6289 (@pxref{Remote Debugging}), etc. Note that with some targets,
6290 @value{GDBN} is only able to detect a thread has exited when the user
6291 explictly asks for the thread list with the @code{info threads}
6294 @node Interrupted System Calls
6295 @subsection Interrupted System Calls
6297 @cindex thread breakpoints and system calls
6298 @cindex system calls and thread breakpoints
6299 @cindex premature return from system calls
6300 There is an unfortunate side effect when using @value{GDBN} to debug
6301 multi-threaded programs. If one thread stops for a
6302 breakpoint, or for some other reason, and another thread is blocked in a
6303 system call, then the system call may return prematurely. This is a
6304 consequence of the interaction between multiple threads and the signals
6305 that @value{GDBN} uses to implement breakpoints and other events that
6308 To handle this problem, your program should check the return value of
6309 each system call and react appropriately. This is good programming
6312 For example, do not write code like this:
6318 The call to @code{sleep} will return early if a different thread stops
6319 at a breakpoint or for some other reason.
6321 Instead, write this:
6326 unslept = sleep (unslept);
6329 A system call is allowed to return early, so the system is still
6330 conforming to its specification. But @value{GDBN} does cause your
6331 multi-threaded program to behave differently than it would without
6334 Also, @value{GDBN} uses internal breakpoints in the thread library to
6335 monitor certain events such as thread creation and thread destruction.
6336 When such an event happens, a system call in another thread may return
6337 prematurely, even though your program does not appear to stop.
6340 @subsection Observer Mode
6342 If you want to build on non-stop mode and observe program behavior
6343 without any chance of disruption by @value{GDBN}, you can set
6344 variables to disable all of the debugger's attempts to modify state,
6345 whether by writing memory, inserting breakpoints, etc. These operate
6346 at a low level, intercepting operations from all commands.
6348 When all of these are set to @code{off}, then @value{GDBN} is said to
6349 be @dfn{observer mode}. As a convenience, the variable
6350 @code{observer} can be set to disable these, plus enable non-stop
6353 Note that @value{GDBN} will not prevent you from making nonsensical
6354 combinations of these settings. For instance, if you have enabled
6355 @code{may-insert-breakpoints} but disabled @code{may-write-memory},
6356 then breakpoints that work by writing trap instructions into the code
6357 stream will still not be able to be placed.
6362 @item set observer on
6363 @itemx set observer off
6364 When set to @code{on}, this disables all the permission variables
6365 below (except for @code{insert-fast-tracepoints}), plus enables
6366 non-stop debugging. Setting this to @code{off} switches back to
6367 normal debugging, though remaining in non-stop mode.
6370 Show whether observer mode is on or off.
6372 @kindex may-write-registers
6373 @item set may-write-registers on
6374 @itemx set may-write-registers off
6375 This controls whether @value{GDBN} will attempt to alter the values of
6376 registers, such as with assignment expressions in @code{print}, or the
6377 @code{jump} command. It defaults to @code{on}.
6379 @item show may-write-registers
6380 Show the current permission to write registers.
6382 @kindex may-write-memory
6383 @item set may-write-memory on
6384 @itemx set may-write-memory off
6385 This controls whether @value{GDBN} will attempt to alter the contents
6386 of memory, such as with assignment expressions in @code{print}. It
6387 defaults to @code{on}.
6389 @item show may-write-memory
6390 Show the current permission to write memory.
6392 @kindex may-insert-breakpoints
6393 @item set may-insert-breakpoints on
6394 @itemx set may-insert-breakpoints off
6395 This controls whether @value{GDBN} will attempt to insert breakpoints.
6396 This affects all breakpoints, including internal breakpoints defined
6397 by @value{GDBN}. It defaults to @code{on}.
6399 @item show may-insert-breakpoints
6400 Show the current permission to insert breakpoints.
6402 @kindex may-insert-tracepoints
6403 @item set may-insert-tracepoints on
6404 @itemx set may-insert-tracepoints off
6405 This controls whether @value{GDBN} will attempt to insert (regular)
6406 tracepoints at the beginning of a tracing experiment. It affects only
6407 non-fast tracepoints, fast tracepoints being under the control of
6408 @code{may-insert-fast-tracepoints}. It defaults to @code{on}.
6410 @item show may-insert-tracepoints
6411 Show the current permission to insert tracepoints.
6413 @kindex may-insert-fast-tracepoints
6414 @item set may-insert-fast-tracepoints on
6415 @itemx set may-insert-fast-tracepoints off
6416 This controls whether @value{GDBN} will attempt to insert fast
6417 tracepoints at the beginning of a tracing experiment. It affects only
6418 fast tracepoints, regular (non-fast) tracepoints being under the
6419 control of @code{may-insert-tracepoints}. It defaults to @code{on}.
6421 @item show may-insert-fast-tracepoints
6422 Show the current permission to insert fast tracepoints.
6424 @kindex may-interrupt
6425 @item set may-interrupt on
6426 @itemx set may-interrupt off
6427 This controls whether @value{GDBN} will attempt to interrupt or stop
6428 program execution. When this variable is @code{off}, the
6429 @code{interrupt} command will have no effect, nor will
6430 @kbd{Ctrl-c}. It defaults to @code{on}.
6432 @item show may-interrupt
6433 Show the current permission to interrupt or stop the program.
6437 @node Reverse Execution
6438 @chapter Running programs backward
6439 @cindex reverse execution
6440 @cindex running programs backward
6442 When you are debugging a program, it is not unusual to realize that
6443 you have gone too far, and some event of interest has already happened.
6444 If the target environment supports it, @value{GDBN} can allow you to
6445 ``rewind'' the program by running it backward.
6447 A target environment that supports reverse execution should be able
6448 to ``undo'' the changes in machine state that have taken place as the
6449 program was executing normally. Variables, registers etc.@: should
6450 revert to their previous values. Obviously this requires a great
6451 deal of sophistication on the part of the target environment; not
6452 all target environments can support reverse execution.
6454 When a program is executed in reverse, the instructions that
6455 have most recently been executed are ``un-executed'', in reverse
6456 order. The program counter runs backward, following the previous
6457 thread of execution in reverse. As each instruction is ``un-executed'',
6458 the values of memory and/or registers that were changed by that
6459 instruction are reverted to their previous states. After executing
6460 a piece of source code in reverse, all side effects of that code
6461 should be ``undone'', and all variables should be returned to their
6462 prior values@footnote{
6463 Note that some side effects are easier to undo than others. For instance,
6464 memory and registers are relatively easy, but device I/O is hard. Some
6465 targets may be able undo things like device I/O, and some may not.
6467 The contract between @value{GDBN} and the reverse executing target
6468 requires only that the target do something reasonable when
6469 @value{GDBN} tells it to execute backwards, and then report the
6470 results back to @value{GDBN}. Whatever the target reports back to
6471 @value{GDBN}, @value{GDBN} will report back to the user. @value{GDBN}
6472 assumes that the memory and registers that the target reports are in a
6473 consistant state, but @value{GDBN} accepts whatever it is given.
6476 If you are debugging in a target environment that supports
6477 reverse execution, @value{GDBN} provides the following commands.
6480 @kindex reverse-continue
6481 @kindex rc @r{(@code{reverse-continue})}
6482 @item reverse-continue @r{[}@var{ignore-count}@r{]}
6483 @itemx rc @r{[}@var{ignore-count}@r{]}
6484 Beginning at the point where your program last stopped, start executing
6485 in reverse. Reverse execution will stop for breakpoints and synchronous
6486 exceptions (signals), just like normal execution. Behavior of
6487 asynchronous signals depends on the target environment.
6489 @kindex reverse-step
6490 @kindex rs @r{(@code{step})}
6491 @item reverse-step @r{[}@var{count}@r{]}
6492 Run the program backward until control reaches the start of a
6493 different source line; then stop it, and return control to @value{GDBN}.
6495 Like the @code{step} command, @code{reverse-step} will only stop
6496 at the beginning of a source line. It ``un-executes'' the previously
6497 executed source line. If the previous source line included calls to
6498 debuggable functions, @code{reverse-step} will step (backward) into
6499 the called function, stopping at the beginning of the @emph{last}
6500 statement in the called function (typically a return statement).
6502 Also, as with the @code{step} command, if non-debuggable functions are
6503 called, @code{reverse-step} will run thru them backward without stopping.
6505 @kindex reverse-stepi
6506 @kindex rsi @r{(@code{reverse-stepi})}
6507 @item reverse-stepi @r{[}@var{count}@r{]}
6508 Reverse-execute one machine instruction. Note that the instruction
6509 to be reverse-executed is @emph{not} the one pointed to by the program
6510 counter, but the instruction executed prior to that one. For instance,
6511 if the last instruction was a jump, @code{reverse-stepi} will take you
6512 back from the destination of the jump to the jump instruction itself.
6514 @kindex reverse-next
6515 @kindex rn @r{(@code{reverse-next})}
6516 @item reverse-next @r{[}@var{count}@r{]}
6517 Run backward to the beginning of the previous line executed in
6518 the current (innermost) stack frame. If the line contains function
6519 calls, they will be ``un-executed'' without stopping. Starting from
6520 the first line of a function, @code{reverse-next} will take you back
6521 to the caller of that function, @emph{before} the function was called,
6522 just as the normal @code{next} command would take you from the last
6523 line of a function back to its return to its caller
6524 @footnote{Unless the code is too heavily optimized.}.
6526 @kindex reverse-nexti
6527 @kindex rni @r{(@code{reverse-nexti})}
6528 @item reverse-nexti @r{[}@var{count}@r{]}
6529 Like @code{nexti}, @code{reverse-nexti} executes a single instruction
6530 in reverse, except that called functions are ``un-executed'' atomically.
6531 That is, if the previously executed instruction was a return from
6532 another function, @code{reverse-nexti} will continue to execute
6533 in reverse until the call to that function (from the current stack
6536 @kindex reverse-finish
6537 @item reverse-finish
6538 Just as the @code{finish} command takes you to the point where the
6539 current function returns, @code{reverse-finish} takes you to the point
6540 where it was called. Instead of ending up at the end of the current
6541 function invocation, you end up at the beginning.
6543 @kindex set exec-direction
6544 @item set exec-direction
6545 Set the direction of target execution.
6546 @item set exec-direction reverse
6547 @cindex execute forward or backward in time
6548 @value{GDBN} will perform all execution commands in reverse, until the
6549 exec-direction mode is changed to ``forward''. Affected commands include
6550 @code{step, stepi, next, nexti, continue, and finish}. The @code{return}
6551 command cannot be used in reverse mode.
6552 @item set exec-direction forward
6553 @value{GDBN} will perform all execution commands in the normal fashion.
6554 This is the default.
6558 @node Process Record and Replay
6559 @chapter Recording Inferior's Execution and Replaying It
6560 @cindex process record and replay
6561 @cindex recording inferior's execution and replaying it
6563 On some platforms, @value{GDBN} provides a special @dfn{process record
6564 and replay} target that can record a log of the process execution, and
6565 replay it later with both forward and reverse execution commands.
6568 When this target is in use, if the execution log includes the record
6569 for the next instruction, @value{GDBN} will debug in @dfn{replay
6570 mode}. In the replay mode, the inferior does not really execute code
6571 instructions. Instead, all the events that normally happen during
6572 code execution are taken from the execution log. While code is not
6573 really executed in replay mode, the values of registers (including the
6574 program counter register) and the memory of the inferior are still
6575 changed as they normally would. Their contents are taken from the
6579 If the record for the next instruction is not in the execution log,
6580 @value{GDBN} will debug in @dfn{record mode}. In this mode, the
6581 inferior executes normally, and @value{GDBN} records the execution log
6584 The process record and replay target supports reverse execution
6585 (@pxref{Reverse Execution}), even if the platform on which the
6586 inferior runs does not. However, the reverse execution is limited in
6587 this case by the range of the instructions recorded in the execution
6588 log. In other words, reverse execution on platforms that don't
6589 support it directly can only be done in the replay mode.
6591 When debugging in the reverse direction, @value{GDBN} will work in
6592 replay mode as long as the execution log includes the record for the
6593 previous instruction; otherwise, it will work in record mode, if the
6594 platform supports reverse execution, or stop if not.
6596 For architecture environments that support process record and replay,
6597 @value{GDBN} provides the following commands:
6600 @kindex target record
6601 @kindex target record-full
6602 @kindex target record-btrace
6605 @kindex record btrace
6606 @kindex record btrace bts
6607 @kindex record btrace pt
6613 @kindex rec btrace bts
6614 @kindex rec btrace pt
6617 @item record @var{method}
6618 This command starts the process record and replay target. The
6619 recording method can be specified as parameter. Without a parameter
6620 the command uses the @code{full} recording method. The following
6621 recording methods are available:
6625 Full record/replay recording using @value{GDBN}'s software record and
6626 replay implementation. This method allows replaying and reverse
6629 @item btrace @var{format}
6630 Hardware-supported instruction recording. This method does not record
6631 data. Further, the data is collected in a ring buffer so old data will
6632 be overwritten when the buffer is full. It allows limited reverse
6633 execution. Variables and registers are not available during reverse
6636 The recording format can be specified as parameter. Without a parameter
6637 the command chooses the recording format. The following recording
6638 formats are available:
6642 @cindex branch trace store
6643 Use the @dfn{Branch Trace Store} (@acronym{BTS}) recording format. In
6644 this format, the processor stores a from/to record for each executed
6645 branch in the btrace ring buffer.
6648 @cindex Intel Processor Trace
6649 Use the @dfn{Intel Processor Trace} recording format. In this
6650 format, the processor stores the execution trace in a compressed form
6651 that is afterwards decoded by @value{GDBN}.
6653 The trace can be recorded with very low overhead. The compressed
6654 trace format also allows small trace buffers to already contain a big
6655 number of instructions compared to @acronym{BTS}.
6657 Decoding the recorded execution trace, on the other hand, is more
6658 expensive than decoding @acronym{BTS} trace. This is mostly due to the
6659 increased number of instructions to process. You should increase the
6660 buffer-size with care.
6663 Not all recording formats may be available on all processors.
6666 The process record and replay target can only debug a process that is
6667 already running. Therefore, you need first to start the process with
6668 the @kbd{run} or @kbd{start} commands, and then start the recording
6669 with the @kbd{record @var{method}} command.
6671 @cindex displaced stepping, and process record and replay
6672 Displaced stepping (@pxref{Maintenance Commands,, displaced stepping})
6673 will be automatically disabled when process record and replay target
6674 is started. That's because the process record and replay target
6675 doesn't support displaced stepping.
6677 @cindex non-stop mode, and process record and replay
6678 @cindex asynchronous execution, and process record and replay
6679 If the inferior is in the non-stop mode (@pxref{Non-Stop Mode}) or in
6680 the asynchronous execution mode (@pxref{Background Execution}), not
6681 all recording methods are available. The @code{full} recording method
6682 does not support these two modes.
6687 Stop the process record and replay target. When process record and
6688 replay target stops, the entire execution log will be deleted and the
6689 inferior will either be terminated, or will remain in its final state.
6691 When you stop the process record and replay target in record mode (at
6692 the end of the execution log), the inferior will be stopped at the
6693 next instruction that would have been recorded. In other words, if
6694 you record for a while and then stop recording, the inferior process
6695 will be left in the same state as if the recording never happened.
6697 On the other hand, if the process record and replay target is stopped
6698 while in replay mode (that is, not at the end of the execution log,
6699 but at some earlier point), the inferior process will become ``live''
6700 at that earlier state, and it will then be possible to continue the
6701 usual ``live'' debugging of the process from that state.
6703 When the inferior process exits, or @value{GDBN} detaches from it,
6704 process record and replay target will automatically stop itself.
6708 Go to a specific location in the execution log. There are several
6709 ways to specify the location to go to:
6712 @item record goto begin
6713 @itemx record goto start
6714 Go to the beginning of the execution log.
6716 @item record goto end
6717 Go to the end of the execution log.
6719 @item record goto @var{n}
6720 Go to instruction number @var{n} in the execution log.
6724 @item record save @var{filename}
6725 Save the execution log to a file @file{@var{filename}}.
6726 Default filename is @file{gdb_record.@var{process_id}}, where
6727 @var{process_id} is the process ID of the inferior.
6729 This command may not be available for all recording methods.
6731 @kindex record restore
6732 @item record restore @var{filename}
6733 Restore the execution log from a file @file{@var{filename}}.
6734 File must have been created with @code{record save}.
6736 @kindex set record full
6737 @item set record full insn-number-max @var{limit}
6738 @itemx set record full insn-number-max unlimited
6739 Set the limit of instructions to be recorded for the @code{full}
6740 recording method. Default value is 200000.
6742 If @var{limit} is a positive number, then @value{GDBN} will start
6743 deleting instructions from the log once the number of the record
6744 instructions becomes greater than @var{limit}. For every new recorded
6745 instruction, @value{GDBN} will delete the earliest recorded
6746 instruction to keep the number of recorded instructions at the limit.
6747 (Since deleting recorded instructions loses information, @value{GDBN}
6748 lets you control what happens when the limit is reached, by means of
6749 the @code{stop-at-limit} option, described below.)
6751 If @var{limit} is @code{unlimited} or zero, @value{GDBN} will never
6752 delete recorded instructions from the execution log. The number of
6753 recorded instructions is limited only by the available memory.
6755 @kindex show record full
6756 @item show record full insn-number-max
6757 Show the limit of instructions to be recorded with the @code{full}
6760 @item set record full stop-at-limit
6761 Control the behavior of the @code{full} recording method when the
6762 number of recorded instructions reaches the limit. If ON (the
6763 default), @value{GDBN} will stop when the limit is reached for the
6764 first time and ask you whether you want to stop the inferior or
6765 continue running it and recording the execution log. If you decide
6766 to continue recording, each new recorded instruction will cause the
6767 oldest one to be deleted.
6769 If this option is OFF, @value{GDBN} will automatically delete the
6770 oldest record to make room for each new one, without asking.
6772 @item show record full stop-at-limit
6773 Show the current setting of @code{stop-at-limit}.
6775 @item set record full memory-query
6776 Control the behavior when @value{GDBN} is unable to record memory
6777 changes caused by an instruction for the @code{full} recording method.
6778 If ON, @value{GDBN} will query whether to stop the inferior in that
6781 If this option is OFF (the default), @value{GDBN} will automatically
6782 ignore the effect of such instructions on memory. Later, when
6783 @value{GDBN} replays this execution log, it will mark the log of this
6784 instruction as not accessible, and it will not affect the replay
6787 @item show record full memory-query
6788 Show the current setting of @code{memory-query}.
6790 @kindex set record btrace
6791 The @code{btrace} record target does not trace data. As a
6792 convenience, when replaying, @value{GDBN} reads read-only memory off
6793 the live program directly, assuming that the addresses of the
6794 read-only areas don't change. This for example makes it possible to
6795 disassemble code while replaying, but not to print variables.
6796 In some cases, being able to inspect variables might be useful.
6797 You can use the following command for that:
6799 @item set record btrace replay-memory-access
6800 Control the behavior of the @code{btrace} recording method when
6801 accessing memory during replay. If @code{read-only} (the default),
6802 @value{GDBN} will only allow accesses to read-only memory.
6803 If @code{read-write}, @value{GDBN} will allow accesses to read-only
6804 and to read-write memory. Beware that the accessed memory corresponds
6805 to the live target and not necessarily to the current replay
6808 @kindex show record btrace
6809 @item show record btrace replay-memory-access
6810 Show the current setting of @code{replay-memory-access}.
6812 @kindex set record btrace bts
6813 @item set record btrace bts buffer-size @var{size}
6814 @itemx set record btrace bts buffer-size unlimited
6815 Set the requested ring buffer size for branch tracing in @acronym{BTS}
6816 format. Default is 64KB.
6818 If @var{size} is a positive number, then @value{GDBN} will try to
6819 allocate a buffer of at least @var{size} bytes for each new thread
6820 that uses the btrace recording method and the @acronym{BTS} format.
6821 The actually obtained buffer size may differ from the requested
6822 @var{size}. Use the @code{info record} command to see the actual
6823 buffer size for each thread that uses the btrace recording method and
6824 the @acronym{BTS} format.
6826 If @var{limit} is @code{unlimited} or zero, @value{GDBN} will try to
6827 allocate a buffer of 4MB.
6829 Bigger buffers mean longer traces. On the other hand, @value{GDBN} will
6830 also need longer to process the branch trace data before it can be used.
6832 @item show record btrace bts buffer-size @var{size}
6833 Show the current setting of the requested ring buffer size for branch
6834 tracing in @acronym{BTS} format.
6836 @kindex set record btrace pt
6837 @item set record btrace pt buffer-size @var{size}
6838 @itemx set record btrace pt buffer-size unlimited
6839 Set the requested ring buffer size for branch tracing in Intel
6840 Processor Trace format. Default is 16KB.
6842 If @var{size} is a positive number, then @value{GDBN} will try to
6843 allocate a buffer of at least @var{size} bytes for each new thread
6844 that uses the btrace recording method and the Intel Processor Trace
6845 format. The actually obtained buffer size may differ from the
6846 requested @var{size}. Use the @code{info record} command to see the
6847 actual buffer size for each thread.
6849 If @var{limit} is @code{unlimited} or zero, @value{GDBN} will try to
6850 allocate a buffer of 4MB.
6852 Bigger buffers mean longer traces. On the other hand, @value{GDBN} will
6853 also need longer to process the branch trace data before it can be used.
6855 @item show record btrace pt buffer-size @var{size}
6856 Show the current setting of the requested ring buffer size for branch
6857 tracing in Intel Processor Trace format.
6861 Show various statistics about the recording depending on the recording
6866 For the @code{full} recording method, it shows the state of process
6867 record and its in-memory execution log buffer, including:
6871 Whether in record mode or replay mode.
6873 Lowest recorded instruction number (counting from when the current execution log started recording instructions).
6875 Highest recorded instruction number.
6877 Current instruction about to be replayed (if in replay mode).
6879 Number of instructions contained in the execution log.
6881 Maximum number of instructions that may be contained in the execution log.
6885 For the @code{btrace} recording method, it shows:
6891 Number of instructions that have been recorded.
6893 Number of blocks of sequential control-flow formed by the recorded
6896 Whether in record mode or replay mode.
6899 For the @code{bts} recording format, it also shows:
6902 Size of the perf ring buffer.
6905 For the @code{pt} recording format, it also shows:
6908 Size of the perf ring buffer.
6912 @kindex record delete
6915 When record target runs in replay mode (``in the past''), delete the
6916 subsequent execution log and begin to record a new execution log starting
6917 from the current address. This means you will abandon the previously
6918 recorded ``future'' and begin recording a new ``future''.
6920 @kindex record instruction-history
6921 @kindex rec instruction-history
6922 @item record instruction-history
6923 Disassembles instructions from the recorded execution log. By
6924 default, ten instructions are disassembled. This can be changed using
6925 the @code{set record instruction-history-size} command. Instructions
6926 are printed in execution order.
6928 It can also print mixed source+disassembly if you specify the the
6929 @code{/m} or @code{/s} modifier, and print the raw instructions in hex
6930 as well as in symbolic form by specifying the @code{/r} modifier.
6932 The current position marker is printed for the instruction at the
6933 current program counter value. This instruction can appear multiple
6934 times in the trace and the current position marker will be printed
6935 every time. To omit the current position marker, specify the
6938 To better align the printed instructions when the trace contains
6939 instructions from more than one function, the function name may be
6940 omitted by specifying the @code{/f} modifier.
6942 Speculatively executed instructions are prefixed with @samp{?}. This
6943 feature is not available for all recording formats.
6945 There are several ways to specify what part of the execution log to
6949 @item record instruction-history @var{insn}
6950 Disassembles ten instructions starting from instruction number
6953 @item record instruction-history @var{insn}, +/-@var{n}
6954 Disassembles @var{n} instructions around instruction number
6955 @var{insn}. If @var{n} is preceded with @code{+}, disassembles
6956 @var{n} instructions after instruction number @var{insn}. If
6957 @var{n} is preceded with @code{-}, disassembles @var{n}
6958 instructions before instruction number @var{insn}.
6960 @item record instruction-history
6961 Disassembles ten more instructions after the last disassembly.
6963 @item record instruction-history -
6964 Disassembles ten more instructions before the last disassembly.
6966 @item record instruction-history @var{begin}, @var{end}
6967 Disassembles instructions beginning with instruction number
6968 @var{begin} until instruction number @var{end}. The instruction
6969 number @var{end} is included.
6972 This command may not be available for all recording methods.
6975 @item set record instruction-history-size @var{size}
6976 @itemx set record instruction-history-size unlimited
6977 Define how many instructions to disassemble in the @code{record
6978 instruction-history} command. The default value is 10.
6979 A @var{size} of @code{unlimited} means unlimited instructions.
6982 @item show record instruction-history-size
6983 Show how many instructions to disassemble in the @code{record
6984 instruction-history} command.
6986 @kindex record function-call-history
6987 @kindex rec function-call-history
6988 @item record function-call-history
6989 Prints the execution history at function granularity. It prints one
6990 line for each sequence of instructions that belong to the same
6991 function giving the name of that function, the source lines
6992 for this instruction sequence (if the @code{/l} modifier is
6993 specified), and the instructions numbers that form the sequence (if
6994 the @code{/i} modifier is specified). The function names are indented
6995 to reflect the call stack depth if the @code{/c} modifier is
6996 specified. The @code{/l}, @code{/i}, and @code{/c} modifiers can be
7000 (@value{GDBP}) @b{list 1, 10}
7011 (@value{GDBP}) @b{record function-call-history /ilc}
7012 1 bar inst 1,4 at foo.c:6,8
7013 2 foo inst 5,10 at foo.c:2,3
7014 3 bar inst 11,13 at foo.c:9,10
7017 By default, ten lines are printed. This can be changed using the
7018 @code{set record function-call-history-size} command. Functions are
7019 printed in execution order. There are several ways to specify what
7023 @item record function-call-history @var{func}
7024 Prints ten functions starting from function number @var{func}.
7026 @item record function-call-history @var{func}, +/-@var{n}
7027 Prints @var{n} functions around function number @var{func}. If
7028 @var{n} is preceded with @code{+}, prints @var{n} functions after
7029 function number @var{func}. If @var{n} is preceded with @code{-},
7030 prints @var{n} functions before function number @var{func}.
7032 @item record function-call-history
7033 Prints ten more functions after the last ten-line print.
7035 @item record function-call-history -
7036 Prints ten more functions before the last ten-line print.
7038 @item record function-call-history @var{begin}, @var{end}
7039 Prints functions beginning with function number @var{begin} until
7040 function number @var{end}. The function number @var{end} is included.
7043 This command may not be available for all recording methods.
7045 @item set record function-call-history-size @var{size}
7046 @itemx set record function-call-history-size unlimited
7047 Define how many lines to print in the
7048 @code{record function-call-history} command. The default value is 10.
7049 A size of @code{unlimited} means unlimited lines.
7051 @item show record function-call-history-size
7052 Show how many lines to print in the
7053 @code{record function-call-history} command.
7058 @chapter Examining the Stack
7060 When your program has stopped, the first thing you need to know is where it
7061 stopped and how it got there.
7064 Each time your program performs a function call, information about the call
7066 That information includes the location of the call in your program,
7067 the arguments of the call,
7068 and the local variables of the function being called.
7069 The information is saved in a block of data called a @dfn{stack frame}.
7070 The stack frames are allocated in a region of memory called the @dfn{call
7073 When your program stops, the @value{GDBN} commands for examining the
7074 stack allow you to see all of this information.
7076 @cindex selected frame
7077 One of the stack frames is @dfn{selected} by @value{GDBN} and many
7078 @value{GDBN} commands refer implicitly to the selected frame. In
7079 particular, whenever you ask @value{GDBN} for the value of a variable in
7080 your program, the value is found in the selected frame. There are
7081 special @value{GDBN} commands to select whichever frame you are
7082 interested in. @xref{Selection, ,Selecting a Frame}.
7084 When your program stops, @value{GDBN} automatically selects the
7085 currently executing frame and describes it briefly, similar to the
7086 @code{frame} command (@pxref{Frame Info, ,Information about a Frame}).
7089 * Frames:: Stack frames
7090 * Backtrace:: Backtraces
7091 * Selection:: Selecting a frame
7092 * Frame Info:: Information on a frame
7093 * Frame Filter Management:: Managing frame filters
7098 @section Stack Frames
7100 @cindex frame, definition
7102 The call stack is divided up into contiguous pieces called @dfn{stack
7103 frames}, or @dfn{frames} for short; each frame is the data associated
7104 with one call to one function. The frame contains the arguments given
7105 to the function, the function's local variables, and the address at
7106 which the function is executing.
7108 @cindex initial frame
7109 @cindex outermost frame
7110 @cindex innermost frame
7111 When your program is started, the stack has only one frame, that of the
7112 function @code{main}. This is called the @dfn{initial} frame or the
7113 @dfn{outermost} frame. Each time a function is called, a new frame is
7114 made. Each time a function returns, the frame for that function invocation
7115 is eliminated. If a function is recursive, there can be many frames for
7116 the same function. The frame for the function in which execution is
7117 actually occurring is called the @dfn{innermost} frame. This is the most
7118 recently created of all the stack frames that still exist.
7120 @cindex frame pointer
7121 Inside your program, stack frames are identified by their addresses. A
7122 stack frame consists of many bytes, each of which has its own address; each
7123 kind of computer has a convention for choosing one byte whose
7124 address serves as the address of the frame. Usually this address is kept
7125 in a register called the @dfn{frame pointer register}
7126 (@pxref{Registers, $fp}) while execution is going on in that frame.
7128 @cindex frame number
7129 @value{GDBN} assigns numbers to all existing stack frames, starting with
7130 zero for the innermost frame, one for the frame that called it,
7131 and so on upward. These numbers do not really exist in your program;
7132 they are assigned by @value{GDBN} to give you a way of designating stack
7133 frames in @value{GDBN} commands.
7135 @c The -fomit-frame-pointer below perennially causes hbox overflow
7136 @c underflow problems.
7137 @cindex frameless execution
7138 Some compilers provide a way to compile functions so that they operate
7139 without stack frames. (For example, the @value{NGCC} option
7141 @samp{-fomit-frame-pointer}
7143 generates functions without a frame.)
7144 This is occasionally done with heavily used library functions to save
7145 the frame setup time. @value{GDBN} has limited facilities for dealing
7146 with these function invocations. If the innermost function invocation
7147 has no stack frame, @value{GDBN} nevertheless regards it as though
7148 it had a separate frame, which is numbered zero as usual, allowing
7149 correct tracing of the function call chain. However, @value{GDBN} has
7150 no provision for frameless functions elsewhere in the stack.
7156 @cindex call stack traces
7157 A backtrace is a summary of how your program got where it is. It shows one
7158 line per frame, for many frames, starting with the currently executing
7159 frame (frame zero), followed by its caller (frame one), and on up the
7162 @anchor{backtrace-command}
7165 @kindex bt @r{(@code{backtrace})}
7168 Print a backtrace of the entire stack: one line per frame for all
7169 frames in the stack.
7171 You can stop the backtrace at any time by typing the system interrupt
7172 character, normally @kbd{Ctrl-c}.
7174 @item backtrace @var{n}
7176 Similar, but print only the innermost @var{n} frames.
7178 @item backtrace -@var{n}
7180 Similar, but print only the outermost @var{n} frames.
7182 @item backtrace full
7184 @itemx bt full @var{n}
7185 @itemx bt full -@var{n}
7186 Print the values of the local variables also. As described above,
7187 @var{n} specifies the number of frames to print.
7189 @item backtrace no-filters
7190 @itemx bt no-filters
7191 @itemx bt no-filters @var{n}
7192 @itemx bt no-filters -@var{n}
7193 @itemx bt no-filters full
7194 @itemx bt no-filters full @var{n}
7195 @itemx bt no-filters full -@var{n}
7196 Do not run Python frame filters on this backtrace. @xref{Frame
7197 Filter API}, for more information. Additionally use @ref{disable
7198 frame-filter all} to turn off all frame filters. This is only
7199 relevant when @value{GDBN} has been configured with @code{Python}
7205 The names @code{where} and @code{info stack} (abbreviated @code{info s})
7206 are additional aliases for @code{backtrace}.
7208 @cindex multiple threads, backtrace
7209 In a multi-threaded program, @value{GDBN} by default shows the
7210 backtrace only for the current thread. To display the backtrace for
7211 several or all of the threads, use the command @code{thread apply}
7212 (@pxref{Threads, thread apply}). For example, if you type @kbd{thread
7213 apply all backtrace}, @value{GDBN} will display the backtrace for all
7214 the threads; this is handy when you debug a core dump of a
7215 multi-threaded program.
7217 Each line in the backtrace shows the frame number and the function name.
7218 The program counter value is also shown---unless you use @code{set
7219 print address off}. The backtrace also shows the source file name and
7220 line number, as well as the arguments to the function. The program
7221 counter value is omitted if it is at the beginning of the code for that
7224 Here is an example of a backtrace. It was made with the command
7225 @samp{bt 3}, so it shows the innermost three frames.
7229 #0 m4_traceon (obs=0x24eb0, argc=1, argv=0x2b8c8)
7231 #1 0x6e38 in expand_macro (sym=0x2b600, data=...) at macro.c:242
7232 #2 0x6840 in expand_token (obs=0x0, t=177664, td=0xf7fffb08)
7234 (More stack frames follow...)
7239 The display for frame zero does not begin with a program counter
7240 value, indicating that your program has stopped at the beginning of the
7241 code for line @code{993} of @code{builtin.c}.
7244 The value of parameter @code{data} in frame 1 has been replaced by
7245 @code{@dots{}}. By default, @value{GDBN} prints the value of a parameter
7246 only if it is a scalar (integer, pointer, enumeration, etc). See command
7247 @kbd{set print frame-arguments} in @ref{Print Settings} for more details
7248 on how to configure the way function parameter values are printed.
7250 @cindex optimized out, in backtrace
7251 @cindex function call arguments, optimized out
7252 If your program was compiled with optimizations, some compilers will
7253 optimize away arguments passed to functions if those arguments are
7254 never used after the call. Such optimizations generate code that
7255 passes arguments through registers, but doesn't store those arguments
7256 in the stack frame. @value{GDBN} has no way of displaying such
7257 arguments in stack frames other than the innermost one. Here's what
7258 such a backtrace might look like:
7262 #0 m4_traceon (obs=0x24eb0, argc=1, argv=0x2b8c8)
7264 #1 0x6e38 in expand_macro (sym=<optimized out>) at macro.c:242
7265 #2 0x6840 in expand_token (obs=0x0, t=<optimized out>, td=0xf7fffb08)
7267 (More stack frames follow...)
7272 The values of arguments that were not saved in their stack frames are
7273 shown as @samp{<optimized out>}.
7275 If you need to display the values of such optimized-out arguments,
7276 either deduce that from other variables whose values depend on the one
7277 you are interested in, or recompile without optimizations.
7279 @cindex backtrace beyond @code{main} function
7280 @cindex program entry point
7281 @cindex startup code, and backtrace
7282 Most programs have a standard user entry point---a place where system
7283 libraries and startup code transition into user code. For C this is
7284 @code{main}@footnote{
7285 Note that embedded programs (the so-called ``free-standing''
7286 environment) are not required to have a @code{main} function as the
7287 entry point. They could even have multiple entry points.}.
7288 When @value{GDBN} finds the entry function in a backtrace
7289 it will terminate the backtrace, to avoid tracing into highly
7290 system-specific (and generally uninteresting) code.
7292 If you need to examine the startup code, or limit the number of levels
7293 in a backtrace, you can change this behavior:
7296 @item set backtrace past-main
7297 @itemx set backtrace past-main on
7298 @kindex set backtrace
7299 Backtraces will continue past the user entry point.
7301 @item set backtrace past-main off
7302 Backtraces will stop when they encounter the user entry point. This is the
7305 @item show backtrace past-main
7306 @kindex show backtrace
7307 Display the current user entry point backtrace policy.
7309 @item set backtrace past-entry
7310 @itemx set backtrace past-entry on
7311 Backtraces will continue past the internal entry point of an application.
7312 This entry point is encoded by the linker when the application is built,
7313 and is likely before the user entry point @code{main} (or equivalent) is called.
7315 @item set backtrace past-entry off
7316 Backtraces will stop when they encounter the internal entry point of an
7317 application. This is the default.
7319 @item show backtrace past-entry
7320 Display the current internal entry point backtrace policy.
7322 @item set backtrace limit @var{n}
7323 @itemx set backtrace limit 0
7324 @itemx set backtrace limit unlimited
7325 @cindex backtrace limit
7326 Limit the backtrace to @var{n} levels. A value of @code{unlimited}
7327 or zero means unlimited levels.
7329 @item show backtrace limit
7330 Display the current limit on backtrace levels.
7333 You can control how file names are displayed.
7336 @item set filename-display
7337 @itemx set filename-display relative
7338 @cindex filename-display
7339 Display file names relative to the compilation directory. This is the default.
7341 @item set filename-display basename
7342 Display only basename of a filename.
7344 @item set filename-display absolute
7345 Display an absolute filename.
7347 @item show filename-display
7348 Show the current way to display filenames.
7352 @section Selecting a Frame
7354 Most commands for examining the stack and other data in your program work on
7355 whichever stack frame is selected at the moment. Here are the commands for
7356 selecting a stack frame; all of them finish by printing a brief description
7357 of the stack frame just selected.
7360 @kindex frame@r{, selecting}
7361 @kindex f @r{(@code{frame})}
7364 Select frame number @var{n}. Recall that frame zero is the innermost
7365 (currently executing) frame, frame one is the frame that called the
7366 innermost one, and so on. The highest-numbered frame is the one for
7369 @item frame @var{stack-addr} [ @var{pc-addr} ]
7370 @itemx f @var{stack-addr} [ @var{pc-addr} ]
7371 Select the frame at address @var{stack-addr}. This is useful mainly if the
7372 chaining of stack frames has been damaged by a bug, making it
7373 impossible for @value{GDBN} to assign numbers properly to all frames. In
7374 addition, this can be useful when your program has multiple stacks and
7375 switches between them. The optional @var{pc-addr} can also be given to
7376 specify the value of PC for the stack frame.
7380 Move @var{n} frames up the stack; @var{n} defaults to 1. For positive
7381 numbers @var{n}, this advances toward the outermost frame, to higher
7382 frame numbers, to frames that have existed longer.
7385 @kindex do @r{(@code{down})}
7387 Move @var{n} frames down the stack; @var{n} defaults to 1. For
7388 positive numbers @var{n}, this advances toward the innermost frame, to
7389 lower frame numbers, to frames that were created more recently.
7390 You may abbreviate @code{down} as @code{do}.
7393 All of these commands end by printing two lines of output describing the
7394 frame. The first line shows the frame number, the function name, the
7395 arguments, and the source file and line number of execution in that
7396 frame. The second line shows the text of that source line.
7404 #1 0x22f0 in main (argc=1, argv=0xf7fffbf4, env=0xf7fffbfc)
7406 10 read_input_file (argv[i]);
7410 After such a printout, the @code{list} command with no arguments
7411 prints ten lines centered on the point of execution in the frame.
7412 You can also edit the program at the point of execution with your favorite
7413 editing program by typing @code{edit}.
7414 @xref{List, ,Printing Source Lines},
7418 @kindex select-frame
7420 The @code{select-frame} command is a variant of @code{frame} that does
7421 not display the new frame after selecting it. This command is
7422 intended primarily for use in @value{GDBN} command scripts, where the
7423 output might be unnecessary and distracting.
7425 @kindex down-silently
7427 @item up-silently @var{n}
7428 @itemx down-silently @var{n}
7429 These two commands are variants of @code{up} and @code{down},
7430 respectively; they differ in that they do their work silently, without
7431 causing display of the new frame. They are intended primarily for use
7432 in @value{GDBN} command scripts, where the output might be unnecessary and
7437 @section Information About a Frame
7439 There are several other commands to print information about the selected
7445 When used without any argument, this command does not change which
7446 frame is selected, but prints a brief description of the currently
7447 selected stack frame. It can be abbreviated @code{f}. With an
7448 argument, this command is used to select a stack frame.
7449 @xref{Selection, ,Selecting a Frame}.
7452 @kindex info f @r{(@code{info frame})}
7455 This command prints a verbose description of the selected stack frame,
7460 the address of the frame
7462 the address of the next frame down (called by this frame)
7464 the address of the next frame up (caller of this frame)
7466 the language in which the source code corresponding to this frame is written
7468 the address of the frame's arguments
7470 the address of the frame's local variables
7472 the program counter saved in it (the address of execution in the caller frame)
7474 which registers were saved in the frame
7477 @noindent The verbose description is useful when
7478 something has gone wrong that has made the stack format fail to fit
7479 the usual conventions.
7481 @item info frame @var{addr}
7482 @itemx info f @var{addr}
7483 Print a verbose description of the frame at address @var{addr}, without
7484 selecting that frame. The selected frame remains unchanged by this
7485 command. This requires the same kind of address (more than one for some
7486 architectures) that you specify in the @code{frame} command.
7487 @xref{Selection, ,Selecting a Frame}.
7491 Print the arguments of the selected frame, each on a separate line.
7495 Print the local variables of the selected frame, each on a separate
7496 line. These are all variables (declared either static or automatic)
7497 accessible at the point of execution of the selected frame.
7501 @node Frame Filter Management
7502 @section Management of Frame Filters.
7503 @cindex managing frame filters
7505 Frame filters are Python based utilities to manage and decorate the
7506 output of frames. @xref{Frame Filter API}, for further information.
7508 Managing frame filters is performed by several commands available
7509 within @value{GDBN}, detailed here.
7512 @kindex info frame-filter
7513 @item info frame-filter
7514 Print a list of installed frame filters from all dictionaries, showing
7515 their name, priority and enabled status.
7517 @kindex disable frame-filter
7518 @anchor{disable frame-filter all}
7519 @item disable frame-filter @var{filter-dictionary} @var{filter-name}
7520 Disable a frame filter in the dictionary matching
7521 @var{filter-dictionary} and @var{filter-name}. The
7522 @var{filter-dictionary} may be @code{all}, @code{global},
7523 @code{progspace}, or the name of the object file where the frame filter
7524 dictionary resides. When @code{all} is specified, all frame filters
7525 across all dictionaries are disabled. The @var{filter-name} is the name
7526 of the frame filter and is used when @code{all} is not the option for
7527 @var{filter-dictionary}. A disabled frame-filter is not deleted, it
7528 may be enabled again later.
7530 @kindex enable frame-filter
7531 @item enable frame-filter @var{filter-dictionary} @var{filter-name}
7532 Enable a frame filter in the dictionary matching
7533 @var{filter-dictionary} and @var{filter-name}. The
7534 @var{filter-dictionary} may be @code{all}, @code{global},
7535 @code{progspace} or the name of the object file where the frame filter
7536 dictionary resides. When @code{all} is specified, all frame filters across
7537 all dictionaries are enabled. The @var{filter-name} is the name of the frame
7538 filter and is used when @code{all} is not the option for
7539 @var{filter-dictionary}.
7544 (gdb) info frame-filter
7546 global frame-filters:
7547 Priority Enabled Name
7548 1000 No PrimaryFunctionFilter
7551 progspace /build/test frame-filters:
7552 Priority Enabled Name
7553 100 Yes ProgspaceFilter
7555 objfile /build/test frame-filters:
7556 Priority Enabled Name
7557 999 Yes BuildProgra Filter
7559 (gdb) disable frame-filter /build/test BuildProgramFilter
7560 (gdb) info frame-filter
7562 global frame-filters:
7563 Priority Enabled Name
7564 1000 No PrimaryFunctionFilter
7567 progspace /build/test frame-filters:
7568 Priority Enabled Name
7569 100 Yes ProgspaceFilter
7571 objfile /build/test frame-filters:
7572 Priority Enabled Name
7573 999 No BuildProgramFilter
7575 (gdb) enable frame-filter global PrimaryFunctionFilter
7576 (gdb) info frame-filter
7578 global frame-filters:
7579 Priority Enabled Name
7580 1000 Yes PrimaryFunctionFilter
7583 progspace /build/test frame-filters:
7584 Priority Enabled Name
7585 100 Yes ProgspaceFilter
7587 objfile /build/test frame-filters:
7588 Priority Enabled Name
7589 999 No BuildProgramFilter
7592 @kindex set frame-filter priority
7593 @item set frame-filter priority @var{filter-dictionary} @var{filter-name} @var{priority}
7594 Set the @var{priority} of a frame filter in the dictionary matching
7595 @var{filter-dictionary}, and the frame filter name matching
7596 @var{filter-name}. The @var{filter-dictionary} may be @code{global},
7597 @code{progspace} or the name of the object file where the frame filter
7598 dictionary resides. The @var{priority} is an integer.
7600 @kindex show frame-filter priority
7601 @item show frame-filter priority @var{filter-dictionary} @var{filter-name}
7602 Show the @var{priority} of a frame filter in the dictionary matching
7603 @var{filter-dictionary}, and the frame filter name matching
7604 @var{filter-name}. The @var{filter-dictionary} may be @code{global},
7605 @code{progspace} or the name of the object file where the frame filter
7611 (gdb) info frame-filter
7613 global frame-filters:
7614 Priority Enabled Name
7615 1000 Yes PrimaryFunctionFilter
7618 progspace /build/test frame-filters:
7619 Priority Enabled Name
7620 100 Yes ProgspaceFilter
7622 objfile /build/test frame-filters:
7623 Priority Enabled Name
7624 999 No BuildProgramFilter
7626 (gdb) set frame-filter priority global Reverse 50
7627 (gdb) info frame-filter
7629 global frame-filters:
7630 Priority Enabled Name
7631 1000 Yes PrimaryFunctionFilter
7634 progspace /build/test frame-filters:
7635 Priority Enabled Name
7636 100 Yes ProgspaceFilter
7638 objfile /build/test frame-filters:
7639 Priority Enabled Name
7640 999 No BuildProgramFilter
7645 @chapter Examining Source Files
7647 @value{GDBN} can print parts of your program's source, since the debugging
7648 information recorded in the program tells @value{GDBN} what source files were
7649 used to build it. When your program stops, @value{GDBN} spontaneously prints
7650 the line where it stopped. Likewise, when you select a stack frame
7651 (@pxref{Selection, ,Selecting a Frame}), @value{GDBN} prints the line where
7652 execution in that frame has stopped. You can print other portions of
7653 source files by explicit command.
7655 If you use @value{GDBN} through its @sc{gnu} Emacs interface, you may
7656 prefer to use Emacs facilities to view source; see @ref{Emacs, ,Using
7657 @value{GDBN} under @sc{gnu} Emacs}.
7660 * List:: Printing source lines
7661 * Specify Location:: How to specify code locations
7662 * Edit:: Editing source files
7663 * Search:: Searching source files
7664 * Source Path:: Specifying source directories
7665 * Machine Code:: Source and machine code
7669 @section Printing Source Lines
7672 @kindex l @r{(@code{list})}
7673 To print lines from a source file, use the @code{list} command
7674 (abbreviated @code{l}). By default, ten lines are printed.
7675 There are several ways to specify what part of the file you want to
7676 print; see @ref{Specify Location}, for the full list.
7678 Here are the forms of the @code{list} command most commonly used:
7681 @item list @var{linenum}
7682 Print lines centered around line number @var{linenum} in the
7683 current source file.
7685 @item list @var{function}
7686 Print lines centered around the beginning of function
7690 Print more lines. If the last lines printed were printed with a
7691 @code{list} command, this prints lines following the last lines
7692 printed; however, if the last line printed was a solitary line printed
7693 as part of displaying a stack frame (@pxref{Stack, ,Examining the
7694 Stack}), this prints lines centered around that line.
7697 Print lines just before the lines last printed.
7700 @cindex @code{list}, how many lines to display
7701 By default, @value{GDBN} prints ten source lines with any of these forms of
7702 the @code{list} command. You can change this using @code{set listsize}:
7705 @kindex set listsize
7706 @item set listsize @var{count}
7707 @itemx set listsize unlimited
7708 Make the @code{list} command display @var{count} source lines (unless
7709 the @code{list} argument explicitly specifies some other number).
7710 Setting @var{count} to @code{unlimited} or 0 means there's no limit.
7712 @kindex show listsize
7714 Display the number of lines that @code{list} prints.
7717 Repeating a @code{list} command with @key{RET} discards the argument,
7718 so it is equivalent to typing just @code{list}. This is more useful
7719 than listing the same lines again. An exception is made for an
7720 argument of @samp{-}; that argument is preserved in repetition so that
7721 each repetition moves up in the source file.
7723 In general, the @code{list} command expects you to supply zero, one or two
7724 @dfn{locations}. Locations specify source lines; there are several ways
7725 of writing them (@pxref{Specify Location}), but the effect is always
7726 to specify some source line.
7728 Here is a complete description of the possible arguments for @code{list}:
7731 @item list @var{location}
7732 Print lines centered around the line specified by @var{location}.
7734 @item list @var{first},@var{last}
7735 Print lines from @var{first} to @var{last}. Both arguments are
7736 locations. When a @code{list} command has two locations, and the
7737 source file of the second location is omitted, this refers to
7738 the same source file as the first location.
7740 @item list ,@var{last}
7741 Print lines ending with @var{last}.
7743 @item list @var{first},
7744 Print lines starting with @var{first}.
7747 Print lines just after the lines last printed.
7750 Print lines just before the lines last printed.
7753 As described in the preceding table.
7756 @node Specify Location
7757 @section Specifying a Location
7758 @cindex specifying location
7760 @cindex source location
7763 * Linespec Locations:: Linespec locations
7764 * Explicit Locations:: Explicit locations
7765 * Address Locations:: Address locations
7768 Several @value{GDBN} commands accept arguments that specify a location
7769 of your program's code. Since @value{GDBN} is a source-level
7770 debugger, a location usually specifies some line in the source code.
7771 Locations may be specified using three different formats:
7772 linespec locations, explicit locations, or address locations.
7774 @node Linespec Locations
7775 @subsection Linespec Locations
7776 @cindex linespec locations
7778 A @dfn{linespec} is a colon-separated list of source location parameters such
7779 as file name, function name, etc. Here are all the different ways of
7780 specifying a linespec:
7784 Specifies the line number @var{linenum} of the current source file.
7787 @itemx +@var{offset}
7788 Specifies the line @var{offset} lines before or after the @dfn{current
7789 line}. For the @code{list} command, the current line is the last one
7790 printed; for the breakpoint commands, this is the line at which
7791 execution stopped in the currently selected @dfn{stack frame}
7792 (@pxref{Frames, ,Frames}, for a description of stack frames.) When
7793 used as the second of the two linespecs in a @code{list} command,
7794 this specifies the line @var{offset} lines up or down from the first
7797 @item @var{filename}:@var{linenum}
7798 Specifies the line @var{linenum} in the source file @var{filename}.
7799 If @var{filename} is a relative file name, then it will match any
7800 source file name with the same trailing components. For example, if
7801 @var{filename} is @samp{gcc/expr.c}, then it will match source file
7802 name of @file{/build/trunk/gcc/expr.c}, but not
7803 @file{/build/trunk/libcpp/expr.c} or @file{/build/trunk/gcc/x-expr.c}.
7805 @item @var{function}
7806 Specifies the line that begins the body of the function @var{function}.
7807 For example, in C, this is the line with the open brace.
7809 @item @var{function}:@var{label}
7810 Specifies the line where @var{label} appears in @var{function}.
7812 @item @var{filename}:@var{function}
7813 Specifies the line that begins the body of the function @var{function}
7814 in the file @var{filename}. You only need the file name with a
7815 function name to avoid ambiguity when there are identically named
7816 functions in different source files.
7819 Specifies the line at which the label named @var{label} appears
7820 in the function corresponding to the currently selected stack frame.
7821 If there is no current selected stack frame (for instance, if the inferior
7822 is not running), then @value{GDBN} will not search for a label.
7824 @cindex breakpoint at static probe point
7825 @item -pstap|-probe-stap @r{[}@var{objfile}:@r{[}@var{provider}:@r{]}@r{]}@var{name}
7826 The @sc{gnu}/Linux tool @code{SystemTap} provides a way for
7827 applications to embed static probes. @xref{Static Probe Points}, for more
7828 information on finding and using static probes. This form of linespec
7829 specifies the location of such a static probe.
7831 If @var{objfile} is given, only probes coming from that shared library
7832 or executable matching @var{objfile} as a regular expression are considered.
7833 If @var{provider} is given, then only probes from that provider are considered.
7834 If several probes match the spec, @value{GDBN} will insert a breakpoint at
7835 each one of those probes.
7838 @node Explicit Locations
7839 @subsection Explicit Locations
7840 @cindex explicit locations
7842 @dfn{Explicit locations} allow the user to directly specify the source
7843 location's parameters using option-value pairs.
7845 Explicit locations are useful when several functions, labels, or
7846 file names have the same name (base name for files) in the program's
7847 sources. In these cases, explicit locations point to the source
7848 line you meant more accurately and unambiguously. Also, using
7849 explicit locations might be faster in large programs.
7851 For example, the linespec @samp{foo:bar} may refer to a function @code{bar}
7852 defined in the file named @file{foo} or the label @code{bar} in a function
7853 named @code{foo}. @value{GDBN} must search either the file system or
7854 the symbol table to know.
7856 The list of valid explicit location options is summarized in the
7860 @item -source @var{filename}
7861 The value specifies the source file name. To differentiate between
7862 files with the same base name, prepend as many directories as is necessary
7863 to uniquely identify the desired file, e.g., @file{foo/bar/baz.c}. Otherwise
7864 @value{GDBN} will use the first file it finds with the given base
7865 name. This option requires the use of either @code{-function} or @code{-line}.
7867 @item -function @var{function}
7868 The value specifies the name of a function. Operations
7869 on function locations unmodified by other options (such as @code{-label}
7870 or @code{-line}) refer to the line that begins the body of the function.
7871 In C, for example, this is the line with the open brace.
7873 @item -label @var{label}
7874 The value specifies the name of a label. When the function
7875 name is not specified, the label is searched in the function of the currently
7876 selected stack frame.
7878 @item -line @var{number}
7879 The value specifies a line offset for the location. The offset may either
7880 be absolute (@code{-line 3}) or relative (@code{-line +3}), depending on
7881 the command. When specified without any other options, the line offset is
7882 relative to the current line.
7885 Explicit location options may be abbreviated by omitting any non-unique
7886 trailing characters from the option name, e.g., @code{break -s main.c -li 3}.
7888 @node Address Locations
7889 @subsection Address Locations
7890 @cindex address locations
7892 @dfn{Address locations} indicate a specific program address. They have
7893 the generalized form *@var{address}.
7895 For line-oriented commands, such as @code{list} and @code{edit}, this
7896 specifies a source line that contains @var{address}. For @code{break} and
7897 other breakpoint-oriented commands, this can be used to set breakpoints in
7898 parts of your program which do not have debugging information or
7901 Here @var{address} may be any expression valid in the current working
7902 language (@pxref{Languages, working language}) that specifies a code
7903 address. In addition, as a convenience, @value{GDBN} extends the
7904 semantics of expressions used in locations to cover several situations
7905 that frequently occur during debugging. Here are the various forms
7909 @item @var{expression}
7910 Any expression valid in the current working language.
7912 @item @var{funcaddr}
7913 An address of a function or procedure derived from its name. In C,
7914 C@t{++}, Java, Objective-C, Fortran, minimal, and assembly, this is
7915 simply the function's name @var{function} (and actually a special case
7916 of a valid expression). In Pascal and Modula-2, this is
7917 @code{&@var{function}}. In Ada, this is @code{@var{function}'Address}
7918 (although the Pascal form also works).
7920 This form specifies the address of the function's first instruction,
7921 before the stack frame and arguments have been set up.
7923 @item '@var{filename}':@var{funcaddr}
7924 Like @var{funcaddr} above, but also specifies the name of the source
7925 file explicitly. This is useful if the name of the function does not
7926 specify the function unambiguously, e.g., if there are several
7927 functions with identical names in different source files.
7931 @section Editing Source Files
7932 @cindex editing source files
7935 @kindex e @r{(@code{edit})}
7936 To edit the lines in a source file, use the @code{edit} command.
7937 The editing program of your choice
7938 is invoked with the current line set to
7939 the active line in the program.
7940 Alternatively, there are several ways to specify what part of the file you
7941 want to print if you want to see other parts of the program:
7944 @item edit @var{location}
7945 Edit the source file specified by @code{location}. Editing starts at
7946 that @var{location}, e.g., at the specified source line of the
7947 specified file. @xref{Specify Location}, for all the possible forms
7948 of the @var{location} argument; here are the forms of the @code{edit}
7949 command most commonly used:
7952 @item edit @var{number}
7953 Edit the current source file with @var{number} as the active line number.
7955 @item edit @var{function}
7956 Edit the file containing @var{function} at the beginning of its definition.
7961 @subsection Choosing your Editor
7962 You can customize @value{GDBN} to use any editor you want
7964 The only restriction is that your editor (say @code{ex}), recognizes the
7965 following command-line syntax:
7967 ex +@var{number} file
7969 The optional numeric value +@var{number} specifies the number of the line in
7970 the file where to start editing.}.
7971 By default, it is @file{@value{EDITOR}}, but you can change this
7972 by setting the environment variable @code{EDITOR} before using
7973 @value{GDBN}. For example, to configure @value{GDBN} to use the
7974 @code{vi} editor, you could use these commands with the @code{sh} shell:
7980 or in the @code{csh} shell,
7982 setenv EDITOR /usr/bin/vi
7987 @section Searching Source Files
7988 @cindex searching source files
7990 There are two commands for searching through the current source file for a
7995 @kindex forward-search
7996 @kindex fo @r{(@code{forward-search})}
7997 @item forward-search @var{regexp}
7998 @itemx search @var{regexp}
7999 The command @samp{forward-search @var{regexp}} checks each line,
8000 starting with the one following the last line listed, for a match for
8001 @var{regexp}. It lists the line that is found. You can use the
8002 synonym @samp{search @var{regexp}} or abbreviate the command name as
8005 @kindex reverse-search
8006 @item reverse-search @var{regexp}
8007 The command @samp{reverse-search @var{regexp}} checks each line, starting
8008 with the one before the last line listed and going backward, for a match
8009 for @var{regexp}. It lists the line that is found. You can abbreviate
8010 this command as @code{rev}.
8014 @section Specifying Source Directories
8017 @cindex directories for source files
8018 Executable programs sometimes do not record the directories of the source
8019 files from which they were compiled, just the names. Even when they do,
8020 the directories could be moved between the compilation and your debugging
8021 session. @value{GDBN} has a list of directories to search for source files;
8022 this is called the @dfn{source path}. Each time @value{GDBN} wants a source file,
8023 it tries all the directories in the list, in the order they are present
8024 in the list, until it finds a file with the desired name.
8026 For example, suppose an executable references the file
8027 @file{/usr/src/foo-1.0/lib/foo.c}, and our source path is
8028 @file{/mnt/cross}. The file is first looked up literally; if this
8029 fails, @file{/mnt/cross/usr/src/foo-1.0/lib/foo.c} is tried; if this
8030 fails, @file{/mnt/cross/foo.c} is opened; if this fails, an error
8031 message is printed. @value{GDBN} does not look up the parts of the
8032 source file name, such as @file{/mnt/cross/src/foo-1.0/lib/foo.c}.
8033 Likewise, the subdirectories of the source path are not searched: if
8034 the source path is @file{/mnt/cross}, and the binary refers to
8035 @file{foo.c}, @value{GDBN} would not find it under
8036 @file{/mnt/cross/usr/src/foo-1.0/lib}.
8038 Plain file names, relative file names with leading directories, file
8039 names containing dots, etc.@: are all treated as described above; for
8040 instance, if the source path is @file{/mnt/cross}, and the source file
8041 is recorded as @file{../lib/foo.c}, @value{GDBN} would first try
8042 @file{../lib/foo.c}, then @file{/mnt/cross/../lib/foo.c}, and after
8043 that---@file{/mnt/cross/foo.c}.
8045 Note that the executable search path is @emph{not} used to locate the
8048 Whenever you reset or rearrange the source path, @value{GDBN} clears out
8049 any information it has cached about where source files are found and where
8050 each line is in the file.
8054 When you start @value{GDBN}, its source path includes only @samp{cdir}
8055 and @samp{cwd}, in that order.
8056 To add other directories, use the @code{directory} command.
8058 The search path is used to find both program source files and @value{GDBN}
8059 script files (read using the @samp{-command} option and @samp{source} command).
8061 In addition to the source path, @value{GDBN} provides a set of commands
8062 that manage a list of source path substitution rules. A @dfn{substitution
8063 rule} specifies how to rewrite source directories stored in the program's
8064 debug information in case the sources were moved to a different
8065 directory between compilation and debugging. A rule is made of
8066 two strings, the first specifying what needs to be rewritten in
8067 the path, and the second specifying how it should be rewritten.
8068 In @ref{set substitute-path}, we name these two parts @var{from} and
8069 @var{to} respectively. @value{GDBN} does a simple string replacement
8070 of @var{from} with @var{to} at the start of the directory part of the
8071 source file name, and uses that result instead of the original file
8072 name to look up the sources.
8074 Using the previous example, suppose the @file{foo-1.0} tree has been
8075 moved from @file{/usr/src} to @file{/mnt/cross}, then you can tell
8076 @value{GDBN} to replace @file{/usr/src} in all source path names with
8077 @file{/mnt/cross}. The first lookup will then be
8078 @file{/mnt/cross/foo-1.0/lib/foo.c} in place of the original location
8079 of @file{/usr/src/foo-1.0/lib/foo.c}. To define a source path
8080 substitution rule, use the @code{set substitute-path} command
8081 (@pxref{set substitute-path}).
8083 To avoid unexpected substitution results, a rule is applied only if the
8084 @var{from} part of the directory name ends at a directory separator.
8085 For instance, a rule substituting @file{/usr/source} into
8086 @file{/mnt/cross} will be applied to @file{/usr/source/foo-1.0} but
8087 not to @file{/usr/sourceware/foo-2.0}. And because the substitution
8088 is applied only at the beginning of the directory name, this rule will
8089 not be applied to @file{/root/usr/source/baz.c} either.
8091 In many cases, you can achieve the same result using the @code{directory}
8092 command. However, @code{set substitute-path} can be more efficient in
8093 the case where the sources are organized in a complex tree with multiple
8094 subdirectories. With the @code{directory} command, you need to add each
8095 subdirectory of your project. If you moved the entire tree while
8096 preserving its internal organization, then @code{set substitute-path}
8097 allows you to direct the debugger to all the sources with one single
8100 @code{set substitute-path} is also more than just a shortcut command.
8101 The source path is only used if the file at the original location no
8102 longer exists. On the other hand, @code{set substitute-path} modifies
8103 the debugger behavior to look at the rewritten location instead. So, if
8104 for any reason a source file that is not relevant to your executable is
8105 located at the original location, a substitution rule is the only
8106 method available to point @value{GDBN} at the new location.
8108 @cindex @samp{--with-relocated-sources}
8109 @cindex default source path substitution
8110 You can configure a default source path substitution rule by
8111 configuring @value{GDBN} with the
8112 @samp{--with-relocated-sources=@var{dir}} option. The @var{dir}
8113 should be the name of a directory under @value{GDBN}'s configured
8114 prefix (set with @samp{--prefix} or @samp{--exec-prefix}), and
8115 directory names in debug information under @var{dir} will be adjusted
8116 automatically if the installed @value{GDBN} is moved to a new
8117 location. This is useful if @value{GDBN}, libraries or executables
8118 with debug information and corresponding source code are being moved
8122 @item directory @var{dirname} @dots{}
8123 @item dir @var{dirname} @dots{}
8124 Add directory @var{dirname} to the front of the source path. Several
8125 directory names may be given to this command, separated by @samp{:}
8126 (@samp{;} on MS-DOS and MS-Windows, where @samp{:} usually appears as
8127 part of absolute file names) or
8128 whitespace. You may specify a directory that is already in the source
8129 path; this moves it forward, so @value{GDBN} searches it sooner.
8133 @vindex $cdir@r{, convenience variable}
8134 @vindex $cwd@r{, convenience variable}
8135 @cindex compilation directory
8136 @cindex current directory
8137 @cindex working directory
8138 @cindex directory, current
8139 @cindex directory, compilation
8140 You can use the string @samp{$cdir} to refer to the compilation
8141 directory (if one is recorded), and @samp{$cwd} to refer to the current
8142 working directory. @samp{$cwd} is not the same as @samp{.}---the former
8143 tracks the current working directory as it changes during your @value{GDBN}
8144 session, while the latter is immediately expanded to the current
8145 directory at the time you add an entry to the source path.
8148 Reset the source path to its default value (@samp{$cdir:$cwd} on Unix systems). This requires confirmation.
8150 @c RET-repeat for @code{directory} is explicitly disabled, but since
8151 @c repeating it would be a no-op we do not say that. (thanks to RMS)
8153 @item set directories @var{path-list}
8154 @kindex set directories
8155 Set the source path to @var{path-list}.
8156 @samp{$cdir:$cwd} are added if missing.
8158 @item show directories
8159 @kindex show directories
8160 Print the source path: show which directories it contains.
8162 @anchor{set substitute-path}
8163 @item set substitute-path @var{from} @var{to}
8164 @kindex set substitute-path
8165 Define a source path substitution rule, and add it at the end of the
8166 current list of existing substitution rules. If a rule with the same
8167 @var{from} was already defined, then the old rule is also deleted.
8169 For example, if the file @file{/foo/bar/baz.c} was moved to
8170 @file{/mnt/cross/baz.c}, then the command
8173 (@value{GDBP}) set substitute-path /foo/bar /mnt/cross
8177 will tell @value{GDBN} to replace @samp{/foo/bar} with
8178 @samp{/mnt/cross}, which will allow @value{GDBN} to find the file
8179 @file{baz.c} even though it was moved.
8181 In the case when more than one substitution rule have been defined,
8182 the rules are evaluated one by one in the order where they have been
8183 defined. The first one matching, if any, is selected to perform
8186 For instance, if we had entered the following commands:
8189 (@value{GDBP}) set substitute-path /usr/src/include /mnt/include
8190 (@value{GDBP}) set substitute-path /usr/src /mnt/src
8194 @value{GDBN} would then rewrite @file{/usr/src/include/defs.h} into
8195 @file{/mnt/include/defs.h} by using the first rule. However, it would
8196 use the second rule to rewrite @file{/usr/src/lib/foo.c} into
8197 @file{/mnt/src/lib/foo.c}.
8200 @item unset substitute-path [path]
8201 @kindex unset substitute-path
8202 If a path is specified, search the current list of substitution rules
8203 for a rule that would rewrite that path. Delete that rule if found.
8204 A warning is emitted by the debugger if no rule could be found.
8206 If no path is specified, then all substitution rules are deleted.
8208 @item show substitute-path [path]
8209 @kindex show substitute-path
8210 If a path is specified, then print the source path substitution rule
8211 which would rewrite that path, if any.
8213 If no path is specified, then print all existing source path substitution
8218 If your source path is cluttered with directories that are no longer of
8219 interest, @value{GDBN} may sometimes cause confusion by finding the wrong
8220 versions of source. You can correct the situation as follows:
8224 Use @code{directory} with no argument to reset the source path to its default value.
8227 Use @code{directory} with suitable arguments to reinstall the
8228 directories you want in the source path. You can add all the
8229 directories in one command.
8233 @section Source and Machine Code
8234 @cindex source line and its code address
8236 You can use the command @code{info line} to map source lines to program
8237 addresses (and vice versa), and the command @code{disassemble} to display
8238 a range of addresses as machine instructions. You can use the command
8239 @code{set disassemble-next-line} to set whether to disassemble next
8240 source line when execution stops. When run under @sc{gnu} Emacs
8241 mode, the @code{info line} command causes the arrow to point to the
8242 line specified. Also, @code{info line} prints addresses in symbolic form as
8247 @item info line @var{location}
8248 Print the starting and ending addresses of the compiled code for
8249 source line @var{location}. You can specify source lines in any of
8250 the ways documented in @ref{Specify Location}.
8253 For example, we can use @code{info line} to discover the location of
8254 the object code for the first line of function
8255 @code{m4_changequote}:
8257 @c FIXME: I think this example should also show the addresses in
8258 @c symbolic form, as they usually would be displayed.
8260 (@value{GDBP}) info line m4_changequote
8261 Line 895 of "builtin.c" starts at pc 0x634c and ends at 0x6350.
8265 @cindex code address and its source line
8266 We can also inquire (using @code{*@var{addr}} as the form for
8267 @var{location}) what source line covers a particular address:
8269 (@value{GDBP}) info line *0x63ff
8270 Line 926 of "builtin.c" starts at pc 0x63e4 and ends at 0x6404.
8273 @cindex @code{$_} and @code{info line}
8274 @cindex @code{x} command, default address
8275 @kindex x@r{(examine), and} info line
8276 After @code{info line}, the default address for the @code{x} command
8277 is changed to the starting address of the line, so that @samp{x/i} is
8278 sufficient to begin examining the machine code (@pxref{Memory,
8279 ,Examining Memory}). Also, this address is saved as the value of the
8280 convenience variable @code{$_} (@pxref{Convenience Vars, ,Convenience
8285 @cindex assembly instructions
8286 @cindex instructions, assembly
8287 @cindex machine instructions
8288 @cindex listing machine instructions
8290 @itemx disassemble /m
8291 @itemx disassemble /s
8292 @itemx disassemble /r
8293 This specialized command dumps a range of memory as machine
8294 instructions. It can also print mixed source+disassembly by specifying
8295 the @code{/m} or @code{/s} modifier and print the raw instructions in hex
8296 as well as in symbolic form by specifying the @code{/r} modifier.
8297 The default memory range is the function surrounding the
8298 program counter of the selected frame. A single argument to this
8299 command is a program counter value; @value{GDBN} dumps the function
8300 surrounding this value. When two arguments are given, they should
8301 be separated by a comma, possibly surrounded by whitespace. The
8302 arguments specify a range of addresses to dump, in one of two forms:
8305 @item @var{start},@var{end}
8306 the addresses from @var{start} (inclusive) to @var{end} (exclusive)
8307 @item @var{start},+@var{length}
8308 the addresses from @var{start} (inclusive) to
8309 @code{@var{start}+@var{length}} (exclusive).
8313 When 2 arguments are specified, the name of the function is also
8314 printed (since there could be several functions in the given range).
8316 The argument(s) can be any expression yielding a numeric value, such as
8317 @samp{0x32c4}, @samp{&main+10} or @samp{$pc - 8}.
8319 If the range of memory being disassembled contains current program counter,
8320 the instruction at that location is shown with a @code{=>} marker.
8323 The following example shows the disassembly of a range of addresses of
8324 HP PA-RISC 2.0 code:
8327 (@value{GDBP}) disas 0x32c4, 0x32e4
8328 Dump of assembler code from 0x32c4 to 0x32e4:
8329 0x32c4 <main+204>: addil 0,dp
8330 0x32c8 <main+208>: ldw 0x22c(sr0,r1),r26
8331 0x32cc <main+212>: ldil 0x3000,r31
8332 0x32d0 <main+216>: ble 0x3f8(sr4,r31)
8333 0x32d4 <main+220>: ldo 0(r31),rp
8334 0x32d8 <main+224>: addil -0x800,dp
8335 0x32dc <main+228>: ldo 0x588(r1),r26
8336 0x32e0 <main+232>: ldil 0x3000,r31
8337 End of assembler dump.
8340 Here is an example showing mixed source+assembly for Intel x86
8341 with @code{/m} or @code{/s}, when the program is stopped just after
8342 function prologue in a non-optimized function with no inline code.
8345 (@value{GDBP}) disas /m main
8346 Dump of assembler code for function main:
8348 0x08048330 <+0>: push %ebp
8349 0x08048331 <+1>: mov %esp,%ebp
8350 0x08048333 <+3>: sub $0x8,%esp
8351 0x08048336 <+6>: and $0xfffffff0,%esp
8352 0x08048339 <+9>: sub $0x10,%esp
8354 6 printf ("Hello.\n");
8355 => 0x0804833c <+12>: movl $0x8048440,(%esp)
8356 0x08048343 <+19>: call 0x8048284 <puts@@plt>
8360 0x08048348 <+24>: mov $0x0,%eax
8361 0x0804834d <+29>: leave
8362 0x0804834e <+30>: ret
8364 End of assembler dump.
8367 The @code{/m} option is deprecated as its output is not useful when
8368 there is either inlined code or re-ordered code.
8369 The @code{/s} option is the preferred choice.
8370 Here is an example for AMD x86-64 showing the difference between
8371 @code{/m} output and @code{/s} output.
8372 This example has one inline function defined in a header file,
8373 and the code is compiled with @samp{-O2} optimization.
8374 Note how the @code{/m} output is missing the disassembly of
8375 several instructions that are present in the @code{/s} output.
8405 (@value{GDBP}) disas /m main
8406 Dump of assembler code for function main:
8410 0x0000000000400400 <+0>: mov 0x200c2e(%rip),%eax # 0x601034 <y>
8411 0x0000000000400417 <+23>: mov %eax,0x200c13(%rip) # 0x601030 <x>
8415 0x000000000040041d <+29>: xor %eax,%eax
8416 0x000000000040041f <+31>: retq
8417 0x0000000000400420 <+32>: add %eax,%eax
8418 0x0000000000400422 <+34>: jmp 0x400417 <main+23>
8420 End of assembler dump.
8421 (@value{GDBP}) disas /s main
8422 Dump of assembler code for function main:
8426 0x0000000000400400 <+0>: mov 0x200c2e(%rip),%eax # 0x601034 <y>
8430 0x0000000000400406 <+6>: test %eax,%eax
8431 0x0000000000400408 <+8>: js 0x400420 <main+32>
8436 0x000000000040040a <+10>: lea 0xa(%rax),%edx
8437 0x000000000040040d <+13>: test %eax,%eax
8438 0x000000000040040f <+15>: mov $0x1,%eax
8439 0x0000000000400414 <+20>: cmovne %edx,%eax
8443 0x0000000000400417 <+23>: mov %eax,0x200c13(%rip) # 0x601030 <x>
8447 0x000000000040041d <+29>: xor %eax,%eax
8448 0x000000000040041f <+31>: retq
8452 0x0000000000400420 <+32>: add %eax,%eax
8453 0x0000000000400422 <+34>: jmp 0x400417 <main+23>
8454 End of assembler dump.
8457 Here is another example showing raw instructions in hex for AMD x86-64,
8460 (gdb) disas /r 0x400281,+10
8461 Dump of assembler code from 0x400281 to 0x40028b:
8462 0x0000000000400281: 38 36 cmp %dh,(%rsi)
8463 0x0000000000400283: 2d 36 34 2e 73 sub $0x732e3436,%eax
8464 0x0000000000400288: 6f outsl %ds:(%rsi),(%dx)
8465 0x0000000000400289: 2e 32 00 xor %cs:(%rax),%al
8466 End of assembler dump.
8469 Addresses cannot be specified as a location (@pxref{Specify Location}).
8470 So, for example, if you want to disassemble function @code{bar}
8471 in file @file{foo.c}, you must type @samp{disassemble 'foo.c'::bar}
8472 and not @samp{disassemble foo.c:bar}.
8474 Some architectures have more than one commonly-used set of instruction
8475 mnemonics or other syntax.
8477 For programs that were dynamically linked and use shared libraries,
8478 instructions that call functions or branch to locations in the shared
8479 libraries might show a seemingly bogus location---it's actually a
8480 location of the relocation table. On some architectures, @value{GDBN}
8481 might be able to resolve these to actual function names.
8484 @kindex set disassembly-flavor
8485 @cindex Intel disassembly flavor
8486 @cindex AT&T disassembly flavor
8487 @item set disassembly-flavor @var{instruction-set}
8488 Select the instruction set to use when disassembling the
8489 program via the @code{disassemble} or @code{x/i} commands.
8491 Currently this command is only defined for the Intel x86 family. You
8492 can set @var{instruction-set} to either @code{intel} or @code{att}.
8493 The default is @code{att}, the AT&T flavor used by default by Unix
8494 assemblers for x86-based targets.
8496 @kindex show disassembly-flavor
8497 @item show disassembly-flavor
8498 Show the current setting of the disassembly flavor.
8502 @kindex set disassemble-next-line
8503 @kindex show disassemble-next-line
8504 @item set disassemble-next-line
8505 @itemx show disassemble-next-line
8506 Control whether or not @value{GDBN} will disassemble the next source
8507 line or instruction when execution stops. If ON, @value{GDBN} will
8508 display disassembly of the next source line when execution of the
8509 program being debugged stops. This is @emph{in addition} to
8510 displaying the source line itself, which @value{GDBN} always does if
8511 possible. If the next source line cannot be displayed for some reason
8512 (e.g., if @value{GDBN} cannot find the source file, or there's no line
8513 info in the debug info), @value{GDBN} will display disassembly of the
8514 next @emph{instruction} instead of showing the next source line. If
8515 AUTO, @value{GDBN} will display disassembly of next instruction only
8516 if the source line cannot be displayed. This setting causes
8517 @value{GDBN} to display some feedback when you step through a function
8518 with no line info or whose source file is unavailable. The default is
8519 OFF, which means never display the disassembly of the next line or
8525 @chapter Examining Data
8527 @cindex printing data
8528 @cindex examining data
8531 The usual way to examine data in your program is with the @code{print}
8532 command (abbreviated @code{p}), or its synonym @code{inspect}. It
8533 evaluates and prints the value of an expression of the language your
8534 program is written in (@pxref{Languages, ,Using @value{GDBN} with
8535 Different Languages}). It may also print the expression using a
8536 Python-based pretty-printer (@pxref{Pretty Printing}).
8539 @item print @var{expr}
8540 @itemx print /@var{f} @var{expr}
8541 @var{expr} is an expression (in the source language). By default the
8542 value of @var{expr} is printed in a format appropriate to its data type;
8543 you can choose a different format by specifying @samp{/@var{f}}, where
8544 @var{f} is a letter specifying the format; see @ref{Output Formats,,Output
8548 @itemx print /@var{f}
8549 @cindex reprint the last value
8550 If you omit @var{expr}, @value{GDBN} displays the last value again (from the
8551 @dfn{value history}; @pxref{Value History, ,Value History}). This allows you to
8552 conveniently inspect the same value in an alternative format.
8555 A more low-level way of examining data is with the @code{x} command.
8556 It examines data in memory at a specified address and prints it in a
8557 specified format. @xref{Memory, ,Examining Memory}.
8559 If you are interested in information about types, or about how the
8560 fields of a struct or a class are declared, use the @code{ptype @var{exp}}
8561 command rather than @code{print}. @xref{Symbols, ,Examining the Symbol
8564 @cindex exploring hierarchical data structures
8566 Another way of examining values of expressions and type information is
8567 through the Python extension command @code{explore} (available only if
8568 the @value{GDBN} build is configured with @code{--with-python}). It
8569 offers an interactive way to start at the highest level (or, the most
8570 abstract level) of the data type of an expression (or, the data type
8571 itself) and explore all the way down to leaf scalar values/fields
8572 embedded in the higher level data types.
8575 @item explore @var{arg}
8576 @var{arg} is either an expression (in the source language), or a type
8577 visible in the current context of the program being debugged.
8580 The working of the @code{explore} command can be illustrated with an
8581 example. If a data type @code{struct ComplexStruct} is defined in your
8591 struct ComplexStruct
8593 struct SimpleStruct *ss_p;
8599 followed by variable declarations as
8602 struct SimpleStruct ss = @{ 10, 1.11 @};
8603 struct ComplexStruct cs = @{ &ss, @{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 @} @};
8607 then, the value of the variable @code{cs} can be explored using the
8608 @code{explore} command as follows.
8612 The value of `cs' is a struct/class of type `struct ComplexStruct' with
8613 the following fields:
8615 ss_p = <Enter 0 to explore this field of type `struct SimpleStruct *'>
8616 arr = <Enter 1 to explore this field of type `int [10]'>
8618 Enter the field number of choice:
8622 Since the fields of @code{cs} are not scalar values, you are being
8623 prompted to chose the field you want to explore. Let's say you choose
8624 the field @code{ss_p} by entering @code{0}. Then, since this field is a
8625 pointer, you will be asked if it is pointing to a single value. From
8626 the declaration of @code{cs} above, it is indeed pointing to a single
8627 value, hence you enter @code{y}. If you enter @code{n}, then you will
8628 be asked if it were pointing to an array of values, in which case this
8629 field will be explored as if it were an array.
8632 `cs.ss_p' is a pointer to a value of type `struct SimpleStruct'
8633 Continue exploring it as a pointer to a single value [y/n]: y
8634 The value of `*(cs.ss_p)' is a struct/class of type `struct
8635 SimpleStruct' with the following fields:
8637 i = 10 .. (Value of type `int')
8638 d = 1.1100000000000001 .. (Value of type `double')
8640 Press enter to return to parent value:
8644 If the field @code{arr} of @code{cs} was chosen for exploration by
8645 entering @code{1} earlier, then since it is as array, you will be
8646 prompted to enter the index of the element in the array that you want
8650 `cs.arr' is an array of `int'.
8651 Enter the index of the element you want to explore in `cs.arr': 5
8653 `(cs.arr)[5]' is a scalar value of type `int'.
8657 Press enter to return to parent value:
8660 In general, at any stage of exploration, you can go deeper towards the
8661 leaf values by responding to the prompts appropriately, or hit the
8662 return key to return to the enclosing data structure (the @i{higher}
8663 level data structure).
8665 Similar to exploring values, you can use the @code{explore} command to
8666 explore types. Instead of specifying a value (which is typically a
8667 variable name or an expression valid in the current context of the
8668 program being debugged), you specify a type name. If you consider the
8669 same example as above, your can explore the type
8670 @code{struct ComplexStruct} by passing the argument
8671 @code{struct ComplexStruct} to the @code{explore} command.
8674 (gdb) explore struct ComplexStruct
8678 By responding to the prompts appropriately in the subsequent interactive
8679 session, you can explore the type @code{struct ComplexStruct} in a
8680 manner similar to how the value @code{cs} was explored in the above
8683 The @code{explore} command also has two sub-commands,
8684 @code{explore value} and @code{explore type}. The former sub-command is
8685 a way to explicitly specify that value exploration of the argument is
8686 being invoked, while the latter is a way to explicitly specify that type
8687 exploration of the argument is being invoked.
8690 @item explore value @var{expr}
8691 @cindex explore value
8692 This sub-command of @code{explore} explores the value of the
8693 expression @var{expr} (if @var{expr} is an expression valid in the
8694 current context of the program being debugged). The behavior of this
8695 command is identical to that of the behavior of the @code{explore}
8696 command being passed the argument @var{expr}.
8698 @item explore type @var{arg}
8699 @cindex explore type
8700 This sub-command of @code{explore} explores the type of @var{arg} (if
8701 @var{arg} is a type visible in the current context of program being
8702 debugged), or the type of the value/expression @var{arg} (if @var{arg}
8703 is an expression valid in the current context of the program being
8704 debugged). If @var{arg} is a type, then the behavior of this command is
8705 identical to that of the @code{explore} command being passed the
8706 argument @var{arg}. If @var{arg} is an expression, then the behavior of
8707 this command will be identical to that of the @code{explore} command
8708 being passed the type of @var{arg} as the argument.
8712 * Expressions:: Expressions
8713 * Ambiguous Expressions:: Ambiguous Expressions
8714 * Variables:: Program variables
8715 * Arrays:: Artificial arrays
8716 * Output Formats:: Output formats
8717 * Memory:: Examining memory
8718 * Auto Display:: Automatic display
8719 * Print Settings:: Print settings
8720 * Pretty Printing:: Python pretty printing
8721 * Value History:: Value history
8722 * Convenience Vars:: Convenience variables
8723 * Convenience Funs:: Convenience functions
8724 * Registers:: Registers
8725 * Floating Point Hardware:: Floating point hardware
8726 * Vector Unit:: Vector Unit
8727 * OS Information:: Auxiliary data provided by operating system
8728 * Memory Region Attributes:: Memory region attributes
8729 * Dump/Restore Files:: Copy between memory and a file
8730 * Core File Generation:: Cause a program dump its core
8731 * Character Sets:: Debugging programs that use a different
8732 character set than GDB does
8733 * Caching Target Data:: Data caching for targets
8734 * Searching Memory:: Searching memory for a sequence of bytes
8735 * Value Sizes:: Managing memory allocated for values
8739 @section Expressions
8742 @code{print} and many other @value{GDBN} commands accept an expression and
8743 compute its value. Any kind of constant, variable or operator defined
8744 by the programming language you are using is valid in an expression in
8745 @value{GDBN}. This includes conditional expressions, function calls,
8746 casts, and string constants. It also includes preprocessor macros, if
8747 you compiled your program to include this information; see
8750 @cindex arrays in expressions
8751 @value{GDBN} supports array constants in expressions input by
8752 the user. The syntax is @{@var{element}, @var{element}@dots{}@}. For example,
8753 you can use the command @code{print @{1, 2, 3@}} to create an array
8754 of three integers. If you pass an array to a function or assign it
8755 to a program variable, @value{GDBN} copies the array to memory that
8756 is @code{malloc}ed in the target program.
8758 Because C is so widespread, most of the expressions shown in examples in
8759 this manual are in C. @xref{Languages, , Using @value{GDBN} with Different
8760 Languages}, for information on how to use expressions in other
8763 In this section, we discuss operators that you can use in @value{GDBN}
8764 expressions regardless of your programming language.
8766 @cindex casts, in expressions
8767 Casts are supported in all languages, not just in C, because it is so
8768 useful to cast a number into a pointer in order to examine a structure
8769 at that address in memory.
8770 @c FIXME: casts supported---Mod2 true?
8772 @value{GDBN} supports these operators, in addition to those common
8773 to programming languages:
8777 @samp{@@} is a binary operator for treating parts of memory as arrays.
8778 @xref{Arrays, ,Artificial Arrays}, for more information.
8781 @samp{::} allows you to specify a variable in terms of the file or
8782 function where it is defined. @xref{Variables, ,Program Variables}.
8784 @cindex @{@var{type}@}
8785 @cindex type casting memory
8786 @cindex memory, viewing as typed object
8787 @cindex casts, to view memory
8788 @item @{@var{type}@} @var{addr}
8789 Refers to an object of type @var{type} stored at address @var{addr} in
8790 memory. The address @var{addr} may be any expression whose value is
8791 an integer or pointer (but parentheses are required around binary
8792 operators, just as in a cast). This construct is allowed regardless
8793 of what kind of data is normally supposed to reside at @var{addr}.
8796 @node Ambiguous Expressions
8797 @section Ambiguous Expressions
8798 @cindex ambiguous expressions
8800 Expressions can sometimes contain some ambiguous elements. For instance,
8801 some programming languages (notably Ada, C@t{++} and Objective-C) permit
8802 a single function name to be defined several times, for application in
8803 different contexts. This is called @dfn{overloading}. Another example
8804 involving Ada is generics. A @dfn{generic package} is similar to C@t{++}
8805 templates and is typically instantiated several times, resulting in
8806 the same function name being defined in different contexts.
8808 In some cases and depending on the language, it is possible to adjust
8809 the expression to remove the ambiguity. For instance in C@t{++}, you
8810 can specify the signature of the function you want to break on, as in
8811 @kbd{break @var{function}(@var{types})}. In Ada, using the fully
8812 qualified name of your function often makes the expression unambiguous
8815 When an ambiguity that needs to be resolved is detected, the debugger
8816 has the capability to display a menu of numbered choices for each
8817 possibility, and then waits for the selection with the prompt @samp{>}.
8818 The first option is always @samp{[0] cancel}, and typing @kbd{0 @key{RET}}
8819 aborts the current command. If the command in which the expression was
8820 used allows more than one choice to be selected, the next option in the
8821 menu is @samp{[1] all}, and typing @kbd{1 @key{RET}} selects all possible
8824 For example, the following session excerpt shows an attempt to set a
8825 breakpoint at the overloaded symbol @code{String::after}.
8826 We choose three particular definitions of that function name:
8828 @c FIXME! This is likely to change to show arg type lists, at least
8831 (@value{GDBP}) b String::after
8834 [2] file:String.cc; line number:867
8835 [3] file:String.cc; line number:860
8836 [4] file:String.cc; line number:875
8837 [5] file:String.cc; line number:853
8838 [6] file:String.cc; line number:846
8839 [7] file:String.cc; line number:735
8841 Breakpoint 1 at 0xb26c: file String.cc, line 867.
8842 Breakpoint 2 at 0xb344: file String.cc, line 875.
8843 Breakpoint 3 at 0xafcc: file String.cc, line 846.
8844 Multiple breakpoints were set.
8845 Use the "delete" command to delete unwanted
8852 @kindex set multiple-symbols
8853 @item set multiple-symbols @var{mode}
8854 @cindex multiple-symbols menu
8856 This option allows you to adjust the debugger behavior when an expression
8859 By default, @var{mode} is set to @code{all}. If the command with which
8860 the expression is used allows more than one choice, then @value{GDBN}
8861 automatically selects all possible choices. For instance, inserting
8862 a breakpoint on a function using an ambiguous name results in a breakpoint
8863 inserted on each possible match. However, if a unique choice must be made,
8864 then @value{GDBN} uses the menu to help you disambiguate the expression.
8865 For instance, printing the address of an overloaded function will result
8866 in the use of the menu.
8868 When @var{mode} is set to @code{ask}, the debugger always uses the menu
8869 when an ambiguity is detected.
8871 Finally, when @var{mode} is set to @code{cancel}, the debugger reports
8872 an error due to the ambiguity and the command is aborted.
8874 @kindex show multiple-symbols
8875 @item show multiple-symbols
8876 Show the current value of the @code{multiple-symbols} setting.
8880 @section Program Variables
8882 The most common kind of expression to use is the name of a variable
8885 Variables in expressions are understood in the selected stack frame
8886 (@pxref{Selection, ,Selecting a Frame}); they must be either:
8890 global (or file-static)
8897 visible according to the scope rules of the
8898 programming language from the point of execution in that frame
8901 @noindent This means that in the function
8916 you can examine and use the variable @code{a} whenever your program is
8917 executing within the function @code{foo}, but you can only use or
8918 examine the variable @code{b} while your program is executing inside
8919 the block where @code{b} is declared.
8921 @cindex variable name conflict
8922 There is an exception: you can refer to a variable or function whose
8923 scope is a single source file even if the current execution point is not
8924 in this file. But it is possible to have more than one such variable or
8925 function with the same name (in different source files). If that
8926 happens, referring to that name has unpredictable effects. If you wish,
8927 you can specify a static variable in a particular function or file by
8928 using the colon-colon (@code{::}) notation:
8930 @cindex colon-colon, context for variables/functions
8932 @c info cannot cope with a :: index entry, but why deprive hard copy readers?
8933 @cindex @code{::}, context for variables/functions
8936 @var{file}::@var{variable}
8937 @var{function}::@var{variable}
8941 Here @var{file} or @var{function} is the name of the context for the
8942 static @var{variable}. In the case of file names, you can use quotes to
8943 make sure @value{GDBN} parses the file name as a single word---for example,
8944 to print a global value of @code{x} defined in @file{f2.c}:
8947 (@value{GDBP}) p 'f2.c'::x
8950 The @code{::} notation is normally used for referring to
8951 static variables, since you typically disambiguate uses of local variables
8952 in functions by selecting the appropriate frame and using the
8953 simple name of the variable. However, you may also use this notation
8954 to refer to local variables in frames enclosing the selected frame:
8963 process (a); /* Stop here */
8974 For example, if there is a breakpoint at the commented line,
8975 here is what you might see
8976 when the program stops after executing the call @code{bar(0)}:
8981 (@value{GDBP}) p bar::a
8984 #2 0x080483d0 in foo (a=5) at foobar.c:12
8987 (@value{GDBP}) p bar::a
8991 @cindex C@t{++} scope resolution
8992 These uses of @samp{::} are very rarely in conflict with the very
8993 similar use of the same notation in C@t{++}. When they are in
8994 conflict, the C@t{++} meaning takes precedence; however, this can be
8995 overridden by quoting the file or function name with single quotes.
8997 For example, suppose the program is stopped in a method of a class
8998 that has a field named @code{includefile}, and there is also an
8999 include file named @file{includefile} that defines a variable,
9003 (@value{GDBP}) p includefile
9005 (@value{GDBP}) p includefile::some_global
9006 A syntax error in expression, near `'.
9007 (@value{GDBP}) p 'includefile'::some_global
9011 @cindex wrong values
9012 @cindex variable values, wrong
9013 @cindex function entry/exit, wrong values of variables
9014 @cindex optimized code, wrong values of variables
9016 @emph{Warning:} Occasionally, a local variable may appear to have the
9017 wrong value at certain points in a function---just after entry to a new
9018 scope, and just before exit.
9020 You may see this problem when you are stepping by machine instructions.
9021 This is because, on most machines, it takes more than one instruction to
9022 set up a stack frame (including local variable definitions); if you are
9023 stepping by machine instructions, variables may appear to have the wrong
9024 values until the stack frame is completely built. On exit, it usually
9025 also takes more than one machine instruction to destroy a stack frame;
9026 after you begin stepping through that group of instructions, local
9027 variable definitions may be gone.
9029 This may also happen when the compiler does significant optimizations.
9030 To be sure of always seeing accurate values, turn off all optimization
9033 @cindex ``No symbol "foo" in current context''
9034 Another possible effect of compiler optimizations is to optimize
9035 unused variables out of existence, or assign variables to registers (as
9036 opposed to memory addresses). Depending on the support for such cases
9037 offered by the debug info format used by the compiler, @value{GDBN}
9038 might not be able to display values for such local variables. If that
9039 happens, @value{GDBN} will print a message like this:
9042 No symbol "foo" in current context.
9045 To solve such problems, either recompile without optimizations, or use a
9046 different debug info format, if the compiler supports several such
9047 formats. @xref{Compilation}, for more information on choosing compiler
9048 options. @xref{C, ,C and C@t{++}}, for more information about debug
9049 info formats that are best suited to C@t{++} programs.
9051 If you ask to print an object whose contents are unknown to
9052 @value{GDBN}, e.g., because its data type is not completely specified
9053 by the debug information, @value{GDBN} will say @samp{<incomplete
9054 type>}. @xref{Symbols, incomplete type}, for more about this.
9056 If you append @kbd{@@entry} string to a function parameter name you get its
9057 value at the time the function got called. If the value is not available an
9058 error message is printed. Entry values are available only with some compilers.
9059 Entry values are normally also printed at the function parameter list according
9060 to @ref{set print entry-values}.
9063 Breakpoint 1, d (i=30) at gdb.base/entry-value.c:29
9069 (gdb) print i@@entry
9073 Strings are identified as arrays of @code{char} values without specified
9074 signedness. Arrays of either @code{signed char} or @code{unsigned char} get
9075 printed as arrays of 1 byte sized integers. @code{-fsigned-char} or
9076 @code{-funsigned-char} @value{NGCC} options have no effect as @value{GDBN}
9077 defines literal string type @code{"char"} as @code{char} without a sign.
9082 signed char var1[] = "A";
9085 You get during debugging
9090 $2 = @{65 'A', 0 '\0'@}
9094 @section Artificial Arrays
9096 @cindex artificial array
9098 @kindex @@@r{, referencing memory as an array}
9099 It is often useful to print out several successive objects of the
9100 same type in memory; a section of an array, or an array of
9101 dynamically determined size for which only a pointer exists in the
9104 You can do this by referring to a contiguous span of memory as an
9105 @dfn{artificial array}, using the binary operator @samp{@@}. The left
9106 operand of @samp{@@} should be the first element of the desired array
9107 and be an individual object. The right operand should be the desired length
9108 of the array. The result is an array value whose elements are all of
9109 the type of the left argument. The first element is actually the left
9110 argument; the second element comes from bytes of memory immediately
9111 following those that hold the first element, and so on. Here is an
9112 example. If a program says
9115 int *array = (int *) malloc (len * sizeof (int));
9119 you can print the contents of @code{array} with
9125 The left operand of @samp{@@} must reside in memory. Array values made
9126 with @samp{@@} in this way behave just like other arrays in terms of
9127 subscripting, and are coerced to pointers when used in expressions.
9128 Artificial arrays most often appear in expressions via the value history
9129 (@pxref{Value History, ,Value History}), after printing one out.
9131 Another way to create an artificial array is to use a cast.
9132 This re-interprets a value as if it were an array.
9133 The value need not be in memory:
9135 (@value{GDBP}) p/x (short[2])0x12345678
9136 $1 = @{0x1234, 0x5678@}
9139 As a convenience, if you leave the array length out (as in
9140 @samp{(@var{type}[])@var{value}}) @value{GDBN} calculates the size to fill
9141 the value (as @samp{sizeof(@var{value})/sizeof(@var{type})}:
9143 (@value{GDBP}) p/x (short[])0x12345678
9144 $2 = @{0x1234, 0x5678@}
9147 Sometimes the artificial array mechanism is not quite enough; in
9148 moderately complex data structures, the elements of interest may not
9149 actually be adjacent---for example, if you are interested in the values
9150 of pointers in an array. One useful work-around in this situation is
9151 to use a convenience variable (@pxref{Convenience Vars, ,Convenience
9152 Variables}) as a counter in an expression that prints the first
9153 interesting value, and then repeat that expression via @key{RET}. For
9154 instance, suppose you have an array @code{dtab} of pointers to
9155 structures, and you are interested in the values of a field @code{fv}
9156 in each structure. Here is an example of what you might type:
9166 @node Output Formats
9167 @section Output Formats
9169 @cindex formatted output
9170 @cindex output formats
9171 By default, @value{GDBN} prints a value according to its data type. Sometimes
9172 this is not what you want. For example, you might want to print a number
9173 in hex, or a pointer in decimal. Or you might want to view data in memory
9174 at a certain address as a character string or as an instruction. To do
9175 these things, specify an @dfn{output format} when you print a value.
9177 The simplest use of output formats is to say how to print a value
9178 already computed. This is done by starting the arguments of the
9179 @code{print} command with a slash and a format letter. The format
9180 letters supported are:
9184 Regard the bits of the value as an integer, and print the integer in
9188 Print as integer in signed decimal.
9191 Print as integer in unsigned decimal.
9194 Print as integer in octal.
9197 Print as integer in binary. The letter @samp{t} stands for ``two''.
9198 @footnote{@samp{b} cannot be used because these format letters are also
9199 used with the @code{x} command, where @samp{b} stands for ``byte'';
9200 see @ref{Memory,,Examining Memory}.}
9203 @cindex unknown address, locating
9204 @cindex locate address
9205 Print as an address, both absolute in hexadecimal and as an offset from
9206 the nearest preceding symbol. You can use this format used to discover
9207 where (in what function) an unknown address is located:
9210 (@value{GDBP}) p/a 0x54320
9211 $3 = 0x54320 <_initialize_vx+396>
9215 The command @code{info symbol 0x54320} yields similar results.
9216 @xref{Symbols, info symbol}.
9219 Regard as an integer and print it as a character constant. This
9220 prints both the numerical value and its character representation. The
9221 character representation is replaced with the octal escape @samp{\nnn}
9222 for characters outside the 7-bit @sc{ascii} range.
9224 Without this format, @value{GDBN} displays @code{char},
9225 @w{@code{unsigned char}}, and @w{@code{signed char}} data as character
9226 constants. Single-byte members of vectors are displayed as integer
9230 Regard the bits of the value as a floating point number and print
9231 using typical floating point syntax.
9234 @cindex printing strings
9235 @cindex printing byte arrays
9236 Regard as a string, if possible. With this format, pointers to single-byte
9237 data are displayed as null-terminated strings and arrays of single-byte data
9238 are displayed as fixed-length strings. Other values are displayed in their
9241 Without this format, @value{GDBN} displays pointers to and arrays of
9242 @code{char}, @w{@code{unsigned char}}, and @w{@code{signed char}} as
9243 strings. Single-byte members of a vector are displayed as an integer
9247 Like @samp{x} formatting, the value is treated as an integer and
9248 printed as hexadecimal, but leading zeros are printed to pad the value
9249 to the size of the integer type.
9252 @cindex raw printing
9253 Print using the @samp{raw} formatting. By default, @value{GDBN} will
9254 use a Python-based pretty-printer, if one is available (@pxref{Pretty
9255 Printing}). This typically results in a higher-level display of the
9256 value's contents. The @samp{r} format bypasses any Python
9257 pretty-printer which might exist.
9260 For example, to print the program counter in hex (@pxref{Registers}), type
9267 Note that no space is required before the slash; this is because command
9268 names in @value{GDBN} cannot contain a slash.
9270 To reprint the last value in the value history with a different format,
9271 you can use the @code{print} command with just a format and no
9272 expression. For example, @samp{p/x} reprints the last value in hex.
9275 @section Examining Memory
9277 You can use the command @code{x} (for ``examine'') to examine memory in
9278 any of several formats, independently of your program's data types.
9280 @cindex examining memory
9282 @kindex x @r{(examine memory)}
9283 @item x/@var{nfu} @var{addr}
9286 Use the @code{x} command to examine memory.
9289 @var{n}, @var{f}, and @var{u} are all optional parameters that specify how
9290 much memory to display and how to format it; @var{addr} is an
9291 expression giving the address where you want to start displaying memory.
9292 If you use defaults for @var{nfu}, you need not type the slash @samp{/}.
9293 Several commands set convenient defaults for @var{addr}.
9296 @item @var{n}, the repeat count
9297 The repeat count is a decimal integer; the default is 1. It specifies
9298 how much memory (counting by units @var{u}) to display.
9299 @c This really is **decimal**; unaffected by 'set radix' as of GDB
9302 @item @var{f}, the display format
9303 The display format is one of the formats used by @code{print}
9304 (@samp{x}, @samp{d}, @samp{u}, @samp{o}, @samp{t}, @samp{a}, @samp{c},
9305 @samp{f}, @samp{s}), and in addition @samp{i} (for machine instructions).
9306 The default is @samp{x} (hexadecimal) initially. The default changes
9307 each time you use either @code{x} or @code{print}.
9309 @item @var{u}, the unit size
9310 The unit size is any of
9316 Halfwords (two bytes).
9318 Words (four bytes). This is the initial default.
9320 Giant words (eight bytes).
9323 Each time you specify a unit size with @code{x}, that size becomes the
9324 default unit the next time you use @code{x}. For the @samp{i} format,
9325 the unit size is ignored and is normally not written. For the @samp{s} format,
9326 the unit size defaults to @samp{b}, unless it is explicitly given.
9327 Use @kbd{x /hs} to display 16-bit char strings and @kbd{x /ws} to display
9328 32-bit strings. The next use of @kbd{x /s} will again display 8-bit strings.
9329 Note that the results depend on the programming language of the
9330 current compilation unit. If the language is C, the @samp{s}
9331 modifier will use the UTF-16 encoding while @samp{w} will use
9332 UTF-32. The encoding is set by the programming language and cannot
9335 @item @var{addr}, starting display address
9336 @var{addr} is the address where you want @value{GDBN} to begin displaying
9337 memory. The expression need not have a pointer value (though it may);
9338 it is always interpreted as an integer address of a byte of memory.
9339 @xref{Expressions, ,Expressions}, for more information on expressions. The default for
9340 @var{addr} is usually just after the last address examined---but several
9341 other commands also set the default address: @code{info breakpoints} (to
9342 the address of the last breakpoint listed), @code{info line} (to the
9343 starting address of a line), and @code{print} (if you use it to display
9344 a value from memory).
9347 For example, @samp{x/3uh 0x54320} is a request to display three halfwords
9348 (@code{h}) of memory, formatted as unsigned decimal integers (@samp{u}),
9349 starting at address @code{0x54320}. @samp{x/4xw $sp} prints the four
9350 words (@samp{w}) of memory above the stack pointer (here, @samp{$sp};
9351 @pxref{Registers, ,Registers}) in hexadecimal (@samp{x}).
9353 Since the letters indicating unit sizes are all distinct from the
9354 letters specifying output formats, you do not have to remember whether
9355 unit size or format comes first; either order works. The output
9356 specifications @samp{4xw} and @samp{4wx} mean exactly the same thing.
9357 (However, the count @var{n} must come first; @samp{wx4} does not work.)
9359 Even though the unit size @var{u} is ignored for the formats @samp{s}
9360 and @samp{i}, you might still want to use a count @var{n}; for example,
9361 @samp{3i} specifies that you want to see three machine instructions,
9362 including any operands. For convenience, especially when used with
9363 the @code{display} command, the @samp{i} format also prints branch delay
9364 slot instructions, if any, beyond the count specified, which immediately
9365 follow the last instruction that is within the count. The command
9366 @code{disassemble} gives an alternative way of inspecting machine
9367 instructions; see @ref{Machine Code,,Source and Machine Code}.
9369 All the defaults for the arguments to @code{x} are designed to make it
9370 easy to continue scanning memory with minimal specifications each time
9371 you use @code{x}. For example, after you have inspected three machine
9372 instructions with @samp{x/3i @var{addr}}, you can inspect the next seven
9373 with just @samp{x/7}. If you use @key{RET} to repeat the @code{x} command,
9374 the repeat count @var{n} is used again; the other arguments default as
9375 for successive uses of @code{x}.
9377 When examining machine instructions, the instruction at current program
9378 counter is shown with a @code{=>} marker. For example:
9381 (@value{GDBP}) x/5i $pc-6
9382 0x804837f <main+11>: mov %esp,%ebp
9383 0x8048381 <main+13>: push %ecx
9384 0x8048382 <main+14>: sub $0x4,%esp
9385 => 0x8048385 <main+17>: movl $0x8048460,(%esp)
9386 0x804838c <main+24>: call 0x80482d4 <puts@@plt>
9389 @cindex @code{$_}, @code{$__}, and value history
9390 The addresses and contents printed by the @code{x} command are not saved
9391 in the value history because there is often too much of them and they
9392 would get in the way. Instead, @value{GDBN} makes these values available for
9393 subsequent use in expressions as values of the convenience variables
9394 @code{$_} and @code{$__}. After an @code{x} command, the last address
9395 examined is available for use in expressions in the convenience variable
9396 @code{$_}. The contents of that address, as examined, are available in
9397 the convenience variable @code{$__}.
9399 If the @code{x} command has a repeat count, the address and contents saved
9400 are from the last memory unit printed; this is not the same as the last
9401 address printed if several units were printed on the last line of output.
9403 @anchor{addressable memory unit}
9404 @cindex addressable memory unit
9405 Most targets have an addressable memory unit size of 8 bits. This means
9406 that to each memory address are associated 8 bits of data. Some
9407 targets, however, have other addressable memory unit sizes.
9408 Within @value{GDBN} and this document, the term
9409 @dfn{addressable memory unit} (or @dfn{memory unit} for short) is used
9410 when explicitly referring to a chunk of data of that size. The word
9411 @dfn{byte} is used to refer to a chunk of data of 8 bits, regardless of
9412 the addressable memory unit size of the target. For most systems,
9413 addressable memory unit is a synonym of byte.
9415 @cindex remote memory comparison
9416 @cindex target memory comparison
9417 @cindex verify remote memory image
9418 @cindex verify target memory image
9419 When you are debugging a program running on a remote target machine
9420 (@pxref{Remote Debugging}), you may wish to verify the program's image
9421 in the remote machine's memory against the executable file you
9422 downloaded to the target. Or, on any target, you may want to check
9423 whether the program has corrupted its own read-only sections. The
9424 @code{compare-sections} command is provided for such situations.
9427 @kindex compare-sections
9428 @item compare-sections @r{[}@var{section-name}@r{|}@code{-r}@r{]}
9429 Compare the data of a loadable section @var{section-name} in the
9430 executable file of the program being debugged with the same section in
9431 the target machine's memory, and report any mismatches. With no
9432 arguments, compares all loadable sections. With an argument of
9433 @code{-r}, compares all loadable read-only sections.
9435 Note: for remote targets, this command can be accelerated if the
9436 target supports computing the CRC checksum of a block of memory
9437 (@pxref{qCRC packet}).
9441 @section Automatic Display
9442 @cindex automatic display
9443 @cindex display of expressions
9445 If you find that you want to print the value of an expression frequently
9446 (to see how it changes), you might want to add it to the @dfn{automatic
9447 display list} so that @value{GDBN} prints its value each time your program stops.
9448 Each expression added to the list is given a number to identify it;
9449 to remove an expression from the list, you specify that number.
9450 The automatic display looks like this:
9454 3: bar[5] = (struct hack *) 0x3804
9458 This display shows item numbers, expressions and their current values. As with
9459 displays you request manually using @code{x} or @code{print}, you can
9460 specify the output format you prefer; in fact, @code{display} decides
9461 whether to use @code{print} or @code{x} depending your format
9462 specification---it uses @code{x} if you specify either the @samp{i}
9463 or @samp{s} format, or a unit size; otherwise it uses @code{print}.
9467 @item display @var{expr}
9468 Add the expression @var{expr} to the list of expressions to display
9469 each time your program stops. @xref{Expressions, ,Expressions}.
9471 @code{display} does not repeat if you press @key{RET} again after using it.
9473 @item display/@var{fmt} @var{expr}
9474 For @var{fmt} specifying only a display format and not a size or
9475 count, add the expression @var{expr} to the auto-display list but
9476 arrange to display it each time in the specified format @var{fmt}.
9477 @xref{Output Formats,,Output Formats}.
9479 @item display/@var{fmt} @var{addr}
9480 For @var{fmt} @samp{i} or @samp{s}, or including a unit-size or a
9481 number of units, add the expression @var{addr} as a memory address to
9482 be examined each time your program stops. Examining means in effect
9483 doing @samp{x/@var{fmt} @var{addr}}. @xref{Memory, ,Examining Memory}.
9486 For example, @samp{display/i $pc} can be helpful, to see the machine
9487 instruction about to be executed each time execution stops (@samp{$pc}
9488 is a common name for the program counter; @pxref{Registers, ,Registers}).
9491 @kindex delete display
9493 @item undisplay @var{dnums}@dots{}
9494 @itemx delete display @var{dnums}@dots{}
9495 Remove items from the list of expressions to display. Specify the
9496 numbers of the displays that you want affected with the command
9497 argument @var{dnums}. It can be a single display number, one of the
9498 numbers shown in the first field of the @samp{info display} display;
9499 or it could be a range of display numbers, as in @code{2-4}.
9501 @code{undisplay} does not repeat if you press @key{RET} after using it.
9502 (Otherwise you would just get the error @samp{No display number @dots{}}.)
9504 @kindex disable display
9505 @item disable display @var{dnums}@dots{}
9506 Disable the display of item numbers @var{dnums}. A disabled display
9507 item is not printed automatically, but is not forgotten. It may be
9508 enabled again later. Specify the numbers of the displays that you
9509 want affected with the command argument @var{dnums}. It can be a
9510 single display number, one of the numbers shown in the first field of
9511 the @samp{info display} display; or it could be a range of display
9512 numbers, as in @code{2-4}.
9514 @kindex enable display
9515 @item enable display @var{dnums}@dots{}
9516 Enable display of item numbers @var{dnums}. It becomes effective once
9517 again in auto display of its expression, until you specify otherwise.
9518 Specify the numbers of the displays that you want affected with the
9519 command argument @var{dnums}. It can be a single display number, one
9520 of the numbers shown in the first field of the @samp{info display}
9521 display; or it could be a range of display numbers, as in @code{2-4}.
9524 Display the current values of the expressions on the list, just as is
9525 done when your program stops.
9527 @kindex info display
9529 Print the list of expressions previously set up to display
9530 automatically, each one with its item number, but without showing the
9531 values. This includes disabled expressions, which are marked as such.
9532 It also includes expressions which would not be displayed right now
9533 because they refer to automatic variables not currently available.
9536 @cindex display disabled out of scope
9537 If a display expression refers to local variables, then it does not make
9538 sense outside the lexical context for which it was set up. Such an
9539 expression is disabled when execution enters a context where one of its
9540 variables is not defined. For example, if you give the command
9541 @code{display last_char} while inside a function with an argument
9542 @code{last_char}, @value{GDBN} displays this argument while your program
9543 continues to stop inside that function. When it stops elsewhere---where
9544 there is no variable @code{last_char}---the display is disabled
9545 automatically. The next time your program stops where @code{last_char}
9546 is meaningful, you can enable the display expression once again.
9548 @node Print Settings
9549 @section Print Settings
9551 @cindex format options
9552 @cindex print settings
9553 @value{GDBN} provides the following ways to control how arrays, structures,
9554 and symbols are printed.
9557 These settings are useful for debugging programs in any language:
9561 @item set print address
9562 @itemx set print address on
9563 @cindex print/don't print memory addresses
9564 @value{GDBN} prints memory addresses showing the location of stack
9565 traces, structure values, pointer values, breakpoints, and so forth,
9566 even when it also displays the contents of those addresses. The default
9567 is @code{on}. For example, this is what a stack frame display looks like with
9568 @code{set print address on}:
9573 #0 set_quotes (lq=0x34c78 "<<", rq=0x34c88 ">>")
9575 530 if (lquote != def_lquote)
9579 @item set print address off
9580 Do not print addresses when displaying their contents. For example,
9581 this is the same stack frame displayed with @code{set print address off}:
9585 (@value{GDBP}) set print addr off
9587 #0 set_quotes (lq="<<", rq=">>") at input.c:530
9588 530 if (lquote != def_lquote)
9592 You can use @samp{set print address off} to eliminate all machine
9593 dependent displays from the @value{GDBN} interface. For example, with
9594 @code{print address off}, you should get the same text for backtraces on
9595 all machines---whether or not they involve pointer arguments.
9598 @item show print address
9599 Show whether or not addresses are to be printed.
9602 When @value{GDBN} prints a symbolic address, it normally prints the
9603 closest earlier symbol plus an offset. If that symbol does not uniquely
9604 identify the address (for example, it is a name whose scope is a single
9605 source file), you may need to clarify. One way to do this is with
9606 @code{info line}, for example @samp{info line *0x4537}. Alternately,
9607 you can set @value{GDBN} to print the source file and line number when
9608 it prints a symbolic address:
9611 @item set print symbol-filename on
9612 @cindex source file and line of a symbol
9613 @cindex symbol, source file and line
9614 Tell @value{GDBN} to print the source file name and line number of a
9615 symbol in the symbolic form of an address.
9617 @item set print symbol-filename off
9618 Do not print source file name and line number of a symbol. This is the
9621 @item show print symbol-filename
9622 Show whether or not @value{GDBN} will print the source file name and
9623 line number of a symbol in the symbolic form of an address.
9626 Another situation where it is helpful to show symbol filenames and line
9627 numbers is when disassembling code; @value{GDBN} shows you the line
9628 number and source file that corresponds to each instruction.
9630 Also, you may wish to see the symbolic form only if the address being
9631 printed is reasonably close to the closest earlier symbol:
9634 @item set print max-symbolic-offset @var{max-offset}
9635 @itemx set print max-symbolic-offset unlimited
9636 @cindex maximum value for offset of closest symbol
9637 Tell @value{GDBN} to only display the symbolic form of an address if the
9638 offset between the closest earlier symbol and the address is less than
9639 @var{max-offset}. The default is @code{unlimited}, which tells @value{GDBN}
9640 to always print the symbolic form of an address if any symbol precedes
9641 it. Zero is equivalent to @code{unlimited}.
9643 @item show print max-symbolic-offset
9644 Ask how large the maximum offset is that @value{GDBN} prints in a
9648 @cindex wild pointer, interpreting
9649 @cindex pointer, finding referent
9650 If you have a pointer and you are not sure where it points, try
9651 @samp{set print symbol-filename on}. Then you can determine the name
9652 and source file location of the variable where it points, using
9653 @samp{p/a @var{pointer}}. This interprets the address in symbolic form.
9654 For example, here @value{GDBN} shows that a variable @code{ptt} points
9655 at another variable @code{t}, defined in @file{hi2.c}:
9658 (@value{GDBP}) set print symbol-filename on
9659 (@value{GDBP}) p/a ptt
9660 $4 = 0xe008 <t in hi2.c>
9664 @emph{Warning:} For pointers that point to a local variable, @samp{p/a}
9665 does not show the symbol name and filename of the referent, even with
9666 the appropriate @code{set print} options turned on.
9669 You can also enable @samp{/a}-like formatting all the time using
9670 @samp{set print symbol on}:
9673 @item set print symbol on
9674 Tell @value{GDBN} to print the symbol corresponding to an address, if
9677 @item set print symbol off
9678 Tell @value{GDBN} not to print the symbol corresponding to an
9679 address. In this mode, @value{GDBN} will still print the symbol
9680 corresponding to pointers to functions. This is the default.
9682 @item show print symbol
9683 Show whether @value{GDBN} will display the symbol corresponding to an
9687 Other settings control how different kinds of objects are printed:
9690 @item set print array
9691 @itemx set print array on
9692 @cindex pretty print arrays
9693 Pretty print arrays. This format is more convenient to read,
9694 but uses more space. The default is off.
9696 @item set print array off
9697 Return to compressed format for arrays.
9699 @item show print array
9700 Show whether compressed or pretty format is selected for displaying
9703 @cindex print array indexes
9704 @item set print array-indexes
9705 @itemx set print array-indexes on
9706 Print the index of each element when displaying arrays. May be more
9707 convenient to locate a given element in the array or quickly find the
9708 index of a given element in that printed array. The default is off.
9710 @item set print array-indexes off
9711 Stop printing element indexes when displaying arrays.
9713 @item show print array-indexes
9714 Show whether the index of each element is printed when displaying
9717 @item set print elements @var{number-of-elements}
9718 @itemx set print elements unlimited
9719 @cindex number of array elements to print
9720 @cindex limit on number of printed array elements
9721 Set a limit on how many elements of an array @value{GDBN} will print.
9722 If @value{GDBN} is printing a large array, it stops printing after it has
9723 printed the number of elements set by the @code{set print elements} command.
9724 This limit also applies to the display of strings.
9725 When @value{GDBN} starts, this limit is set to 200.
9726 Setting @var{number-of-elements} to @code{unlimited} or zero means
9727 that the number of elements to print is unlimited.
9729 @item show print elements
9730 Display the number of elements of a large array that @value{GDBN} will print.
9731 If the number is 0, then the printing is unlimited.
9733 @item set print frame-arguments @var{value}
9734 @kindex set print frame-arguments
9735 @cindex printing frame argument values
9736 @cindex print all frame argument values
9737 @cindex print frame argument values for scalars only
9738 @cindex do not print frame argument values
9739 This command allows to control how the values of arguments are printed
9740 when the debugger prints a frame (@pxref{Frames}). The possible
9745 The values of all arguments are printed.
9748 Print the value of an argument only if it is a scalar. The value of more
9749 complex arguments such as arrays, structures, unions, etc, is replaced
9750 by @code{@dots{}}. This is the default. Here is an example where
9751 only scalar arguments are shown:
9754 #1 0x08048361 in call_me (i=3, s=@dots{}, ss=0xbf8d508c, u=@dots{}, e=green)
9759 None of the argument values are printed. Instead, the value of each argument
9760 is replaced by @code{@dots{}}. In this case, the example above now becomes:
9763 #1 0x08048361 in call_me (i=@dots{}, s=@dots{}, ss=@dots{}, u=@dots{}, e=@dots{})
9768 By default, only scalar arguments are printed. This command can be used
9769 to configure the debugger to print the value of all arguments, regardless
9770 of their type. However, it is often advantageous to not print the value
9771 of more complex parameters. For instance, it reduces the amount of
9772 information printed in each frame, making the backtrace more readable.
9773 Also, it improves performance when displaying Ada frames, because
9774 the computation of large arguments can sometimes be CPU-intensive,
9775 especially in large applications. Setting @code{print frame-arguments}
9776 to @code{scalars} (the default) or @code{none} avoids this computation,
9777 thus speeding up the display of each Ada frame.
9779 @item show print frame-arguments
9780 Show how the value of arguments should be displayed when printing a frame.
9782 @item set print raw frame-arguments on
9783 Print frame arguments in raw, non pretty-printed, form.
9785 @item set print raw frame-arguments off
9786 Print frame arguments in pretty-printed form, if there is a pretty-printer
9787 for the value (@pxref{Pretty Printing}),
9788 otherwise print the value in raw form.
9789 This is the default.
9791 @item show print raw frame-arguments
9792 Show whether to print frame arguments in raw form.
9794 @anchor{set print entry-values}
9795 @item set print entry-values @var{value}
9796 @kindex set print entry-values
9797 Set printing of frame argument values at function entry. In some cases
9798 @value{GDBN} can determine the value of function argument which was passed by
9799 the function caller, even if the value was modified inside the called function
9800 and therefore is different. With optimized code, the current value could be
9801 unavailable, but the entry value may still be known.
9803 The default value is @code{default} (see below for its description). Older
9804 @value{GDBN} behaved as with the setting @code{no}. Compilers not supporting
9805 this feature will behave in the @code{default} setting the same way as with the
9808 This functionality is currently supported only by DWARF 2 debugging format and
9809 the compiler has to produce @samp{DW_TAG_GNU_call_site} tags. With
9810 @value{NGCC}, you need to specify @option{-O -g} during compilation, to get
9813 The @var{value} parameter can be one of the following:
9817 Print only actual parameter values, never print values from function entry
9821 #0 different (val=6)
9822 #0 lost (val=<optimized out>)
9824 #0 invalid (val=<optimized out>)
9828 Print only parameter values from function entry point. The actual parameter
9829 values are never printed.
9831 #0 equal (val@@entry=5)
9832 #0 different (val@@entry=5)
9833 #0 lost (val@@entry=5)
9834 #0 born (val@@entry=<optimized out>)
9835 #0 invalid (val@@entry=<optimized out>)
9839 Print only parameter values from function entry point. If value from function
9840 entry point is not known while the actual value is known, print the actual
9841 value for such parameter.
9843 #0 equal (val@@entry=5)
9844 #0 different (val@@entry=5)
9845 #0 lost (val@@entry=5)
9847 #0 invalid (val@@entry=<optimized out>)
9851 Print actual parameter values. If actual parameter value is not known while
9852 value from function entry point is known, print the entry point value for such
9856 #0 different (val=6)
9857 #0 lost (val@@entry=5)
9859 #0 invalid (val=<optimized out>)
9863 Always print both the actual parameter value and its value from function entry
9864 point, even if values of one or both are not available due to compiler
9867 #0 equal (val=5, val@@entry=5)
9868 #0 different (val=6, val@@entry=5)
9869 #0 lost (val=<optimized out>, val@@entry=5)
9870 #0 born (val=10, val@@entry=<optimized out>)
9871 #0 invalid (val=<optimized out>, val@@entry=<optimized out>)
9875 Print the actual parameter value if it is known and also its value from
9876 function entry point if it is known. If neither is known, print for the actual
9877 value @code{<optimized out>}. If not in MI mode (@pxref{GDB/MI}) and if both
9878 values are known and identical, print the shortened
9879 @code{param=param@@entry=VALUE} notation.
9881 #0 equal (val=val@@entry=5)
9882 #0 different (val=6, val@@entry=5)
9883 #0 lost (val@@entry=5)
9885 #0 invalid (val=<optimized out>)
9889 Always print the actual parameter value. Print also its value from function
9890 entry point, but only if it is known. If not in MI mode (@pxref{GDB/MI}) and
9891 if both values are known and identical, print the shortened
9892 @code{param=param@@entry=VALUE} notation.
9894 #0 equal (val=val@@entry=5)
9895 #0 different (val=6, val@@entry=5)
9896 #0 lost (val=<optimized out>, val@@entry=5)
9898 #0 invalid (val=<optimized out>)
9902 For analysis messages on possible failures of frame argument values at function
9903 entry resolution see @ref{set debug entry-values}.
9905 @item show print entry-values
9906 Show the method being used for printing of frame argument values at function
9909 @item set print repeats @var{number-of-repeats}
9910 @itemx set print repeats unlimited
9911 @cindex repeated array elements
9912 Set the threshold for suppressing display of repeated array
9913 elements. When the number of consecutive identical elements of an
9914 array exceeds the threshold, @value{GDBN} prints the string
9915 @code{"<repeats @var{n} times>"}, where @var{n} is the number of
9916 identical repetitions, instead of displaying the identical elements
9917 themselves. Setting the threshold to @code{unlimited} or zero will
9918 cause all elements to be individually printed. The default threshold
9921 @item show print repeats
9922 Display the current threshold for printing repeated identical
9925 @item set print null-stop
9926 @cindex @sc{null} elements in arrays
9927 Cause @value{GDBN} to stop printing the characters of an array when the first
9928 @sc{null} is encountered. This is useful when large arrays actually
9929 contain only short strings.
9932 @item show print null-stop
9933 Show whether @value{GDBN} stops printing an array on the first
9934 @sc{null} character.
9936 @item set print pretty on
9937 @cindex print structures in indented form
9938 @cindex indentation in structure display
9939 Cause @value{GDBN} to print structures in an indented format with one member
9940 per line, like this:
9955 @item set print pretty off
9956 Cause @value{GDBN} to print structures in a compact format, like this:
9960 $1 = @{next = 0x0, flags = @{sweet = 1, sour = 1@}, \
9961 meat = 0x54 "Pork"@}
9966 This is the default format.
9968 @item show print pretty
9969 Show which format @value{GDBN} is using to print structures.
9971 @item set print sevenbit-strings on
9972 @cindex eight-bit characters in strings
9973 @cindex octal escapes in strings
9974 Print using only seven-bit characters; if this option is set,
9975 @value{GDBN} displays any eight-bit characters (in strings or
9976 character values) using the notation @code{\}@var{nnn}. This setting is
9977 best if you are working in English (@sc{ascii}) and you use the
9978 high-order bit of characters as a marker or ``meta'' bit.
9980 @item set print sevenbit-strings off
9981 Print full eight-bit characters. This allows the use of more
9982 international character sets, and is the default.
9984 @item show print sevenbit-strings
9985 Show whether or not @value{GDBN} is printing only seven-bit characters.
9987 @item set print union on
9988 @cindex unions in structures, printing
9989 Tell @value{GDBN} to print unions which are contained in structures
9990 and other unions. This is the default setting.
9992 @item set print union off
9993 Tell @value{GDBN} not to print unions which are contained in
9994 structures and other unions. @value{GDBN} will print @code{"@{...@}"}
9997 @item show print union
9998 Ask @value{GDBN} whether or not it will print unions which are contained in
9999 structures and other unions.
10001 For example, given the declarations
10004 typedef enum @{Tree, Bug@} Species;
10005 typedef enum @{Big_tree, Acorn, Seedling@} Tree_forms;
10006 typedef enum @{Caterpillar, Cocoon, Butterfly@}
10017 struct thing foo = @{Tree, @{Acorn@}@};
10021 with @code{set print union on} in effect @samp{p foo} would print
10024 $1 = @{it = Tree, form = @{tree = Acorn, bug = Cocoon@}@}
10028 and with @code{set print union off} in effect it would print
10031 $1 = @{it = Tree, form = @{...@}@}
10035 @code{set print union} affects programs written in C-like languages
10041 These settings are of interest when debugging C@t{++} programs:
10044 @cindex demangling C@t{++} names
10045 @item set print demangle
10046 @itemx set print demangle on
10047 Print C@t{++} names in their source form rather than in the encoded
10048 (``mangled'') form passed to the assembler and linker for type-safe
10049 linkage. The default is on.
10051 @item show print demangle
10052 Show whether C@t{++} names are printed in mangled or demangled form.
10054 @item set print asm-demangle
10055 @itemx set print asm-demangle on
10056 Print C@t{++} names in their source form rather than their mangled form, even
10057 in assembler code printouts such as instruction disassemblies.
10058 The default is off.
10060 @item show print asm-demangle
10061 Show whether C@t{++} names in assembly listings are printed in mangled
10064 @cindex C@t{++} symbol decoding style
10065 @cindex symbol decoding style, C@t{++}
10066 @kindex set demangle-style
10067 @item set demangle-style @var{style}
10068 Choose among several encoding schemes used by different compilers to
10069 represent C@t{++} names. The choices for @var{style} are currently:
10073 Allow @value{GDBN} to choose a decoding style by inspecting your program.
10074 This is the default.
10077 Decode based on the @sc{gnu} C@t{++} compiler (@code{g++}) encoding algorithm.
10080 Decode based on the HP ANSI C@t{++} (@code{aCC}) encoding algorithm.
10083 Decode based on the Lucid C@t{++} compiler (@code{lcc}) encoding algorithm.
10086 Decode using the algorithm in the @cite{C@t{++} Annotated Reference Manual}.
10087 @strong{Warning:} this setting alone is not sufficient to allow
10088 debugging @code{cfront}-generated executables. @value{GDBN} would
10089 require further enhancement to permit that.
10092 If you omit @var{style}, you will see a list of possible formats.
10094 @item show demangle-style
10095 Display the encoding style currently in use for decoding C@t{++} symbols.
10097 @item set print object
10098 @itemx set print object on
10099 @cindex derived type of an object, printing
10100 @cindex display derived types
10101 When displaying a pointer to an object, identify the @emph{actual}
10102 (derived) type of the object rather than the @emph{declared} type, using
10103 the virtual function table. Note that the virtual function table is
10104 required---this feature can only work for objects that have run-time
10105 type identification; a single virtual method in the object's declared
10106 type is sufficient. Note that this setting is also taken into account when
10107 working with variable objects via MI (@pxref{GDB/MI}).
10109 @item set print object off
10110 Display only the declared type of objects, without reference to the
10111 virtual function table. This is the default setting.
10113 @item show print object
10114 Show whether actual, or declared, object types are displayed.
10116 @item set print static-members
10117 @itemx set print static-members on
10118 @cindex static members of C@t{++} objects
10119 Print static members when displaying a C@t{++} object. The default is on.
10121 @item set print static-members off
10122 Do not print static members when displaying a C@t{++} object.
10124 @item show print static-members
10125 Show whether C@t{++} static members are printed or not.
10127 @item set print pascal_static-members
10128 @itemx set print pascal_static-members on
10129 @cindex static members of Pascal objects
10130 @cindex Pascal objects, static members display
10131 Print static members when displaying a Pascal object. The default is on.
10133 @item set print pascal_static-members off
10134 Do not print static members when displaying a Pascal object.
10136 @item show print pascal_static-members
10137 Show whether Pascal static members are printed or not.
10139 @c These don't work with HP ANSI C++ yet.
10140 @item set print vtbl
10141 @itemx set print vtbl on
10142 @cindex pretty print C@t{++} virtual function tables
10143 @cindex virtual functions (C@t{++}) display
10144 @cindex VTBL display
10145 Pretty print C@t{++} virtual function tables. The default is off.
10146 (The @code{vtbl} commands do not work on programs compiled with the HP
10147 ANSI C@t{++} compiler (@code{aCC}).)
10149 @item set print vtbl off
10150 Do not pretty print C@t{++} virtual function tables.
10152 @item show print vtbl
10153 Show whether C@t{++} virtual function tables are pretty printed, or not.
10156 @node Pretty Printing
10157 @section Pretty Printing
10159 @value{GDBN} provides a mechanism to allow pretty-printing of values using
10160 Python code. It greatly simplifies the display of complex objects. This
10161 mechanism works for both MI and the CLI.
10164 * Pretty-Printer Introduction:: Introduction to pretty-printers
10165 * Pretty-Printer Example:: An example pretty-printer
10166 * Pretty-Printer Commands:: Pretty-printer commands
10169 @node Pretty-Printer Introduction
10170 @subsection Pretty-Printer Introduction
10172 When @value{GDBN} prints a value, it first sees if there is a pretty-printer
10173 registered for the value. If there is then @value{GDBN} invokes the
10174 pretty-printer to print the value. Otherwise the value is printed normally.
10176 Pretty-printers are normally named. This makes them easy to manage.
10177 The @samp{info pretty-printer} command will list all the installed
10178 pretty-printers with their names.
10179 If a pretty-printer can handle multiple data types, then its
10180 @dfn{subprinters} are the printers for the individual data types.
10181 Each such subprinter has its own name.
10182 The format of the name is @var{printer-name};@var{subprinter-name}.
10184 Pretty-printers are installed by @dfn{registering} them with @value{GDBN}.
10185 Typically they are automatically loaded and registered when the corresponding
10186 debug information is loaded, thus making them available without having to
10187 do anything special.
10189 There are three places where a pretty-printer can be registered.
10193 Pretty-printers registered globally are available when debugging
10197 Pretty-printers registered with a program space are available only
10198 when debugging that program.
10199 @xref{Progspaces In Python}, for more details on program spaces in Python.
10202 Pretty-printers registered with an objfile are loaded and unloaded
10203 with the corresponding objfile (e.g., shared library).
10204 @xref{Objfiles In Python}, for more details on objfiles in Python.
10207 @xref{Selecting Pretty-Printers}, for further information on how
10208 pretty-printers are selected,
10210 @xref{Writing a Pretty-Printer}, for implementing pretty printers
10213 @node Pretty-Printer Example
10214 @subsection Pretty-Printer Example
10216 Here is how a C@t{++} @code{std::string} looks without a pretty-printer:
10219 (@value{GDBP}) print s
10221 static npos = 4294967295,
10223 <std::allocator<char>> = @{
10224 <__gnu_cxx::new_allocator<char>> = @{
10225 <No data fields>@}, <No data fields>
10227 members of std::basic_string<char, std::char_traits<char>,
10228 std::allocator<char> >::_Alloc_hider:
10229 _M_p = 0x804a014 "abcd"
10234 With a pretty-printer for @code{std::string} only the contents are printed:
10237 (@value{GDBP}) print s
10241 @node Pretty-Printer Commands
10242 @subsection Pretty-Printer Commands
10243 @cindex pretty-printer commands
10246 @kindex info pretty-printer
10247 @item info pretty-printer [@var{object-regexp} [@var{name-regexp}]]
10248 Print the list of installed pretty-printers.
10249 This includes disabled pretty-printers, which are marked as such.
10251 @var{object-regexp} is a regular expression matching the objects
10252 whose pretty-printers to list.
10253 Objects can be @code{global}, the program space's file
10254 (@pxref{Progspaces In Python}),
10255 and the object files within that program space (@pxref{Objfiles In Python}).
10256 @xref{Selecting Pretty-Printers}, for details on how @value{GDBN}
10257 looks up a printer from these three objects.
10259 @var{name-regexp} is a regular expression matching the name of the printers
10262 @kindex disable pretty-printer
10263 @item disable pretty-printer [@var{object-regexp} [@var{name-regexp}]]
10264 Disable pretty-printers matching @var{object-regexp} and @var{name-regexp}.
10265 A disabled pretty-printer is not forgotten, it may be enabled again later.
10267 @kindex enable pretty-printer
10268 @item enable pretty-printer [@var{object-regexp} [@var{name-regexp}]]
10269 Enable pretty-printers matching @var{object-regexp} and @var{name-regexp}.
10274 Suppose we have three pretty-printers installed: one from library1.so
10275 named @code{foo} that prints objects of type @code{foo}, and
10276 another from library2.so named @code{bar} that prints two types of objects,
10277 @code{bar1} and @code{bar2}.
10280 (gdb) info pretty-printer
10287 (gdb) info pretty-printer library2
10292 (gdb) disable pretty-printer library1
10294 2 of 3 printers enabled
10295 (gdb) info pretty-printer
10302 (gdb) disable pretty-printer library2 bar:bar1
10304 1 of 3 printers enabled
10305 (gdb) info pretty-printer library2
10312 (gdb) disable pretty-printer library2 bar
10314 0 of 3 printers enabled
10315 (gdb) info pretty-printer library2
10324 Note that for @code{bar} the entire printer can be disabled,
10325 as can each individual subprinter.
10327 @node Value History
10328 @section Value History
10330 @cindex value history
10331 @cindex history of values printed by @value{GDBN}
10332 Values printed by the @code{print} command are saved in the @value{GDBN}
10333 @dfn{value history}. This allows you to refer to them in other expressions.
10334 Values are kept until the symbol table is re-read or discarded
10335 (for example with the @code{file} or @code{symbol-file} commands).
10336 When the symbol table changes, the value history is discarded,
10337 since the values may contain pointers back to the types defined in the
10342 @cindex history number
10343 The values printed are given @dfn{history numbers} by which you can
10344 refer to them. These are successive integers starting with one.
10345 @code{print} shows you the history number assigned to a value by
10346 printing @samp{$@var{num} = } before the value; here @var{num} is the
10349 To refer to any previous value, use @samp{$} followed by the value's
10350 history number. The way @code{print} labels its output is designed to
10351 remind you of this. Just @code{$} refers to the most recent value in
10352 the history, and @code{$$} refers to the value before that.
10353 @code{$$@var{n}} refers to the @var{n}th value from the end; @code{$$2}
10354 is the value just prior to @code{$$}, @code{$$1} is equivalent to
10355 @code{$$}, and @code{$$0} is equivalent to @code{$}.
10357 For example, suppose you have just printed a pointer to a structure and
10358 want to see the contents of the structure. It suffices to type
10364 If you have a chain of structures where the component @code{next} points
10365 to the next one, you can print the contents of the next one with this:
10372 You can print successive links in the chain by repeating this
10373 command---which you can do by just typing @key{RET}.
10375 Note that the history records values, not expressions. If the value of
10376 @code{x} is 4 and you type these commands:
10384 then the value recorded in the value history by the @code{print} command
10385 remains 4 even though the value of @code{x} has changed.
10388 @kindex show values
10390 Print the last ten values in the value history, with their item numbers.
10391 This is like @samp{p@ $$9} repeated ten times, except that @code{show
10392 values} does not change the history.
10394 @item show values @var{n}
10395 Print ten history values centered on history item number @var{n}.
10397 @item show values +
10398 Print ten history values just after the values last printed. If no more
10399 values are available, @code{show values +} produces no display.
10402 Pressing @key{RET} to repeat @code{show values @var{n}} has exactly the
10403 same effect as @samp{show values +}.
10405 @node Convenience Vars
10406 @section Convenience Variables
10408 @cindex convenience variables
10409 @cindex user-defined variables
10410 @value{GDBN} provides @dfn{convenience variables} that you can use within
10411 @value{GDBN} to hold on to a value and refer to it later. These variables
10412 exist entirely within @value{GDBN}; they are not part of your program, and
10413 setting a convenience variable has no direct effect on further execution
10414 of your program. That is why you can use them freely.
10416 Convenience variables are prefixed with @samp{$}. Any name preceded by
10417 @samp{$} can be used for a convenience variable, unless it is one of
10418 the predefined machine-specific register names (@pxref{Registers, ,Registers}).
10419 (Value history references, in contrast, are @emph{numbers} preceded
10420 by @samp{$}. @xref{Value History, ,Value History}.)
10422 You can save a value in a convenience variable with an assignment
10423 expression, just as you would set a variable in your program.
10427 set $foo = *object_ptr
10431 would save in @code{$foo} the value contained in the object pointed to by
10434 Using a convenience variable for the first time creates it, but its
10435 value is @code{void} until you assign a new value. You can alter the
10436 value with another assignment at any time.
10438 Convenience variables have no fixed types. You can assign a convenience
10439 variable any type of value, including structures and arrays, even if
10440 that variable already has a value of a different type. The convenience
10441 variable, when used as an expression, has the type of its current value.
10444 @kindex show convenience
10445 @cindex show all user variables and functions
10446 @item show convenience
10447 Print a list of convenience variables used so far, and their values,
10448 as well as a list of the convenience functions.
10449 Abbreviated @code{show conv}.
10451 @kindex init-if-undefined
10452 @cindex convenience variables, initializing
10453 @item init-if-undefined $@var{variable} = @var{expression}
10454 Set a convenience variable if it has not already been set. This is useful
10455 for user-defined commands that keep some state. It is similar, in concept,
10456 to using local static variables with initializers in C (except that
10457 convenience variables are global). It can also be used to allow users to
10458 override default values used in a command script.
10460 If the variable is already defined then the expression is not evaluated so
10461 any side-effects do not occur.
10464 One of the ways to use a convenience variable is as a counter to be
10465 incremented or a pointer to be advanced. For example, to print
10466 a field from successive elements of an array of structures:
10470 print bar[$i++]->contents
10474 Repeat that command by typing @key{RET}.
10476 Some convenience variables are created automatically by @value{GDBN} and given
10477 values likely to be useful.
10480 @vindex $_@r{, convenience variable}
10482 The variable @code{$_} is automatically set by the @code{x} command to
10483 the last address examined (@pxref{Memory, ,Examining Memory}). Other
10484 commands which provide a default address for @code{x} to examine also
10485 set @code{$_} to that address; these commands include @code{info line}
10486 and @code{info breakpoint}. The type of @code{$_} is @code{void *}
10487 except when set by the @code{x} command, in which case it is a pointer
10488 to the type of @code{$__}.
10490 @vindex $__@r{, convenience variable}
10492 The variable @code{$__} is automatically set by the @code{x} command
10493 to the value found in the last address examined. Its type is chosen
10494 to match the format in which the data was printed.
10497 @vindex $_exitcode@r{, convenience variable}
10498 When the program being debugged terminates normally, @value{GDBN}
10499 automatically sets this variable to the exit code of the program, and
10500 resets @code{$_exitsignal} to @code{void}.
10503 @vindex $_exitsignal@r{, convenience variable}
10504 When the program being debugged dies due to an uncaught signal,
10505 @value{GDBN} automatically sets this variable to that signal's number,
10506 and resets @code{$_exitcode} to @code{void}.
10508 To distinguish between whether the program being debugged has exited
10509 (i.e., @code{$_exitcode} is not @code{void}) or signalled (i.e.,
10510 @code{$_exitsignal} is not @code{void}), the convenience function
10511 @code{$_isvoid} can be used (@pxref{Convenience Funs,, Convenience
10512 Functions}). For example, considering the following source code:
10515 #include <signal.h>
10518 main (int argc, char *argv[])
10525 A valid way of telling whether the program being debugged has exited
10526 or signalled would be:
10529 (@value{GDBP}) define has_exited_or_signalled
10530 Type commands for definition of ``has_exited_or_signalled''.
10531 End with a line saying just ``end''.
10532 >if $_isvoid ($_exitsignal)
10533 >echo The program has exited\n
10535 >echo The program has signalled\n
10541 Program terminated with signal SIGALRM, Alarm clock.
10542 The program no longer exists.
10543 (@value{GDBP}) has_exited_or_signalled
10544 The program has signalled
10547 As can be seen, @value{GDBN} correctly informs that the program being
10548 debugged has signalled, since it calls @code{raise} and raises a
10549 @code{SIGALRM} signal. If the program being debugged had not called
10550 @code{raise}, then @value{GDBN} would report a normal exit:
10553 (@value{GDBP}) has_exited_or_signalled
10554 The program has exited
10558 The variable @code{$_exception} is set to the exception object being
10559 thrown at an exception-related catchpoint. @xref{Set Catchpoints}.
10562 @itemx $_probe_arg0@dots{}$_probe_arg11
10563 Arguments to a static probe. @xref{Static Probe Points}.
10566 @vindex $_sdata@r{, inspect, convenience variable}
10567 The variable @code{$_sdata} contains extra collected static tracepoint
10568 data. @xref{Tracepoint Actions,,Tracepoint Action Lists}. Note that
10569 @code{$_sdata} could be empty, if not inspecting a trace buffer, or
10570 if extra static tracepoint data has not been collected.
10573 @vindex $_siginfo@r{, convenience variable}
10574 The variable @code{$_siginfo} contains extra signal information
10575 (@pxref{extra signal information}). Note that @code{$_siginfo}
10576 could be empty, if the application has not yet received any signals.
10577 For example, it will be empty before you execute the @code{run} command.
10580 @vindex $_tlb@r{, convenience variable}
10581 The variable @code{$_tlb} is automatically set when debugging
10582 applications running on MS-Windows in native mode or connected to
10583 gdbserver that supports the @code{qGetTIBAddr} request.
10584 @xref{General Query Packets}.
10585 This variable contains the address of the thread information block.
10588 The number of the current inferior. @xref{Inferiors and
10589 Programs, ,Debugging Multiple Inferiors and Programs}.
10592 The thread number of the current thread. @xref{thread numbers}.
10595 The global number of the current thread. @xref{global thread numbers}.
10599 @node Convenience Funs
10600 @section Convenience Functions
10602 @cindex convenience functions
10603 @value{GDBN} also supplies some @dfn{convenience functions}. These
10604 have a syntax similar to convenience variables. A convenience
10605 function can be used in an expression just like an ordinary function;
10606 however, a convenience function is implemented internally to
10609 These functions do not require @value{GDBN} to be configured with
10610 @code{Python} support, which means that they are always available.
10614 @item $_isvoid (@var{expr})
10615 @findex $_isvoid@r{, convenience function}
10616 Return one if the expression @var{expr} is @code{void}. Otherwise it
10619 A @code{void} expression is an expression where the type of the result
10620 is @code{void}. For example, you can examine a convenience variable
10621 (see @ref{Convenience Vars,, Convenience Variables}) to check whether
10625 (@value{GDBP}) print $_exitcode
10627 (@value{GDBP}) print $_isvoid ($_exitcode)
10630 Starting program: ./a.out
10631 [Inferior 1 (process 29572) exited normally]
10632 (@value{GDBP}) print $_exitcode
10634 (@value{GDBP}) print $_isvoid ($_exitcode)
10638 In the example above, we used @code{$_isvoid} to check whether
10639 @code{$_exitcode} is @code{void} before and after the execution of the
10640 program being debugged. Before the execution there is no exit code to
10641 be examined, therefore @code{$_exitcode} is @code{void}. After the
10642 execution the program being debugged returned zero, therefore
10643 @code{$_exitcode} is zero, which means that it is not @code{void}
10646 The @code{void} expression can also be a call of a function from the
10647 program being debugged. For example, given the following function:
10656 The result of calling it inside @value{GDBN} is @code{void}:
10659 (@value{GDBP}) print foo ()
10661 (@value{GDBP}) print $_isvoid (foo ())
10663 (@value{GDBP}) set $v = foo ()
10664 (@value{GDBP}) print $v
10666 (@value{GDBP}) print $_isvoid ($v)
10672 These functions require @value{GDBN} to be configured with
10673 @code{Python} support.
10677 @item $_memeq(@var{buf1}, @var{buf2}, @var{length})
10678 @findex $_memeq@r{, convenience function}
10679 Returns one if the @var{length} bytes at the addresses given by
10680 @var{buf1} and @var{buf2} are equal.
10681 Otherwise it returns zero.
10683 @item $_regex(@var{str}, @var{regex})
10684 @findex $_regex@r{, convenience function}
10685 Returns one if the string @var{str} matches the regular expression
10686 @var{regex}. Otherwise it returns zero.
10687 The syntax of the regular expression is that specified by @code{Python}'s
10688 regular expression support.
10690 @item $_streq(@var{str1}, @var{str2})
10691 @findex $_streq@r{, convenience function}
10692 Returns one if the strings @var{str1} and @var{str2} are equal.
10693 Otherwise it returns zero.
10695 @item $_strlen(@var{str})
10696 @findex $_strlen@r{, convenience function}
10697 Returns the length of string @var{str}.
10699 @item $_caller_is(@var{name}@r{[}, @var{number_of_frames}@r{]})
10700 @findex $_caller_is@r{, convenience function}
10701 Returns one if the calling function's name is equal to @var{name}.
10702 Otherwise it returns zero.
10704 If the optional argument @var{number_of_frames} is provided,
10705 it is the number of frames up in the stack to look.
10713 at testsuite/gdb.python/py-caller-is.c:21
10714 #1 0x00000000004005a0 in middle_func ()
10715 at testsuite/gdb.python/py-caller-is.c:27
10716 #2 0x00000000004005ab in top_func ()
10717 at testsuite/gdb.python/py-caller-is.c:33
10718 #3 0x00000000004005b6 in main ()
10719 at testsuite/gdb.python/py-caller-is.c:39
10720 (gdb) print $_caller_is ("middle_func")
10722 (gdb) print $_caller_is ("top_func", 2)
10726 @item $_caller_matches(@var{regexp}@r{[}, @var{number_of_frames}@r{]})
10727 @findex $_caller_matches@r{, convenience function}
10728 Returns one if the calling function's name matches the regular expression
10729 @var{regexp}. Otherwise it returns zero.
10731 If the optional argument @var{number_of_frames} is provided,
10732 it is the number of frames up in the stack to look.
10735 @item $_any_caller_is(@var{name}@r{[}, @var{number_of_frames}@r{]})
10736 @findex $_any_caller_is@r{, convenience function}
10737 Returns one if any calling function's name is equal to @var{name}.
10738 Otherwise it returns zero.
10740 If the optional argument @var{number_of_frames} is provided,
10741 it is the number of frames up in the stack to look.
10744 This function differs from @code{$_caller_is} in that this function
10745 checks all stack frames from the immediate caller to the frame specified
10746 by @var{number_of_frames}, whereas @code{$_caller_is} only checks the
10747 frame specified by @var{number_of_frames}.
10749 @item $_any_caller_matches(@var{regexp}@r{[}, @var{number_of_frames}@r{]})
10750 @findex $_any_caller_matches@r{, convenience function}
10751 Returns one if any calling function's name matches the regular expression
10752 @var{regexp}. Otherwise it returns zero.
10754 If the optional argument @var{number_of_frames} is provided,
10755 it is the number of frames up in the stack to look.
10758 This function differs from @code{$_caller_matches} in that this function
10759 checks all stack frames from the immediate caller to the frame specified
10760 by @var{number_of_frames}, whereas @code{$_caller_matches} only checks the
10761 frame specified by @var{number_of_frames}.
10763 @item $_as_string(@var{value})
10764 @findex $_as_string@r{, convenience function}
10765 Return the string representation of @var{value}.
10767 This function is useful to obtain the textual label (enumerator) of an
10768 enumeration value. For example, assuming the variable @var{node} is of
10769 an enumerated type:
10772 (gdb) printf "Visiting node of type %s\n", $_as_string(node)
10773 Visiting node of type NODE_INTEGER
10778 @value{GDBN} provides the ability to list and get help on
10779 convenience functions.
10782 @item help function
10783 @kindex help function
10784 @cindex show all convenience functions
10785 Print a list of all convenience functions.
10792 You can refer to machine register contents, in expressions, as variables
10793 with names starting with @samp{$}. The names of registers are different
10794 for each machine; use @code{info registers} to see the names used on
10798 @kindex info registers
10799 @item info registers
10800 Print the names and values of all registers except floating-point
10801 and vector registers (in the selected stack frame).
10803 @kindex info all-registers
10804 @cindex floating point registers
10805 @item info all-registers
10806 Print the names and values of all registers, including floating-point
10807 and vector registers (in the selected stack frame).
10809 @item info registers @var{regname} @dots{}
10810 Print the @dfn{relativized} value of each specified register @var{regname}.
10811 As discussed in detail below, register values are normally relative to
10812 the selected stack frame. The @var{regname} may be any register name valid on
10813 the machine you are using, with or without the initial @samp{$}.
10816 @anchor{standard registers}
10817 @cindex stack pointer register
10818 @cindex program counter register
10819 @cindex process status register
10820 @cindex frame pointer register
10821 @cindex standard registers
10822 @value{GDBN} has four ``standard'' register names that are available (in
10823 expressions) on most machines---whenever they do not conflict with an
10824 architecture's canonical mnemonics for registers. The register names
10825 @code{$pc} and @code{$sp} are used for the program counter register and
10826 the stack pointer. @code{$fp} is used for a register that contains a
10827 pointer to the current stack frame, and @code{$ps} is used for a
10828 register that contains the processor status. For example,
10829 you could print the program counter in hex with
10836 or print the instruction to be executed next with
10843 or add four to the stack pointer@footnote{This is a way of removing
10844 one word from the stack, on machines where stacks grow downward in
10845 memory (most machines, nowadays). This assumes that the innermost
10846 stack frame is selected; setting @code{$sp} is not allowed when other
10847 stack frames are selected. To pop entire frames off the stack,
10848 regardless of machine architecture, use @code{return};
10849 see @ref{Returning, ,Returning from a Function}.} with
10855 Whenever possible, these four standard register names are available on
10856 your machine even though the machine has different canonical mnemonics,
10857 so long as there is no conflict. The @code{info registers} command
10858 shows the canonical names. For example, on the SPARC, @code{info
10859 registers} displays the processor status register as @code{$psr} but you
10860 can also refer to it as @code{$ps}; and on x86-based machines @code{$ps}
10861 is an alias for the @sc{eflags} register.
10863 @value{GDBN} always considers the contents of an ordinary register as an
10864 integer when the register is examined in this way. Some machines have
10865 special registers which can hold nothing but floating point; these
10866 registers are considered to have floating point values. There is no way
10867 to refer to the contents of an ordinary register as floating point value
10868 (although you can @emph{print} it as a floating point value with
10869 @samp{print/f $@var{regname}}).
10871 Some registers have distinct ``raw'' and ``virtual'' data formats. This
10872 means that the data format in which the register contents are saved by
10873 the operating system is not the same one that your program normally
10874 sees. For example, the registers of the 68881 floating point
10875 coprocessor are always saved in ``extended'' (raw) format, but all C
10876 programs expect to work with ``double'' (virtual) format. In such
10877 cases, @value{GDBN} normally works with the virtual format only (the format
10878 that makes sense for your program), but the @code{info registers} command
10879 prints the data in both formats.
10881 @cindex SSE registers (x86)
10882 @cindex MMX registers (x86)
10883 Some machines have special registers whose contents can be interpreted
10884 in several different ways. For example, modern x86-based machines
10885 have SSE and MMX registers that can hold several values packed
10886 together in several different formats. @value{GDBN} refers to such
10887 registers in @code{struct} notation:
10890 (@value{GDBP}) print $xmm1
10892 v4_float = @{0, 3.43859137e-038, 1.54142831e-044, 1.821688e-044@},
10893 v2_double = @{9.92129282474342e-303, 2.7585945287983262e-313@},
10894 v16_int8 = "\000\000\000\000\3706;\001\v\000\000\000\r\000\000",
10895 v8_int16 = @{0, 0, 14072, 315, 11, 0, 13, 0@},
10896 v4_int32 = @{0, 20657912, 11, 13@},
10897 v2_int64 = @{88725056443645952, 55834574859@},
10898 uint128 = 0x0000000d0000000b013b36f800000000
10903 To set values of such registers, you need to tell @value{GDBN} which
10904 view of the register you wish to change, as if you were assigning
10905 value to a @code{struct} member:
10908 (@value{GDBP}) set $xmm1.uint128 = 0x000000000000000000000000FFFFFFFF
10911 Normally, register values are relative to the selected stack frame
10912 (@pxref{Selection, ,Selecting a Frame}). This means that you get the
10913 value that the register would contain if all stack frames farther in
10914 were exited and their saved registers restored. In order to see the
10915 true contents of hardware registers, you must select the innermost
10916 frame (with @samp{frame 0}).
10918 @cindex caller-saved registers
10919 @cindex call-clobbered registers
10920 @cindex volatile registers
10921 @cindex <not saved> values
10922 Usually ABIs reserve some registers as not needed to be saved by the
10923 callee (a.k.a.: ``caller-saved'', ``call-clobbered'' or ``volatile''
10924 registers). It may therefore not be possible for @value{GDBN} to know
10925 the value a register had before the call (in other words, in the outer
10926 frame), if the register value has since been changed by the callee.
10927 @value{GDBN} tries to deduce where the inner frame saved
10928 (``callee-saved'') registers, from the debug info, unwind info, or the
10929 machine code generated by your compiler. If some register is not
10930 saved, and @value{GDBN} knows the register is ``caller-saved'' (via
10931 its own knowledge of the ABI, or because the debug/unwind info
10932 explicitly says the register's value is undefined), @value{GDBN}
10933 displays @w{@samp{<not saved>}} as the register's value. With targets
10934 that @value{GDBN} has no knowledge of the register saving convention,
10935 if a register was not saved by the callee, then its value and location
10936 in the outer frame are assumed to be the same of the inner frame.
10937 This is usually harmless, because if the register is call-clobbered,
10938 the caller either does not care what is in the register after the
10939 call, or has code to restore the value that it does care about. Note,
10940 however, that if you change such a register in the outer frame, you
10941 may also be affecting the inner frame. Also, the more ``outer'' the
10942 frame is you're looking at, the more likely a call-clobbered
10943 register's value is to be wrong, in the sense that it doesn't actually
10944 represent the value the register had just before the call.
10946 @node Floating Point Hardware
10947 @section Floating Point Hardware
10948 @cindex floating point
10950 Depending on the configuration, @value{GDBN} may be able to give
10951 you more information about the status of the floating point hardware.
10956 Display hardware-dependent information about the floating
10957 point unit. The exact contents and layout vary depending on the
10958 floating point chip. Currently, @samp{info float} is supported on
10959 the ARM and x86 machines.
10963 @section Vector Unit
10964 @cindex vector unit
10966 Depending on the configuration, @value{GDBN} may be able to give you
10967 more information about the status of the vector unit.
10970 @kindex info vector
10972 Display information about the vector unit. The exact contents and
10973 layout vary depending on the hardware.
10976 @node OS Information
10977 @section Operating System Auxiliary Information
10978 @cindex OS information
10980 @value{GDBN} provides interfaces to useful OS facilities that can help
10981 you debug your program.
10983 @cindex auxiliary vector
10984 @cindex vector, auxiliary
10985 Some operating systems supply an @dfn{auxiliary vector} to programs at
10986 startup. This is akin to the arguments and environment that you
10987 specify for a program, but contains a system-dependent variety of
10988 binary values that tell system libraries important details about the
10989 hardware, operating system, and process. Each value's purpose is
10990 identified by an integer tag; the meanings are well-known but system-specific.
10991 Depending on the configuration and operating system facilities,
10992 @value{GDBN} may be able to show you this information. For remote
10993 targets, this functionality may further depend on the remote stub's
10994 support of the @samp{qXfer:auxv:read} packet, see
10995 @ref{qXfer auxiliary vector read}.
11000 Display the auxiliary vector of the inferior, which can be either a
11001 live process or a core dump file. @value{GDBN} prints each tag value
11002 numerically, and also shows names and text descriptions for recognized
11003 tags. Some values in the vector are numbers, some bit masks, and some
11004 pointers to strings or other data. @value{GDBN} displays each value in the
11005 most appropriate form for a recognized tag, and in hexadecimal for
11006 an unrecognized tag.
11009 On some targets, @value{GDBN} can access operating system-specific
11010 information and show it to you. The types of information available
11011 will differ depending on the type of operating system running on the
11012 target. The mechanism used to fetch the data is described in
11013 @ref{Operating System Information}. For remote targets, this
11014 functionality depends on the remote stub's support of the
11015 @samp{qXfer:osdata:read} packet, see @ref{qXfer osdata read}.
11019 @item info os @var{infotype}
11021 Display OS information of the requested type.
11023 On @sc{gnu}/Linux, the following values of @var{infotype} are valid:
11025 @anchor{linux info os infotypes}
11027 @kindex info os cpus
11029 Display the list of all CPUs/cores. For each CPU/core, @value{GDBN} prints
11030 the available fields from /proc/cpuinfo. For each supported architecture
11031 different fields are available. Two common entries are processor which gives
11032 CPU number and bogomips; a system constant that is calculated during
11033 kernel initialization.
11035 @kindex info os files
11037 Display the list of open file descriptors on the target. For each
11038 file descriptor, @value{GDBN} prints the identifier of the process
11039 owning the descriptor, the command of the owning process, the value
11040 of the descriptor, and the target of the descriptor.
11042 @kindex info os modules
11044 Display the list of all loaded kernel modules on the target. For each
11045 module, @value{GDBN} prints the module name, the size of the module in
11046 bytes, the number of times the module is used, the dependencies of the
11047 module, the status of the module, and the address of the loaded module
11050 @kindex info os msg
11052 Display the list of all System V message queues on the target. For each
11053 message queue, @value{GDBN} prints the message queue key, the message
11054 queue identifier, the access permissions, the current number of bytes
11055 on the queue, the current number of messages on the queue, the processes
11056 that last sent and received a message on the queue, the user and group
11057 of the owner and creator of the message queue, the times at which a
11058 message was last sent and received on the queue, and the time at which
11059 the message queue was last changed.
11061 @kindex info os processes
11063 Display the list of processes on the target. For each process,
11064 @value{GDBN} prints the process identifier, the name of the user, the
11065 command corresponding to the process, and the list of processor cores
11066 that the process is currently running on. (To understand what these
11067 properties mean, for this and the following info types, please consult
11068 the general @sc{gnu}/Linux documentation.)
11070 @kindex info os procgroups
11072 Display the list of process groups on the target. For each process,
11073 @value{GDBN} prints the identifier of the process group that it belongs
11074 to, the command corresponding to the process group leader, the process
11075 identifier, and the command line of the process. The list is sorted
11076 first by the process group identifier, then by the process identifier,
11077 so that processes belonging to the same process group are grouped together
11078 and the process group leader is listed first.
11080 @kindex info os semaphores
11082 Display the list of all System V semaphore sets on the target. For each
11083 semaphore set, @value{GDBN} prints the semaphore set key, the semaphore
11084 set identifier, the access permissions, the number of semaphores in the
11085 set, the user and group of the owner and creator of the semaphore set,
11086 and the times at which the semaphore set was operated upon and changed.
11088 @kindex info os shm
11090 Display the list of all System V shared-memory regions on the target.
11091 For each shared-memory region, @value{GDBN} prints the region key,
11092 the shared-memory identifier, the access permissions, the size of the
11093 region, the process that created the region, the process that last
11094 attached to or detached from the region, the current number of live
11095 attaches to the region, and the times at which the region was last
11096 attached to, detach from, and changed.
11098 @kindex info os sockets
11100 Display the list of Internet-domain sockets on the target. For each
11101 socket, @value{GDBN} prints the address and port of the local and
11102 remote endpoints, the current state of the connection, the creator of
11103 the socket, the IP address family of the socket, and the type of the
11106 @kindex info os threads
11108 Display the list of threads running on the target. For each thread,
11109 @value{GDBN} prints the identifier of the process that the thread
11110 belongs to, the command of the process, the thread identifier, and the
11111 processor core that it is currently running on. The main thread of a
11112 process is not listed.
11116 If @var{infotype} is omitted, then list the possible values for
11117 @var{infotype} and the kind of OS information available for each
11118 @var{infotype}. If the target does not return a list of possible
11119 types, this command will report an error.
11122 @node Memory Region Attributes
11123 @section Memory Region Attributes
11124 @cindex memory region attributes
11126 @dfn{Memory region attributes} allow you to describe special handling
11127 required by regions of your target's memory. @value{GDBN} uses
11128 attributes to determine whether to allow certain types of memory
11129 accesses; whether to use specific width accesses; and whether to cache
11130 target memory. By default the description of memory regions is
11131 fetched from the target (if the current target supports this), but the
11132 user can override the fetched regions.
11134 Defined memory regions can be individually enabled and disabled. When a
11135 memory region is disabled, @value{GDBN} uses the default attributes when
11136 accessing memory in that region. Similarly, if no memory regions have
11137 been defined, @value{GDBN} uses the default attributes when accessing
11140 When a memory region is defined, it is given a number to identify it;
11141 to enable, disable, or remove a memory region, you specify that number.
11145 @item mem @var{lower} @var{upper} @var{attributes}@dots{}
11146 Define a memory region bounded by @var{lower} and @var{upper} with
11147 attributes @var{attributes}@dots{}, and add it to the list of regions
11148 monitored by @value{GDBN}. Note that @var{upper} == 0 is a special
11149 case: it is treated as the target's maximum memory address.
11150 (0xffff on 16 bit targets, 0xffffffff on 32 bit targets, etc.)
11153 Discard any user changes to the memory regions and use target-supplied
11154 regions, if available, or no regions if the target does not support.
11157 @item delete mem @var{nums}@dots{}
11158 Remove memory regions @var{nums}@dots{} from the list of regions
11159 monitored by @value{GDBN}.
11161 @kindex disable mem
11162 @item disable mem @var{nums}@dots{}
11163 Disable monitoring of memory regions @var{nums}@dots{}.
11164 A disabled memory region is not forgotten.
11165 It may be enabled again later.
11168 @item enable mem @var{nums}@dots{}
11169 Enable monitoring of memory regions @var{nums}@dots{}.
11173 Print a table of all defined memory regions, with the following columns
11177 @item Memory Region Number
11178 @item Enabled or Disabled.
11179 Enabled memory regions are marked with @samp{y}.
11180 Disabled memory regions are marked with @samp{n}.
11183 The address defining the inclusive lower bound of the memory region.
11186 The address defining the exclusive upper bound of the memory region.
11189 The list of attributes set for this memory region.
11194 @subsection Attributes
11196 @subsubsection Memory Access Mode
11197 The access mode attributes set whether @value{GDBN} may make read or
11198 write accesses to a memory region.
11200 While these attributes prevent @value{GDBN} from performing invalid
11201 memory accesses, they do nothing to prevent the target system, I/O DMA,
11202 etc.@: from accessing memory.
11206 Memory is read only.
11208 Memory is write only.
11210 Memory is read/write. This is the default.
11213 @subsubsection Memory Access Size
11214 The access size attribute tells @value{GDBN} to use specific sized
11215 accesses in the memory region. Often memory mapped device registers
11216 require specific sized accesses. If no access size attribute is
11217 specified, @value{GDBN} may use accesses of any size.
11221 Use 8 bit memory accesses.
11223 Use 16 bit memory accesses.
11225 Use 32 bit memory accesses.
11227 Use 64 bit memory accesses.
11230 @c @subsubsection Hardware/Software Breakpoints
11231 @c The hardware/software breakpoint attributes set whether @value{GDBN}
11232 @c will use hardware or software breakpoints for the internal breakpoints
11233 @c used by the step, next, finish, until, etc. commands.
11237 @c Always use hardware breakpoints
11238 @c @item swbreak (default)
11241 @subsubsection Data Cache
11242 The data cache attributes set whether @value{GDBN} will cache target
11243 memory. While this generally improves performance by reducing debug
11244 protocol overhead, it can lead to incorrect results because @value{GDBN}
11245 does not know about volatile variables or memory mapped device
11250 Enable @value{GDBN} to cache target memory.
11252 Disable @value{GDBN} from caching target memory. This is the default.
11255 @subsection Memory Access Checking
11256 @value{GDBN} can be instructed to refuse accesses to memory that is
11257 not explicitly described. This can be useful if accessing such
11258 regions has undesired effects for a specific target, or to provide
11259 better error checking. The following commands control this behaviour.
11262 @kindex set mem inaccessible-by-default
11263 @item set mem inaccessible-by-default [on|off]
11264 If @code{on} is specified, make @value{GDBN} treat memory not
11265 explicitly described by the memory ranges as non-existent and refuse accesses
11266 to such memory. The checks are only performed if there's at least one
11267 memory range defined. If @code{off} is specified, make @value{GDBN}
11268 treat the memory not explicitly described by the memory ranges as RAM.
11269 The default value is @code{on}.
11270 @kindex show mem inaccessible-by-default
11271 @item show mem inaccessible-by-default
11272 Show the current handling of accesses to unknown memory.
11276 @c @subsubsection Memory Write Verification
11277 @c The memory write verification attributes set whether @value{GDBN}
11278 @c will re-reads data after each write to verify the write was successful.
11282 @c @item noverify (default)
11285 @node Dump/Restore Files
11286 @section Copy Between Memory and a File
11287 @cindex dump/restore files
11288 @cindex append data to a file
11289 @cindex dump data to a file
11290 @cindex restore data from a file
11292 You can use the commands @code{dump}, @code{append}, and
11293 @code{restore} to copy data between target memory and a file. The
11294 @code{dump} and @code{append} commands write data to a file, and the
11295 @code{restore} command reads data from a file back into the inferior's
11296 memory. Files may be in binary, Motorola S-record, Intel hex,
11297 Tektronix Hex, or Verilog Hex format; however, @value{GDBN} can only
11298 append to binary files, and cannot read from Verilog Hex files.
11303 @item dump @r{[}@var{format}@r{]} memory @var{filename} @var{start_addr} @var{end_addr}
11304 @itemx dump @r{[}@var{format}@r{]} value @var{filename} @var{expr}
11305 Dump the contents of memory from @var{start_addr} to @var{end_addr},
11306 or the value of @var{expr}, to @var{filename} in the given format.
11308 The @var{format} parameter may be any one of:
11315 Motorola S-record format.
11317 Tektronix Hex format.
11319 Verilog Hex format.
11322 @value{GDBN} uses the same definitions of these formats as the
11323 @sc{gnu} binary utilities, like @samp{objdump} and @samp{objcopy}. If
11324 @var{format} is omitted, @value{GDBN} dumps the data in raw binary
11328 @item append @r{[}binary@r{]} memory @var{filename} @var{start_addr} @var{end_addr}
11329 @itemx append @r{[}binary@r{]} value @var{filename} @var{expr}
11330 Append the contents of memory from @var{start_addr} to @var{end_addr},
11331 or the value of @var{expr}, to the file @var{filename}, in raw binary form.
11332 (@value{GDBN} can only append data to files in raw binary form.)
11335 @item restore @var{filename} @r{[}binary@r{]} @var{bias} @var{start} @var{end}
11336 Restore the contents of file @var{filename} into memory. The
11337 @code{restore} command can automatically recognize any known @sc{bfd}
11338 file format, except for raw binary. To restore a raw binary file you
11339 must specify the optional keyword @code{binary} after the filename.
11341 If @var{bias} is non-zero, its value will be added to the addresses
11342 contained in the file. Binary files always start at address zero, so
11343 they will be restored at address @var{bias}. Other bfd files have
11344 a built-in location; they will be restored at offset @var{bias}
11345 from that location.
11347 If @var{start} and/or @var{end} are non-zero, then only data between
11348 file offset @var{start} and file offset @var{end} will be restored.
11349 These offsets are relative to the addresses in the file, before
11350 the @var{bias} argument is applied.
11354 @node Core File Generation
11355 @section How to Produce a Core File from Your Program
11356 @cindex dump core from inferior
11358 A @dfn{core file} or @dfn{core dump} is a file that records the memory
11359 image of a running process and its process status (register values
11360 etc.). Its primary use is post-mortem debugging of a program that
11361 crashed while it ran outside a debugger. A program that crashes
11362 automatically produces a core file, unless this feature is disabled by
11363 the user. @xref{Files}, for information on invoking @value{GDBN} in
11364 the post-mortem debugging mode.
11366 Occasionally, you may wish to produce a core file of the program you
11367 are debugging in order to preserve a snapshot of its state.
11368 @value{GDBN} has a special command for that.
11372 @kindex generate-core-file
11373 @item generate-core-file [@var{file}]
11374 @itemx gcore [@var{file}]
11375 Produce a core dump of the inferior process. The optional argument
11376 @var{file} specifies the file name where to put the core dump. If not
11377 specified, the file name defaults to @file{core.@var{pid}}, where
11378 @var{pid} is the inferior process ID.
11380 Note that this command is implemented only for some systems (as of
11381 this writing, @sc{gnu}/Linux, FreeBSD, Solaris, and S390).
11383 On @sc{gnu}/Linux, this command can take into account the value of the
11384 file @file{/proc/@var{pid}/coredump_filter} when generating the core
11385 dump (@pxref{set use-coredump-filter}).
11387 @kindex set use-coredump-filter
11388 @anchor{set use-coredump-filter}
11389 @item set use-coredump-filter on
11390 @itemx set use-coredump-filter off
11391 Enable or disable the use of the file
11392 @file{/proc/@var{pid}/coredump_filter} when generating core dump
11393 files. This file is used by the Linux kernel to decide what types of
11394 memory mappings will be dumped or ignored when generating a core dump
11395 file. @var{pid} is the process ID of a currently running process.
11397 To make use of this feature, you have to write in the
11398 @file{/proc/@var{pid}/coredump_filter} file a value, in hexadecimal,
11399 which is a bit mask representing the memory mapping types. If a bit
11400 is set in the bit mask, then the memory mappings of the corresponding
11401 types will be dumped; otherwise, they will be ignored. This
11402 configuration is inherited by child processes. For more information
11403 about the bits that can be set in the
11404 @file{/proc/@var{pid}/coredump_filter} file, please refer to the
11405 manpage of @code{core(5)}.
11407 By default, this option is @code{on}. If this option is turned
11408 @code{off}, @value{GDBN} does not read the @file{coredump_filter} file
11409 and instead uses the same default value as the Linux kernel in order
11410 to decide which pages will be dumped in the core dump file. This
11411 value is currently @code{0x33}, which means that bits @code{0}
11412 (anonymous private mappings), @code{1} (anonymous shared mappings),
11413 @code{4} (ELF headers) and @code{5} (private huge pages) are active.
11414 This will cause these memory mappings to be dumped automatically.
11417 @node Character Sets
11418 @section Character Sets
11419 @cindex character sets
11421 @cindex translating between character sets
11422 @cindex host character set
11423 @cindex target character set
11425 If the program you are debugging uses a different character set to
11426 represent characters and strings than the one @value{GDBN} uses itself,
11427 @value{GDBN} can automatically translate between the character sets for
11428 you. The character set @value{GDBN} uses we call the @dfn{host
11429 character set}; the one the inferior program uses we call the
11430 @dfn{target character set}.
11432 For example, if you are running @value{GDBN} on a @sc{gnu}/Linux system, which
11433 uses the ISO Latin 1 character set, but you are using @value{GDBN}'s
11434 remote protocol (@pxref{Remote Debugging}) to debug a program
11435 running on an IBM mainframe, which uses the @sc{ebcdic} character set,
11436 then the host character set is Latin-1, and the target character set is
11437 @sc{ebcdic}. If you give @value{GDBN} the command @code{set
11438 target-charset EBCDIC-US}, then @value{GDBN} translates between
11439 @sc{ebcdic} and Latin 1 as you print character or string values, or use
11440 character and string literals in expressions.
11442 @value{GDBN} has no way to automatically recognize which character set
11443 the inferior program uses; you must tell it, using the @code{set
11444 target-charset} command, described below.
11446 Here are the commands for controlling @value{GDBN}'s character set
11450 @item set target-charset @var{charset}
11451 @kindex set target-charset
11452 Set the current target character set to @var{charset}. To display the
11453 list of supported target character sets, type
11454 @kbd{@w{set target-charset @key{TAB}@key{TAB}}}.
11456 @item set host-charset @var{charset}
11457 @kindex set host-charset
11458 Set the current host character set to @var{charset}.
11460 By default, @value{GDBN} uses a host character set appropriate to the
11461 system it is running on; you can override that default using the
11462 @code{set host-charset} command. On some systems, @value{GDBN} cannot
11463 automatically determine the appropriate host character set. In this
11464 case, @value{GDBN} uses @samp{UTF-8}.
11466 @value{GDBN} can only use certain character sets as its host character
11467 set. If you type @kbd{@w{set host-charset @key{TAB}@key{TAB}}},
11468 @value{GDBN} will list the host character sets it supports.
11470 @item set charset @var{charset}
11471 @kindex set charset
11472 Set the current host and target character sets to @var{charset}. As
11473 above, if you type @kbd{@w{set charset @key{TAB}@key{TAB}}},
11474 @value{GDBN} will list the names of the character sets that can be used
11475 for both host and target.
11478 @kindex show charset
11479 Show the names of the current host and target character sets.
11481 @item show host-charset
11482 @kindex show host-charset
11483 Show the name of the current host character set.
11485 @item show target-charset
11486 @kindex show target-charset
11487 Show the name of the current target character set.
11489 @item set target-wide-charset @var{charset}
11490 @kindex set target-wide-charset
11491 Set the current target's wide character set to @var{charset}. This is
11492 the character set used by the target's @code{wchar_t} type. To
11493 display the list of supported wide character sets, type
11494 @kbd{@w{set target-wide-charset @key{TAB}@key{TAB}}}.
11496 @item show target-wide-charset
11497 @kindex show target-wide-charset
11498 Show the name of the current target's wide character set.
11501 Here is an example of @value{GDBN}'s character set support in action.
11502 Assume that the following source code has been placed in the file
11503 @file{charset-test.c}:
11509 = @{72, 101, 108, 108, 111, 44, 32, 119,
11510 111, 114, 108, 100, 33, 10, 0@};
11511 char ibm1047_hello[]
11512 = @{200, 133, 147, 147, 150, 107, 64, 166,
11513 150, 153, 147, 132, 90, 37, 0@};
11517 printf ("Hello, world!\n");
11521 In this program, @code{ascii_hello} and @code{ibm1047_hello} are arrays
11522 containing the string @samp{Hello, world!} followed by a newline,
11523 encoded in the @sc{ascii} and @sc{ibm1047} character sets.
11525 We compile the program, and invoke the debugger on it:
11528 $ gcc -g charset-test.c -o charset-test
11529 $ gdb -nw charset-test
11530 GNU gdb 2001-12-19-cvs
11531 Copyright 2001 Free Software Foundation, Inc.
11536 We can use the @code{show charset} command to see what character sets
11537 @value{GDBN} is currently using to interpret and display characters and
11541 (@value{GDBP}) show charset
11542 The current host and target character set is `ISO-8859-1'.
11546 For the sake of printing this manual, let's use @sc{ascii} as our
11547 initial character set:
11549 (@value{GDBP}) set charset ASCII
11550 (@value{GDBP}) show charset
11551 The current host and target character set is `ASCII'.
11555 Let's assume that @sc{ascii} is indeed the correct character set for our
11556 host system --- in other words, let's assume that if @value{GDBN} prints
11557 characters using the @sc{ascii} character set, our terminal will display
11558 them properly. Since our current target character set is also
11559 @sc{ascii}, the contents of @code{ascii_hello} print legibly:
11562 (@value{GDBP}) print ascii_hello
11563 $1 = 0x401698 "Hello, world!\n"
11564 (@value{GDBP}) print ascii_hello[0]
11569 @value{GDBN} uses the target character set for character and string
11570 literals you use in expressions:
11573 (@value{GDBP}) print '+'
11578 The @sc{ascii} character set uses the number 43 to encode the @samp{+}
11581 @value{GDBN} relies on the user to tell it which character set the
11582 target program uses. If we print @code{ibm1047_hello} while our target
11583 character set is still @sc{ascii}, we get jibberish:
11586 (@value{GDBP}) print ibm1047_hello
11587 $4 = 0x4016a8 "\310\205\223\223\226k@@\246\226\231\223\204Z%"
11588 (@value{GDBP}) print ibm1047_hello[0]
11593 If we invoke the @code{set target-charset} followed by @key{TAB}@key{TAB},
11594 @value{GDBN} tells us the character sets it supports:
11597 (@value{GDBP}) set target-charset
11598 ASCII EBCDIC-US IBM1047 ISO-8859-1
11599 (@value{GDBP}) set target-charset
11602 We can select @sc{ibm1047} as our target character set, and examine the
11603 program's strings again. Now the @sc{ascii} string is wrong, but
11604 @value{GDBN} translates the contents of @code{ibm1047_hello} from the
11605 target character set, @sc{ibm1047}, to the host character set,
11606 @sc{ascii}, and they display correctly:
11609 (@value{GDBP}) set target-charset IBM1047
11610 (@value{GDBP}) show charset
11611 The current host character set is `ASCII'.
11612 The current target character set is `IBM1047'.
11613 (@value{GDBP}) print ascii_hello
11614 $6 = 0x401698 "\110\145%%?\054\040\167?\162%\144\041\012"
11615 (@value{GDBP}) print ascii_hello[0]
11617 (@value{GDBP}) print ibm1047_hello
11618 $8 = 0x4016a8 "Hello, world!\n"
11619 (@value{GDBP}) print ibm1047_hello[0]
11624 As above, @value{GDBN} uses the target character set for character and
11625 string literals you use in expressions:
11628 (@value{GDBP}) print '+'
11633 The @sc{ibm1047} character set uses the number 78 to encode the @samp{+}
11636 @node Caching Target Data
11637 @section Caching Data of Targets
11638 @cindex caching data of targets
11640 @value{GDBN} caches data exchanged between the debugger and a target.
11641 Each cache is associated with the address space of the inferior.
11642 @xref{Inferiors and Programs}, about inferior and address space.
11643 Such caching generally improves performance in remote debugging
11644 (@pxref{Remote Debugging}), because it reduces the overhead of the
11645 remote protocol by bundling memory reads and writes into large chunks.
11646 Unfortunately, simply caching everything would lead to incorrect results,
11647 since @value{GDBN} does not necessarily know anything about volatile
11648 values, memory-mapped I/O addresses, etc. Furthermore, in non-stop mode
11649 (@pxref{Non-Stop Mode}) memory can be changed @emph{while} a gdb command
11651 Therefore, by default, @value{GDBN} only caches data
11652 known to be on the stack@footnote{In non-stop mode, it is moderately
11653 rare for a running thread to modify the stack of a stopped thread
11654 in a way that would interfere with a backtrace, and caching of
11655 stack reads provides a significant speed up of remote backtraces.} or
11656 in the code segment.
11657 Other regions of memory can be explicitly marked as
11658 cacheable; @pxref{Memory Region Attributes}.
11661 @kindex set remotecache
11662 @item set remotecache on
11663 @itemx set remotecache off
11664 This option no longer does anything; it exists for compatibility
11667 @kindex show remotecache
11668 @item show remotecache
11669 Show the current state of the obsolete remotecache flag.
11671 @kindex set stack-cache
11672 @item set stack-cache on
11673 @itemx set stack-cache off
11674 Enable or disable caching of stack accesses. When @code{on}, use
11675 caching. By default, this option is @code{on}.
11677 @kindex show stack-cache
11678 @item show stack-cache
11679 Show the current state of data caching for memory accesses.
11681 @kindex set code-cache
11682 @item set code-cache on
11683 @itemx set code-cache off
11684 Enable or disable caching of code segment accesses. When @code{on},
11685 use caching. By default, this option is @code{on}. This improves
11686 performance of disassembly in remote debugging.
11688 @kindex show code-cache
11689 @item show code-cache
11690 Show the current state of target memory cache for code segment
11693 @kindex info dcache
11694 @item info dcache @r{[}line@r{]}
11695 Print the information about the performance of data cache of the
11696 current inferior's address space. The information displayed
11697 includes the dcache width and depth, and for each cache line, its
11698 number, address, and how many times it was referenced. This
11699 command is useful for debugging the data cache operation.
11701 If a line number is specified, the contents of that line will be
11704 @item set dcache size @var{size}
11705 @cindex dcache size
11706 @kindex set dcache size
11707 Set maximum number of entries in dcache (dcache depth above).
11709 @item set dcache line-size @var{line-size}
11710 @cindex dcache line-size
11711 @kindex set dcache line-size
11712 Set number of bytes each dcache entry caches (dcache width above).
11713 Must be a power of 2.
11715 @item show dcache size
11716 @kindex show dcache size
11717 Show maximum number of dcache entries. @xref{Caching Target Data, info dcache}.
11719 @item show dcache line-size
11720 @kindex show dcache line-size
11721 Show default size of dcache lines.
11725 @node Searching Memory
11726 @section Search Memory
11727 @cindex searching memory
11729 Memory can be searched for a particular sequence of bytes with the
11730 @code{find} command.
11734 @item find @r{[}/@var{sn}@r{]} @var{start_addr}, +@var{len}, @var{val1} @r{[}, @var{val2}, @dots{}@r{]}
11735 @itemx find @r{[}/@var{sn}@r{]} @var{start_addr}, @var{end_addr}, @var{val1} @r{[}, @var{val2}, @dots{}@r{]}
11736 Search memory for the sequence of bytes specified by @var{val1}, @var{val2},
11737 etc. The search begins at address @var{start_addr} and continues for either
11738 @var{len} bytes or through to @var{end_addr} inclusive.
11741 @var{s} and @var{n} are optional parameters.
11742 They may be specified in either order, apart or together.
11745 @item @var{s}, search query size
11746 The size of each search query value.
11752 halfwords (two bytes)
11756 giant words (eight bytes)
11759 All values are interpreted in the current language.
11760 This means, for example, that if the current source language is C/C@t{++}
11761 then searching for the string ``hello'' includes the trailing '\0'.
11763 If the value size is not specified, it is taken from the
11764 value's type in the current language.
11765 This is useful when one wants to specify the search
11766 pattern as a mixture of types.
11767 Note that this means, for example, that in the case of C-like languages
11768 a search for an untyped 0x42 will search for @samp{(int) 0x42}
11769 which is typically four bytes.
11771 @item @var{n}, maximum number of finds
11772 The maximum number of matches to print. The default is to print all finds.
11775 You can use strings as search values. Quote them with double-quotes
11777 The string value is copied into the search pattern byte by byte,
11778 regardless of the endianness of the target and the size specification.
11780 The address of each match found is printed as well as a count of the
11781 number of matches found.
11783 The address of the last value found is stored in convenience variable
11785 A count of the number of matches is stored in @samp{$numfound}.
11787 For example, if stopped at the @code{printf} in this function:
11793 static char hello[] = "hello-hello";
11794 static struct @{ char c; short s; int i; @}
11795 __attribute__ ((packed)) mixed
11796 = @{ 'c', 0x1234, 0x87654321 @};
11797 printf ("%s\n", hello);
11802 you get during debugging:
11805 (gdb) find &hello[0], +sizeof(hello), "hello"
11806 0x804956d <hello.1620+6>
11808 (gdb) find &hello[0], +sizeof(hello), 'h', 'e', 'l', 'l', 'o'
11809 0x8049567 <hello.1620>
11810 0x804956d <hello.1620+6>
11812 (gdb) find /b1 &hello[0], +sizeof(hello), 'h', 0x65, 'l'
11813 0x8049567 <hello.1620>
11815 (gdb) find &mixed, +sizeof(mixed), (char) 'c', (short) 0x1234, (int) 0x87654321
11816 0x8049560 <mixed.1625>
11818 (gdb) print $numfound
11821 $2 = (void *) 0x8049560
11825 @section Value Sizes
11827 Whenever @value{GDBN} prints a value memory will be allocated within
11828 @value{GDBN} to hold the contents of the value. It is possible in
11829 some languages with dynamic typing systems, that an invalid program
11830 may indicate a value that is incorrectly large, this in turn may cause
11831 @value{GDBN} to try and allocate an overly large ammount of memory.
11834 @kindex set max-value-size
11835 @item set max-value-size @var{bytes}
11836 @itemx set max-value-size unlimited
11837 Set the maximum size of memory that @value{GDBN} will allocate for the
11838 contents of a value to @var{bytes}, trying to display a value that
11839 requires more memory than that will result in an error.
11841 Setting this variable does not effect values that have already been
11842 allocated within @value{GDBN}, only future allocations.
11844 There's a minimum size that @code{max-value-size} can be set to in
11845 order that @value{GDBN} can still operate correctly, this minimum is
11846 currently 16 bytes.
11848 The limit applies to the results of some subexpressions as well as to
11849 complete expressions. For example, an expression denoting a simple
11850 integer component, such as @code{x.y.z}, may fail if the size of
11851 @var{x.y} is dynamic and exceeds @var{bytes}. On the other hand,
11852 @value{GDBN} is sometimes clever; the expression @code{A[i]}, where
11853 @var{A} is an array variable with non-constant size, will generally
11854 succeed regardless of the bounds on @var{A}, as long as the component
11855 size is less than @var{bytes}.
11857 The default value of @code{max-value-size} is currently 64k.
11859 @kindex show max-value-size
11860 @item show max-value-size
11861 Show the maximum size of memory, in bytes, that @value{GDBN} will
11862 allocate for the contents of a value.
11865 @node Optimized Code
11866 @chapter Debugging Optimized Code
11867 @cindex optimized code, debugging
11868 @cindex debugging optimized code
11870 Almost all compilers support optimization. With optimization
11871 disabled, the compiler generates assembly code that corresponds
11872 directly to your source code, in a simplistic way. As the compiler
11873 applies more powerful optimizations, the generated assembly code
11874 diverges from your original source code. With help from debugging
11875 information generated by the compiler, @value{GDBN} can map from
11876 the running program back to constructs from your original source.
11878 @value{GDBN} is more accurate with optimization disabled. If you
11879 can recompile without optimization, it is easier to follow the
11880 progress of your program during debugging. But, there are many cases
11881 where you may need to debug an optimized version.
11883 When you debug a program compiled with @samp{-g -O}, remember that the
11884 optimizer has rearranged your code; the debugger shows you what is
11885 really there. Do not be too surprised when the execution path does not
11886 exactly match your source file! An extreme example: if you define a
11887 variable, but never use it, @value{GDBN} never sees that
11888 variable---because the compiler optimizes it out of existence.
11890 Some things do not work as well with @samp{-g -O} as with just
11891 @samp{-g}, particularly on machines with instruction scheduling. If in
11892 doubt, recompile with @samp{-g} alone, and if this fixes the problem,
11893 please report it to us as a bug (including a test case!).
11894 @xref{Variables}, for more information about debugging optimized code.
11897 * Inline Functions:: How @value{GDBN} presents inlining
11898 * Tail Call Frames:: @value{GDBN} analysis of jumps to functions
11901 @node Inline Functions
11902 @section Inline Functions
11903 @cindex inline functions, debugging
11905 @dfn{Inlining} is an optimization that inserts a copy of the function
11906 body directly at each call site, instead of jumping to a shared
11907 routine. @value{GDBN} displays inlined functions just like
11908 non-inlined functions. They appear in backtraces. You can view their
11909 arguments and local variables, step into them with @code{step}, skip
11910 them with @code{next}, and escape from them with @code{finish}.
11911 You can check whether a function was inlined by using the
11912 @code{info frame} command.
11914 For @value{GDBN} to support inlined functions, the compiler must
11915 record information about inlining in the debug information ---
11916 @value{NGCC} using the @sc{dwarf 2} format does this, and several
11917 other compilers do also. @value{GDBN} only supports inlined functions
11918 when using @sc{dwarf 2}. Versions of @value{NGCC} before 4.1
11919 do not emit two required attributes (@samp{DW_AT_call_file} and
11920 @samp{DW_AT_call_line}); @value{GDBN} does not display inlined
11921 function calls with earlier versions of @value{NGCC}. It instead
11922 displays the arguments and local variables of inlined functions as
11923 local variables in the caller.
11925 The body of an inlined function is directly included at its call site;
11926 unlike a non-inlined function, there are no instructions devoted to
11927 the call. @value{GDBN} still pretends that the call site and the
11928 start of the inlined function are different instructions. Stepping to
11929 the call site shows the call site, and then stepping again shows
11930 the first line of the inlined function, even though no additional
11931 instructions are executed.
11933 This makes source-level debugging much clearer; you can see both the
11934 context of the call and then the effect of the call. Only stepping by
11935 a single instruction using @code{stepi} or @code{nexti} does not do
11936 this; single instruction steps always show the inlined body.
11938 There are some ways that @value{GDBN} does not pretend that inlined
11939 function calls are the same as normal calls:
11943 Setting breakpoints at the call site of an inlined function may not
11944 work, because the call site does not contain any code. @value{GDBN}
11945 may incorrectly move the breakpoint to the next line of the enclosing
11946 function, after the call. This limitation will be removed in a future
11947 version of @value{GDBN}; until then, set a breakpoint on an earlier line
11948 or inside the inlined function instead.
11951 @value{GDBN} cannot locate the return value of inlined calls after
11952 using the @code{finish} command. This is a limitation of compiler-generated
11953 debugging information; after @code{finish}, you can step to the next line
11954 and print a variable where your program stored the return value.
11958 @node Tail Call Frames
11959 @section Tail Call Frames
11960 @cindex tail call frames, debugging
11962 Function @code{B} can call function @code{C} in its very last statement. In
11963 unoptimized compilation the call of @code{C} is immediately followed by return
11964 instruction at the end of @code{B} code. Optimizing compiler may replace the
11965 call and return in function @code{B} into one jump to function @code{C}
11966 instead. Such use of a jump instruction is called @dfn{tail call}.
11968 During execution of function @code{C}, there will be no indication in the
11969 function call stack frames that it was tail-called from @code{B}. If function
11970 @code{A} regularly calls function @code{B} which tail-calls function @code{C},
11971 then @value{GDBN} will see @code{A} as the caller of @code{C}. However, in
11972 some cases @value{GDBN} can determine that @code{C} was tail-called from
11973 @code{B}, and it will then create fictitious call frame for that, with the
11974 return address set up as if @code{B} called @code{C} normally.
11976 This functionality is currently supported only by DWARF 2 debugging format and
11977 the compiler has to produce @samp{DW_TAG_GNU_call_site} tags. With
11978 @value{NGCC}, you need to specify @option{-O -g} during compilation, to get
11981 @kbd{info frame} command (@pxref{Frame Info}) will indicate the tail call frame
11982 kind by text @code{tail call frame} such as in this sample @value{GDBN} output:
11986 0x40066b <b(int, double)+11>: jmp 0x400640 <c(int, double)>
11988 Stack level 1, frame at 0x7fffffffda30:
11989 rip = 0x40066d in b (amd64-entry-value.cc:59); saved rip 0x4004c5
11990 tail call frame, caller of frame at 0x7fffffffda30
11991 source language c++.
11992 Arglist at unknown address.
11993 Locals at unknown address, Previous frame's sp is 0x7fffffffda30
11996 The detection of all the possible code path executions can find them ambiguous.
11997 There is no execution history stored (possible @ref{Reverse Execution} is never
11998 used for this purpose) and the last known caller could have reached the known
11999 callee by multiple different jump sequences. In such case @value{GDBN} still
12000 tries to show at least all the unambiguous top tail callers and all the
12001 unambiguous bottom tail calees, if any.
12004 @anchor{set debug entry-values}
12005 @item set debug entry-values
12006 @kindex set debug entry-values
12007 When set to on, enables printing of analysis messages for both frame argument
12008 values at function entry and tail calls. It will show all the possible valid
12009 tail calls code paths it has considered. It will also print the intersection
12010 of them with the final unambiguous (possibly partial or even empty) code path
12013 @item show debug entry-values
12014 @kindex show debug entry-values
12015 Show the current state of analysis messages printing for both frame argument
12016 values at function entry and tail calls.
12019 The analysis messages for tail calls can for example show why the virtual tail
12020 call frame for function @code{c} has not been recognized (due to the indirect
12021 reference by variable @code{x}):
12024 static void __attribute__((noinline, noclone)) c (void);
12025 void (*x) (void) = c;
12026 static void __attribute__((noinline, noclone)) a (void) @{ x++; @}
12027 static void __attribute__((noinline, noclone)) c (void) @{ a (); @}
12028 int main (void) @{ x (); return 0; @}
12030 Breakpoint 1, DW_OP_GNU_entry_value resolving cannot find
12031 DW_TAG_GNU_call_site 0x40039a in main
12033 3 static void __attribute__((noinline, noclone)) a (void) @{ x++; @}
12036 #1 0x000000000040039a in main () at t.c:5
12039 Another possibility is an ambiguous virtual tail call frames resolution:
12043 static void __attribute__((noinline, noclone)) f (void) @{ i++; @}
12044 static void __attribute__((noinline, noclone)) e (void) @{ f (); @}
12045 static void __attribute__((noinline, noclone)) d (void) @{ f (); @}
12046 static void __attribute__((noinline, noclone)) c (void) @{ d (); @}
12047 static void __attribute__((noinline, noclone)) b (void)
12048 @{ if (i) c (); else e (); @}
12049 static void __attribute__((noinline, noclone)) a (void) @{ b (); @}
12050 int main (void) @{ a (); return 0; @}
12052 tailcall: initial: 0x4004d2(a) 0x4004ce(b) 0x4004b2(c) 0x4004a2(d)
12053 tailcall: compare: 0x4004d2(a) 0x4004cc(b) 0x400492(e)
12054 tailcall: reduced: 0x4004d2(a) |
12057 #1 0x00000000004004d2 in a () at t.c:8
12058 #2 0x0000000000400395 in main () at t.c:9
12061 @set CALLSEQ1A @code{main@value{ARROW}a@value{ARROW}b@value{ARROW}c@value{ARROW}d@value{ARROW}f}
12062 @set CALLSEQ2A @code{main@value{ARROW}a@value{ARROW}b@value{ARROW}e@value{ARROW}f}
12064 @c Convert CALLSEQ#A to CALLSEQ#B depending on HAVE_MAKEINFO_CLICK.
12065 @ifset HAVE_MAKEINFO_CLICK
12066 @set ARROW @click{}
12067 @set CALLSEQ1B @clicksequence{@value{CALLSEQ1A}}
12068 @set CALLSEQ2B @clicksequence{@value{CALLSEQ2A}}
12070 @ifclear HAVE_MAKEINFO_CLICK
12072 @set CALLSEQ1B @value{CALLSEQ1A}
12073 @set CALLSEQ2B @value{CALLSEQ2A}
12076 Frames #0 and #2 are real, #1 is a virtual tail call frame.
12077 The code can have possible execution paths @value{CALLSEQ1B} or
12078 @value{CALLSEQ2B}, @value{GDBN} cannot find which one from the inferior state.
12080 @code{initial:} state shows some random possible calling sequence @value{GDBN}
12081 has found. It then finds another possible calling sequcen - that one is
12082 prefixed by @code{compare:}. The non-ambiguous intersection of these two is
12083 printed as the @code{reduced:} calling sequence. That one could have many
12084 futher @code{compare:} and @code{reduced:} statements as long as there remain
12085 any non-ambiguous sequence entries.
12087 For the frame of function @code{b} in both cases there are different possible
12088 @code{$pc} values (@code{0x4004cc} or @code{0x4004ce}), therefore this frame is
12089 also ambigous. The only non-ambiguous frame is the one for function @code{a},
12090 therefore this one is displayed to the user while the ambiguous frames are
12093 There can be also reasons why printing of frame argument values at function
12098 static void __attribute__((noinline, noclone)) c (int i) @{ v++; @}
12099 static void __attribute__((noinline, noclone)) a (int i);
12100 static void __attribute__((noinline, noclone)) b (int i) @{ a (i); @}
12101 static void __attribute__((noinline, noclone)) a (int i)
12102 @{ if (i) b (i - 1); else c (0); @}
12103 int main (void) @{ a (5); return 0; @}
12106 #0 c (i=i@@entry=0) at t.c:2
12107 #1 0x0000000000400428 in a (DW_OP_GNU_entry_value resolving has found
12108 function "a" at 0x400420 can call itself via tail calls
12109 i=<optimized out>) at t.c:6
12110 #2 0x000000000040036e in main () at t.c:7
12113 @value{GDBN} cannot find out from the inferior state if and how many times did
12114 function @code{a} call itself (via function @code{b}) as these calls would be
12115 tail calls. Such tail calls would modify thue @code{i} variable, therefore
12116 @value{GDBN} cannot be sure the value it knows would be right - @value{GDBN}
12117 prints @code{<optimized out>} instead.
12120 @chapter C Preprocessor Macros
12122 Some languages, such as C and C@t{++}, provide a way to define and invoke
12123 ``preprocessor macros'' which expand into strings of tokens.
12124 @value{GDBN} can evaluate expressions containing macro invocations, show
12125 the result of macro expansion, and show a macro's definition, including
12126 where it was defined.
12128 You may need to compile your program specially to provide @value{GDBN}
12129 with information about preprocessor macros. Most compilers do not
12130 include macros in their debugging information, even when you compile
12131 with the @option{-g} flag. @xref{Compilation}.
12133 A program may define a macro at one point, remove that definition later,
12134 and then provide a different definition after that. Thus, at different
12135 points in the program, a macro may have different definitions, or have
12136 no definition at all. If there is a current stack frame, @value{GDBN}
12137 uses the macros in scope at that frame's source code line. Otherwise,
12138 @value{GDBN} uses the macros in scope at the current listing location;
12141 Whenever @value{GDBN} evaluates an expression, it always expands any
12142 macro invocations present in the expression. @value{GDBN} also provides
12143 the following commands for working with macros explicitly.
12147 @kindex macro expand
12148 @cindex macro expansion, showing the results of preprocessor
12149 @cindex preprocessor macro expansion, showing the results of
12150 @cindex expanding preprocessor macros
12151 @item macro expand @var{expression}
12152 @itemx macro exp @var{expression}
12153 Show the results of expanding all preprocessor macro invocations in
12154 @var{expression}. Since @value{GDBN} simply expands macros, but does
12155 not parse the result, @var{expression} need not be a valid expression;
12156 it can be any string of tokens.
12159 @item macro expand-once @var{expression}
12160 @itemx macro exp1 @var{expression}
12161 @cindex expand macro once
12162 @i{(This command is not yet implemented.)} Show the results of
12163 expanding those preprocessor macro invocations that appear explicitly in
12164 @var{expression}. Macro invocations appearing in that expansion are
12165 left unchanged. This command allows you to see the effect of a
12166 particular macro more clearly, without being confused by further
12167 expansions. Since @value{GDBN} simply expands macros, but does not
12168 parse the result, @var{expression} need not be a valid expression; it
12169 can be any string of tokens.
12172 @cindex macro definition, showing
12173 @cindex definition of a macro, showing
12174 @cindex macros, from debug info
12175 @item info macro [-a|-all] [--] @var{macro}
12176 Show the current definition or all definitions of the named @var{macro},
12177 and describe the source location or compiler command-line where that
12178 definition was established. The optional double dash is to signify the end of
12179 argument processing and the beginning of @var{macro} for non C-like macros where
12180 the macro may begin with a hyphen.
12182 @kindex info macros
12183 @item info macros @var{location}
12184 Show all macro definitions that are in effect at the location specified
12185 by @var{location}, and describe the source location or compiler
12186 command-line where those definitions were established.
12188 @kindex macro define
12189 @cindex user-defined macros
12190 @cindex defining macros interactively
12191 @cindex macros, user-defined
12192 @item macro define @var{macro} @var{replacement-list}
12193 @itemx macro define @var{macro}(@var{arglist}) @var{replacement-list}
12194 Introduce a definition for a preprocessor macro named @var{macro},
12195 invocations of which are replaced by the tokens given in
12196 @var{replacement-list}. The first form of this command defines an
12197 ``object-like'' macro, which takes no arguments; the second form
12198 defines a ``function-like'' macro, which takes the arguments given in
12201 A definition introduced by this command is in scope in every
12202 expression evaluated in @value{GDBN}, until it is removed with the
12203 @code{macro undef} command, described below. The definition overrides
12204 all definitions for @var{macro} present in the program being debugged,
12205 as well as any previous user-supplied definition.
12207 @kindex macro undef
12208 @item macro undef @var{macro}
12209 Remove any user-supplied definition for the macro named @var{macro}.
12210 This command only affects definitions provided with the @code{macro
12211 define} command, described above; it cannot remove definitions present
12212 in the program being debugged.
12216 List all the macros defined using the @code{macro define} command.
12219 @cindex macros, example of debugging with
12220 Here is a transcript showing the above commands in action. First, we
12221 show our source files:
12226 #include "sample.h"
12229 #define ADD(x) (M + x)
12234 printf ("Hello, world!\n");
12236 printf ("We're so creative.\n");
12238 printf ("Goodbye, world!\n");
12245 Now, we compile the program using the @sc{gnu} C compiler,
12246 @value{NGCC}. We pass the @option{-gdwarf-2}@footnote{This is the
12247 minimum. Recent versions of @value{NGCC} support @option{-gdwarf-3}
12248 and @option{-gdwarf-4}; we recommend always choosing the most recent
12249 version of DWARF.} @emph{and} @option{-g3} flags to ensure the compiler
12250 includes information about preprocessor macros in the debugging
12254 $ gcc -gdwarf-2 -g3 sample.c -o sample
12258 Now, we start @value{GDBN} on our sample program:
12262 GNU gdb 2002-05-06-cvs
12263 Copyright 2002 Free Software Foundation, Inc.
12264 GDB is free software, @dots{}
12268 We can expand macros and examine their definitions, even when the
12269 program is not running. @value{GDBN} uses the current listing position
12270 to decide which macro definitions are in scope:
12273 (@value{GDBP}) list main
12276 5 #define ADD(x) (M + x)
12281 10 printf ("Hello, world!\n");
12283 12 printf ("We're so creative.\n");
12284 (@value{GDBP}) info macro ADD
12285 Defined at /home/jimb/gdb/macros/play/sample.c:5
12286 #define ADD(x) (M + x)
12287 (@value{GDBP}) info macro Q
12288 Defined at /home/jimb/gdb/macros/play/sample.h:1
12289 included at /home/jimb/gdb/macros/play/sample.c:2
12291 (@value{GDBP}) macro expand ADD(1)
12292 expands to: (42 + 1)
12293 (@value{GDBP}) macro expand-once ADD(1)
12294 expands to: once (M + 1)
12298 In the example above, note that @code{macro expand-once} expands only
12299 the macro invocation explicit in the original text --- the invocation of
12300 @code{ADD} --- but does not expand the invocation of the macro @code{M},
12301 which was introduced by @code{ADD}.
12303 Once the program is running, @value{GDBN} uses the macro definitions in
12304 force at the source line of the current stack frame:
12307 (@value{GDBP}) break main
12308 Breakpoint 1 at 0x8048370: file sample.c, line 10.
12310 Starting program: /home/jimb/gdb/macros/play/sample
12312 Breakpoint 1, main () at sample.c:10
12313 10 printf ("Hello, world!\n");
12317 At line 10, the definition of the macro @code{N} at line 9 is in force:
12320 (@value{GDBP}) info macro N
12321 Defined at /home/jimb/gdb/macros/play/sample.c:9
12323 (@value{GDBP}) macro expand N Q M
12324 expands to: 28 < 42
12325 (@value{GDBP}) print N Q M
12330 As we step over directives that remove @code{N}'s definition, and then
12331 give it a new definition, @value{GDBN} finds the definition (or lack
12332 thereof) in force at each point:
12335 (@value{GDBP}) next
12337 12 printf ("We're so creative.\n");
12338 (@value{GDBP}) info macro N
12339 The symbol `N' has no definition as a C/C++ preprocessor macro
12340 at /home/jimb/gdb/macros/play/sample.c:12
12341 (@value{GDBP}) next
12343 14 printf ("Goodbye, world!\n");
12344 (@value{GDBP}) info macro N
12345 Defined at /home/jimb/gdb/macros/play/sample.c:13
12347 (@value{GDBP}) macro expand N Q M
12348 expands to: 1729 < 42
12349 (@value{GDBP}) print N Q M
12354 In addition to source files, macros can be defined on the compilation command
12355 line using the @option{-D@var{name}=@var{value}} syntax. For macros defined in
12356 such a way, @value{GDBN} displays the location of their definition as line zero
12357 of the source file submitted to the compiler.
12360 (@value{GDBP}) info macro __STDC__
12361 Defined at /home/jimb/gdb/macros/play/sample.c:0
12368 @chapter Tracepoints
12369 @c This chapter is based on the documentation written by Michael
12370 @c Snyder, David Taylor, Jim Blandy, and Elena Zannoni.
12372 @cindex tracepoints
12373 In some applications, it is not feasible for the debugger to interrupt
12374 the program's execution long enough for the developer to learn
12375 anything helpful about its behavior. If the program's correctness
12376 depends on its real-time behavior, delays introduced by a debugger
12377 might cause the program to change its behavior drastically, or perhaps
12378 fail, even when the code itself is correct. It is useful to be able
12379 to observe the program's behavior without interrupting it.
12381 Using @value{GDBN}'s @code{trace} and @code{collect} commands, you can
12382 specify locations in the program, called @dfn{tracepoints}, and
12383 arbitrary expressions to evaluate when those tracepoints are reached.
12384 Later, using the @code{tfind} command, you can examine the values
12385 those expressions had when the program hit the tracepoints. The
12386 expressions may also denote objects in memory---structures or arrays,
12387 for example---whose values @value{GDBN} should record; while visiting
12388 a particular tracepoint, you may inspect those objects as if they were
12389 in memory at that moment. However, because @value{GDBN} records these
12390 values without interacting with you, it can do so quickly and
12391 unobtrusively, hopefully not disturbing the program's behavior.
12393 The tracepoint facility is currently available only for remote
12394 targets. @xref{Targets}. In addition, your remote target must know
12395 how to collect trace data. This functionality is implemented in the
12396 remote stub; however, none of the stubs distributed with @value{GDBN}
12397 support tracepoints as of this writing. The format of the remote
12398 packets used to implement tracepoints are described in @ref{Tracepoint
12401 It is also possible to get trace data from a file, in a manner reminiscent
12402 of corefiles; you specify the filename, and use @code{tfind} to search
12403 through the file. @xref{Trace Files}, for more details.
12405 This chapter describes the tracepoint commands and features.
12408 * Set Tracepoints::
12409 * Analyze Collected Data::
12410 * Tracepoint Variables::
12414 @node Set Tracepoints
12415 @section Commands to Set Tracepoints
12417 Before running such a @dfn{trace experiment}, an arbitrary number of
12418 tracepoints can be set. A tracepoint is actually a special type of
12419 breakpoint (@pxref{Set Breaks}), so you can manipulate it using
12420 standard breakpoint commands. For instance, as with breakpoints,
12421 tracepoint numbers are successive integers starting from one, and many
12422 of the commands associated with tracepoints take the tracepoint number
12423 as their argument, to identify which tracepoint to work on.
12425 For each tracepoint, you can specify, in advance, some arbitrary set
12426 of data that you want the target to collect in the trace buffer when
12427 it hits that tracepoint. The collected data can include registers,
12428 local variables, or global data. Later, you can use @value{GDBN}
12429 commands to examine the values these data had at the time the
12430 tracepoint was hit.
12432 Tracepoints do not support every breakpoint feature. Ignore counts on
12433 tracepoints have no effect, and tracepoints cannot run @value{GDBN}
12434 commands when they are hit. Tracepoints may not be thread-specific
12437 @cindex fast tracepoints
12438 Some targets may support @dfn{fast tracepoints}, which are inserted in
12439 a different way (such as with a jump instead of a trap), that is
12440 faster but possibly restricted in where they may be installed.
12442 @cindex static tracepoints
12443 @cindex markers, static tracepoints
12444 @cindex probing markers, static tracepoints
12445 Regular and fast tracepoints are dynamic tracing facilities, meaning
12446 that they can be used to insert tracepoints at (almost) any location
12447 in the target. Some targets may also support controlling @dfn{static
12448 tracepoints} from @value{GDBN}. With static tracing, a set of
12449 instrumentation points, also known as @dfn{markers}, are embedded in
12450 the target program, and can be activated or deactivated by name or
12451 address. These are usually placed at locations which facilitate
12452 investigating what the target is actually doing. @value{GDBN}'s
12453 support for static tracing includes being able to list instrumentation
12454 points, and attach them with @value{GDBN} defined high level
12455 tracepoints that expose the whole range of convenience of
12456 @value{GDBN}'s tracepoints support. Namely, support for collecting
12457 registers values and values of global or local (to the instrumentation
12458 point) variables; tracepoint conditions and trace state variables.
12459 The act of installing a @value{GDBN} static tracepoint on an
12460 instrumentation point, or marker, is referred to as @dfn{probing} a
12461 static tracepoint marker.
12463 @code{gdbserver} supports tracepoints on some target systems.
12464 @xref{Server,,Tracepoints support in @code{gdbserver}}.
12466 This section describes commands to set tracepoints and associated
12467 conditions and actions.
12470 * Create and Delete Tracepoints::
12471 * Enable and Disable Tracepoints::
12472 * Tracepoint Passcounts::
12473 * Tracepoint Conditions::
12474 * Trace State Variables::
12475 * Tracepoint Actions::
12476 * Listing Tracepoints::
12477 * Listing Static Tracepoint Markers::
12478 * Starting and Stopping Trace Experiments::
12479 * Tracepoint Restrictions::
12482 @node Create and Delete Tracepoints
12483 @subsection Create and Delete Tracepoints
12486 @cindex set tracepoint
12488 @item trace @var{location}
12489 The @code{trace} command is very similar to the @code{break} command.
12490 Its argument @var{location} can be any valid location.
12491 @xref{Specify Location}. The @code{trace} command defines a tracepoint,
12492 which is a point in the target program where the debugger will briefly stop,
12493 collect some data, and then allow the program to continue. Setting a tracepoint
12494 or changing its actions takes effect immediately if the remote stub
12495 supports the @samp{InstallInTrace} feature (@pxref{install tracepoint
12497 If remote stub doesn't support the @samp{InstallInTrace} feature, all
12498 these changes don't take effect until the next @code{tstart}
12499 command, and once a trace experiment is running, further changes will
12500 not have any effect until the next trace experiment starts. In addition,
12501 @value{GDBN} supports @dfn{pending tracepoints}---tracepoints whose
12502 address is not yet resolved. (This is similar to pending breakpoints.)
12503 Pending tracepoints are not downloaded to the target and not installed
12504 until they are resolved. The resolution of pending tracepoints requires
12505 @value{GDBN} support---when debugging with the remote target, and
12506 @value{GDBN} disconnects from the remote stub (@pxref{disconnected
12507 tracing}), pending tracepoints can not be resolved (and downloaded to
12508 the remote stub) while @value{GDBN} is disconnected.
12510 Here are some examples of using the @code{trace} command:
12513 (@value{GDBP}) @b{trace foo.c:121} // a source file and line number
12515 (@value{GDBP}) @b{trace +2} // 2 lines forward
12517 (@value{GDBP}) @b{trace my_function} // first source line of function
12519 (@value{GDBP}) @b{trace *my_function} // EXACT start address of function
12521 (@value{GDBP}) @b{trace *0x2117c4} // an address
12525 You can abbreviate @code{trace} as @code{tr}.
12527 @item trace @var{location} if @var{cond}
12528 Set a tracepoint with condition @var{cond}; evaluate the expression
12529 @var{cond} each time the tracepoint is reached, and collect data only
12530 if the value is nonzero---that is, if @var{cond} evaluates as true.
12531 @xref{Tracepoint Conditions, ,Tracepoint Conditions}, for more
12532 information on tracepoint conditions.
12534 @item ftrace @var{location} [ if @var{cond} ]
12535 @cindex set fast tracepoint
12536 @cindex fast tracepoints, setting
12538 The @code{ftrace} command sets a fast tracepoint. For targets that
12539 support them, fast tracepoints will use a more efficient but possibly
12540 less general technique to trigger data collection, such as a jump
12541 instruction instead of a trap, or some sort of hardware support. It
12542 may not be possible to create a fast tracepoint at the desired
12543 location, in which case the command will exit with an explanatory
12546 @value{GDBN} handles arguments to @code{ftrace} exactly as for
12549 On 32-bit x86-architecture systems, fast tracepoints normally need to
12550 be placed at an instruction that is 5 bytes or longer, but can be
12551 placed at 4-byte instructions if the low 64K of memory of the target
12552 program is available to install trampolines. Some Unix-type systems,
12553 such as @sc{gnu}/Linux, exclude low addresses from the program's
12554 address space; but for instance with the Linux kernel it is possible
12555 to let @value{GDBN} use this area by doing a @command{sysctl} command
12556 to set the @code{mmap_min_addr} kernel parameter, as in
12559 sudo sysctl -w vm.mmap_min_addr=32768
12563 which sets the low address to 32K, which leaves plenty of room for
12564 trampolines. The minimum address should be set to a page boundary.
12566 @item strace @var{location} [ if @var{cond} ]
12567 @cindex set static tracepoint
12568 @cindex static tracepoints, setting
12569 @cindex probe static tracepoint marker
12571 The @code{strace} command sets a static tracepoint. For targets that
12572 support it, setting a static tracepoint probes a static
12573 instrumentation point, or marker, found at @var{location}. It may not
12574 be possible to set a static tracepoint at the desired location, in
12575 which case the command will exit with an explanatory message.
12577 @value{GDBN} handles arguments to @code{strace} exactly as for
12578 @code{trace}, with the addition that the user can also specify
12579 @code{-m @var{marker}} as @var{location}. This probes the marker
12580 identified by the @var{marker} string identifier. This identifier
12581 depends on the static tracepoint backend library your program is
12582 using. You can find all the marker identifiers in the @samp{ID} field
12583 of the @code{info static-tracepoint-markers} command output.
12584 @xref{Listing Static Tracepoint Markers,,Listing Static Tracepoint
12585 Markers}. For example, in the following small program using the UST
12591 trace_mark(ust, bar33, "str %s", "FOOBAZ");
12596 the marker id is composed of joining the first two arguments to the
12597 @code{trace_mark} call with a slash, which translates to:
12600 (@value{GDBP}) info static-tracepoint-markers
12601 Cnt Enb ID Address What
12602 1 n ust/bar33 0x0000000000400ddc in main at stexample.c:22
12608 so you may probe the marker above with:
12611 (@value{GDBP}) strace -m ust/bar33
12614 Static tracepoints accept an extra collect action --- @code{collect
12615 $_sdata}. This collects arbitrary user data passed in the probe point
12616 call to the tracing library. In the UST example above, you'll see
12617 that the third argument to @code{trace_mark} is a printf-like format
12618 string. The user data is then the result of running that formating
12619 string against the following arguments. Note that @code{info
12620 static-tracepoint-markers} command output lists that format string in
12621 the @samp{Data:} field.
12623 You can inspect this data when analyzing the trace buffer, by printing
12624 the $_sdata variable like any other variable available to
12625 @value{GDBN}. @xref{Tracepoint Actions,,Tracepoint Action Lists}.
12628 @cindex last tracepoint number
12629 @cindex recent tracepoint number
12630 @cindex tracepoint number
12631 The convenience variable @code{$tpnum} records the tracepoint number
12632 of the most recently set tracepoint.
12634 @kindex delete tracepoint
12635 @cindex tracepoint deletion
12636 @item delete tracepoint @r{[}@var{num}@r{]}
12637 Permanently delete one or more tracepoints. With no argument, the
12638 default is to delete all tracepoints. Note that the regular
12639 @code{delete} command can remove tracepoints also.
12644 (@value{GDBP}) @b{delete trace 1 2 3} // remove three tracepoints
12646 (@value{GDBP}) @b{delete trace} // remove all tracepoints
12650 You can abbreviate this command as @code{del tr}.
12653 @node Enable and Disable Tracepoints
12654 @subsection Enable and Disable Tracepoints
12656 These commands are deprecated; they are equivalent to plain @code{disable} and @code{enable}.
12659 @kindex disable tracepoint
12660 @item disable tracepoint @r{[}@var{num}@r{]}
12661 Disable tracepoint @var{num}, or all tracepoints if no argument
12662 @var{num} is given. A disabled tracepoint will have no effect during
12663 a trace experiment, but it is not forgotten. You can re-enable
12664 a disabled tracepoint using the @code{enable tracepoint} command.
12665 If the command is issued during a trace experiment and the debug target
12666 has support for disabling tracepoints during a trace experiment, then the
12667 change will be effective immediately. Otherwise, it will be applied to the
12668 next trace experiment.
12670 @kindex enable tracepoint
12671 @item enable tracepoint @r{[}@var{num}@r{]}
12672 Enable tracepoint @var{num}, or all tracepoints. If this command is
12673 issued during a trace experiment and the debug target supports enabling
12674 tracepoints during a trace experiment, then the enabled tracepoints will
12675 become effective immediately. Otherwise, they will become effective the
12676 next time a trace experiment is run.
12679 @node Tracepoint Passcounts
12680 @subsection Tracepoint Passcounts
12684 @cindex tracepoint pass count
12685 @item passcount @r{[}@var{n} @r{[}@var{num}@r{]]}
12686 Set the @dfn{passcount} of a tracepoint. The passcount is a way to
12687 automatically stop a trace experiment. If a tracepoint's passcount is
12688 @var{n}, then the trace experiment will be automatically stopped on
12689 the @var{n}'th time that tracepoint is hit. If the tracepoint number
12690 @var{num} is not specified, the @code{passcount} command sets the
12691 passcount of the most recently defined tracepoint. If no passcount is
12692 given, the trace experiment will run until stopped explicitly by the
12698 (@value{GDBP}) @b{passcount 5 2} // Stop on the 5th execution of
12699 @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// tracepoint 2}
12701 (@value{GDBP}) @b{passcount 12} // Stop on the 12th execution of the
12702 @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// most recently defined tracepoint.}
12703 (@value{GDBP}) @b{trace foo}
12704 (@value{GDBP}) @b{pass 3}
12705 (@value{GDBP}) @b{trace bar}
12706 (@value{GDBP}) @b{pass 2}
12707 (@value{GDBP}) @b{trace baz}
12708 (@value{GDBP}) @b{pass 1} // Stop tracing when foo has been
12709 @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// executed 3 times OR when bar has}
12710 @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// been executed 2 times}
12711 @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// OR when baz has been executed 1 time.}
12715 @node Tracepoint Conditions
12716 @subsection Tracepoint Conditions
12717 @cindex conditional tracepoints
12718 @cindex tracepoint conditions
12720 The simplest sort of tracepoint collects data every time your program
12721 reaches a specified place. You can also specify a @dfn{condition} for
12722 a tracepoint. A condition is just a Boolean expression in your
12723 programming language (@pxref{Expressions, ,Expressions}). A
12724 tracepoint with a condition evaluates the expression each time your
12725 program reaches it, and data collection happens only if the condition
12728 Tracepoint conditions can be specified when a tracepoint is set, by
12729 using @samp{if} in the arguments to the @code{trace} command.
12730 @xref{Create and Delete Tracepoints, ,Setting Tracepoints}. They can
12731 also be set or changed at any time with the @code{condition} command,
12732 just as with breakpoints.
12734 Unlike breakpoint conditions, @value{GDBN} does not actually evaluate
12735 the conditional expression itself. Instead, @value{GDBN} encodes the
12736 expression into an agent expression (@pxref{Agent Expressions})
12737 suitable for execution on the target, independently of @value{GDBN}.
12738 Global variables become raw memory locations, locals become stack
12739 accesses, and so forth.
12741 For instance, suppose you have a function that is usually called
12742 frequently, but should not be called after an error has occurred. You
12743 could use the following tracepoint command to collect data about calls
12744 of that function that happen while the error code is propagating
12745 through the program; an unconditional tracepoint could end up
12746 collecting thousands of useless trace frames that you would have to
12750 (@value{GDBP}) @kbd{trace normal_operation if errcode > 0}
12753 @node Trace State Variables
12754 @subsection Trace State Variables
12755 @cindex trace state variables
12757 A @dfn{trace state variable} is a special type of variable that is
12758 created and managed by target-side code. The syntax is the same as
12759 that for GDB's convenience variables (a string prefixed with ``$''),
12760 but they are stored on the target. They must be created explicitly,
12761 using a @code{tvariable} command. They are always 64-bit signed
12764 Trace state variables are remembered by @value{GDBN}, and downloaded
12765 to the target along with tracepoint information when the trace
12766 experiment starts. There are no intrinsic limits on the number of
12767 trace state variables, beyond memory limitations of the target.
12769 @cindex convenience variables, and trace state variables
12770 Although trace state variables are managed by the target, you can use
12771 them in print commands and expressions as if they were convenience
12772 variables; @value{GDBN} will get the current value from the target
12773 while the trace experiment is running. Trace state variables share
12774 the same namespace as other ``$'' variables, which means that you
12775 cannot have trace state variables with names like @code{$23} or
12776 @code{$pc}, nor can you have a trace state variable and a convenience
12777 variable with the same name.
12781 @item tvariable $@var{name} [ = @var{expression} ]
12783 The @code{tvariable} command creates a new trace state variable named
12784 @code{$@var{name}}, and optionally gives it an initial value of
12785 @var{expression}. The @var{expression} is evaluated when this command is
12786 entered; the result will be converted to an integer if possible,
12787 otherwise @value{GDBN} will report an error. A subsequent
12788 @code{tvariable} command specifying the same name does not create a
12789 variable, but instead assigns the supplied initial value to the
12790 existing variable of that name, overwriting any previous initial
12791 value. The default initial value is 0.
12793 @item info tvariables
12794 @kindex info tvariables
12795 List all the trace state variables along with their initial values.
12796 Their current values may also be displayed, if the trace experiment is
12799 @item delete tvariable @r{[} $@var{name} @dots{} @r{]}
12800 @kindex delete tvariable
12801 Delete the given trace state variables, or all of them if no arguments
12806 @node Tracepoint Actions
12807 @subsection Tracepoint Action Lists
12811 @cindex tracepoint actions
12812 @item actions @r{[}@var{num}@r{]}
12813 This command will prompt for a list of actions to be taken when the
12814 tracepoint is hit. If the tracepoint number @var{num} is not
12815 specified, this command sets the actions for the one that was most
12816 recently defined (so that you can define a tracepoint and then say
12817 @code{actions} without bothering about its number). You specify the
12818 actions themselves on the following lines, one action at a time, and
12819 terminate the actions list with a line containing just @code{end}. So
12820 far, the only defined actions are @code{collect}, @code{teval}, and
12821 @code{while-stepping}.
12823 @code{actions} is actually equivalent to @code{commands} (@pxref{Break
12824 Commands, ,Breakpoint Command Lists}), except that only the defined
12825 actions are allowed; any other @value{GDBN} command is rejected.
12827 @cindex remove actions from a tracepoint
12828 To remove all actions from a tracepoint, type @samp{actions @var{num}}
12829 and follow it immediately with @samp{end}.
12832 (@value{GDBP}) @b{collect @var{data}} // collect some data
12834 (@value{GDBP}) @b{while-stepping 5} // single-step 5 times, collect data
12836 (@value{GDBP}) @b{end} // signals the end of actions.
12839 In the following example, the action list begins with @code{collect}
12840 commands indicating the things to be collected when the tracepoint is
12841 hit. Then, in order to single-step and collect additional data
12842 following the tracepoint, a @code{while-stepping} command is used,
12843 followed by the list of things to be collected after each step in a
12844 sequence of single steps. The @code{while-stepping} command is
12845 terminated by its own separate @code{end} command. Lastly, the action
12846 list is terminated by an @code{end} command.
12849 (@value{GDBP}) @b{trace foo}
12850 (@value{GDBP}) @b{actions}
12851 Enter actions for tracepoint 1, one per line:
12854 > while-stepping 12
12855 > collect $pc, arr[i]
12860 @kindex collect @r{(tracepoints)}
12861 @item collect@r{[}/@var{mods}@r{]} @var{expr1}, @var{expr2}, @dots{}
12862 Collect values of the given expressions when the tracepoint is hit.
12863 This command accepts a comma-separated list of any valid expressions.
12864 In addition to global, static, or local variables, the following
12865 special arguments are supported:
12869 Collect all registers.
12872 Collect all function arguments.
12875 Collect all local variables.
12878 Collect the return address. This is helpful if you want to see more
12882 Collects the number of arguments from the static probe at which the
12883 tracepoint is located.
12884 @xref{Static Probe Points}.
12886 @item $_probe_arg@var{n}
12887 @var{n} is an integer between 0 and 11. Collects the @var{n}th argument
12888 from the static probe at which the tracepoint is located.
12889 @xref{Static Probe Points}.
12892 @vindex $_sdata@r{, collect}
12893 Collect static tracepoint marker specific data. Only available for
12894 static tracepoints. @xref{Tracepoint Actions,,Tracepoint Action
12895 Lists}. On the UST static tracepoints library backend, an
12896 instrumentation point resembles a @code{printf} function call. The
12897 tracing library is able to collect user specified data formatted to a
12898 character string using the format provided by the programmer that
12899 instrumented the program. Other backends have similar mechanisms.
12900 Here's an example of a UST marker call:
12903 const char master_name[] = "$your_name";
12904 trace_mark(channel1, marker1, "hello %s", master_name)
12907 In this case, collecting @code{$_sdata} collects the string
12908 @samp{hello $yourname}. When analyzing the trace buffer, you can
12909 inspect @samp{$_sdata} like any other variable available to
12913 You can give several consecutive @code{collect} commands, each one
12914 with a single argument, or one @code{collect} command with several
12915 arguments separated by commas; the effect is the same.
12917 The optional @var{mods} changes the usual handling of the arguments.
12918 @code{s} requests that pointers to chars be handled as strings, in
12919 particular collecting the contents of the memory being pointed at, up
12920 to the first zero. The upper bound is by default the value of the
12921 @code{print elements} variable; if @code{s} is followed by a decimal
12922 number, that is the upper bound instead. So for instance
12923 @samp{collect/s25 mystr} collects as many as 25 characters at
12926 The command @code{info scope} (@pxref{Symbols, info scope}) is
12927 particularly useful for figuring out what data to collect.
12929 @kindex teval @r{(tracepoints)}
12930 @item teval @var{expr1}, @var{expr2}, @dots{}
12931 Evaluate the given expressions when the tracepoint is hit. This
12932 command accepts a comma-separated list of expressions. The results
12933 are discarded, so this is mainly useful for assigning values to trace
12934 state variables (@pxref{Trace State Variables}) without adding those
12935 values to the trace buffer, as would be the case if the @code{collect}
12938 @kindex while-stepping @r{(tracepoints)}
12939 @item while-stepping @var{n}
12940 Perform @var{n} single-step instruction traces after the tracepoint,
12941 collecting new data after each step. The @code{while-stepping}
12942 command is followed by the list of what to collect while stepping
12943 (followed by its own @code{end} command):
12946 > while-stepping 12
12947 > collect $regs, myglobal
12953 Note that @code{$pc} is not automatically collected by
12954 @code{while-stepping}; you need to explicitly collect that register if
12955 you need it. You may abbreviate @code{while-stepping} as @code{ws} or
12958 @item set default-collect @var{expr1}, @var{expr2}, @dots{}
12959 @kindex set default-collect
12960 @cindex default collection action
12961 This variable is a list of expressions to collect at each tracepoint
12962 hit. It is effectively an additional @code{collect} action prepended
12963 to every tracepoint action list. The expressions are parsed
12964 individually for each tracepoint, so for instance a variable named
12965 @code{xyz} may be interpreted as a global for one tracepoint, and a
12966 local for another, as appropriate to the tracepoint's location.
12968 @item show default-collect
12969 @kindex show default-collect
12970 Show the list of expressions that are collected by default at each
12975 @node Listing Tracepoints
12976 @subsection Listing Tracepoints
12979 @kindex info tracepoints @r{[}@var{n}@dots{}@r{]}
12980 @kindex info tp @r{[}@var{n}@dots{}@r{]}
12981 @cindex information about tracepoints
12982 @item info tracepoints @r{[}@var{num}@dots{}@r{]}
12983 Display information about the tracepoint @var{num}. If you don't
12984 specify a tracepoint number, displays information about all the
12985 tracepoints defined so far. The format is similar to that used for
12986 @code{info breakpoints}; in fact, @code{info tracepoints} is the same
12987 command, simply restricting itself to tracepoints.
12989 A tracepoint's listing may include additional information specific to
12994 its passcount as given by the @code{passcount @var{n}} command
12997 the state about installed on target of each location
13001 (@value{GDBP}) @b{info trace}
13002 Num Type Disp Enb Address What
13003 1 tracepoint keep y 0x0804ab57 in foo() at main.cxx:7
13005 collect globfoo, $regs
13010 2 tracepoint keep y <MULTIPLE>
13012 2.1 y 0x0804859c in func4 at change-loc.h:35
13013 installed on target
13014 2.2 y 0xb7ffc480 in func4 at change-loc.h:35
13015 installed on target
13016 2.3 y <PENDING> set_tracepoint
13017 3 tracepoint keep y 0x080485b1 in foo at change-loc.c:29
13018 not installed on target
13023 This command can be abbreviated @code{info tp}.
13026 @node Listing Static Tracepoint Markers
13027 @subsection Listing Static Tracepoint Markers
13030 @kindex info static-tracepoint-markers
13031 @cindex information about static tracepoint markers
13032 @item info static-tracepoint-markers
13033 Display information about all static tracepoint markers defined in the
13036 For each marker, the following columns are printed:
13040 An incrementing counter, output to help readability. This is not a
13043 The marker ID, as reported by the target.
13044 @item Enabled or Disabled
13045 Probed markers are tagged with @samp{y}. @samp{n} identifies marks
13046 that are not enabled.
13048 Where the marker is in your program, as a memory address.
13050 Where the marker is in the source for your program, as a file and line
13051 number. If the debug information included in the program does not
13052 allow @value{GDBN} to locate the source of the marker, this column
13053 will be left blank.
13057 In addition, the following information may be printed for each marker:
13061 User data passed to the tracing library by the marker call. In the
13062 UST backend, this is the format string passed as argument to the
13064 @item Static tracepoints probing the marker
13065 The list of static tracepoints attached to the marker.
13069 (@value{GDBP}) info static-tracepoint-markers
13070 Cnt ID Enb Address What
13071 1 ust/bar2 y 0x0000000000400e1a in main at stexample.c:25
13072 Data: number1 %d number2 %d
13073 Probed by static tracepoints: #2
13074 2 ust/bar33 n 0x0000000000400c87 in main at stexample.c:24
13080 @node Starting and Stopping Trace Experiments
13081 @subsection Starting and Stopping Trace Experiments
13084 @kindex tstart [ @var{notes} ]
13085 @cindex start a new trace experiment
13086 @cindex collected data discarded
13088 This command starts the trace experiment, and begins collecting data.
13089 It has the side effect of discarding all the data collected in the
13090 trace buffer during the previous trace experiment. If any arguments
13091 are supplied, they are taken as a note and stored with the trace
13092 experiment's state. The notes may be arbitrary text, and are
13093 especially useful with disconnected tracing in a multi-user context;
13094 the notes can explain what the trace is doing, supply user contact
13095 information, and so forth.
13097 @kindex tstop [ @var{notes} ]
13098 @cindex stop a running trace experiment
13100 This command stops the trace experiment. If any arguments are
13101 supplied, they are recorded with the experiment as a note. This is
13102 useful if you are stopping a trace started by someone else, for
13103 instance if the trace is interfering with the system's behavior and
13104 needs to be stopped quickly.
13106 @strong{Note}: a trace experiment and data collection may stop
13107 automatically if any tracepoint's passcount is reached
13108 (@pxref{Tracepoint Passcounts}), or if the trace buffer becomes full.
13111 @cindex status of trace data collection
13112 @cindex trace experiment, status of
13114 This command displays the status of the current trace data
13118 Here is an example of the commands we described so far:
13121 (@value{GDBP}) @b{trace gdb_c_test}
13122 (@value{GDBP}) @b{actions}
13123 Enter actions for tracepoint #1, one per line.
13124 > collect $regs,$locals,$args
13125 > while-stepping 11
13129 (@value{GDBP}) @b{tstart}
13130 [time passes @dots{}]
13131 (@value{GDBP}) @b{tstop}
13134 @anchor{disconnected tracing}
13135 @cindex disconnected tracing
13136 You can choose to continue running the trace experiment even if
13137 @value{GDBN} disconnects from the target, voluntarily or
13138 involuntarily. For commands such as @code{detach}, the debugger will
13139 ask what you want to do with the trace. But for unexpected
13140 terminations (@value{GDBN} crash, network outage), it would be
13141 unfortunate to lose hard-won trace data, so the variable
13142 @code{disconnected-tracing} lets you decide whether the trace should
13143 continue running without @value{GDBN}.
13146 @item set disconnected-tracing on
13147 @itemx set disconnected-tracing off
13148 @kindex set disconnected-tracing
13149 Choose whether a tracing run should continue to run if @value{GDBN}
13150 has disconnected from the target. Note that @code{detach} or
13151 @code{quit} will ask you directly what to do about a running trace no
13152 matter what this variable's setting, so the variable is mainly useful
13153 for handling unexpected situations, such as loss of the network.
13155 @item show disconnected-tracing
13156 @kindex show disconnected-tracing
13157 Show the current choice for disconnected tracing.
13161 When you reconnect to the target, the trace experiment may or may not
13162 still be running; it might have filled the trace buffer in the
13163 meantime, or stopped for one of the other reasons. If it is running,
13164 it will continue after reconnection.
13166 Upon reconnection, the target will upload information about the
13167 tracepoints in effect. @value{GDBN} will then compare that
13168 information to the set of tracepoints currently defined, and attempt
13169 to match them up, allowing for the possibility that the numbers may
13170 have changed due to creation and deletion in the meantime. If one of
13171 the target's tracepoints does not match any in @value{GDBN}, the
13172 debugger will create a new tracepoint, so that you have a number with
13173 which to specify that tracepoint. This matching-up process is
13174 necessarily heuristic, and it may result in useless tracepoints being
13175 created; you may simply delete them if they are of no use.
13177 @cindex circular trace buffer
13178 If your target agent supports a @dfn{circular trace buffer}, then you
13179 can run a trace experiment indefinitely without filling the trace
13180 buffer; when space runs out, the agent deletes already-collected trace
13181 frames, oldest first, until there is enough room to continue
13182 collecting. This is especially useful if your tracepoints are being
13183 hit too often, and your trace gets terminated prematurely because the
13184 buffer is full. To ask for a circular trace buffer, simply set
13185 @samp{circular-trace-buffer} to on. You can set this at any time,
13186 including during tracing; if the agent can do it, it will change
13187 buffer handling on the fly, otherwise it will not take effect until
13191 @item set circular-trace-buffer on
13192 @itemx set circular-trace-buffer off
13193 @kindex set circular-trace-buffer
13194 Choose whether a tracing run should use a linear or circular buffer
13195 for trace data. A linear buffer will not lose any trace data, but may
13196 fill up prematurely, while a circular buffer will discard old trace
13197 data, but it will have always room for the latest tracepoint hits.
13199 @item show circular-trace-buffer
13200 @kindex show circular-trace-buffer
13201 Show the current choice for the trace buffer. Note that this may not
13202 match the agent's current buffer handling, nor is it guaranteed to
13203 match the setting that might have been in effect during a past run,
13204 for instance if you are looking at frames from a trace file.
13209 @item set trace-buffer-size @var{n}
13210 @itemx set trace-buffer-size unlimited
13211 @kindex set trace-buffer-size
13212 Request that the target use a trace buffer of @var{n} bytes. Not all
13213 targets will honor the request; they may have a compiled-in size for
13214 the trace buffer, or some other limitation. Set to a value of
13215 @code{unlimited} or @code{-1} to let the target use whatever size it
13216 likes. This is also the default.
13218 @item show trace-buffer-size
13219 @kindex show trace-buffer-size
13220 Show the current requested size for the trace buffer. Note that this
13221 will only match the actual size if the target supports size-setting,
13222 and was able to handle the requested size. For instance, if the
13223 target can only change buffer size between runs, this variable will
13224 not reflect the change until the next run starts. Use @code{tstatus}
13225 to get a report of the actual buffer size.
13229 @item set trace-user @var{text}
13230 @kindex set trace-user
13232 @item show trace-user
13233 @kindex show trace-user
13235 @item set trace-notes @var{text}
13236 @kindex set trace-notes
13237 Set the trace run's notes.
13239 @item show trace-notes
13240 @kindex show trace-notes
13241 Show the trace run's notes.
13243 @item set trace-stop-notes @var{text}
13244 @kindex set trace-stop-notes
13245 Set the trace run's stop notes. The handling of the note is as for
13246 @code{tstop} arguments; the set command is convenient way to fix a
13247 stop note that is mistaken or incomplete.
13249 @item show trace-stop-notes
13250 @kindex show trace-stop-notes
13251 Show the trace run's stop notes.
13255 @node Tracepoint Restrictions
13256 @subsection Tracepoint Restrictions
13258 @cindex tracepoint restrictions
13259 There are a number of restrictions on the use of tracepoints. As
13260 described above, tracepoint data gathering occurs on the target
13261 without interaction from @value{GDBN}. Thus the full capabilities of
13262 the debugger are not available during data gathering, and then at data
13263 examination time, you will be limited by only having what was
13264 collected. The following items describe some common problems, but it
13265 is not exhaustive, and you may run into additional difficulties not
13271 Tracepoint expressions are intended to gather objects (lvalues). Thus
13272 the full flexibility of GDB's expression evaluator is not available.
13273 You cannot call functions, cast objects to aggregate types, access
13274 convenience variables or modify values (except by assignment to trace
13275 state variables). Some language features may implicitly call
13276 functions (for instance Objective-C fields with accessors), and therefore
13277 cannot be collected either.
13280 Collection of local variables, either individually or in bulk with
13281 @code{$locals} or @code{$args}, during @code{while-stepping} may
13282 behave erratically. The stepping action may enter a new scope (for
13283 instance by stepping into a function), or the location of the variable
13284 may change (for instance it is loaded into a register). The
13285 tracepoint data recorded uses the location information for the
13286 variables that is correct for the tracepoint location. When the
13287 tracepoint is created, it is not possible, in general, to determine
13288 where the steps of a @code{while-stepping} sequence will advance the
13289 program---particularly if a conditional branch is stepped.
13292 Collection of an incompletely-initialized or partially-destroyed object
13293 may result in something that @value{GDBN} cannot display, or displays
13294 in a misleading way.
13297 When @value{GDBN} displays a pointer to character it automatically
13298 dereferences the pointer to also display characters of the string
13299 being pointed to. However, collecting the pointer during tracing does
13300 not automatically collect the string. You need to explicitly
13301 dereference the pointer and provide size information if you want to
13302 collect not only the pointer, but the memory pointed to. For example,
13303 @code{*ptr@@50} can be used to collect the 50 element array pointed to
13307 It is not possible to collect a complete stack backtrace at a
13308 tracepoint. Instead, you may collect the registers and a few hundred
13309 bytes from the stack pointer with something like @code{*(unsigned char *)$esp@@300}
13310 (adjust to use the name of the actual stack pointer register on your
13311 target architecture, and the amount of stack you wish to capture).
13312 Then the @code{backtrace} command will show a partial backtrace when
13313 using a trace frame. The number of stack frames that can be examined
13314 depends on the sizes of the frames in the collected stack. Note that
13315 if you ask for a block so large that it goes past the bottom of the
13316 stack, the target agent may report an error trying to read from an
13320 If you do not collect registers at a tracepoint, @value{GDBN} can
13321 infer that the value of @code{$pc} must be the same as the address of
13322 the tracepoint and use that when you are looking at a trace frame
13323 for that tracepoint. However, this cannot work if the tracepoint has
13324 multiple locations (for instance if it was set in a function that was
13325 inlined), or if it has a @code{while-stepping} loop. In those cases
13326 @value{GDBN} will warn you that it can't infer @code{$pc}, and default
13331 @node Analyze Collected Data
13332 @section Using the Collected Data
13334 After the tracepoint experiment ends, you use @value{GDBN} commands
13335 for examining the trace data. The basic idea is that each tracepoint
13336 collects a trace @dfn{snapshot} every time it is hit and another
13337 snapshot every time it single-steps. All these snapshots are
13338 consecutively numbered from zero and go into a buffer, and you can
13339 examine them later. The way you examine them is to @dfn{focus} on a
13340 specific trace snapshot. When the remote stub is focused on a trace
13341 snapshot, it will respond to all @value{GDBN} requests for memory and
13342 registers by reading from the buffer which belongs to that snapshot,
13343 rather than from @emph{real} memory or registers of the program being
13344 debugged. This means that @strong{all} @value{GDBN} commands
13345 (@code{print}, @code{info registers}, @code{backtrace}, etc.) will
13346 behave as if we were currently debugging the program state as it was
13347 when the tracepoint occurred. Any requests for data that are not in
13348 the buffer will fail.
13351 * tfind:: How to select a trace snapshot
13352 * tdump:: How to display all data for a snapshot
13353 * save tracepoints:: How to save tracepoints for a future run
13357 @subsection @code{tfind @var{n}}
13360 @cindex select trace snapshot
13361 @cindex find trace snapshot
13362 The basic command for selecting a trace snapshot from the buffer is
13363 @code{tfind @var{n}}, which finds trace snapshot number @var{n},
13364 counting from zero. If no argument @var{n} is given, the next
13365 snapshot is selected.
13367 Here are the various forms of using the @code{tfind} command.
13371 Find the first snapshot in the buffer. This is a synonym for
13372 @code{tfind 0} (since 0 is the number of the first snapshot).
13375 Stop debugging trace snapshots, resume @emph{live} debugging.
13378 Same as @samp{tfind none}.
13381 No argument means find the next trace snapshot.
13384 Find the previous trace snapshot before the current one. This permits
13385 retracing earlier steps.
13387 @item tfind tracepoint @var{num}
13388 Find the next snapshot associated with tracepoint @var{num}. Search
13389 proceeds forward from the last examined trace snapshot. If no
13390 argument @var{num} is given, it means find the next snapshot collected
13391 for the same tracepoint as the current snapshot.
13393 @item tfind pc @var{addr}
13394 Find the next snapshot associated with the value @var{addr} of the
13395 program counter. Search proceeds forward from the last examined trace
13396 snapshot. If no argument @var{addr} is given, it means find the next
13397 snapshot with the same value of PC as the current snapshot.
13399 @item tfind outside @var{addr1}, @var{addr2}
13400 Find the next snapshot whose PC is outside the given range of
13401 addresses (exclusive).
13403 @item tfind range @var{addr1}, @var{addr2}
13404 Find the next snapshot whose PC is between @var{addr1} and
13405 @var{addr2} (inclusive).
13407 @item tfind line @r{[}@var{file}:@r{]}@var{n}
13408 Find the next snapshot associated with the source line @var{n}. If
13409 the optional argument @var{file} is given, refer to line @var{n} in
13410 that source file. Search proceeds forward from the last examined
13411 trace snapshot. If no argument @var{n} is given, it means find the
13412 next line other than the one currently being examined; thus saying
13413 @code{tfind line} repeatedly can appear to have the same effect as
13414 stepping from line to line in a @emph{live} debugging session.
13417 The default arguments for the @code{tfind} commands are specifically
13418 designed to make it easy to scan through the trace buffer. For
13419 instance, @code{tfind} with no argument selects the next trace
13420 snapshot, and @code{tfind -} with no argument selects the previous
13421 trace snapshot. So, by giving one @code{tfind} command, and then
13422 simply hitting @key{RET} repeatedly you can examine all the trace
13423 snapshots in order. Or, by saying @code{tfind -} and then hitting
13424 @key{RET} repeatedly you can examine the snapshots in reverse order.
13425 The @code{tfind line} command with no argument selects the snapshot
13426 for the next source line executed. The @code{tfind pc} command with
13427 no argument selects the next snapshot with the same program counter
13428 (PC) as the current frame. The @code{tfind tracepoint} command with
13429 no argument selects the next trace snapshot collected by the same
13430 tracepoint as the current one.
13432 In addition to letting you scan through the trace buffer manually,
13433 these commands make it easy to construct @value{GDBN} scripts that
13434 scan through the trace buffer and print out whatever collected data
13435 you are interested in. Thus, if we want to examine the PC, FP, and SP
13436 registers from each trace frame in the buffer, we can say this:
13439 (@value{GDBP}) @b{tfind start}
13440 (@value{GDBP}) @b{while ($trace_frame != -1)}
13441 > printf "Frame %d, PC = %08X, SP = %08X, FP = %08X\n", \
13442 $trace_frame, $pc, $sp, $fp
13446 Frame 0, PC = 0020DC64, SP = 0030BF3C, FP = 0030BF44
13447 Frame 1, PC = 0020DC6C, SP = 0030BF38, FP = 0030BF44
13448 Frame 2, PC = 0020DC70, SP = 0030BF34, FP = 0030BF44
13449 Frame 3, PC = 0020DC74, SP = 0030BF30, FP = 0030BF44
13450 Frame 4, PC = 0020DC78, SP = 0030BF2C, FP = 0030BF44
13451 Frame 5, PC = 0020DC7C, SP = 0030BF28, FP = 0030BF44
13452 Frame 6, PC = 0020DC80, SP = 0030BF24, FP = 0030BF44
13453 Frame 7, PC = 0020DC84, SP = 0030BF20, FP = 0030BF44
13454 Frame 8, PC = 0020DC88, SP = 0030BF1C, FP = 0030BF44
13455 Frame 9, PC = 0020DC8E, SP = 0030BF18, FP = 0030BF44
13456 Frame 10, PC = 00203F6C, SP = 0030BE3C, FP = 0030BF14
13459 Or, if we want to examine the variable @code{X} at each source line in
13463 (@value{GDBP}) @b{tfind start}
13464 (@value{GDBP}) @b{while ($trace_frame != -1)}
13465 > printf "Frame %d, X == %d\n", $trace_frame, X
13475 @subsection @code{tdump}
13477 @cindex dump all data collected at tracepoint
13478 @cindex tracepoint data, display
13480 This command takes no arguments. It prints all the data collected at
13481 the current trace snapshot.
13484 (@value{GDBP}) @b{trace 444}
13485 (@value{GDBP}) @b{actions}
13486 Enter actions for tracepoint #2, one per line:
13487 > collect $regs, $locals, $args, gdb_long_test
13490 (@value{GDBP}) @b{tstart}
13492 (@value{GDBP}) @b{tfind line 444}
13493 #0 gdb_test (p1=0x11, p2=0x22, p3=0x33, p4=0x44, p5=0x55, p6=0x66)
13495 444 printp( "%s: arguments = 0x%X 0x%X 0x%X 0x%X 0x%X 0x%X\n", )
13497 (@value{GDBP}) @b{tdump}
13498 Data collected at tracepoint 2, trace frame 1:
13499 d0 0xc4aa0085 -995491707
13503 d4 0x71aea3d 119204413
13506 d7 0x380035 3670069
13507 a0 0x19e24a 1696330
13508 a1 0x3000668 50333288
13510 a3 0x322000 3284992
13511 a4 0x3000698 50333336
13512 a5 0x1ad3cc 1758156
13513 fp 0x30bf3c 0x30bf3c
13514 sp 0x30bf34 0x30bf34
13516 pc 0x20b2c8 0x20b2c8
13520 p = 0x20e5b4 "gdb-test"
13527 gdb_long_test = 17 '\021'
13532 @code{tdump} works by scanning the tracepoint's current collection
13533 actions and printing the value of each expression listed. So
13534 @code{tdump} can fail, if after a run, you change the tracepoint's
13535 actions to mention variables that were not collected during the run.
13537 Also, for tracepoints with @code{while-stepping} loops, @code{tdump}
13538 uses the collected value of @code{$pc} to distinguish between trace
13539 frames that were collected at the tracepoint hit, and frames that were
13540 collected while stepping. This allows it to correctly choose whether
13541 to display the basic list of collections, or the collections from the
13542 body of the while-stepping loop. However, if @code{$pc} was not collected,
13543 then @code{tdump} will always attempt to dump using the basic collection
13544 list, and may fail if a while-stepping frame does not include all the
13545 same data that is collected at the tracepoint hit.
13546 @c This is getting pretty arcane, example would be good.
13548 @node save tracepoints
13549 @subsection @code{save tracepoints @var{filename}}
13550 @kindex save tracepoints
13551 @kindex save-tracepoints
13552 @cindex save tracepoints for future sessions
13554 This command saves all current tracepoint definitions together with
13555 their actions and passcounts, into a file @file{@var{filename}}
13556 suitable for use in a later debugging session. To read the saved
13557 tracepoint definitions, use the @code{source} command (@pxref{Command
13558 Files}). The @w{@code{save-tracepoints}} command is a deprecated
13559 alias for @w{@code{save tracepoints}}
13561 @node Tracepoint Variables
13562 @section Convenience Variables for Tracepoints
13563 @cindex tracepoint variables
13564 @cindex convenience variables for tracepoints
13567 @vindex $trace_frame
13568 @item (int) $trace_frame
13569 The current trace snapshot (a.k.a.@: @dfn{frame}) number, or -1 if no
13570 snapshot is selected.
13572 @vindex $tracepoint
13573 @item (int) $tracepoint
13574 The tracepoint for the current trace snapshot.
13576 @vindex $trace_line
13577 @item (int) $trace_line
13578 The line number for the current trace snapshot.
13580 @vindex $trace_file
13581 @item (char []) $trace_file
13582 The source file for the current trace snapshot.
13584 @vindex $trace_func
13585 @item (char []) $trace_func
13586 The name of the function containing @code{$tracepoint}.
13589 Note: @code{$trace_file} is not suitable for use in @code{printf},
13590 use @code{output} instead.
13592 Here's a simple example of using these convenience variables for
13593 stepping through all the trace snapshots and printing some of their
13594 data. Note that these are not the same as trace state variables,
13595 which are managed by the target.
13598 (@value{GDBP}) @b{tfind start}
13600 (@value{GDBP}) @b{while $trace_frame != -1}
13601 > output $trace_file
13602 > printf ", line %d (tracepoint #%d)\n", $trace_line, $tracepoint
13608 @section Using Trace Files
13609 @cindex trace files
13611 In some situations, the target running a trace experiment may no
13612 longer be available; perhaps it crashed, or the hardware was needed
13613 for a different activity. To handle these cases, you can arrange to
13614 dump the trace data into a file, and later use that file as a source
13615 of trace data, via the @code{target tfile} command.
13620 @item tsave [ -r ] @var{filename}
13621 @itemx tsave [-ctf] @var{dirname}
13622 Save the trace data to @var{filename}. By default, this command
13623 assumes that @var{filename} refers to the host filesystem, so if
13624 necessary @value{GDBN} will copy raw trace data up from the target and
13625 then save it. If the target supports it, you can also supply the
13626 optional argument @code{-r} (``remote'') to direct the target to save
13627 the data directly into @var{filename} in its own filesystem, which may be
13628 more efficient if the trace buffer is very large. (Note, however, that
13629 @code{target tfile} can only read from files accessible to the host.)
13630 By default, this command will save trace frame in tfile format.
13631 You can supply the optional argument @code{-ctf} to save date in CTF
13632 format. The @dfn{Common Trace Format} (CTF) is proposed as a trace format
13633 that can be shared by multiple debugging and tracing tools. Please go to
13634 @indicateurl{http://www.efficios.com/ctf} to get more information.
13636 @kindex target tfile
13640 @item target tfile @var{filename}
13641 @itemx target ctf @var{dirname}
13642 Use the file named @var{filename} or directory named @var{dirname} as
13643 a source of trace data. Commands that examine data work as they do with
13644 a live target, but it is not possible to run any new trace experiments.
13645 @code{tstatus} will report the state of the trace run at the moment
13646 the data was saved, as well as the current trace frame you are examining.
13647 Both @var{filename} and @var{dirname} must be on a filesystem accessible to
13651 (@value{GDBP}) target ctf ctf.ctf
13652 (@value{GDBP}) tfind
13653 Found trace frame 0, tracepoint 2
13654 39 ++a; /* set tracepoint 1 here */
13655 (@value{GDBP}) tdump
13656 Data collected at tracepoint 2, trace frame 0:
13660 c = @{"123", "456", "789", "123", "456", "789"@}
13661 d = @{@{@{a = 1, b = 2@}, @{a = 3, b = 4@}@}, @{@{a = 5, b = 6@}, @{a = 7, b = 8@}@}@}
13669 @chapter Debugging Programs That Use Overlays
13672 If your program is too large to fit completely in your target system's
13673 memory, you can sometimes use @dfn{overlays} to work around this
13674 problem. @value{GDBN} provides some support for debugging programs that
13678 * How Overlays Work:: A general explanation of overlays.
13679 * Overlay Commands:: Managing overlays in @value{GDBN}.
13680 * Automatic Overlay Debugging:: @value{GDBN} can find out which overlays are
13681 mapped by asking the inferior.
13682 * Overlay Sample Program:: A sample program using overlays.
13685 @node How Overlays Work
13686 @section How Overlays Work
13687 @cindex mapped overlays
13688 @cindex unmapped overlays
13689 @cindex load address, overlay's
13690 @cindex mapped address
13691 @cindex overlay area
13693 Suppose you have a computer whose instruction address space is only 64
13694 kilobytes long, but which has much more memory which can be accessed by
13695 other means: special instructions, segment registers, or memory
13696 management hardware, for example. Suppose further that you want to
13697 adapt a program which is larger than 64 kilobytes to run on this system.
13699 One solution is to identify modules of your program which are relatively
13700 independent, and need not call each other directly; call these modules
13701 @dfn{overlays}. Separate the overlays from the main program, and place
13702 their machine code in the larger memory. Place your main program in
13703 instruction memory, but leave at least enough space there to hold the
13704 largest overlay as well.
13706 Now, to call a function located in an overlay, you must first copy that
13707 overlay's machine code from the large memory into the space set aside
13708 for it in the instruction memory, and then jump to its entry point
13711 @c NB: In the below the mapped area's size is greater or equal to the
13712 @c size of all overlays. This is intentional to remind the developer
13713 @c that overlays don't necessarily need to be the same size.
13717 Data Instruction Larger
13718 Address Space Address Space Address Space
13719 +-----------+ +-----------+ +-----------+
13721 +-----------+ +-----------+ +-----------+<-- overlay 1
13722 | program | | main | .----| overlay 1 | load address
13723 | variables | | program | | +-----------+
13724 | and heap | | | | | |
13725 +-----------+ | | | +-----------+<-- overlay 2
13726 | | +-----------+ | | | load address
13727 +-----------+ | | | .-| overlay 2 |
13729 mapped --->+-----------+ | | +-----------+
13730 address | | | | | |
13731 | overlay | <-' | | |
13732 | area | <---' +-----------+<-- overlay 3
13733 | | <---. | | load address
13734 +-----------+ `--| overlay 3 |
13741 @anchor{A code overlay}A code overlay
13745 The diagram (@pxref{A code overlay}) shows a system with separate data
13746 and instruction address spaces. To map an overlay, the program copies
13747 its code from the larger address space to the instruction address space.
13748 Since the overlays shown here all use the same mapped address, only one
13749 may be mapped at a time. For a system with a single address space for
13750 data and instructions, the diagram would be similar, except that the
13751 program variables and heap would share an address space with the main
13752 program and the overlay area.
13754 An overlay loaded into instruction memory and ready for use is called a
13755 @dfn{mapped} overlay; its @dfn{mapped address} is its address in the
13756 instruction memory. An overlay not present (or only partially present)
13757 in instruction memory is called @dfn{unmapped}; its @dfn{load address}
13758 is its address in the larger memory. The mapped address is also called
13759 the @dfn{virtual memory address}, or @dfn{VMA}; the load address is also
13760 called the @dfn{load memory address}, or @dfn{LMA}.
13762 Unfortunately, overlays are not a completely transparent way to adapt a
13763 program to limited instruction memory. They introduce a new set of
13764 global constraints you must keep in mind as you design your program:
13769 Before calling or returning to a function in an overlay, your program
13770 must make sure that overlay is actually mapped. Otherwise, the call or
13771 return will transfer control to the right address, but in the wrong
13772 overlay, and your program will probably crash.
13775 If the process of mapping an overlay is expensive on your system, you
13776 will need to choose your overlays carefully to minimize their effect on
13777 your program's performance.
13780 The executable file you load onto your system must contain each
13781 overlay's instructions, appearing at the overlay's load address, not its
13782 mapped address. However, each overlay's instructions must be relocated
13783 and its symbols defined as if the overlay were at its mapped address.
13784 You can use GNU linker scripts to specify different load and relocation
13785 addresses for pieces of your program; see @ref{Overlay Description,,,
13786 ld.info, Using ld: the GNU linker}.
13789 The procedure for loading executable files onto your system must be able
13790 to load their contents into the larger address space as well as the
13791 instruction and data spaces.
13795 The overlay system described above is rather simple, and could be
13796 improved in many ways:
13801 If your system has suitable bank switch registers or memory management
13802 hardware, you could use those facilities to make an overlay's load area
13803 contents simply appear at their mapped address in instruction space.
13804 This would probably be faster than copying the overlay to its mapped
13805 area in the usual way.
13808 If your overlays are small enough, you could set aside more than one
13809 overlay area, and have more than one overlay mapped at a time.
13812 You can use overlays to manage data, as well as instructions. In
13813 general, data overlays are even less transparent to your design than
13814 code overlays: whereas code overlays only require care when you call or
13815 return to functions, data overlays require care every time you access
13816 the data. Also, if you change the contents of a data overlay, you
13817 must copy its contents back out to its load address before you can copy a
13818 different data overlay into the same mapped area.
13823 @node Overlay Commands
13824 @section Overlay Commands
13826 To use @value{GDBN}'s overlay support, each overlay in your program must
13827 correspond to a separate section of the executable file. The section's
13828 virtual memory address and load memory address must be the overlay's
13829 mapped and load addresses. Identifying overlays with sections allows
13830 @value{GDBN} to determine the appropriate address of a function or
13831 variable, depending on whether the overlay is mapped or not.
13833 @value{GDBN}'s overlay commands all start with the word @code{overlay};
13834 you can abbreviate this as @code{ov} or @code{ovly}. The commands are:
13839 Disable @value{GDBN}'s overlay support. When overlay support is
13840 disabled, @value{GDBN} assumes that all functions and variables are
13841 always present at their mapped addresses. By default, @value{GDBN}'s
13842 overlay support is disabled.
13844 @item overlay manual
13845 @cindex manual overlay debugging
13846 Enable @dfn{manual} overlay debugging. In this mode, @value{GDBN}
13847 relies on you to tell it which overlays are mapped, and which are not,
13848 using the @code{overlay map-overlay} and @code{overlay unmap-overlay}
13849 commands described below.
13851 @item overlay map-overlay @var{overlay}
13852 @itemx overlay map @var{overlay}
13853 @cindex map an overlay
13854 Tell @value{GDBN} that @var{overlay} is now mapped; @var{overlay} must
13855 be the name of the object file section containing the overlay. When an
13856 overlay is mapped, @value{GDBN} assumes it can find the overlay's
13857 functions and variables at their mapped addresses. @value{GDBN} assumes
13858 that any other overlays whose mapped ranges overlap that of
13859 @var{overlay} are now unmapped.
13861 @item overlay unmap-overlay @var{overlay}
13862 @itemx overlay unmap @var{overlay}
13863 @cindex unmap an overlay
13864 Tell @value{GDBN} that @var{overlay} is no longer mapped; @var{overlay}
13865 must be the name of the object file section containing the overlay.
13866 When an overlay is unmapped, @value{GDBN} assumes it can find the
13867 overlay's functions and variables at their load addresses.
13870 Enable @dfn{automatic} overlay debugging. In this mode, @value{GDBN}
13871 consults a data structure the overlay manager maintains in the inferior
13872 to see which overlays are mapped. For details, see @ref{Automatic
13873 Overlay Debugging}.
13875 @item overlay load-target
13876 @itemx overlay load
13877 @cindex reloading the overlay table
13878 Re-read the overlay table from the inferior. Normally, @value{GDBN}
13879 re-reads the table @value{GDBN} automatically each time the inferior
13880 stops, so this command should only be necessary if you have changed the
13881 overlay mapping yourself using @value{GDBN}. This command is only
13882 useful when using automatic overlay debugging.
13884 @item overlay list-overlays
13885 @itemx overlay list
13886 @cindex listing mapped overlays
13887 Display a list of the overlays currently mapped, along with their mapped
13888 addresses, load addresses, and sizes.
13892 Normally, when @value{GDBN} prints a code address, it includes the name
13893 of the function the address falls in:
13896 (@value{GDBP}) print main
13897 $3 = @{int ()@} 0x11a0 <main>
13900 When overlay debugging is enabled, @value{GDBN} recognizes code in
13901 unmapped overlays, and prints the names of unmapped functions with
13902 asterisks around them. For example, if @code{foo} is a function in an
13903 unmapped overlay, @value{GDBN} prints it this way:
13906 (@value{GDBP}) overlay list
13907 No sections are mapped.
13908 (@value{GDBP}) print foo
13909 $5 = @{int (int)@} 0x100000 <*foo*>
13912 When @code{foo}'s overlay is mapped, @value{GDBN} prints the function's
13916 (@value{GDBP}) overlay list
13917 Section .ov.foo.text, loaded at 0x100000 - 0x100034,
13918 mapped at 0x1016 - 0x104a
13919 (@value{GDBP}) print foo
13920 $6 = @{int (int)@} 0x1016 <foo>
13923 When overlay debugging is enabled, @value{GDBN} can find the correct
13924 address for functions and variables in an overlay, whether or not the
13925 overlay is mapped. This allows most @value{GDBN} commands, like
13926 @code{break} and @code{disassemble}, to work normally, even on unmapped
13927 code. However, @value{GDBN}'s breakpoint support has some limitations:
13931 @cindex breakpoints in overlays
13932 @cindex overlays, setting breakpoints in
13933 You can set breakpoints in functions in unmapped overlays, as long as
13934 @value{GDBN} can write to the overlay at its load address.
13936 @value{GDBN} can not set hardware or simulator-based breakpoints in
13937 unmapped overlays. However, if you set a breakpoint at the end of your
13938 overlay manager (and tell @value{GDBN} which overlays are now mapped, if
13939 you are using manual overlay management), @value{GDBN} will re-set its
13940 breakpoints properly.
13944 @node Automatic Overlay Debugging
13945 @section Automatic Overlay Debugging
13946 @cindex automatic overlay debugging
13948 @value{GDBN} can automatically track which overlays are mapped and which
13949 are not, given some simple co-operation from the overlay manager in the
13950 inferior. If you enable automatic overlay debugging with the
13951 @code{overlay auto} command (@pxref{Overlay Commands}), @value{GDBN}
13952 looks in the inferior's memory for certain variables describing the
13953 current state of the overlays.
13955 Here are the variables your overlay manager must define to support
13956 @value{GDBN}'s automatic overlay debugging:
13960 @item @code{_ovly_table}:
13961 This variable must be an array of the following structures:
13966 /* The overlay's mapped address. */
13969 /* The size of the overlay, in bytes. */
13970 unsigned long size;
13972 /* The overlay's load address. */
13975 /* Non-zero if the overlay is currently mapped;
13977 unsigned long mapped;
13981 @item @code{_novlys}:
13982 This variable must be a four-byte signed integer, holding the total
13983 number of elements in @code{_ovly_table}.
13987 To decide whether a particular overlay is mapped or not, @value{GDBN}
13988 looks for an entry in @w{@code{_ovly_table}} whose @code{vma} and
13989 @code{lma} members equal the VMA and LMA of the overlay's section in the
13990 executable file. When @value{GDBN} finds a matching entry, it consults
13991 the entry's @code{mapped} member to determine whether the overlay is
13994 In addition, your overlay manager may define a function called
13995 @code{_ovly_debug_event}. If this function is defined, @value{GDBN}
13996 will silently set a breakpoint there. If the overlay manager then
13997 calls this function whenever it has changed the overlay table, this
13998 will enable @value{GDBN} to accurately keep track of which overlays
13999 are in program memory, and update any breakpoints that may be set
14000 in overlays. This will allow breakpoints to work even if the
14001 overlays are kept in ROM or other non-writable memory while they
14002 are not being executed.
14004 @node Overlay Sample Program
14005 @section Overlay Sample Program
14006 @cindex overlay example program
14008 When linking a program which uses overlays, you must place the overlays
14009 at their load addresses, while relocating them to run at their mapped
14010 addresses. To do this, you must write a linker script (@pxref{Overlay
14011 Description,,, ld.info, Using ld: the GNU linker}). Unfortunately,
14012 since linker scripts are specific to a particular host system, target
14013 architecture, and target memory layout, this manual cannot provide
14014 portable sample code demonstrating @value{GDBN}'s overlay support.
14016 However, the @value{GDBN} source distribution does contain an overlaid
14017 program, with linker scripts for a few systems, as part of its test
14018 suite. The program consists of the following files from
14019 @file{gdb/testsuite/gdb.base}:
14023 The main program file.
14025 A simple overlay manager, used by @file{overlays.c}.
14030 Overlay modules, loaded and used by @file{overlays.c}.
14033 Linker scripts for linking the test program on the @code{d10v-elf}
14034 and @code{m32r-elf} targets.
14037 You can build the test program using the @code{d10v-elf} GCC
14038 cross-compiler like this:
14041 $ d10v-elf-gcc -g -c overlays.c
14042 $ d10v-elf-gcc -g -c ovlymgr.c
14043 $ d10v-elf-gcc -g -c foo.c
14044 $ d10v-elf-gcc -g -c bar.c
14045 $ d10v-elf-gcc -g -c baz.c
14046 $ d10v-elf-gcc -g -c grbx.c
14047 $ d10v-elf-gcc -g overlays.o ovlymgr.o foo.o bar.o \
14048 baz.o grbx.o -Wl,-Td10v.ld -o overlays
14051 The build process is identical for any other architecture, except that
14052 you must substitute the appropriate compiler and linker script for the
14053 target system for @code{d10v-elf-gcc} and @code{d10v.ld}.
14057 @chapter Using @value{GDBN} with Different Languages
14060 Although programming languages generally have common aspects, they are
14061 rarely expressed in the same manner. For instance, in ANSI C,
14062 dereferencing a pointer @code{p} is accomplished by @code{*p}, but in
14063 Modula-2, it is accomplished by @code{p^}. Values can also be
14064 represented (and displayed) differently. Hex numbers in C appear as
14065 @samp{0x1ae}, while in Modula-2 they appear as @samp{1AEH}.
14067 @cindex working language
14068 Language-specific information is built into @value{GDBN} for some languages,
14069 allowing you to express operations like the above in your program's
14070 native language, and allowing @value{GDBN} to output values in a manner
14071 consistent with the syntax of your program's native language. The
14072 language you use to build expressions is called the @dfn{working
14076 * Setting:: Switching between source languages
14077 * Show:: Displaying the language
14078 * Checks:: Type and range checks
14079 * Supported Languages:: Supported languages
14080 * Unsupported Languages:: Unsupported languages
14084 @section Switching Between Source Languages
14086 There are two ways to control the working language---either have @value{GDBN}
14087 set it automatically, or select it manually yourself. You can use the
14088 @code{set language} command for either purpose. On startup, @value{GDBN}
14089 defaults to setting the language automatically. The working language is
14090 used to determine how expressions you type are interpreted, how values
14093 In addition to the working language, every source file that
14094 @value{GDBN} knows about has its own working language. For some object
14095 file formats, the compiler might indicate which language a particular
14096 source file is in. However, most of the time @value{GDBN} infers the
14097 language from the name of the file. The language of a source file
14098 controls whether C@t{++} names are demangled---this way @code{backtrace} can
14099 show each frame appropriately for its own language. There is no way to
14100 set the language of a source file from within @value{GDBN}, but you can
14101 set the language associated with a filename extension. @xref{Show, ,
14102 Displaying the Language}.
14104 This is most commonly a problem when you use a program, such
14105 as @code{cfront} or @code{f2c}, that generates C but is written in
14106 another language. In that case, make the
14107 program use @code{#line} directives in its C output; that way
14108 @value{GDBN} will know the correct language of the source code of the original
14109 program, and will display that source code, not the generated C code.
14112 * Filenames:: Filename extensions and languages.
14113 * Manually:: Setting the working language manually
14114 * Automatically:: Having @value{GDBN} infer the source language
14118 @subsection List of Filename Extensions and Languages
14120 If a source file name ends in one of the following extensions, then
14121 @value{GDBN} infers that its language is the one indicated.
14139 C@t{++} source file
14145 Objective-C source file
14149 Fortran source file
14152 Modula-2 source file
14156 Assembler source file. This actually behaves almost like C, but
14157 @value{GDBN} does not skip over function prologues when stepping.
14160 In addition, you may set the language associated with a filename
14161 extension. @xref{Show, , Displaying the Language}.
14164 @subsection Setting the Working Language
14166 If you allow @value{GDBN} to set the language automatically,
14167 expressions are interpreted the same way in your debugging session and
14170 @kindex set language
14171 If you wish, you may set the language manually. To do this, issue the
14172 command @samp{set language @var{lang}}, where @var{lang} is the name of
14173 a language, such as
14174 @code{c} or @code{modula-2}.
14175 For a list of the supported languages, type @samp{set language}.
14177 Setting the language manually prevents @value{GDBN} from updating the working
14178 language automatically. This can lead to confusion if you try
14179 to debug a program when the working language is not the same as the
14180 source language, when an expression is acceptable to both
14181 languages---but means different things. For instance, if the current
14182 source file were written in C, and @value{GDBN} was parsing Modula-2, a
14190 might not have the effect you intended. In C, this means to add
14191 @code{b} and @code{c} and place the result in @code{a}. The result
14192 printed would be the value of @code{a}. In Modula-2, this means to compare
14193 @code{a} to the result of @code{b+c}, yielding a @code{BOOLEAN} value.
14195 @node Automatically
14196 @subsection Having @value{GDBN} Infer the Source Language
14198 To have @value{GDBN} set the working language automatically, use
14199 @samp{set language local} or @samp{set language auto}. @value{GDBN}
14200 then infers the working language. That is, when your program stops in a
14201 frame (usually by encountering a breakpoint), @value{GDBN} sets the
14202 working language to the language recorded for the function in that
14203 frame. If the language for a frame is unknown (that is, if the function
14204 or block corresponding to the frame was defined in a source file that
14205 does not have a recognized extension), the current working language is
14206 not changed, and @value{GDBN} issues a warning.
14208 This may not seem necessary for most programs, which are written
14209 entirely in one source language. However, program modules and libraries
14210 written in one source language can be used by a main program written in
14211 a different source language. Using @samp{set language auto} in this
14212 case frees you from having to set the working language manually.
14215 @section Displaying the Language
14217 The following commands help you find out which language is the
14218 working language, and also what language source files were written in.
14221 @item show language
14222 @anchor{show language}
14223 @kindex show language
14224 Display the current working language. This is the
14225 language you can use with commands such as @code{print} to
14226 build and compute expressions that may involve variables in your program.
14229 @kindex info frame@r{, show the source language}
14230 Display the source language for this frame. This language becomes the
14231 working language if you use an identifier from this frame.
14232 @xref{Frame Info, ,Information about a Frame}, to identify the other
14233 information listed here.
14236 @kindex info source@r{, show the source language}
14237 Display the source language of this source file.
14238 @xref{Symbols, ,Examining the Symbol Table}, to identify the other
14239 information listed here.
14242 In unusual circumstances, you may have source files with extensions
14243 not in the standard list. You can then set the extension associated
14244 with a language explicitly:
14247 @item set extension-language @var{ext} @var{language}
14248 @kindex set extension-language
14249 Tell @value{GDBN} that source files with extension @var{ext} are to be
14250 assumed as written in the source language @var{language}.
14252 @item info extensions
14253 @kindex info extensions
14254 List all the filename extensions and the associated languages.
14258 @section Type and Range Checking
14260 Some languages are designed to guard you against making seemingly common
14261 errors through a series of compile- and run-time checks. These include
14262 checking the type of arguments to functions and operators and making
14263 sure mathematical overflows are caught at run time. Checks such as
14264 these help to ensure a program's correctness once it has been compiled
14265 by eliminating type mismatches and providing active checks for range
14266 errors when your program is running.
14268 By default @value{GDBN} checks for these errors according to the
14269 rules of the current source language. Although @value{GDBN} does not check
14270 the statements in your program, it can check expressions entered directly
14271 into @value{GDBN} for evaluation via the @code{print} command, for example.
14274 * Type Checking:: An overview of type checking
14275 * Range Checking:: An overview of range checking
14278 @cindex type checking
14279 @cindex checks, type
14280 @node Type Checking
14281 @subsection An Overview of Type Checking
14283 Some languages, such as C and C@t{++}, are strongly typed, meaning that the
14284 arguments to operators and functions have to be of the correct type,
14285 otherwise an error occurs. These checks prevent type mismatch
14286 errors from ever causing any run-time problems. For example,
14289 int klass::my_method(char *b) @{ return b ? 1 : 2; @}
14291 (@value{GDBP}) print obj.my_method (0)
14294 (@value{GDBP}) print obj.my_method (0x1234)
14295 Cannot resolve method klass::my_method to any overloaded instance
14298 The second example fails because in C@t{++} the integer constant
14299 @samp{0x1234} is not type-compatible with the pointer parameter type.
14301 For the expressions you use in @value{GDBN} commands, you can tell
14302 @value{GDBN} to not enforce strict type checking or
14303 to treat any mismatches as errors and abandon the expression;
14304 When type checking is disabled, @value{GDBN} successfully evaluates
14305 expressions like the second example above.
14307 Even if type checking is off, there may be other reasons
14308 related to type that prevent @value{GDBN} from evaluating an expression.
14309 For instance, @value{GDBN} does not know how to add an @code{int} and
14310 a @code{struct foo}. These particular type errors have nothing to do
14311 with the language in use and usually arise from expressions which make
14312 little sense to evaluate anyway.
14314 @value{GDBN} provides some additional commands for controlling type checking:
14316 @kindex set check type
14317 @kindex show check type
14319 @item set check type on
14320 @itemx set check type off
14321 Set strict type checking on or off. If any type mismatches occur in
14322 evaluating an expression while type checking is on, @value{GDBN} prints a
14323 message and aborts evaluation of the expression.
14325 @item show check type
14326 Show the current setting of type checking and whether @value{GDBN}
14327 is enforcing strict type checking rules.
14330 @cindex range checking
14331 @cindex checks, range
14332 @node Range Checking
14333 @subsection An Overview of Range Checking
14335 In some languages (such as Modula-2), it is an error to exceed the
14336 bounds of a type; this is enforced with run-time checks. Such range
14337 checking is meant to ensure program correctness by making sure
14338 computations do not overflow, or indices on an array element access do
14339 not exceed the bounds of the array.
14341 For expressions you use in @value{GDBN} commands, you can tell
14342 @value{GDBN} to treat range errors in one of three ways: ignore them,
14343 always treat them as errors and abandon the expression, or issue
14344 warnings but evaluate the expression anyway.
14346 A range error can result from numerical overflow, from exceeding an
14347 array index bound, or when you type a constant that is not a member
14348 of any type. Some languages, however, do not treat overflows as an
14349 error. In many implementations of C, mathematical overflow causes the
14350 result to ``wrap around'' to lower values---for example, if @var{m} is
14351 the largest integer value, and @var{s} is the smallest, then
14354 @var{m} + 1 @result{} @var{s}
14357 This, too, is specific to individual languages, and in some cases
14358 specific to individual compilers or machines. @xref{Supported Languages, ,
14359 Supported Languages}, for further details on specific languages.
14361 @value{GDBN} provides some additional commands for controlling the range checker:
14363 @kindex set check range
14364 @kindex show check range
14366 @item set check range auto
14367 Set range checking on or off based on the current working language.
14368 @xref{Supported Languages, ,Supported Languages}, for the default settings for
14371 @item set check range on
14372 @itemx set check range off
14373 Set range checking on or off, overriding the default setting for the
14374 current working language. A warning is issued if the setting does not
14375 match the language default. If a range error occurs and range checking is on,
14376 then a message is printed and evaluation of the expression is aborted.
14378 @item set check range warn
14379 Output messages when the @value{GDBN} range checker detects a range error,
14380 but attempt to evaluate the expression anyway. Evaluating the
14381 expression may still be impossible for other reasons, such as accessing
14382 memory that the process does not own (a typical example from many Unix
14386 Show the current setting of the range checker, and whether or not it is
14387 being set automatically by @value{GDBN}.
14390 @node Supported Languages
14391 @section Supported Languages
14393 @value{GDBN} supports C, C@t{++}, D, Go, Objective-C, Fortran, Java,
14394 OpenCL C, Pascal, assembly, Modula-2, and Ada.
14395 @c This is false ...
14396 Some @value{GDBN} features may be used in expressions regardless of the
14397 language you use: the @value{GDBN} @code{@@} and @code{::} operators,
14398 and the @samp{@{type@}addr} construct (@pxref{Expressions,
14399 ,Expressions}) can be used with the constructs of any supported
14402 The following sections detail to what degree each source language is
14403 supported by @value{GDBN}. These sections are not meant to be language
14404 tutorials or references, but serve only as a reference guide to what the
14405 @value{GDBN} expression parser accepts, and what input and output
14406 formats should look like for different languages. There are many good
14407 books written on each of these languages; please look to these for a
14408 language reference or tutorial.
14411 * C:: C and C@t{++}
14414 * Objective-C:: Objective-C
14415 * OpenCL C:: OpenCL C
14416 * Fortran:: Fortran
14418 * Modula-2:: Modula-2
14423 @subsection C and C@t{++}
14425 @cindex C and C@t{++}
14426 @cindex expressions in C or C@t{++}
14428 Since C and C@t{++} are so closely related, many features of @value{GDBN} apply
14429 to both languages. Whenever this is the case, we discuss those languages
14433 @cindex @code{g++}, @sc{gnu} C@t{++} compiler
14434 @cindex @sc{gnu} C@t{++}
14435 The C@t{++} debugging facilities are jointly implemented by the C@t{++}
14436 compiler and @value{GDBN}. Therefore, to debug your C@t{++} code
14437 effectively, you must compile your C@t{++} programs with a supported
14438 C@t{++} compiler, such as @sc{gnu} @code{g++}, or the HP ANSI C@t{++}
14439 compiler (@code{aCC}).
14442 * C Operators:: C and C@t{++} operators
14443 * C Constants:: C and C@t{++} constants
14444 * C Plus Plus Expressions:: C@t{++} expressions
14445 * C Defaults:: Default settings for C and C@t{++}
14446 * C Checks:: C and C@t{++} type and range checks
14447 * Debugging C:: @value{GDBN} and C
14448 * Debugging C Plus Plus:: @value{GDBN} features for C@t{++}
14449 * Decimal Floating Point:: Numbers in Decimal Floating Point format
14453 @subsubsection C and C@t{++} Operators
14455 @cindex C and C@t{++} operators
14457 Operators must be defined on values of specific types. For instance,
14458 @code{+} is defined on numbers, but not on structures. Operators are
14459 often defined on groups of types.
14461 For the purposes of C and C@t{++}, the following definitions hold:
14466 @emph{Integral types} include @code{int} with any of its storage-class
14467 specifiers; @code{char}; @code{enum}; and, for C@t{++}, @code{bool}.
14470 @emph{Floating-point types} include @code{float}, @code{double}, and
14471 @code{long double} (if supported by the target platform).
14474 @emph{Pointer types} include all types defined as @code{(@var{type} *)}.
14477 @emph{Scalar types} include all of the above.
14482 The following operators are supported. They are listed here
14483 in order of increasing precedence:
14487 The comma or sequencing operator. Expressions in a comma-separated list
14488 are evaluated from left to right, with the result of the entire
14489 expression being the last expression evaluated.
14492 Assignment. The value of an assignment expression is the value
14493 assigned. Defined on scalar types.
14496 Used in an expression of the form @w{@code{@var{a} @var{op}= @var{b}}},
14497 and translated to @w{@code{@var{a} = @var{a op b}}}.
14498 @w{@code{@var{op}=}} and @code{=} have the same precedence. The operator
14499 @var{op} is any one of the operators @code{|}, @code{^}, @code{&},
14500 @code{<<}, @code{>>}, @code{+}, @code{-}, @code{*}, @code{/}, @code{%}.
14503 The ternary operator. @code{@var{a} ? @var{b} : @var{c}} can be thought
14504 of as: if @var{a} then @var{b} else @var{c}. The argument @var{a}
14505 should be of an integral type.
14508 Logical @sc{or}. Defined on integral types.
14511 Logical @sc{and}. Defined on integral types.
14514 Bitwise @sc{or}. Defined on integral types.
14517 Bitwise exclusive-@sc{or}. Defined on integral types.
14520 Bitwise @sc{and}. Defined on integral types.
14523 Equality and inequality. Defined on scalar types. The value of these
14524 expressions is 0 for false and non-zero for true.
14526 @item <@r{, }>@r{, }<=@r{, }>=
14527 Less than, greater than, less than or equal, greater than or equal.
14528 Defined on scalar types. The value of these expressions is 0 for false
14529 and non-zero for true.
14532 left shift, and right shift. Defined on integral types.
14535 The @value{GDBN} ``artificial array'' operator (@pxref{Expressions, ,Expressions}).
14538 Addition and subtraction. Defined on integral types, floating-point types and
14541 @item *@r{, }/@r{, }%
14542 Multiplication, division, and modulus. Multiplication and division are
14543 defined on integral and floating-point types. Modulus is defined on
14547 Increment and decrement. When appearing before a variable, the
14548 operation is performed before the variable is used in an expression;
14549 when appearing after it, the variable's value is used before the
14550 operation takes place.
14553 Pointer dereferencing. Defined on pointer types. Same precedence as
14557 Address operator. Defined on variables. Same precedence as @code{++}.
14559 For debugging C@t{++}, @value{GDBN} implements a use of @samp{&} beyond what is
14560 allowed in the C@t{++} language itself: you can use @samp{&(&@var{ref})}
14561 to examine the address
14562 where a C@t{++} reference variable (declared with @samp{&@var{ref}}) is
14566 Negative. Defined on integral and floating-point types. Same
14567 precedence as @code{++}.
14570 Logical negation. Defined on integral types. Same precedence as
14574 Bitwise complement operator. Defined on integral types. Same precedence as
14579 Structure member, and pointer-to-structure member. For convenience,
14580 @value{GDBN} regards the two as equivalent, choosing whether to dereference a
14581 pointer based on the stored type information.
14582 Defined on @code{struct} and @code{union} data.
14585 Dereferences of pointers to members.
14588 Array indexing. @code{@var{a}[@var{i}]} is defined as
14589 @code{*(@var{a}+@var{i})}. Same precedence as @code{->}.
14592 Function parameter list. Same precedence as @code{->}.
14595 C@t{++} scope resolution operator. Defined on @code{struct}, @code{union},
14596 and @code{class} types.
14599 Doubled colons also represent the @value{GDBN} scope operator
14600 (@pxref{Expressions, ,Expressions}). Same precedence as @code{::},
14604 If an operator is redefined in the user code, @value{GDBN} usually
14605 attempts to invoke the redefined version instead of using the operator's
14606 predefined meaning.
14609 @subsubsection C and C@t{++} Constants
14611 @cindex C and C@t{++} constants
14613 @value{GDBN} allows you to express the constants of C and C@t{++} in the
14618 Integer constants are a sequence of digits. Octal constants are
14619 specified by a leading @samp{0} (i.e.@: zero), and hexadecimal constants
14620 by a leading @samp{0x} or @samp{0X}. Constants may also end with a letter
14621 @samp{l}, specifying that the constant should be treated as a
14625 Floating point constants are a sequence of digits, followed by a decimal
14626 point, followed by a sequence of digits, and optionally followed by an
14627 exponent. An exponent is of the form:
14628 @samp{@w{e@r{[[}+@r{]|}-@r{]}@var{nnn}}}, where @var{nnn} is another
14629 sequence of digits. The @samp{+} is optional for positive exponents.
14630 A floating-point constant may also end with a letter @samp{f} or
14631 @samp{F}, specifying that the constant should be treated as being of
14632 the @code{float} (as opposed to the default @code{double}) type; or with
14633 a letter @samp{l} or @samp{L}, which specifies a @code{long double}
14637 Enumerated constants consist of enumerated identifiers, or their
14638 integral equivalents.
14641 Character constants are a single character surrounded by single quotes
14642 (@code{'}), or a number---the ordinal value of the corresponding character
14643 (usually its @sc{ascii} value). Within quotes, the single character may
14644 be represented by a letter or by @dfn{escape sequences}, which are of
14645 the form @samp{\@var{nnn}}, where @var{nnn} is the octal representation
14646 of the character's ordinal value; or of the form @samp{\@var{x}}, where
14647 @samp{@var{x}} is a predefined special character---for example,
14648 @samp{\n} for newline.
14650 Wide character constants can be written by prefixing a character
14651 constant with @samp{L}, as in C. For example, @samp{L'x'} is the wide
14652 form of @samp{x}. The target wide character set is used when
14653 computing the value of this constant (@pxref{Character Sets}).
14656 String constants are a sequence of character constants surrounded by
14657 double quotes (@code{"}). Any valid character constant (as described
14658 above) may appear. Double quotes within the string must be preceded by
14659 a backslash, so for instance @samp{"a\"b'c"} is a string of five
14662 Wide string constants can be written by prefixing a string constant
14663 with @samp{L}, as in C. The target wide character set is used when
14664 computing the value of this constant (@pxref{Character Sets}).
14667 Pointer constants are an integral value. You can also write pointers
14668 to constants using the C operator @samp{&}.
14671 Array constants are comma-separated lists surrounded by braces @samp{@{}
14672 and @samp{@}}; for example, @samp{@{1,2,3@}} is a three-element array of
14673 integers, @samp{@{@{1,2@}, @{3,4@}, @{5,6@}@}} is a three-by-two array,
14674 and @samp{@{&"hi", &"there", &"fred"@}} is a three-element array of pointers.
14677 @node C Plus Plus Expressions
14678 @subsubsection C@t{++} Expressions
14680 @cindex expressions in C@t{++}
14681 @value{GDBN} expression handling can interpret most C@t{++} expressions.
14683 @cindex debugging C@t{++} programs
14684 @cindex C@t{++} compilers
14685 @cindex debug formats and C@t{++}
14686 @cindex @value{NGCC} and C@t{++}
14688 @emph{Warning:} @value{GDBN} can only debug C@t{++} code if you use
14689 the proper compiler and the proper debug format. Currently,
14690 @value{GDBN} works best when debugging C@t{++} code that is compiled
14691 with the most recent version of @value{NGCC} possible. The DWARF
14692 debugging format is preferred; @value{NGCC} defaults to this on most
14693 popular platforms. Other compilers and/or debug formats are likely to
14694 work badly or not at all when using @value{GDBN} to debug C@t{++}
14695 code. @xref{Compilation}.
14700 @cindex member functions
14702 Member function calls are allowed; you can use expressions like
14705 count = aml->GetOriginal(x, y)
14708 @vindex this@r{, inside C@t{++} member functions}
14709 @cindex namespace in C@t{++}
14711 While a member function is active (in the selected stack frame), your
14712 expressions have the same namespace available as the member function;
14713 that is, @value{GDBN} allows implicit references to the class instance
14714 pointer @code{this} following the same rules as C@t{++}. @code{using}
14715 declarations in the current scope are also respected by @value{GDBN}.
14717 @cindex call overloaded functions
14718 @cindex overloaded functions, calling
14719 @cindex type conversions in C@t{++}
14721 You can call overloaded functions; @value{GDBN} resolves the function
14722 call to the right definition, with some restrictions. @value{GDBN} does not
14723 perform overload resolution involving user-defined type conversions,
14724 calls to constructors, or instantiations of templates that do not exist
14725 in the program. It also cannot handle ellipsis argument lists or
14728 It does perform integral conversions and promotions, floating-point
14729 promotions, arithmetic conversions, pointer conversions, conversions of
14730 class objects to base classes, and standard conversions such as those of
14731 functions or arrays to pointers; it requires an exact match on the
14732 number of function arguments.
14734 Overload resolution is always performed, unless you have specified
14735 @code{set overload-resolution off}. @xref{Debugging C Plus Plus,
14736 ,@value{GDBN} Features for C@t{++}}.
14738 You must specify @code{set overload-resolution off} in order to use an
14739 explicit function signature to call an overloaded function, as in
14741 p 'foo(char,int)'('x', 13)
14744 The @value{GDBN} command-completion facility can simplify this;
14745 see @ref{Completion, ,Command Completion}.
14747 @cindex reference declarations
14749 @value{GDBN} understands variables declared as C@t{++} references; you can use
14750 them in expressions just as you do in C@t{++} source---they are automatically
14753 In the parameter list shown when @value{GDBN} displays a frame, the values of
14754 reference variables are not displayed (unlike other variables); this
14755 avoids clutter, since references are often used for large structures.
14756 The @emph{address} of a reference variable is always shown, unless
14757 you have specified @samp{set print address off}.
14760 @value{GDBN} supports the C@t{++} name resolution operator @code{::}---your
14761 expressions can use it just as expressions in your program do. Since
14762 one scope may be defined in another, you can use @code{::} repeatedly if
14763 necessary, for example in an expression like
14764 @samp{@var{scope1}::@var{scope2}::@var{name}}. @value{GDBN} also allows
14765 resolving name scope by reference to source files, in both C and C@t{++}
14766 debugging (@pxref{Variables, ,Program Variables}).
14769 @value{GDBN} performs argument-dependent lookup, following the C@t{++}
14774 @subsubsection C and C@t{++} Defaults
14776 @cindex C and C@t{++} defaults
14778 If you allow @value{GDBN} to set range checking automatically, it
14779 defaults to @code{off} whenever the working language changes to
14780 C or C@t{++}. This happens regardless of whether you or @value{GDBN}
14781 selects the working language.
14783 If you allow @value{GDBN} to set the language automatically, it
14784 recognizes source files whose names end with @file{.c}, @file{.C}, or
14785 @file{.cc}, etc, and when @value{GDBN} enters code compiled from one of
14786 these files, it sets the working language to C or C@t{++}.
14787 @xref{Automatically, ,Having @value{GDBN} Infer the Source Language},
14788 for further details.
14791 @subsubsection C and C@t{++} Type and Range Checks
14793 @cindex C and C@t{++} checks
14795 By default, when @value{GDBN} parses C or C@t{++} expressions, strict type
14796 checking is used. However, if you turn type checking off, @value{GDBN}
14797 will allow certain non-standard conversions, such as promoting integer
14798 constants to pointers.
14800 Range checking, if turned on, is done on mathematical operations. Array
14801 indices are not checked, since they are often used to index a pointer
14802 that is not itself an array.
14805 @subsubsection @value{GDBN} and C
14807 The @code{set print union} and @code{show print union} commands apply to
14808 the @code{union} type. When set to @samp{on}, any @code{union} that is
14809 inside a @code{struct} or @code{class} is also printed. Otherwise, it
14810 appears as @samp{@{...@}}.
14812 The @code{@@} operator aids in the debugging of dynamic arrays, formed
14813 with pointers and a memory allocation function. @xref{Expressions,
14816 @node Debugging C Plus Plus
14817 @subsubsection @value{GDBN} Features for C@t{++}
14819 @cindex commands for C@t{++}
14821 Some @value{GDBN} commands are particularly useful with C@t{++}, and some are
14822 designed specifically for use with C@t{++}. Here is a summary:
14825 @cindex break in overloaded functions
14826 @item @r{breakpoint menus}
14827 When you want a breakpoint in a function whose name is overloaded,
14828 @value{GDBN} has the capability to display a menu of possible breakpoint
14829 locations to help you specify which function definition you want.
14830 @xref{Ambiguous Expressions,,Ambiguous Expressions}.
14832 @cindex overloading in C@t{++}
14833 @item rbreak @var{regex}
14834 Setting breakpoints using regular expressions is helpful for setting
14835 breakpoints on overloaded functions that are not members of any special
14837 @xref{Set Breaks, ,Setting Breakpoints}.
14839 @cindex C@t{++} exception handling
14841 @itemx catch rethrow
14843 Debug C@t{++} exception handling using these commands. @xref{Set
14844 Catchpoints, , Setting Catchpoints}.
14846 @cindex inheritance
14847 @item ptype @var{typename}
14848 Print inheritance relationships as well as other information for type
14850 @xref{Symbols, ,Examining the Symbol Table}.
14852 @item info vtbl @var{expression}.
14853 The @code{info vtbl} command can be used to display the virtual
14854 method tables of the object computed by @var{expression}. This shows
14855 one entry per virtual table; there may be multiple virtual tables when
14856 multiple inheritance is in use.
14858 @cindex C@t{++} demangling
14859 @item demangle @var{name}
14860 Demangle @var{name}.
14861 @xref{Symbols}, for a more complete description of the @code{demangle} command.
14863 @cindex C@t{++} symbol display
14864 @item set print demangle
14865 @itemx show print demangle
14866 @itemx set print asm-demangle
14867 @itemx show print asm-demangle
14868 Control whether C@t{++} symbols display in their source form, both when
14869 displaying code as C@t{++} source and when displaying disassemblies.
14870 @xref{Print Settings, ,Print Settings}.
14872 @item set print object
14873 @itemx show print object
14874 Choose whether to print derived (actual) or declared types of objects.
14875 @xref{Print Settings, ,Print Settings}.
14877 @item set print vtbl
14878 @itemx show print vtbl
14879 Control the format for printing virtual function tables.
14880 @xref{Print Settings, ,Print Settings}.
14881 (The @code{vtbl} commands do not work on programs compiled with the HP
14882 ANSI C@t{++} compiler (@code{aCC}).)
14884 @kindex set overload-resolution
14885 @cindex overloaded functions, overload resolution
14886 @item set overload-resolution on
14887 Enable overload resolution for C@t{++} expression evaluation. The default
14888 is on. For overloaded functions, @value{GDBN} evaluates the arguments
14889 and searches for a function whose signature matches the argument types,
14890 using the standard C@t{++} conversion rules (see @ref{C Plus Plus
14891 Expressions, ,C@t{++} Expressions}, for details).
14892 If it cannot find a match, it emits a message.
14894 @item set overload-resolution off
14895 Disable overload resolution for C@t{++} expression evaluation. For
14896 overloaded functions that are not class member functions, @value{GDBN}
14897 chooses the first function of the specified name that it finds in the
14898 symbol table, whether or not its arguments are of the correct type. For
14899 overloaded functions that are class member functions, @value{GDBN}
14900 searches for a function whose signature @emph{exactly} matches the
14903 @kindex show overload-resolution
14904 @item show overload-resolution
14905 Show the current setting of overload resolution.
14907 @item @r{Overloaded symbol names}
14908 You can specify a particular definition of an overloaded symbol, using
14909 the same notation that is used to declare such symbols in C@t{++}: type
14910 @code{@var{symbol}(@var{types})} rather than just @var{symbol}. You can
14911 also use the @value{GDBN} command-line word completion facilities to list the
14912 available choices, or to finish the type list for you.
14913 @xref{Completion,, Command Completion}, for details on how to do this.
14916 @node Decimal Floating Point
14917 @subsubsection Decimal Floating Point format
14918 @cindex decimal floating point format
14920 @value{GDBN} can examine, set and perform computations with numbers in
14921 decimal floating point format, which in the C language correspond to the
14922 @code{_Decimal32}, @code{_Decimal64} and @code{_Decimal128} types as
14923 specified by the extension to support decimal floating-point arithmetic.
14925 There are two encodings in use, depending on the architecture: BID (Binary
14926 Integer Decimal) for x86 and x86-64, and DPD (Densely Packed Decimal) for
14927 PowerPC and S/390. @value{GDBN} will use the appropriate encoding for the
14930 Because of a limitation in @file{libdecnumber}, the library used by @value{GDBN}
14931 to manipulate decimal floating point numbers, it is not possible to convert
14932 (using a cast, for example) integers wider than 32-bit to decimal float.
14934 In addition, in order to imitate @value{GDBN}'s behaviour with binary floating
14935 point computations, error checking in decimal float operations ignores
14936 underflow, overflow and divide by zero exceptions.
14938 In the PowerPC architecture, @value{GDBN} provides a set of pseudo-registers
14939 to inspect @code{_Decimal128} values stored in floating point registers.
14940 See @ref{PowerPC,,PowerPC} for more details.
14946 @value{GDBN} can be used to debug programs written in D and compiled with
14947 GDC, LDC or DMD compilers. Currently @value{GDBN} supports only one D
14948 specific feature --- dynamic arrays.
14953 @cindex Go (programming language)
14954 @value{GDBN} can be used to debug programs written in Go and compiled with
14955 @file{gccgo} or @file{6g} compilers.
14957 Here is a summary of the Go-specific features and restrictions:
14960 @cindex current Go package
14961 @item The current Go package
14962 The name of the current package does not need to be specified when
14963 specifying global variables and functions.
14965 For example, given the program:
14969 var myglob = "Shall we?"
14975 When stopped inside @code{main} either of these work:
14979 (gdb) p main.myglob
14982 @cindex builtin Go types
14983 @item Builtin Go types
14984 The @code{string} type is recognized by @value{GDBN} and is printed
14987 @cindex builtin Go functions
14988 @item Builtin Go functions
14989 The @value{GDBN} expression parser recognizes the @code{unsafe.Sizeof}
14990 function and handles it internally.
14992 @cindex restrictions on Go expressions
14993 @item Restrictions on Go expressions
14994 All Go operators are supported except @code{&^}.
14995 The Go @code{_} ``blank identifier'' is not supported.
14996 Automatic dereferencing of pointers is not supported.
15000 @subsection Objective-C
15002 @cindex Objective-C
15003 This section provides information about some commands and command
15004 options that are useful for debugging Objective-C code. See also
15005 @ref{Symbols, info classes}, and @ref{Symbols, info selectors}, for a
15006 few more commands specific to Objective-C support.
15009 * Method Names in Commands::
15010 * The Print Command with Objective-C::
15013 @node Method Names in Commands
15014 @subsubsection Method Names in Commands
15016 The following commands have been extended to accept Objective-C method
15017 names as line specifications:
15019 @kindex clear@r{, and Objective-C}
15020 @kindex break@r{, and Objective-C}
15021 @kindex info line@r{, and Objective-C}
15022 @kindex jump@r{, and Objective-C}
15023 @kindex list@r{, and Objective-C}
15027 @item @code{info line}
15032 A fully qualified Objective-C method name is specified as
15035 -[@var{Class} @var{methodName}]
15038 where the minus sign is used to indicate an instance method and a
15039 plus sign (not shown) is used to indicate a class method. The class
15040 name @var{Class} and method name @var{methodName} are enclosed in
15041 brackets, similar to the way messages are specified in Objective-C
15042 source code. For example, to set a breakpoint at the @code{create}
15043 instance method of class @code{Fruit} in the program currently being
15047 break -[Fruit create]
15050 To list ten program lines around the @code{initialize} class method,
15054 list +[NSText initialize]
15057 In the current version of @value{GDBN}, the plus or minus sign is
15058 required. In future versions of @value{GDBN}, the plus or minus
15059 sign will be optional, but you can use it to narrow the search. It
15060 is also possible to specify just a method name:
15066 You must specify the complete method name, including any colons. If
15067 your program's source files contain more than one @code{create} method,
15068 you'll be presented with a numbered list of classes that implement that
15069 method. Indicate your choice by number, or type @samp{0} to exit if
15072 As another example, to clear a breakpoint established at the
15073 @code{makeKeyAndOrderFront:} method of the @code{NSWindow} class, enter:
15076 clear -[NSWindow makeKeyAndOrderFront:]
15079 @node The Print Command with Objective-C
15080 @subsubsection The Print Command With Objective-C
15081 @cindex Objective-C, print objects
15082 @kindex print-object
15083 @kindex po @r{(@code{print-object})}
15085 The print command has also been extended to accept methods. For example:
15088 print -[@var{object} hash]
15091 @cindex print an Objective-C object description
15092 @cindex @code{_NSPrintForDebugger}, and printing Objective-C objects
15094 will tell @value{GDBN} to send the @code{hash} message to @var{object}
15095 and print the result. Also, an additional command has been added,
15096 @code{print-object} or @code{po} for short, which is meant to print
15097 the description of an object. However, this command may only work
15098 with certain Objective-C libraries that have a particular hook
15099 function, @code{_NSPrintForDebugger}, defined.
15102 @subsection OpenCL C
15105 This section provides information about @value{GDBN}s OpenCL C support.
15108 * OpenCL C Datatypes::
15109 * OpenCL C Expressions::
15110 * OpenCL C Operators::
15113 @node OpenCL C Datatypes
15114 @subsubsection OpenCL C Datatypes
15116 @cindex OpenCL C Datatypes
15117 @value{GDBN} supports the builtin scalar and vector datatypes specified
15118 by OpenCL 1.1. In addition the half- and double-precision floating point
15119 data types of the @code{cl_khr_fp16} and @code{cl_khr_fp64} OpenCL
15120 extensions are also known to @value{GDBN}.
15122 @node OpenCL C Expressions
15123 @subsubsection OpenCL C Expressions
15125 @cindex OpenCL C Expressions
15126 @value{GDBN} supports accesses to vector components including the access as
15127 lvalue where possible. Since OpenCL C is based on C99 most C expressions
15128 supported by @value{GDBN} can be used as well.
15130 @node OpenCL C Operators
15131 @subsubsection OpenCL C Operators
15133 @cindex OpenCL C Operators
15134 @value{GDBN} supports the operators specified by OpenCL 1.1 for scalar and
15138 @subsection Fortran
15139 @cindex Fortran-specific support in @value{GDBN}
15141 @value{GDBN} can be used to debug programs written in Fortran, but it
15142 currently supports only the features of Fortran 77 language.
15144 @cindex trailing underscore, in Fortran symbols
15145 Some Fortran compilers (@sc{gnu} Fortran 77 and Fortran 95 compilers
15146 among them) append an underscore to the names of variables and
15147 functions. When you debug programs compiled by those compilers, you
15148 will need to refer to variables and functions with a trailing
15152 * Fortran Operators:: Fortran operators and expressions
15153 * Fortran Defaults:: Default settings for Fortran
15154 * Special Fortran Commands:: Special @value{GDBN} commands for Fortran
15157 @node Fortran Operators
15158 @subsubsection Fortran Operators and Expressions
15160 @cindex Fortran operators and expressions
15162 Operators must be defined on values of specific types. For instance,
15163 @code{+} is defined on numbers, but not on characters or other non-
15164 arithmetic types. Operators are often defined on groups of types.
15168 The exponentiation operator. It raises the first operand to the power
15172 The range operator. Normally used in the form of array(low:high) to
15173 represent a section of array.
15176 The access component operator. Normally used to access elements in derived
15177 types. Also suitable for unions. As unions aren't part of regular Fortran,
15178 this can only happen when accessing a register that uses a gdbarch-defined
15182 @node Fortran Defaults
15183 @subsubsection Fortran Defaults
15185 @cindex Fortran Defaults
15187 Fortran symbols are usually case-insensitive, so @value{GDBN} by
15188 default uses case-insensitive matches for Fortran symbols. You can
15189 change that with the @samp{set case-insensitive} command, see
15190 @ref{Symbols}, for the details.
15192 @node Special Fortran Commands
15193 @subsubsection Special Fortran Commands
15195 @cindex Special Fortran commands
15197 @value{GDBN} has some commands to support Fortran-specific features,
15198 such as displaying common blocks.
15201 @cindex @code{COMMON} blocks, Fortran
15202 @kindex info common
15203 @item info common @r{[}@var{common-name}@r{]}
15204 This command prints the values contained in the Fortran @code{COMMON}
15205 block whose name is @var{common-name}. With no argument, the names of
15206 all @code{COMMON} blocks visible at the current program location are
15213 @cindex Pascal support in @value{GDBN}, limitations
15214 Debugging Pascal programs which use sets, subranges, file variables, or
15215 nested functions does not currently work. @value{GDBN} does not support
15216 entering expressions, printing values, or similar features using Pascal
15219 The Pascal-specific command @code{set print pascal_static-members}
15220 controls whether static members of Pascal objects are displayed.
15221 @xref{Print Settings, pascal_static-members}.
15224 @subsection Modula-2
15226 @cindex Modula-2, @value{GDBN} support
15228 The extensions made to @value{GDBN} to support Modula-2 only support
15229 output from the @sc{gnu} Modula-2 compiler (which is currently being
15230 developed). Other Modula-2 compilers are not currently supported, and
15231 attempting to debug executables produced by them is most likely
15232 to give an error as @value{GDBN} reads in the executable's symbol
15235 @cindex expressions in Modula-2
15237 * M2 Operators:: Built-in operators
15238 * Built-In Func/Proc:: Built-in functions and procedures
15239 * M2 Constants:: Modula-2 constants
15240 * M2 Types:: Modula-2 types
15241 * M2 Defaults:: Default settings for Modula-2
15242 * Deviations:: Deviations from standard Modula-2
15243 * M2 Checks:: Modula-2 type and range checks
15244 * M2 Scope:: The scope operators @code{::} and @code{.}
15245 * GDB/M2:: @value{GDBN} and Modula-2
15249 @subsubsection Operators
15250 @cindex Modula-2 operators
15252 Operators must be defined on values of specific types. For instance,
15253 @code{+} is defined on numbers, but not on structures. Operators are
15254 often defined on groups of types. For the purposes of Modula-2, the
15255 following definitions hold:
15260 @emph{Integral types} consist of @code{INTEGER}, @code{CARDINAL}, and
15264 @emph{Character types} consist of @code{CHAR} and its subranges.
15267 @emph{Floating-point types} consist of @code{REAL}.
15270 @emph{Pointer types} consist of anything declared as @code{POINTER TO
15274 @emph{Scalar types} consist of all of the above.
15277 @emph{Set types} consist of @code{SET} and @code{BITSET} types.
15280 @emph{Boolean types} consist of @code{BOOLEAN}.
15284 The following operators are supported, and appear in order of
15285 increasing precedence:
15289 Function argument or array index separator.
15292 Assignment. The value of @var{var} @code{:=} @var{value} is
15296 Less than, greater than on integral, floating-point, or enumerated
15300 Less than or equal to, greater than or equal to
15301 on integral, floating-point and enumerated types, or set inclusion on
15302 set types. Same precedence as @code{<}.
15304 @item =@r{, }<>@r{, }#
15305 Equality and two ways of expressing inequality, valid on scalar types.
15306 Same precedence as @code{<}. In @value{GDBN} scripts, only @code{<>} is
15307 available for inequality, since @code{#} conflicts with the script
15311 Set membership. Defined on set types and the types of their members.
15312 Same precedence as @code{<}.
15315 Boolean disjunction. Defined on boolean types.
15318 Boolean conjunction. Defined on boolean types.
15321 The @value{GDBN} ``artificial array'' operator (@pxref{Expressions, ,Expressions}).
15324 Addition and subtraction on integral and floating-point types, or union
15325 and difference on set types.
15328 Multiplication on integral and floating-point types, or set intersection
15332 Division on floating-point types, or symmetric set difference on set
15333 types. Same precedence as @code{*}.
15336 Integer division and remainder. Defined on integral types. Same
15337 precedence as @code{*}.
15340 Negative. Defined on @code{INTEGER} and @code{REAL} data.
15343 Pointer dereferencing. Defined on pointer types.
15346 Boolean negation. Defined on boolean types. Same precedence as
15350 @code{RECORD} field selector. Defined on @code{RECORD} data. Same
15351 precedence as @code{^}.
15354 Array indexing. Defined on @code{ARRAY} data. Same precedence as @code{^}.
15357 Procedure argument list. Defined on @code{PROCEDURE} objects. Same precedence
15361 @value{GDBN} and Modula-2 scope operators.
15365 @emph{Warning:} Set expressions and their operations are not yet supported, so @value{GDBN}
15366 treats the use of the operator @code{IN}, or the use of operators
15367 @code{+}, @code{-}, @code{*}, @code{/}, @code{=}, , @code{<>}, @code{#},
15368 @code{<=}, and @code{>=} on sets as an error.
15372 @node Built-In Func/Proc
15373 @subsubsection Built-in Functions and Procedures
15374 @cindex Modula-2 built-ins
15376 Modula-2 also makes available several built-in procedures and functions.
15377 In describing these, the following metavariables are used:
15382 represents an @code{ARRAY} variable.
15385 represents a @code{CHAR} constant or variable.
15388 represents a variable or constant of integral type.
15391 represents an identifier that belongs to a set. Generally used in the
15392 same function with the metavariable @var{s}. The type of @var{s} should
15393 be @code{SET OF @var{mtype}} (where @var{mtype} is the type of @var{m}).
15396 represents a variable or constant of integral or floating-point type.
15399 represents a variable or constant of floating-point type.
15405 represents a variable.
15408 represents a variable or constant of one of many types. See the
15409 explanation of the function for details.
15412 All Modula-2 built-in procedures also return a result, described below.
15416 Returns the absolute value of @var{n}.
15419 If @var{c} is a lower case letter, it returns its upper case
15420 equivalent, otherwise it returns its argument.
15423 Returns the character whose ordinal value is @var{i}.
15426 Decrements the value in the variable @var{v} by one. Returns the new value.
15428 @item DEC(@var{v},@var{i})
15429 Decrements the value in the variable @var{v} by @var{i}. Returns the
15432 @item EXCL(@var{m},@var{s})
15433 Removes the element @var{m} from the set @var{s}. Returns the new
15436 @item FLOAT(@var{i})
15437 Returns the floating point equivalent of the integer @var{i}.
15439 @item HIGH(@var{a})
15440 Returns the index of the last member of @var{a}.
15443 Increments the value in the variable @var{v} by one. Returns the new value.
15445 @item INC(@var{v},@var{i})
15446 Increments the value in the variable @var{v} by @var{i}. Returns the
15449 @item INCL(@var{m},@var{s})
15450 Adds the element @var{m} to the set @var{s} if it is not already
15451 there. Returns the new set.
15454 Returns the maximum value of the type @var{t}.
15457 Returns the minimum value of the type @var{t}.
15460 Returns boolean TRUE if @var{i} is an odd number.
15463 Returns the ordinal value of its argument. For example, the ordinal
15464 value of a character is its @sc{ascii} value (on machines supporting
15465 the @sc{ascii} character set). The argument @var{x} must be of an
15466 ordered type, which include integral, character and enumerated types.
15468 @item SIZE(@var{x})
15469 Returns the size of its argument. The argument @var{x} can be a
15470 variable or a type.
15472 @item TRUNC(@var{r})
15473 Returns the integral part of @var{r}.
15475 @item TSIZE(@var{x})
15476 Returns the size of its argument. The argument @var{x} can be a
15477 variable or a type.
15479 @item VAL(@var{t},@var{i})
15480 Returns the member of the type @var{t} whose ordinal value is @var{i}.
15484 @emph{Warning:} Sets and their operations are not yet supported, so
15485 @value{GDBN} treats the use of procedures @code{INCL} and @code{EXCL} as
15489 @cindex Modula-2 constants
15491 @subsubsection Constants
15493 @value{GDBN} allows you to express the constants of Modula-2 in the following
15499 Integer constants are simply a sequence of digits. When used in an
15500 expression, a constant is interpreted to be type-compatible with the
15501 rest of the expression. Hexadecimal integers are specified by a
15502 trailing @samp{H}, and octal integers by a trailing @samp{B}.
15505 Floating point constants appear as a sequence of digits, followed by a
15506 decimal point and another sequence of digits. An optional exponent can
15507 then be specified, in the form @samp{E@r{[}+@r{|}-@r{]}@var{nnn}}, where
15508 @samp{@r{[}+@r{|}-@r{]}@var{nnn}} is the desired exponent. All of the
15509 digits of the floating point constant must be valid decimal (base 10)
15513 Character constants consist of a single character enclosed by a pair of
15514 like quotes, either single (@code{'}) or double (@code{"}). They may
15515 also be expressed by their ordinal value (their @sc{ascii} value, usually)
15516 followed by a @samp{C}.
15519 String constants consist of a sequence of characters enclosed by a
15520 pair of like quotes, either single (@code{'}) or double (@code{"}).
15521 Escape sequences in the style of C are also allowed. @xref{C
15522 Constants, ,C and C@t{++} Constants}, for a brief explanation of escape
15526 Enumerated constants consist of an enumerated identifier.
15529 Boolean constants consist of the identifiers @code{TRUE} and
15533 Pointer constants consist of integral values only.
15536 Set constants are not yet supported.
15540 @subsubsection Modula-2 Types
15541 @cindex Modula-2 types
15543 Currently @value{GDBN} can print the following data types in Modula-2
15544 syntax: array types, record types, set types, pointer types, procedure
15545 types, enumerated types, subrange types and base types. You can also
15546 print the contents of variables declared using these type.
15547 This section gives a number of simple source code examples together with
15548 sample @value{GDBN} sessions.
15550 The first example contains the following section of code:
15559 and you can request @value{GDBN} to interrogate the type and value of
15560 @code{r} and @code{s}.
15563 (@value{GDBP}) print s
15565 (@value{GDBP}) ptype s
15567 (@value{GDBP}) print r
15569 (@value{GDBP}) ptype r
15574 Likewise if your source code declares @code{s} as:
15578 s: SET ['A'..'Z'] ;
15582 then you may query the type of @code{s} by:
15585 (@value{GDBP}) ptype s
15586 type = SET ['A'..'Z']
15590 Note that at present you cannot interactively manipulate set
15591 expressions using the debugger.
15593 The following example shows how you might declare an array in Modula-2
15594 and how you can interact with @value{GDBN} to print its type and contents:
15598 s: ARRAY [-10..10] OF CHAR ;
15602 (@value{GDBP}) ptype s
15603 ARRAY [-10..10] OF CHAR
15606 Note that the array handling is not yet complete and although the type
15607 is printed correctly, expression handling still assumes that all
15608 arrays have a lower bound of zero and not @code{-10} as in the example
15611 Here are some more type related Modula-2 examples:
15615 colour = (blue, red, yellow, green) ;
15616 t = [blue..yellow] ;
15624 The @value{GDBN} interaction shows how you can query the data type
15625 and value of a variable.
15628 (@value{GDBP}) print s
15630 (@value{GDBP}) ptype t
15631 type = [blue..yellow]
15635 In this example a Modula-2 array is declared and its contents
15636 displayed. Observe that the contents are written in the same way as
15637 their @code{C} counterparts.
15641 s: ARRAY [1..5] OF CARDINAL ;
15647 (@value{GDBP}) print s
15648 $1 = @{1, 0, 0, 0, 0@}
15649 (@value{GDBP}) ptype s
15650 type = ARRAY [1..5] OF CARDINAL
15653 The Modula-2 language interface to @value{GDBN} also understands
15654 pointer types as shown in this example:
15658 s: POINTER TO ARRAY [1..5] OF CARDINAL ;
15665 and you can request that @value{GDBN} describes the type of @code{s}.
15668 (@value{GDBP}) ptype s
15669 type = POINTER TO ARRAY [1..5] OF CARDINAL
15672 @value{GDBN} handles compound types as we can see in this example.
15673 Here we combine array types, record types, pointer types and subrange
15684 myarray = ARRAY myrange OF CARDINAL ;
15685 myrange = [-2..2] ;
15687 s: POINTER TO ARRAY myrange OF foo ;
15691 and you can ask @value{GDBN} to describe the type of @code{s} as shown
15695 (@value{GDBP}) ptype s
15696 type = POINTER TO ARRAY [-2..2] OF foo = RECORD
15699 f3 : ARRAY [-2..2] OF CARDINAL;
15704 @subsubsection Modula-2 Defaults
15705 @cindex Modula-2 defaults
15707 If type and range checking are set automatically by @value{GDBN}, they
15708 both default to @code{on} whenever the working language changes to
15709 Modula-2. This happens regardless of whether you or @value{GDBN}
15710 selected the working language.
15712 If you allow @value{GDBN} to set the language automatically, then entering
15713 code compiled from a file whose name ends with @file{.mod} sets the
15714 working language to Modula-2. @xref{Automatically, ,Having @value{GDBN}
15715 Infer the Source Language}, for further details.
15718 @subsubsection Deviations from Standard Modula-2
15719 @cindex Modula-2, deviations from
15721 A few changes have been made to make Modula-2 programs easier to debug.
15722 This is done primarily via loosening its type strictness:
15726 Unlike in standard Modula-2, pointer constants can be formed by
15727 integers. This allows you to modify pointer variables during
15728 debugging. (In standard Modula-2, the actual address contained in a
15729 pointer variable is hidden from you; it can only be modified
15730 through direct assignment to another pointer variable or expression that
15731 returned a pointer.)
15734 C escape sequences can be used in strings and characters to represent
15735 non-printable characters. @value{GDBN} prints out strings with these
15736 escape sequences embedded. Single non-printable characters are
15737 printed using the @samp{CHR(@var{nnn})} format.
15740 The assignment operator (@code{:=}) returns the value of its right-hand
15744 All built-in procedures both modify @emph{and} return their argument.
15748 @subsubsection Modula-2 Type and Range Checks
15749 @cindex Modula-2 checks
15752 @emph{Warning:} in this release, @value{GDBN} does not yet perform type or
15755 @c FIXME remove warning when type/range checks added
15757 @value{GDBN} considers two Modula-2 variables type equivalent if:
15761 They are of types that have been declared equivalent via a @code{TYPE
15762 @var{t1} = @var{t2}} statement
15765 They have been declared on the same line. (Note: This is true of the
15766 @sc{gnu} Modula-2 compiler, but it may not be true of other compilers.)
15769 As long as type checking is enabled, any attempt to combine variables
15770 whose types are not equivalent is an error.
15772 Range checking is done on all mathematical operations, assignment, array
15773 index bounds, and all built-in functions and procedures.
15776 @subsubsection The Scope Operators @code{::} and @code{.}
15778 @cindex @code{.}, Modula-2 scope operator
15779 @cindex colon, doubled as scope operator
15781 @vindex colon-colon@r{, in Modula-2}
15782 @c Info cannot handle :: but TeX can.
15785 @vindex ::@r{, in Modula-2}
15788 There are a few subtle differences between the Modula-2 scope operator
15789 (@code{.}) and the @value{GDBN} scope operator (@code{::}). The two have
15794 @var{module} . @var{id}
15795 @var{scope} :: @var{id}
15799 where @var{scope} is the name of a module or a procedure,
15800 @var{module} the name of a module, and @var{id} is any declared
15801 identifier within your program, except another module.
15803 Using the @code{::} operator makes @value{GDBN} search the scope
15804 specified by @var{scope} for the identifier @var{id}. If it is not
15805 found in the specified scope, then @value{GDBN} searches all scopes
15806 enclosing the one specified by @var{scope}.
15808 Using the @code{.} operator makes @value{GDBN} search the current scope for
15809 the identifier specified by @var{id} that was imported from the
15810 definition module specified by @var{module}. With this operator, it is
15811 an error if the identifier @var{id} was not imported from definition
15812 module @var{module}, or if @var{id} is not an identifier in
15816 @subsubsection @value{GDBN} and Modula-2
15818 Some @value{GDBN} commands have little use when debugging Modula-2 programs.
15819 Five subcommands of @code{set print} and @code{show print} apply
15820 specifically to C and C@t{++}: @samp{vtbl}, @samp{demangle},
15821 @samp{asm-demangle}, @samp{object}, and @samp{union}. The first four
15822 apply to C@t{++}, and the last to the C @code{union} type, which has no direct
15823 analogue in Modula-2.
15825 The @code{@@} operator (@pxref{Expressions, ,Expressions}), while available
15826 with any language, is not useful with Modula-2. Its
15827 intent is to aid the debugging of @dfn{dynamic arrays}, which cannot be
15828 created in Modula-2 as they can in C or C@t{++}. However, because an
15829 address can be specified by an integral constant, the construct
15830 @samp{@{@var{type}@}@var{adrexp}} is still useful.
15832 @cindex @code{#} in Modula-2
15833 In @value{GDBN} scripts, the Modula-2 inequality operator @code{#} is
15834 interpreted as the beginning of a comment. Use @code{<>} instead.
15840 The extensions made to @value{GDBN} for Ada only support
15841 output from the @sc{gnu} Ada (GNAT) compiler.
15842 Other Ada compilers are not currently supported, and
15843 attempting to debug executables produced by them is most likely
15847 @cindex expressions in Ada
15849 * Ada Mode Intro:: General remarks on the Ada syntax
15850 and semantics supported by Ada mode
15852 * Omissions from Ada:: Restrictions on the Ada expression syntax.
15853 * Additions to Ada:: Extensions of the Ada expression syntax.
15854 * Overloading support for Ada:: Support for expressions involving overloaded
15856 * Stopping Before Main Program:: Debugging the program during elaboration.
15857 * Ada Exceptions:: Ada Exceptions
15858 * Ada Tasks:: Listing and setting breakpoints in tasks.
15859 * Ada Tasks and Core Files:: Tasking Support when Debugging Core Files
15860 * Ravenscar Profile:: Tasking Support when using the Ravenscar
15862 * Ada Glitches:: Known peculiarities of Ada mode.
15865 @node Ada Mode Intro
15866 @subsubsection Introduction
15867 @cindex Ada mode, general
15869 The Ada mode of @value{GDBN} supports a fairly large subset of Ada expression
15870 syntax, with some extensions.
15871 The philosophy behind the design of this subset is
15875 That @value{GDBN} should provide basic literals and access to operations for
15876 arithmetic, dereferencing, field selection, indexing, and subprogram calls,
15877 leaving more sophisticated computations to subprograms written into the
15878 program (which therefore may be called from @value{GDBN}).
15881 That type safety and strict adherence to Ada language restrictions
15882 are not particularly important to the @value{GDBN} user.
15885 That brevity is important to the @value{GDBN} user.
15888 Thus, for brevity, the debugger acts as if all names declared in
15889 user-written packages are directly visible, even if they are not visible
15890 according to Ada rules, thus making it unnecessary to fully qualify most
15891 names with their packages, regardless of context. Where this causes
15892 ambiguity, @value{GDBN} asks the user's intent.
15894 The debugger will start in Ada mode if it detects an Ada main program.
15895 As for other languages, it will enter Ada mode when stopped in a program that
15896 was translated from an Ada source file.
15898 While in Ada mode, you may use `@t{--}' for comments. This is useful
15899 mostly for documenting command files. The standard @value{GDBN} comment
15900 (@samp{#}) still works at the beginning of a line in Ada mode, but not in the
15901 middle (to allow based literals).
15903 @node Omissions from Ada
15904 @subsubsection Omissions from Ada
15905 @cindex Ada, omissions from
15907 Here are the notable omissions from the subset:
15911 Only a subset of the attributes are supported:
15915 @t{'First}, @t{'Last}, and @t{'Length}
15916 on array objects (not on types and subtypes).
15919 @t{'Min} and @t{'Max}.
15922 @t{'Pos} and @t{'Val}.
15928 @t{'Range} on array objects (not subtypes), but only as the right
15929 operand of the membership (@code{in}) operator.
15932 @t{'Access}, @t{'Unchecked_Access}, and
15933 @t{'Unrestricted_Access} (a GNAT extension).
15941 @code{Characters.Latin_1} are not available and
15942 concatenation is not implemented. Thus, escape characters in strings are
15943 not currently available.
15946 Equality tests (@samp{=} and @samp{/=}) on arrays test for bitwise
15947 equality of representations. They will generally work correctly
15948 for strings and arrays whose elements have integer or enumeration types.
15949 They may not work correctly for arrays whose element
15950 types have user-defined equality, for arrays of real values
15951 (in particular, IEEE-conformant floating point, because of negative
15952 zeroes and NaNs), and for arrays whose elements contain unused bits with
15953 indeterminate values.
15956 The other component-by-component array operations (@code{and}, @code{or},
15957 @code{xor}, @code{not}, and relational tests other than equality)
15958 are not implemented.
15961 @cindex array aggregates (Ada)
15962 @cindex record aggregates (Ada)
15963 @cindex aggregates (Ada)
15964 There is limited support for array and record aggregates. They are
15965 permitted only on the right sides of assignments, as in these examples:
15968 (@value{GDBP}) set An_Array := (1, 2, 3, 4, 5, 6)
15969 (@value{GDBP}) set An_Array := (1, others => 0)
15970 (@value{GDBP}) set An_Array := (0|4 => 1, 1..3 => 2, 5 => 6)
15971 (@value{GDBP}) set A_2D_Array := ((1, 2, 3), (4, 5, 6), (7, 8, 9))
15972 (@value{GDBP}) set A_Record := (1, "Peter", True);
15973 (@value{GDBP}) set A_Record := (Name => "Peter", Id => 1, Alive => True)
15977 discriminant's value by assigning an aggregate has an
15978 undefined effect if that discriminant is used within the record.
15979 However, you can first modify discriminants by directly assigning to
15980 them (which normally would not be allowed in Ada), and then performing an
15981 aggregate assignment. For example, given a variable @code{A_Rec}
15982 declared to have a type such as:
15985 type Rec (Len : Small_Integer := 0) is record
15987 Vals : IntArray (1 .. Len);
15991 you can assign a value with a different size of @code{Vals} with two
15995 (@value{GDBP}) set A_Rec.Len := 4
15996 (@value{GDBP}) set A_Rec := (Id => 42, Vals => (1, 2, 3, 4))
15999 As this example also illustrates, @value{GDBN} is very loose about the usual
16000 rules concerning aggregates. You may leave out some of the
16001 components of an array or record aggregate (such as the @code{Len}
16002 component in the assignment to @code{A_Rec} above); they will retain their
16003 original values upon assignment. You may freely use dynamic values as
16004 indices in component associations. You may even use overlapping or
16005 redundant component associations, although which component values are
16006 assigned in such cases is not defined.
16009 Calls to dispatching subprograms are not implemented.
16012 The overloading algorithm is much more limited (i.e., less selective)
16013 than that of real Ada. It makes only limited use of the context in
16014 which a subexpression appears to resolve its meaning, and it is much
16015 looser in its rules for allowing type matches. As a result, some
16016 function calls will be ambiguous, and the user will be asked to choose
16017 the proper resolution.
16020 The @code{new} operator is not implemented.
16023 Entry calls are not implemented.
16026 Aside from printing, arithmetic operations on the native VAX floating-point
16027 formats are not supported.
16030 It is not possible to slice a packed array.
16033 The names @code{True} and @code{False}, when not part of a qualified name,
16034 are interpreted as if implicitly prefixed by @code{Standard}, regardless of
16036 Should your program
16037 redefine these names in a package or procedure (at best a dubious practice),
16038 you will have to use fully qualified names to access their new definitions.
16041 @node Additions to Ada
16042 @subsubsection Additions to Ada
16043 @cindex Ada, deviations from
16045 As it does for other languages, @value{GDBN} makes certain generic
16046 extensions to Ada (@pxref{Expressions}):
16050 If the expression @var{E} is a variable residing in memory (typically
16051 a local variable or array element) and @var{N} is a positive integer,
16052 then @code{@var{E}@@@var{N}} displays the values of @var{E} and the
16053 @var{N}-1 adjacent variables following it in memory as an array. In
16054 Ada, this operator is generally not necessary, since its prime use is
16055 in displaying parts of an array, and slicing will usually do this in
16056 Ada. However, there are occasional uses when debugging programs in
16057 which certain debugging information has been optimized away.
16060 @code{@var{B}::@var{var}} means ``the variable named @var{var} that
16061 appears in function or file @var{B}.'' When @var{B} is a file name,
16062 you must typically surround it in single quotes.
16065 The expression @code{@{@var{type}@} @var{addr}} means ``the variable of type
16066 @var{type} that appears at address @var{addr}.''
16069 A name starting with @samp{$} is a convenience variable
16070 (@pxref{Convenience Vars}) or a machine register (@pxref{Registers}).
16073 In addition, @value{GDBN} provides a few other shortcuts and outright
16074 additions specific to Ada:
16078 The assignment statement is allowed as an expression, returning
16079 its right-hand operand as its value. Thus, you may enter
16082 (@value{GDBP}) set x := y + 3
16083 (@value{GDBP}) print A(tmp := y + 1)
16087 The semicolon is allowed as an ``operator,'' returning as its value
16088 the value of its right-hand operand.
16089 This allows, for example,
16090 complex conditional breaks:
16093 (@value{GDBP}) break f
16094 (@value{GDBP}) condition 1 (report(i); k += 1; A(k) > 100)
16098 Rather than use catenation and symbolic character names to introduce special
16099 characters into strings, one may instead use a special bracket notation,
16100 which is also used to print strings. A sequence of characters of the form
16101 @samp{["@var{XX}"]} within a string or character literal denotes the
16102 (single) character whose numeric encoding is @var{XX} in hexadecimal. The
16103 sequence of characters @samp{["""]} also denotes a single quotation mark
16104 in strings. For example,
16106 "One line.["0a"]Next line.["0a"]"
16109 contains an ASCII newline character (@code{Ada.Characters.Latin_1.LF})
16113 The subtype used as a prefix for the attributes @t{'Pos}, @t{'Min}, and
16114 @t{'Max} is optional (and is ignored in any case). For example, it is valid
16118 (@value{GDBP}) print 'max(x, y)
16122 When printing arrays, @value{GDBN} uses positional notation when the
16123 array has a lower bound of 1, and uses a modified named notation otherwise.
16124 For example, a one-dimensional array of three integers with a lower bound
16125 of 3 might print as
16132 That is, in contrast to valid Ada, only the first component has a @code{=>}
16136 You may abbreviate attributes in expressions with any unique,
16137 multi-character subsequence of
16138 their names (an exact match gets preference).
16139 For example, you may use @t{a'len}, @t{a'gth}, or @t{a'lh}
16140 in place of @t{a'length}.
16143 @cindex quoting Ada internal identifiers
16144 Since Ada is case-insensitive, the debugger normally maps identifiers you type
16145 to lower case. The GNAT compiler uses upper-case characters for
16146 some of its internal identifiers, which are normally of no interest to users.
16147 For the rare occasions when you actually have to look at them,
16148 enclose them in angle brackets to avoid the lower-case mapping.
16151 (@value{GDBP}) print <JMPBUF_SAVE>[0]
16155 Printing an object of class-wide type or dereferencing an
16156 access-to-class-wide value will display all the components of the object's
16157 specific type (as indicated by its run-time tag). Likewise, component
16158 selection on such a value will operate on the specific type of the
16163 @node Overloading support for Ada
16164 @subsubsection Overloading support for Ada
16165 @cindex overloading, Ada
16167 The debugger supports limited overloading. Given a subprogram call in which
16168 the function symbol has multiple definitions, it will use the number of
16169 actual parameters and some information about their types to attempt to narrow
16170 the set of definitions. It also makes very limited use of context, preferring
16171 procedures to functions in the context of the @code{call} command, and
16172 functions to procedures elsewhere.
16174 If, after narrowing, the set of matching definitions still contains more than
16175 one definition, @value{GDBN} will display a menu to query which one it should
16179 (@value{GDBP}) print f(1)
16180 Multiple matches for f
16182 [1] foo.f (integer) return boolean at foo.adb:23
16183 [2] foo.f (foo.new_integer) return boolean at foo.adb:28
16187 In this case, just select one menu entry either to cancel expression evaluation
16188 (type @kbd{0} and press @key{RET}) or to continue evaluation with a specific
16189 instance (type the corresponding number and press @key{RET}).
16191 Here are a couple of commands to customize @value{GDBN}'s behavior in this
16196 @kindex set ada print-signatures
16197 @item set ada print-signatures
16198 Control whether parameter types and return types are displayed in overloads
16199 selection menus. It is @code{on} by default.
16200 @xref{Overloading support for Ada}.
16202 @kindex show ada print-signatures
16203 @item show ada print-signatures
16204 Show the current setting for displaying parameter types and return types in
16205 overloads selection menu.
16206 @xref{Overloading support for Ada}.
16210 @node Stopping Before Main Program
16211 @subsubsection Stopping at the Very Beginning
16213 @cindex breakpointing Ada elaboration code
16214 It is sometimes necessary to debug the program during elaboration, and
16215 before reaching the main procedure.
16216 As defined in the Ada Reference
16217 Manual, the elaboration code is invoked from a procedure called
16218 @code{adainit}. To run your program up to the beginning of
16219 elaboration, simply use the following two commands:
16220 @code{tbreak adainit} and @code{run}.
16222 @node Ada Exceptions
16223 @subsubsection Ada Exceptions
16225 A command is provided to list all Ada exceptions:
16228 @kindex info exceptions
16229 @item info exceptions
16230 @itemx info exceptions @var{regexp}
16231 The @code{info exceptions} command allows you to list all Ada exceptions
16232 defined within the program being debugged, as well as their addresses.
16233 With a regular expression, @var{regexp}, as argument, only those exceptions
16234 whose names match @var{regexp} are listed.
16237 Below is a small example, showing how the command can be used, first
16238 without argument, and next with a regular expression passed as an
16242 (@value{GDBP}) info exceptions
16243 All defined Ada exceptions:
16244 constraint_error: 0x613da0
16245 program_error: 0x613d20
16246 storage_error: 0x613ce0
16247 tasking_error: 0x613ca0
16248 const.aint_global_e: 0x613b00
16249 (@value{GDBP}) info exceptions const.aint
16250 All Ada exceptions matching regular expression "const.aint":
16251 constraint_error: 0x613da0
16252 const.aint_global_e: 0x613b00
16255 It is also possible to ask @value{GDBN} to stop your program's execution
16256 when an exception is raised. For more details, see @ref{Set Catchpoints}.
16259 @subsubsection Extensions for Ada Tasks
16260 @cindex Ada, tasking
16262 Support for Ada tasks is analogous to that for threads (@pxref{Threads}).
16263 @value{GDBN} provides the following task-related commands:
16268 This command shows a list of current Ada tasks, as in the following example:
16275 (@value{GDBP}) info tasks
16276 ID TID P-ID Pri State Name
16277 1 8088000 0 15 Child Activation Wait main_task
16278 2 80a4000 1 15 Accept Statement b
16279 3 809a800 1 15 Child Activation Wait a
16280 * 4 80ae800 3 15 Runnable c
16285 In this listing, the asterisk before the last task indicates it to be the
16286 task currently being inspected.
16290 Represents @value{GDBN}'s internal task number.
16296 The parent's task ID (@value{GDBN}'s internal task number).
16299 The base priority of the task.
16302 Current state of the task.
16306 The task has been created but has not been activated. It cannot be
16310 The task is not blocked for any reason known to Ada. (It may be waiting
16311 for a mutex, though.) It is conceptually "executing" in normal mode.
16314 The task is terminated, in the sense of ARM 9.3 (5). Any dependents
16315 that were waiting on terminate alternatives have been awakened and have
16316 terminated themselves.
16318 @item Child Activation Wait
16319 The task is waiting for created tasks to complete activation.
16321 @item Accept Statement
16322 The task is waiting on an accept or selective wait statement.
16324 @item Waiting on entry call
16325 The task is waiting on an entry call.
16327 @item Async Select Wait
16328 The task is waiting to start the abortable part of an asynchronous
16332 The task is waiting on a select statement with only a delay
16335 @item Child Termination Wait
16336 The task is sleeping having completed a master within itself, and is
16337 waiting for the tasks dependent on that master to become terminated or
16338 waiting on a terminate Phase.
16340 @item Wait Child in Term Alt
16341 The task is sleeping waiting for tasks on terminate alternatives to
16342 finish terminating.
16344 @item Accepting RV with @var{taskno}
16345 The task is accepting a rendez-vous with the task @var{taskno}.
16349 Name of the task in the program.
16353 @kindex info task @var{taskno}
16354 @item info task @var{taskno}
16355 This command shows detailled informations on the specified task, as in
16356 the following example:
16361 (@value{GDBP}) info tasks
16362 ID TID P-ID Pri State Name
16363 1 8077880 0 15 Child Activation Wait main_task
16364 * 2 807c468 1 15 Runnable task_1
16365 (@value{GDBP}) info task 2
16366 Ada Task: 0x807c468
16369 Parent: 1 (main_task)
16375 @kindex task@r{ (Ada)}
16376 @cindex current Ada task ID
16377 This command prints the ID of the current task.
16383 (@value{GDBP}) info tasks
16384 ID TID P-ID Pri State Name
16385 1 8077870 0 15 Child Activation Wait main_task
16386 * 2 807c458 1 15 Runnable t
16387 (@value{GDBP}) task
16388 [Current task is 2]
16391 @item task @var{taskno}
16392 @cindex Ada task switching
16393 This command is like the @code{thread @var{thread-id}}
16394 command (@pxref{Threads}). It switches the context of debugging
16395 from the current task to the given task.
16401 (@value{GDBP}) info tasks
16402 ID TID P-ID Pri State Name
16403 1 8077870 0 15 Child Activation Wait main_task
16404 * 2 807c458 1 15 Runnable t
16405 (@value{GDBP}) task 1
16406 [Switching to task 1]
16407 #0 0x8067726 in pthread_cond_wait ()
16409 #0 0x8067726 in pthread_cond_wait ()
16410 #1 0x8056714 in system.os_interface.pthread_cond_wait ()
16411 #2 0x805cb63 in system.task_primitives.operations.sleep ()
16412 #3 0x806153e in system.tasking.stages.activate_tasks ()
16413 #4 0x804aacc in un () at un.adb:5
16416 @item break @var{location} task @var{taskno}
16417 @itemx break @var{location} task @var{taskno} if @dots{}
16418 @cindex breakpoints and tasks, in Ada
16419 @cindex task breakpoints, in Ada
16420 @kindex break @dots{} task @var{taskno}@r{ (Ada)}
16421 These commands are like the @code{break @dots{} thread @dots{}}
16422 command (@pxref{Thread Stops}). The
16423 @var{location} argument specifies source lines, as described
16424 in @ref{Specify Location}.
16426 Use the qualifier @samp{task @var{taskno}} with a breakpoint command
16427 to specify that you only want @value{GDBN} to stop the program when a
16428 particular Ada task reaches this breakpoint. The @var{taskno} is one of the
16429 numeric task identifiers assigned by @value{GDBN}, shown in the first
16430 column of the @samp{info tasks} display.
16432 If you do not specify @samp{task @var{taskno}} when you set a
16433 breakpoint, the breakpoint applies to @emph{all} tasks of your
16436 You can use the @code{task} qualifier on conditional breakpoints as
16437 well; in this case, place @samp{task @var{taskno}} before the
16438 breakpoint condition (before the @code{if}).
16446 (@value{GDBP}) info tasks
16447 ID TID P-ID Pri State Name
16448 1 140022020 0 15 Child Activation Wait main_task
16449 2 140045060 1 15 Accept/Select Wait t2
16450 3 140044840 1 15 Runnable t1
16451 * 4 140056040 1 15 Runnable t3
16452 (@value{GDBP}) b 15 task 2
16453 Breakpoint 5 at 0x120044cb0: file test_task_debug.adb, line 15.
16454 (@value{GDBP}) cont
16459 Breakpoint 5, test_task_debug () at test_task_debug.adb:15
16461 (@value{GDBP}) info tasks
16462 ID TID P-ID Pri State Name
16463 1 140022020 0 15 Child Activation Wait main_task
16464 * 2 140045060 1 15 Runnable t2
16465 3 140044840 1 15 Runnable t1
16466 4 140056040 1 15 Delay Sleep t3
16470 @node Ada Tasks and Core Files
16471 @subsubsection Tasking Support when Debugging Core Files
16472 @cindex Ada tasking and core file debugging
16474 When inspecting a core file, as opposed to debugging a live program,
16475 tasking support may be limited or even unavailable, depending on
16476 the platform being used.
16477 For instance, on x86-linux, the list of tasks is available, but task
16478 switching is not supported.
16480 On certain platforms, the debugger needs to perform some
16481 memory writes in order to provide Ada tasking support. When inspecting
16482 a core file, this means that the core file must be opened with read-write
16483 privileges, using the command @samp{"set write on"} (@pxref{Patching}).
16484 Under these circumstances, you should make a backup copy of the core
16485 file before inspecting it with @value{GDBN}.
16487 @node Ravenscar Profile
16488 @subsubsection Tasking Support when using the Ravenscar Profile
16489 @cindex Ravenscar Profile
16491 The @dfn{Ravenscar Profile} is a subset of the Ada tasking features,
16492 specifically designed for systems with safety-critical real-time
16496 @kindex set ravenscar task-switching on
16497 @cindex task switching with program using Ravenscar Profile
16498 @item set ravenscar task-switching on
16499 Allows task switching when debugging a program that uses the Ravenscar
16500 Profile. This is the default.
16502 @kindex set ravenscar task-switching off
16503 @item set ravenscar task-switching off
16504 Turn off task switching when debugging a program that uses the Ravenscar
16505 Profile. This is mostly intended to disable the code that adds support
16506 for the Ravenscar Profile, in case a bug in either @value{GDBN} or in
16507 the Ravenscar runtime is preventing @value{GDBN} from working properly.
16508 To be effective, this command should be run before the program is started.
16510 @kindex show ravenscar task-switching
16511 @item show ravenscar task-switching
16512 Show whether it is possible to switch from task to task in a program
16513 using the Ravenscar Profile.
16518 @subsubsection Known Peculiarities of Ada Mode
16519 @cindex Ada, problems
16521 Besides the omissions listed previously (@pxref{Omissions from Ada}),
16522 we know of several problems with and limitations of Ada mode in
16524 some of which will be fixed with planned future releases of the debugger
16525 and the GNU Ada compiler.
16529 Static constants that the compiler chooses not to materialize as objects in
16530 storage are invisible to the debugger.
16533 Named parameter associations in function argument lists are ignored (the
16534 argument lists are treated as positional).
16537 Many useful library packages are currently invisible to the debugger.
16540 Fixed-point arithmetic, conversions, input, and output is carried out using
16541 floating-point arithmetic, and may give results that only approximate those on
16545 The GNAT compiler never generates the prefix @code{Standard} for any of
16546 the standard symbols defined by the Ada language. @value{GDBN} knows about
16547 this: it will strip the prefix from names when you use it, and will never
16548 look for a name you have so qualified among local symbols, nor match against
16549 symbols in other packages or subprograms. If you have
16550 defined entities anywhere in your program other than parameters and
16551 local variables whose simple names match names in @code{Standard},
16552 GNAT's lack of qualification here can cause confusion. When this happens,
16553 you can usually resolve the confusion
16554 by qualifying the problematic names with package
16555 @code{Standard} explicitly.
16558 Older versions of the compiler sometimes generate erroneous debugging
16559 information, resulting in the debugger incorrectly printing the value
16560 of affected entities. In some cases, the debugger is able to work
16561 around an issue automatically. In other cases, the debugger is able
16562 to work around the issue, but the work-around has to be specifically
16565 @kindex set ada trust-PAD-over-XVS
16566 @kindex show ada trust-PAD-over-XVS
16569 @item set ada trust-PAD-over-XVS on
16570 Configure GDB to strictly follow the GNAT encoding when computing the
16571 value of Ada entities, particularly when @code{PAD} and @code{PAD___XVS}
16572 types are involved (see @code{ada/exp_dbug.ads} in the GCC sources for
16573 a complete description of the encoding used by the GNAT compiler).
16574 This is the default.
16576 @item set ada trust-PAD-over-XVS off
16577 This is related to the encoding using by the GNAT compiler. If @value{GDBN}
16578 sometimes prints the wrong value for certain entities, changing @code{ada
16579 trust-PAD-over-XVS} to @code{off} activates a work-around which may fix
16580 the issue. It is always safe to set @code{ada trust-PAD-over-XVS} to
16581 @code{off}, but this incurs a slight performance penalty, so it is
16582 recommended to leave this setting to @code{on} unless necessary.
16586 @cindex GNAT descriptive types
16587 @cindex GNAT encoding
16588 Internally, the debugger also relies on the compiler following a number
16589 of conventions known as the @samp{GNAT Encoding}, all documented in
16590 @file{gcc/ada/exp_dbug.ads} in the GCC sources. This encoding describes
16591 how the debugging information should be generated for certain types.
16592 In particular, this convention makes use of @dfn{descriptive types},
16593 which are artificial types generated purely to help the debugger.
16595 These encodings were defined at a time when the debugging information
16596 format used was not powerful enough to describe some of the more complex
16597 types available in Ada. Since DWARF allows us to express nearly all
16598 Ada features, the long-term goal is to slowly replace these descriptive
16599 types by their pure DWARF equivalent. To facilitate that transition,
16600 a new maintenance option is available to force the debugger to ignore
16601 those descriptive types. It allows the user to quickly evaluate how
16602 well @value{GDBN} works without them.
16606 @kindex maint ada set ignore-descriptive-types
16607 @item maintenance ada set ignore-descriptive-types [on|off]
16608 Control whether the debugger should ignore descriptive types.
16609 The default is not to ignore descriptives types (@code{off}).
16611 @kindex maint ada show ignore-descriptive-types
16612 @item maintenance ada show ignore-descriptive-types
16613 Show if descriptive types are ignored by @value{GDBN}.
16617 @node Unsupported Languages
16618 @section Unsupported Languages
16620 @cindex unsupported languages
16621 @cindex minimal language
16622 In addition to the other fully-supported programming languages,
16623 @value{GDBN} also provides a pseudo-language, called @code{minimal}.
16624 It does not represent a real programming language, but provides a set
16625 of capabilities close to what the C or assembly languages provide.
16626 This should allow most simple operations to be performed while debugging
16627 an application that uses a language currently not supported by @value{GDBN}.
16629 If the language is set to @code{auto}, @value{GDBN} will automatically
16630 select this language if the current frame corresponds to an unsupported
16634 @chapter Examining the Symbol Table
16636 The commands described in this chapter allow you to inquire about the
16637 symbols (names of variables, functions and types) defined in your
16638 program. This information is inherent in the text of your program and
16639 does not change as your program executes. @value{GDBN} finds it in your
16640 program's symbol table, in the file indicated when you started @value{GDBN}
16641 (@pxref{File Options, ,Choosing Files}), or by one of the
16642 file-management commands (@pxref{Files, ,Commands to Specify Files}).
16644 @cindex symbol names
16645 @cindex names of symbols
16646 @cindex quoting names
16647 Occasionally, you may need to refer to symbols that contain unusual
16648 characters, which @value{GDBN} ordinarily treats as word delimiters. The
16649 most frequent case is in referring to static variables in other
16650 source files (@pxref{Variables,,Program Variables}). File names
16651 are recorded in object files as debugging symbols, but @value{GDBN} would
16652 ordinarily parse a typical file name, like @file{foo.c}, as the three words
16653 @samp{foo} @samp{.} @samp{c}. To allow @value{GDBN} to recognize
16654 @samp{foo.c} as a single symbol, enclose it in single quotes; for example,
16661 looks up the value of @code{x} in the scope of the file @file{foo.c}.
16664 @cindex case-insensitive symbol names
16665 @cindex case sensitivity in symbol names
16666 @kindex set case-sensitive
16667 @item set case-sensitive on
16668 @itemx set case-sensitive off
16669 @itemx set case-sensitive auto
16670 Normally, when @value{GDBN} looks up symbols, it matches their names
16671 with case sensitivity determined by the current source language.
16672 Occasionally, you may wish to control that. The command @code{set
16673 case-sensitive} lets you do that by specifying @code{on} for
16674 case-sensitive matches or @code{off} for case-insensitive ones. If
16675 you specify @code{auto}, case sensitivity is reset to the default
16676 suitable for the source language. The default is case-sensitive
16677 matches for all languages except for Fortran, for which the default is
16678 case-insensitive matches.
16680 @kindex show case-sensitive
16681 @item show case-sensitive
16682 This command shows the current setting of case sensitivity for symbols
16685 @kindex set print type methods
16686 @item set print type methods
16687 @itemx set print type methods on
16688 @itemx set print type methods off
16689 Normally, when @value{GDBN} prints a class, it displays any methods
16690 declared in that class. You can control this behavior either by
16691 passing the appropriate flag to @code{ptype}, or using @command{set
16692 print type methods}. Specifying @code{on} will cause @value{GDBN} to
16693 display the methods; this is the default. Specifying @code{off} will
16694 cause @value{GDBN} to omit the methods.
16696 @kindex show print type methods
16697 @item show print type methods
16698 This command shows the current setting of method display when printing
16701 @kindex set print type typedefs
16702 @item set print type typedefs
16703 @itemx set print type typedefs on
16704 @itemx set print type typedefs off
16706 Normally, when @value{GDBN} prints a class, it displays any typedefs
16707 defined in that class. You can control this behavior either by
16708 passing the appropriate flag to @code{ptype}, or using @command{set
16709 print type typedefs}. Specifying @code{on} will cause @value{GDBN} to
16710 display the typedef definitions; this is the default. Specifying
16711 @code{off} will cause @value{GDBN} to omit the typedef definitions.
16712 Note that this controls whether the typedef definition itself is
16713 printed, not whether typedef names are substituted when printing other
16716 @kindex show print type typedefs
16717 @item show print type typedefs
16718 This command shows the current setting of typedef display when
16721 @kindex info address
16722 @cindex address of a symbol
16723 @item info address @var{symbol}
16724 Describe where the data for @var{symbol} is stored. For a register
16725 variable, this says which register it is kept in. For a non-register
16726 local variable, this prints the stack-frame offset at which the variable
16729 Note the contrast with @samp{print &@var{symbol}}, which does not work
16730 at all for a register variable, and for a stack local variable prints
16731 the exact address of the current instantiation of the variable.
16733 @kindex info symbol
16734 @cindex symbol from address
16735 @cindex closest symbol and offset for an address
16736 @item info symbol @var{addr}
16737 Print the name of a symbol which is stored at the address @var{addr}.
16738 If no symbol is stored exactly at @var{addr}, @value{GDBN} prints the
16739 nearest symbol and an offset from it:
16742 (@value{GDBP}) info symbol 0x54320
16743 _initialize_vx + 396 in section .text
16747 This is the opposite of the @code{info address} command. You can use
16748 it to find out the name of a variable or a function given its address.
16750 For dynamically linked executables, the name of executable or shared
16751 library containing the symbol is also printed:
16754 (@value{GDBP}) info symbol 0x400225
16755 _start + 5 in section .text of /tmp/a.out
16756 (@value{GDBP}) info symbol 0x2aaaac2811cf
16757 __read_nocancel + 6 in section .text of /usr/lib64/libc.so.6
16762 @item demangle @r{[}-l @var{language}@r{]} @r{[}@var{--}@r{]} @var{name}
16763 Demangle @var{name}.
16764 If @var{language} is provided it is the name of the language to demangle
16765 @var{name} in. Otherwise @var{name} is demangled in the current language.
16767 The @samp{--} option specifies the end of options,
16768 and is useful when @var{name} begins with a dash.
16770 The parameter @code{demangle-style} specifies how to interpret the kind
16771 of mangling used. @xref{Print Settings}.
16774 @item whatis[/@var{flags}] [@var{arg}]
16775 Print the data type of @var{arg}, which can be either an expression
16776 or a name of a data type. With no argument, print the data type of
16777 @code{$}, the last value in the value history.
16779 If @var{arg} is an expression (@pxref{Expressions, ,Expressions}), it
16780 is not actually evaluated, and any side-effecting operations (such as
16781 assignments or function calls) inside it do not take place.
16783 If @var{arg} is a variable or an expression, @code{whatis} prints its
16784 literal type as it is used in the source code. If the type was
16785 defined using a @code{typedef}, @code{whatis} will @emph{not} print
16786 the data type underlying the @code{typedef}. If the type of the
16787 variable or the expression is a compound data type, such as
16788 @code{struct} or @code{class}, @code{whatis} never prints their
16789 fields or methods. It just prints the @code{struct}/@code{class}
16790 name (a.k.a.@: its @dfn{tag}). If you want to see the members of
16791 such a compound data type, use @code{ptype}.
16793 If @var{arg} is a type name that was defined using @code{typedef},
16794 @code{whatis} @dfn{unrolls} only one level of that @code{typedef}.
16795 Unrolling means that @code{whatis} will show the underlying type used
16796 in the @code{typedef} declaration of @var{arg}. However, if that
16797 underlying type is also a @code{typedef}, @code{whatis} will not
16800 For C code, the type names may also have the form @samp{class
16801 @var{class-name}}, @samp{struct @var{struct-tag}}, @samp{union
16802 @var{union-tag}} or @samp{enum @var{enum-tag}}.
16804 @var{flags} can be used to modify how the type is displayed.
16805 Available flags are:
16809 Display in ``raw'' form. Normally, @value{GDBN} substitutes template
16810 parameters and typedefs defined in a class when printing the class'
16811 members. The @code{/r} flag disables this.
16814 Do not print methods defined in the class.
16817 Print methods defined in the class. This is the default, but the flag
16818 exists in case you change the default with @command{set print type methods}.
16821 Do not print typedefs defined in the class. Note that this controls
16822 whether the typedef definition itself is printed, not whether typedef
16823 names are substituted when printing other types.
16826 Print typedefs defined in the class. This is the default, but the flag
16827 exists in case you change the default with @command{set print type typedefs}.
16831 @item ptype[/@var{flags}] [@var{arg}]
16832 @code{ptype} accepts the same arguments as @code{whatis}, but prints a
16833 detailed description of the type, instead of just the name of the type.
16834 @xref{Expressions, ,Expressions}.
16836 Contrary to @code{whatis}, @code{ptype} always unrolls any
16837 @code{typedef}s in its argument declaration, whether the argument is
16838 a variable, expression, or a data type. This means that @code{ptype}
16839 of a variable or an expression will not print literally its type as
16840 present in the source code---use @code{whatis} for that. @code{typedef}s at
16841 the pointer or reference targets are also unrolled. Only @code{typedef}s of
16842 fields, methods and inner @code{class typedef}s of @code{struct}s,
16843 @code{class}es and @code{union}s are not unrolled even with @code{ptype}.
16845 For example, for this variable declaration:
16848 typedef double real_t;
16849 struct complex @{ real_t real; double imag; @};
16850 typedef struct complex complex_t;
16852 real_t *real_pointer_var;
16856 the two commands give this output:
16860 (@value{GDBP}) whatis var
16862 (@value{GDBP}) ptype var
16863 type = struct complex @{
16867 (@value{GDBP}) whatis complex_t
16868 type = struct complex
16869 (@value{GDBP}) whatis struct complex
16870 type = struct complex
16871 (@value{GDBP}) ptype struct complex
16872 type = struct complex @{
16876 (@value{GDBP}) whatis real_pointer_var
16878 (@value{GDBP}) ptype real_pointer_var
16884 As with @code{whatis}, using @code{ptype} without an argument refers to
16885 the type of @code{$}, the last value in the value history.
16887 @cindex incomplete type
16888 Sometimes, programs use opaque data types or incomplete specifications
16889 of complex data structure. If the debug information included in the
16890 program does not allow @value{GDBN} to display a full declaration of
16891 the data type, it will say @samp{<incomplete type>}. For example,
16892 given these declarations:
16896 struct foo *fooptr;
16900 but no definition for @code{struct foo} itself, @value{GDBN} will say:
16903 (@value{GDBP}) ptype foo
16904 $1 = <incomplete type>
16908 ``Incomplete type'' is C terminology for data types that are not
16909 completely specified.
16912 @item info types @var{regexp}
16914 Print a brief description of all types whose names match the regular
16915 expression @var{regexp} (or all types in your program, if you supply
16916 no argument). Each complete typename is matched as though it were a
16917 complete line; thus, @samp{i type value} gives information on all
16918 types in your program whose names include the string @code{value}, but
16919 @samp{i type ^value$} gives information only on types whose complete
16920 name is @code{value}.
16922 This command differs from @code{ptype} in two ways: first, like
16923 @code{whatis}, it does not print a detailed description; second, it
16924 lists all source files where a type is defined.
16926 @kindex info type-printers
16927 @item info type-printers
16928 Versions of @value{GDBN} that ship with Python scripting enabled may
16929 have ``type printers'' available. When using @command{ptype} or
16930 @command{whatis}, these printers are consulted when the name of a type
16931 is needed. @xref{Type Printing API}, for more information on writing
16934 @code{info type-printers} displays all the available type printers.
16936 @kindex enable type-printer
16937 @kindex disable type-printer
16938 @item enable type-printer @var{name}@dots{}
16939 @item disable type-printer @var{name}@dots{}
16940 These commands can be used to enable or disable type printers.
16943 @cindex local variables
16944 @item info scope @var{location}
16945 List all the variables local to a particular scope. This command
16946 accepts a @var{location} argument---a function name, a source line, or
16947 an address preceded by a @samp{*}, and prints all the variables local
16948 to the scope defined by that location. (@xref{Specify Location}, for
16949 details about supported forms of @var{location}.) For example:
16952 (@value{GDBP}) @b{info scope command_line_handler}
16953 Scope for command_line_handler:
16954 Symbol rl is an argument at stack/frame offset 8, length 4.
16955 Symbol linebuffer is in static storage at address 0x150a18, length 4.
16956 Symbol linelength is in static storage at address 0x150a1c, length 4.
16957 Symbol p is a local variable in register $esi, length 4.
16958 Symbol p1 is a local variable in register $ebx, length 4.
16959 Symbol nline is a local variable in register $edx, length 4.
16960 Symbol repeat is a local variable at frame offset -8, length 4.
16964 This command is especially useful for determining what data to collect
16965 during a @dfn{trace experiment}, see @ref{Tracepoint Actions,
16968 @kindex info source
16970 Show information about the current source file---that is, the source file for
16971 the function containing the current point of execution:
16974 the name of the source file, and the directory containing it,
16976 the directory it was compiled in,
16978 its length, in lines,
16980 which programming language it is written in,
16982 if the debug information provides it, the program that compiled the file
16983 (which may include, e.g., the compiler version and command line arguments),
16985 whether the executable includes debugging information for that file, and
16986 if so, what format the information is in (e.g., STABS, Dwarf 2, etc.), and
16988 whether the debugging information includes information about
16989 preprocessor macros.
16993 @kindex info sources
16995 Print the names of all source files in your program for which there is
16996 debugging information, organized into two lists: files whose symbols
16997 have already been read, and files whose symbols will be read when needed.
16999 @kindex info functions
17000 @item info functions
17001 Print the names and data types of all defined functions.
17003 @item info functions @var{regexp}
17004 Print the names and data types of all defined functions
17005 whose names contain a match for regular expression @var{regexp}.
17006 Thus, @samp{info fun step} finds all functions whose names
17007 include @code{step}; @samp{info fun ^step} finds those whose names
17008 start with @code{step}. If a function name contains characters
17009 that conflict with the regular expression language (e.g.@:
17010 @samp{operator*()}), they may be quoted with a backslash.
17012 @kindex info variables
17013 @item info variables
17014 Print the names and data types of all variables that are defined
17015 outside of functions (i.e.@: excluding local variables).
17017 @item info variables @var{regexp}
17018 Print the names and data types of all variables (except for local
17019 variables) whose names contain a match for regular expression
17022 @kindex info classes
17023 @cindex Objective-C, classes and selectors
17025 @itemx info classes @var{regexp}
17026 Display all Objective-C classes in your program, or
17027 (with the @var{regexp} argument) all those matching a particular regular
17030 @kindex info selectors
17031 @item info selectors
17032 @itemx info selectors @var{regexp}
17033 Display all Objective-C selectors in your program, or
17034 (with the @var{regexp} argument) all those matching a particular regular
17038 This was never implemented.
17039 @kindex info methods
17041 @itemx info methods @var{regexp}
17042 The @code{info methods} command permits the user to examine all defined
17043 methods within C@t{++} program, or (with the @var{regexp} argument) a
17044 specific set of methods found in the various C@t{++} classes. Many
17045 C@t{++} classes provide a large number of methods. Thus, the output
17046 from the @code{ptype} command can be overwhelming and hard to use. The
17047 @code{info-methods} command filters the methods, printing only those
17048 which match the regular-expression @var{regexp}.
17051 @cindex opaque data types
17052 @kindex set opaque-type-resolution
17053 @item set opaque-type-resolution on
17054 Tell @value{GDBN} to resolve opaque types. An opaque type is a type
17055 declared as a pointer to a @code{struct}, @code{class}, or
17056 @code{union}---for example, @code{struct MyType *}---that is used in one
17057 source file although the full declaration of @code{struct MyType} is in
17058 another source file. The default is on.
17060 A change in the setting of this subcommand will not take effect until
17061 the next time symbols for a file are loaded.
17063 @item set opaque-type-resolution off
17064 Tell @value{GDBN} not to resolve opaque types. In this case, the type
17065 is printed as follows:
17067 @{<no data fields>@}
17070 @kindex show opaque-type-resolution
17071 @item show opaque-type-resolution
17072 Show whether opaque types are resolved or not.
17074 @kindex set print symbol-loading
17075 @cindex print messages when symbols are loaded
17076 @item set print symbol-loading
17077 @itemx set print symbol-loading full
17078 @itemx set print symbol-loading brief
17079 @itemx set print symbol-loading off
17080 The @code{set print symbol-loading} command allows you to control the
17081 printing of messages when @value{GDBN} loads symbol information.
17082 By default a message is printed for the executable and one for each
17083 shared library, and normally this is what you want. However, when
17084 debugging apps with large numbers of shared libraries these messages
17086 When set to @code{brief} a message is printed for each executable,
17087 and when @value{GDBN} loads a collection of shared libraries at once
17088 it will only print one message regardless of the number of shared
17089 libraries. When set to @code{off} no messages are printed.
17091 @kindex show print symbol-loading
17092 @item show print symbol-loading
17093 Show whether messages will be printed when a @value{GDBN} command
17094 entered from the keyboard causes symbol information to be loaded.
17096 @kindex maint print symbols
17097 @cindex symbol dump
17098 @kindex maint print psymbols
17099 @cindex partial symbol dump
17100 @kindex maint print msymbols
17101 @cindex minimal symbol dump
17102 @item maint print symbols @var{filename}
17103 @itemx maint print psymbols @var{filename}
17104 @itemx maint print msymbols @var{filename}
17105 Write a dump of debugging symbol data into the file @var{filename}.
17106 These commands are used to debug the @value{GDBN} symbol-reading code. Only
17107 symbols with debugging data are included. If you use @samp{maint print
17108 symbols}, @value{GDBN} includes all the symbols for which it has already
17109 collected full details: that is, @var{filename} reflects symbols for
17110 only those files whose symbols @value{GDBN} has read. You can use the
17111 command @code{info sources} to find out which files these are. If you
17112 use @samp{maint print psymbols} instead, the dump shows information about
17113 symbols that @value{GDBN} only knows partially---that is, symbols defined in
17114 files that @value{GDBN} has skimmed, but not yet read completely. Finally,
17115 @samp{maint print msymbols} dumps just the minimal symbol information
17116 required for each object file from which @value{GDBN} has read some symbols.
17117 @xref{Files, ,Commands to Specify Files}, for a discussion of how
17118 @value{GDBN} reads symbols (in the description of @code{symbol-file}).
17120 @kindex maint info symtabs
17121 @kindex maint info psymtabs
17122 @cindex listing @value{GDBN}'s internal symbol tables
17123 @cindex symbol tables, listing @value{GDBN}'s internal
17124 @cindex full symbol tables, listing @value{GDBN}'s internal
17125 @cindex partial symbol tables, listing @value{GDBN}'s internal
17126 @item maint info symtabs @r{[} @var{regexp} @r{]}
17127 @itemx maint info psymtabs @r{[} @var{regexp} @r{]}
17129 List the @code{struct symtab} or @code{struct partial_symtab}
17130 structures whose names match @var{regexp}. If @var{regexp} is not
17131 given, list them all. The output includes expressions which you can
17132 copy into a @value{GDBN} debugging this one to examine a particular
17133 structure in more detail. For example:
17136 (@value{GDBP}) maint info psymtabs dwarf2read
17137 @{ objfile /home/gnu/build/gdb/gdb
17138 ((struct objfile *) 0x82e69d0)
17139 @{ psymtab /home/gnu/src/gdb/dwarf2read.c
17140 ((struct partial_symtab *) 0x8474b10)
17143 text addresses 0x814d3c8 -- 0x8158074
17144 globals (* (struct partial_symbol **) 0x8507a08 @@ 9)
17145 statics (* (struct partial_symbol **) 0x40e95b78 @@ 2882)
17146 dependencies (none)
17149 (@value{GDBP}) maint info symtabs
17153 We see that there is one partial symbol table whose filename contains
17154 the string @samp{dwarf2read}, belonging to the @samp{gdb} executable;
17155 and we see that @value{GDBN} has not read in any symtabs yet at all.
17156 If we set a breakpoint on a function, that will cause @value{GDBN} to
17157 read the symtab for the compilation unit containing that function:
17160 (@value{GDBP}) break dwarf2_psymtab_to_symtab
17161 Breakpoint 1 at 0x814e5da: file /home/gnu/src/gdb/dwarf2read.c,
17163 (@value{GDBP}) maint info symtabs
17164 @{ objfile /home/gnu/build/gdb/gdb
17165 ((struct objfile *) 0x82e69d0)
17166 @{ symtab /home/gnu/src/gdb/dwarf2read.c
17167 ((struct symtab *) 0x86c1f38)
17170 blockvector ((struct blockvector *) 0x86c1bd0) (primary)
17171 linetable ((struct linetable *) 0x8370fa0)
17172 debugformat DWARF 2
17178 @kindex maint set symbol-cache-size
17179 @cindex symbol cache size
17180 @item maint set symbol-cache-size @var{size}
17181 Set the size of the symbol cache to @var{size}.
17182 The default size is intended to be good enough for debugging
17183 most applications. This option exists to allow for experimenting
17184 with different sizes.
17186 @kindex maint show symbol-cache-size
17187 @item maint show symbol-cache-size
17188 Show the size of the symbol cache.
17190 @kindex maint print symbol-cache
17191 @cindex symbol cache, printing its contents
17192 @item maint print symbol-cache
17193 Print the contents of the symbol cache.
17194 This is useful when debugging symbol cache issues.
17196 @kindex maint print symbol-cache-statistics
17197 @cindex symbol cache, printing usage statistics
17198 @item maint print symbol-cache-statistics
17199 Print symbol cache usage statistics.
17200 This helps determine how well the cache is being utilized.
17202 @kindex maint flush-symbol-cache
17203 @cindex symbol cache, flushing
17204 @item maint flush-symbol-cache
17205 Flush the contents of the symbol cache, all entries are removed.
17206 This command is useful when debugging the symbol cache.
17207 It is also useful when collecting performance data.
17212 @chapter Altering Execution
17214 Once you think you have found an error in your program, you might want to
17215 find out for certain whether correcting the apparent error would lead to
17216 correct results in the rest of the run. You can find the answer by
17217 experiment, using the @value{GDBN} features for altering execution of the
17220 For example, you can store new values into variables or memory
17221 locations, give your program a signal, restart it at a different
17222 address, or even return prematurely from a function.
17225 * Assignment:: Assignment to variables
17226 * Jumping:: Continuing at a different address
17227 * Signaling:: Giving your program a signal
17228 * Returning:: Returning from a function
17229 * Calling:: Calling your program's functions
17230 * Patching:: Patching your program
17231 * Compiling and Injecting Code:: Compiling and injecting code in @value{GDBN}
17235 @section Assignment to Variables
17238 @cindex setting variables
17239 To alter the value of a variable, evaluate an assignment expression.
17240 @xref{Expressions, ,Expressions}. For example,
17247 stores the value 4 into the variable @code{x}, and then prints the
17248 value of the assignment expression (which is 4).
17249 @xref{Languages, ,Using @value{GDBN} with Different Languages}, for more
17250 information on operators in supported languages.
17252 @kindex set variable
17253 @cindex variables, setting
17254 If you are not interested in seeing the value of the assignment, use the
17255 @code{set} command instead of the @code{print} command. @code{set} is
17256 really the same as @code{print} except that the expression's value is
17257 not printed and is not put in the value history (@pxref{Value History,
17258 ,Value History}). The expression is evaluated only for its effects.
17260 If the beginning of the argument string of the @code{set} command
17261 appears identical to a @code{set} subcommand, use the @code{set
17262 variable} command instead of just @code{set}. This command is identical
17263 to @code{set} except for its lack of subcommands. For example, if your
17264 program has a variable @code{width}, you get an error if you try to set
17265 a new value with just @samp{set width=13}, because @value{GDBN} has the
17266 command @code{set width}:
17269 (@value{GDBP}) whatis width
17271 (@value{GDBP}) p width
17273 (@value{GDBP}) set width=47
17274 Invalid syntax in expression.
17278 The invalid expression, of course, is @samp{=47}. In
17279 order to actually set the program's variable @code{width}, use
17282 (@value{GDBP}) set var width=47
17285 Because the @code{set} command has many subcommands that can conflict
17286 with the names of program variables, it is a good idea to use the
17287 @code{set variable} command instead of just @code{set}. For example, if
17288 your program has a variable @code{g}, you run into problems if you try
17289 to set a new value with just @samp{set g=4}, because @value{GDBN} has
17290 the command @code{set gnutarget}, abbreviated @code{set g}:
17294 (@value{GDBP}) whatis g
17298 (@value{GDBP}) set g=4
17302 The program being debugged has been started already.
17303 Start it from the beginning? (y or n) y
17304 Starting program: /home/smith/cc_progs/a.out
17305 "/home/smith/cc_progs/a.out": can't open to read symbols:
17306 Invalid bfd target.
17307 (@value{GDBP}) show g
17308 The current BFD target is "=4".
17313 The program variable @code{g} did not change, and you silently set the
17314 @code{gnutarget} to an invalid value. In order to set the variable
17318 (@value{GDBP}) set var g=4
17321 @value{GDBN} allows more implicit conversions in assignments than C; you can
17322 freely store an integer value into a pointer variable or vice versa,
17323 and you can convert any structure to any other structure that is the
17324 same length or shorter.
17325 @comment FIXME: how do structs align/pad in these conversions?
17326 @comment /doc@cygnus.com 18dec1990
17328 To store values into arbitrary places in memory, use the @samp{@{@dots{}@}}
17329 construct to generate a value of specified type at a specified address
17330 (@pxref{Expressions, ,Expressions}). For example, @code{@{int@}0x83040} refers
17331 to memory location @code{0x83040} as an integer (which implies a certain size
17332 and representation in memory), and
17335 set @{int@}0x83040 = 4
17339 stores the value 4 into that memory location.
17342 @section Continuing at a Different Address
17344 Ordinarily, when you continue your program, you do so at the place where
17345 it stopped, with the @code{continue} command. You can instead continue at
17346 an address of your own choosing, with the following commands:
17350 @kindex j @r{(@code{jump})}
17351 @item jump @var{location}
17352 @itemx j @var{location}
17353 Resume execution at @var{location}. Execution stops again immediately
17354 if there is a breakpoint there. @xref{Specify Location}, for a description
17355 of the different forms of @var{location}. It is common
17356 practice to use the @code{tbreak} command in conjunction with
17357 @code{jump}. @xref{Set Breaks, ,Setting Breakpoints}.
17359 The @code{jump} command does not change the current stack frame, or
17360 the stack pointer, or the contents of any memory location or any
17361 register other than the program counter. If @var{location} is in
17362 a different function from the one currently executing, the results may
17363 be bizarre if the two functions expect different patterns of arguments or
17364 of local variables. For this reason, the @code{jump} command requests
17365 confirmation if the specified line is not in the function currently
17366 executing. However, even bizarre results are predictable if you are
17367 well acquainted with the machine-language code of your program.
17370 On many systems, you can get much the same effect as the @code{jump}
17371 command by storing a new value into the register @code{$pc}. The
17372 difference is that this does not start your program running; it only
17373 changes the address of where it @emph{will} run when you continue. For
17381 makes the next @code{continue} command or stepping command execute at
17382 address @code{0x485}, rather than at the address where your program stopped.
17383 @xref{Continuing and Stepping, ,Continuing and Stepping}.
17385 The most common occasion to use the @code{jump} command is to back
17386 up---perhaps with more breakpoints set---over a portion of a program
17387 that has already executed, in order to examine its execution in more
17392 @section Giving your Program a Signal
17393 @cindex deliver a signal to a program
17397 @item signal @var{signal}
17398 Resume execution where your program is stopped, but immediately give it the
17399 signal @var{signal}. The @var{signal} can be the name or the number of a
17400 signal. For example, on many systems @code{signal 2} and @code{signal
17401 SIGINT} are both ways of sending an interrupt signal.
17403 Alternatively, if @var{signal} is zero, continue execution without
17404 giving a signal. This is useful when your program stopped on account of
17405 a signal and would ordinarily see the signal when resumed with the
17406 @code{continue} command; @samp{signal 0} causes it to resume without a
17409 @emph{Note:} When resuming a multi-threaded program, @var{signal} is
17410 delivered to the currently selected thread, not the thread that last
17411 reported a stop. This includes the situation where a thread was
17412 stopped due to a signal. So if you want to continue execution
17413 suppressing the signal that stopped a thread, you should select that
17414 same thread before issuing the @samp{signal 0} command. If you issue
17415 the @samp{signal 0} command with another thread as the selected one,
17416 @value{GDBN} detects that and asks for confirmation.
17418 Invoking the @code{signal} command is not the same as invoking the
17419 @code{kill} utility from the shell. Sending a signal with @code{kill}
17420 causes @value{GDBN} to decide what to do with the signal depending on
17421 the signal handling tables (@pxref{Signals}). The @code{signal} command
17422 passes the signal directly to your program.
17424 @code{signal} does not repeat when you press @key{RET} a second time
17425 after executing the command.
17427 @kindex queue-signal
17428 @item queue-signal @var{signal}
17429 Queue @var{signal} to be delivered immediately to the current thread
17430 when execution of the thread resumes. The @var{signal} can be the name or
17431 the number of a signal. For example, on many systems @code{signal 2} and
17432 @code{signal SIGINT} are both ways of sending an interrupt signal.
17433 The handling of the signal must be set to pass the signal to the program,
17434 otherwise @value{GDBN} will report an error.
17435 You can control the handling of signals from @value{GDBN} with the
17436 @code{handle} command (@pxref{Signals}).
17438 Alternatively, if @var{signal} is zero, any currently queued signal
17439 for the current thread is discarded and when execution resumes no signal
17440 will be delivered. This is useful when your program stopped on account
17441 of a signal and would ordinarily see the signal when resumed with the
17442 @code{continue} command.
17444 This command differs from the @code{signal} command in that the signal
17445 is just queued, execution is not resumed. And @code{queue-signal} cannot
17446 be used to pass a signal whose handling state has been set to @code{nopass}
17451 @xref{stepping into signal handlers}, for information on how stepping
17452 commands behave when the thread has a signal queued.
17455 @section Returning from a Function
17458 @cindex returning from a function
17461 @itemx return @var{expression}
17462 You can cancel execution of a function call with the @code{return}
17463 command. If you give an
17464 @var{expression} argument, its value is used as the function's return
17468 When you use @code{return}, @value{GDBN} discards the selected stack frame
17469 (and all frames within it). You can think of this as making the
17470 discarded frame return prematurely. If you wish to specify a value to
17471 be returned, give that value as the argument to @code{return}.
17473 This pops the selected stack frame (@pxref{Selection, ,Selecting a
17474 Frame}), and any other frames inside of it, leaving its caller as the
17475 innermost remaining frame. That frame becomes selected. The
17476 specified value is stored in the registers used for returning values
17479 The @code{return} command does not resume execution; it leaves the
17480 program stopped in the state that would exist if the function had just
17481 returned. In contrast, the @code{finish} command (@pxref{Continuing
17482 and Stepping, ,Continuing and Stepping}) resumes execution until the
17483 selected stack frame returns naturally.
17485 @value{GDBN} needs to know how the @var{expression} argument should be set for
17486 the inferior. The concrete registers assignment depends on the OS ABI and the
17487 type being returned by the selected stack frame. For example it is common for
17488 OS ABI to return floating point values in FPU registers while integer values in
17489 CPU registers. Still some ABIs return even floating point values in CPU
17490 registers. Larger integer widths (such as @code{long long int}) also have
17491 specific placement rules. @value{GDBN} already knows the OS ABI from its
17492 current target so it needs to find out also the type being returned to make the
17493 assignment into the right register(s).
17495 Normally, the selected stack frame has debug info. @value{GDBN} will always
17496 use the debug info instead of the implicit type of @var{expression} when the
17497 debug info is available. For example, if you type @kbd{return -1}, and the
17498 function in the current stack frame is declared to return a @code{long long
17499 int}, @value{GDBN} transparently converts the implicit @code{int} value of -1
17500 into a @code{long long int}:
17503 Breakpoint 1, func () at gdb.base/return-nodebug.c:29
17505 (@value{GDBP}) return -1
17506 Make func return now? (y or n) y
17507 #0 0x004004f6 in main () at gdb.base/return-nodebug.c:43
17508 43 printf ("result=%lld\n", func ());
17512 However, if the selected stack frame does not have a debug info, e.g., if the
17513 function was compiled without debug info, @value{GDBN} has to find out the type
17514 to return from user. Specifying a different type by mistake may set the value
17515 in different inferior registers than the caller code expects. For example,
17516 typing @kbd{return -1} with its implicit type @code{int} would set only a part
17517 of a @code{long long int} result for a debug info less function (on 32-bit
17518 architectures). Therefore the user is required to specify the return type by
17519 an appropriate cast explicitly:
17522 Breakpoint 2, 0x0040050b in func ()
17523 (@value{GDBP}) return -1
17524 Return value type not available for selected stack frame.
17525 Please use an explicit cast of the value to return.
17526 (@value{GDBP}) return (long long int) -1
17527 Make selected stack frame return now? (y or n) y
17528 #0 0x00400526 in main ()
17533 @section Calling Program Functions
17536 @cindex calling functions
17537 @cindex inferior functions, calling
17538 @item print @var{expr}
17539 Evaluate the expression @var{expr} and display the resulting value.
17540 The expression may include calls to functions in the program being
17544 @item call @var{expr}
17545 Evaluate the expression @var{expr} without displaying @code{void}
17548 You can use this variant of the @code{print} command if you want to
17549 execute a function from your program that does not return anything
17550 (a.k.a.@: @dfn{a void function}), but without cluttering the output
17551 with @code{void} returned values that @value{GDBN} will otherwise
17552 print. If the result is not void, it is printed and saved in the
17556 It is possible for the function you call via the @code{print} or
17557 @code{call} command to generate a signal (e.g., if there's a bug in
17558 the function, or if you passed it incorrect arguments). What happens
17559 in that case is controlled by the @code{set unwindonsignal} command.
17561 Similarly, with a C@t{++} program it is possible for the function you
17562 call via the @code{print} or @code{call} command to generate an
17563 exception that is not handled due to the constraints of the dummy
17564 frame. In this case, any exception that is raised in the frame, but has
17565 an out-of-frame exception handler will not be found. GDB builds a
17566 dummy-frame for the inferior function call, and the unwinder cannot
17567 seek for exception handlers outside of this dummy-frame. What happens
17568 in that case is controlled by the
17569 @code{set unwind-on-terminating-exception} command.
17572 @item set unwindonsignal
17573 @kindex set unwindonsignal
17574 @cindex unwind stack in called functions
17575 @cindex call dummy stack unwinding
17576 Set unwinding of the stack if a signal is received while in a function
17577 that @value{GDBN} called in the program being debugged. If set to on,
17578 @value{GDBN} unwinds the stack it created for the call and restores
17579 the context to what it was before the call. If set to off (the
17580 default), @value{GDBN} stops in the frame where the signal was
17583 @item show unwindonsignal
17584 @kindex show unwindonsignal
17585 Show the current setting of stack unwinding in the functions called by
17588 @item set unwind-on-terminating-exception
17589 @kindex set unwind-on-terminating-exception
17590 @cindex unwind stack in called functions with unhandled exceptions
17591 @cindex call dummy stack unwinding on unhandled exception.
17592 Set unwinding of the stack if a C@t{++} exception is raised, but left
17593 unhandled while in a function that @value{GDBN} called in the program being
17594 debugged. If set to on (the default), @value{GDBN} unwinds the stack
17595 it created for the call and restores the context to what it was before
17596 the call. If set to off, @value{GDBN} the exception is delivered to
17597 the default C@t{++} exception handler and the inferior terminated.
17599 @item show unwind-on-terminating-exception
17600 @kindex show unwind-on-terminating-exception
17601 Show the current setting of stack unwinding in the functions called by
17606 @cindex weak alias functions
17607 Sometimes, a function you wish to call is actually a @dfn{weak alias}
17608 for another function. In such case, @value{GDBN} might not pick up
17609 the type information, including the types of the function arguments,
17610 which causes @value{GDBN} to call the inferior function incorrectly.
17611 As a result, the called function will function erroneously and may
17612 even crash. A solution to that is to use the name of the aliased
17616 @section Patching Programs
17618 @cindex patching binaries
17619 @cindex writing into executables
17620 @cindex writing into corefiles
17622 By default, @value{GDBN} opens the file containing your program's
17623 executable code (or the corefile) read-only. This prevents accidental
17624 alterations to machine code; but it also prevents you from intentionally
17625 patching your program's binary.
17627 If you'd like to be able to patch the binary, you can specify that
17628 explicitly with the @code{set write} command. For example, you might
17629 want to turn on internal debugging flags, or even to make emergency
17635 @itemx set write off
17636 If you specify @samp{set write on}, @value{GDBN} opens executable and
17637 core files for both reading and writing; if you specify @kbd{set write
17638 off} (the default), @value{GDBN} opens them read-only.
17640 If you have already loaded a file, you must load it again (using the
17641 @code{exec-file} or @code{core-file} command) after changing @code{set
17642 write}, for your new setting to take effect.
17646 Display whether executable files and core files are opened for writing
17647 as well as reading.
17650 @node Compiling and Injecting Code
17651 @section Compiling and injecting code in @value{GDBN}
17652 @cindex injecting code
17653 @cindex writing into executables
17654 @cindex compiling code
17656 @value{GDBN} supports on-demand compilation and code injection into
17657 programs running under @value{GDBN}. GCC 5.0 or higher built with
17658 @file{libcc1.so} must be installed for this functionality to be enabled.
17659 This functionality is implemented with the following commands.
17662 @kindex compile code
17663 @item compile code @var{source-code}
17664 @itemx compile code -raw @var{--} @var{source-code}
17665 Compile @var{source-code} with the compiler language found as the current
17666 language in @value{GDBN} (@pxref{Languages}). If compilation and
17667 injection is not supported with the current language specified in
17668 @value{GDBN}, or the compiler does not support this feature, an error
17669 message will be printed. If @var{source-code} compiles and links
17670 successfully, @value{GDBN} will load the object-code emitted,
17671 and execute it within the context of the currently selected inferior.
17672 It is important to note that the compiled code is executed immediately.
17673 After execution, the compiled code is removed from @value{GDBN} and any
17674 new types or variables you have defined will be deleted.
17676 The command allows you to specify @var{source-code} in two ways.
17677 The simplest method is to provide a single line of code to the command.
17681 compile code printf ("hello world\n");
17684 If you specify options on the command line as well as source code, they
17685 may conflict. The @samp{--} delimiter can be used to separate options
17686 from actual source code. E.g.:
17689 compile code -r -- printf ("hello world\n");
17692 Alternatively you can enter source code as multiple lines of text. To
17693 enter this mode, invoke the @samp{compile code} command without any text
17694 following the command. This will start the multiple-line editor and
17695 allow you to type as many lines of source code as required. When you
17696 have completed typing, enter @samp{end} on its own line to exit the
17701 >printf ("hello\n");
17702 >printf ("world\n");
17706 Specifying @samp{-raw}, prohibits @value{GDBN} from wrapping the
17707 provided @var{source-code} in a callable scope. In this case, you must
17708 specify the entry point of the code by defining a function named
17709 @code{_gdb_expr_}. The @samp{-raw} code cannot access variables of the
17710 inferior. Using @samp{-raw} option may be needed for example when
17711 @var{source-code} requires @samp{#include} lines which may conflict with
17712 inferior symbols otherwise.
17714 @kindex compile file
17715 @item compile file @var{filename}
17716 @itemx compile file -raw @var{filename}
17717 Like @code{compile code}, but take the source code from @var{filename}.
17720 compile file /home/user/example.c
17725 @item compile print @var{expr}
17726 @itemx compile print /@var{f} @var{expr}
17727 Compile and execute @var{expr} with the compiler language found as the
17728 current language in @value{GDBN} (@pxref{Languages}). By default the
17729 value of @var{expr} is printed in a format appropriate to its data type;
17730 you can choose a different format by specifying @samp{/@var{f}}, where
17731 @var{f} is a letter specifying the format; see @ref{Output Formats,,Output
17734 @item compile print
17735 @itemx compile print /@var{f}
17736 @cindex reprint the last value
17737 Alternatively you can enter the expression (source code producing it) as
17738 multiple lines of text. To enter this mode, invoke the @samp{compile print}
17739 command without any text following the command. This will start the
17740 multiple-line editor.
17744 The process of compiling and injecting the code can be inspected using:
17747 @anchor{set debug compile}
17748 @item set debug compile
17749 @cindex compile command debugging info
17750 Turns on or off display of @value{GDBN} process of compiling and
17751 injecting the code. The default is off.
17753 @item show debug compile
17754 Displays the current state of displaying @value{GDBN} process of
17755 compiling and injecting the code.
17758 @subsection Compilation options for the @code{compile} command
17760 @value{GDBN} needs to specify the right compilation options for the code
17761 to be injected, in part to make its ABI compatible with the inferior
17762 and in part to make the injected code compatible with @value{GDBN}'s
17766 The options used, in increasing precedence:
17769 @item target architecture and OS options (@code{gdbarch})
17770 These options depend on target processor type and target operating
17771 system, usually they specify at least 32-bit (@code{-m32}) or 64-bit
17772 (@code{-m64}) compilation option.
17774 @item compilation options recorded in the target
17775 @value{NGCC} (since version 4.7) stores the options used for compilation
17776 into @code{DW_AT_producer} part of DWARF debugging information according
17777 to the @value{NGCC} option @code{-grecord-gcc-switches}. One has to
17778 explicitly specify @code{-g} during inferior compilation otherwise
17779 @value{NGCC} produces no DWARF. This feature is only relevant for
17780 platforms where @code{-g} produces DWARF by default, otherwise one may
17781 try to enforce DWARF by using @code{-gdwarf-4}.
17783 @item compilation options set by @code{set compile-args}
17787 You can override compilation options using the following command:
17790 @item set compile-args
17791 @cindex compile command options override
17792 Set compilation options used for compiling and injecting code with the
17793 @code{compile} commands. These options override any conflicting ones
17794 from the target architecture and/or options stored during inferior
17797 @item show compile-args
17798 Displays the current state of compilation options override.
17799 This does not show all the options actually used during compilation,
17800 use @ref{set debug compile} for that.
17803 @subsection Caveats when using the @code{compile} command
17805 There are a few caveats to keep in mind when using the @code{compile}
17806 command. As the caveats are different per language, the table below
17807 highlights specific issues on a per language basis.
17810 @item C code examples and caveats
17811 When the language in @value{GDBN} is set to @samp{C}, the compiler will
17812 attempt to compile the source code with a @samp{C} compiler. The source
17813 code provided to the @code{compile} command will have much the same
17814 access to variables and types as it normally would if it were part of
17815 the program currently being debugged in @value{GDBN}.
17817 Below is a sample program that forms the basis of the examples that
17818 follow. This program has been compiled and loaded into @value{GDBN},
17819 much like any other normal debugging session.
17822 void function1 (void)
17825 printf ("function 1\n");
17828 void function2 (void)
17843 For the purposes of the examples in this section, the program above has
17844 been compiled, loaded into @value{GDBN}, stopped at the function
17845 @code{main}, and @value{GDBN} is awaiting input from the user.
17847 To access variables and types for any program in @value{GDBN}, the
17848 program must be compiled and packaged with debug information. The
17849 @code{compile} command is not an exception to this rule. Without debug
17850 information, you can still use the @code{compile} command, but you will
17851 be very limited in what variables and types you can access.
17853 So with that in mind, the example above has been compiled with debug
17854 information enabled. The @code{compile} command will have access to
17855 all variables and types (except those that may have been optimized
17856 out). Currently, as @value{GDBN} has stopped the program in the
17857 @code{main} function, the @code{compile} command would have access to
17858 the variable @code{k}. You could invoke the @code{compile} command
17859 and type some source code to set the value of @code{k}. You can also
17860 read it, or do anything with that variable you would normally do in
17861 @code{C}. Be aware that changes to inferior variables in the
17862 @code{compile} command are persistent. In the following example:
17865 compile code k = 3;
17869 the variable @code{k} is now 3. It will retain that value until
17870 something else in the example program changes it, or another
17871 @code{compile} command changes it.
17873 Normal scope and access rules apply to source code compiled and
17874 injected by the @code{compile} command. In the example, the variables
17875 @code{j} and @code{k} are not accessible yet, because the program is
17876 currently stopped in the @code{main} function, where these variables
17877 are not in scope. Therefore, the following command
17880 compile code j = 3;
17884 will result in a compilation error message.
17886 Once the program is continued, execution will bring these variables in
17887 scope, and they will become accessible; then the code you specify via
17888 the @code{compile} command will be able to access them.
17890 You can create variables and types with the @code{compile} command as
17891 part of your source code. Variables and types that are created as part
17892 of the @code{compile} command are not visible to the rest of the program for
17893 the duration of its run. This example is valid:
17896 compile code int ff = 5; printf ("ff is %d\n", ff);
17899 However, if you were to type the following into @value{GDBN} after that
17900 command has completed:
17903 compile code printf ("ff is %d\n'', ff);
17907 a compiler error would be raised as the variable @code{ff} no longer
17908 exists. Object code generated and injected by the @code{compile}
17909 command is removed when its execution ends. Caution is advised
17910 when assigning to program variables values of variables created by the
17911 code submitted to the @code{compile} command. This example is valid:
17914 compile code int ff = 5; k = ff;
17917 The value of the variable @code{ff} is assigned to @code{k}. The variable
17918 @code{k} does not require the existence of @code{ff} to maintain the value
17919 it has been assigned. However, pointers require particular care in
17920 assignment. If the source code compiled with the @code{compile} command
17921 changed the address of a pointer in the example program, perhaps to a
17922 variable created in the @code{compile} command, that pointer would point
17923 to an invalid location when the command exits. The following example
17924 would likely cause issues with your debugged program:
17927 compile code int ff = 5; p = &ff;
17930 In this example, @code{p} would point to @code{ff} when the
17931 @code{compile} command is executing the source code provided to it.
17932 However, as variables in the (example) program persist with their
17933 assigned values, the variable @code{p} would point to an invalid
17934 location when the command exists. A general rule should be followed
17935 in that you should either assign @code{NULL} to any assigned pointers,
17936 or restore a valid location to the pointer before the command exits.
17938 Similar caution must be exercised with any structs, unions, and typedefs
17939 defined in @code{compile} command. Types defined in the @code{compile}
17940 command will no longer be available in the next @code{compile} command.
17941 Therefore, if you cast a variable to a type defined in the
17942 @code{compile} command, care must be taken to ensure that any future
17943 need to resolve the type can be achieved.
17946 (gdb) compile code static struct a @{ int a; @} v = @{ 42 @}; argv = &v;
17947 (gdb) compile code printf ("%d\n", ((struct a *) argv)->a);
17948 gdb command line:1:36: error: dereferencing pointer to incomplete type ‘struct a’
17949 Compilation failed.
17950 (gdb) compile code struct a @{ int a; @}; printf ("%d\n", ((struct a *) argv)->a);
17954 Variables that have been optimized away by the compiler are not
17955 accessible to the code submitted to the @code{compile} command.
17956 Access to those variables will generate a compiler error which @value{GDBN}
17957 will print to the console.
17960 @subsection Compiler search for the @code{compile} command
17962 @value{GDBN} needs to find @value{NGCC} for the inferior being debugged which
17963 may not be obvious for remote targets of different architecture than where
17964 @value{GDBN} is running. Environment variable @code{PATH} (@code{PATH} from
17965 shell that executed @value{GDBN}, not the one set by @value{GDBN}
17966 command @code{set environment}). @xref{Environment}. @code{PATH} on
17967 @value{GDBN} host is searched for @value{NGCC} binary matching the
17968 target architecture and operating system.
17970 Specifically @code{PATH} is searched for binaries matching regular expression
17971 @code{@var{arch}(-[^-]*)?-@var{os}-gcc} according to the inferior target being
17972 debugged. @var{arch} is processor name --- multiarch is supported, so for
17973 example both @code{i386} and @code{x86_64} targets look for pattern
17974 @code{(x86_64|i.86)} and both @code{s390} and @code{s390x} targets look
17975 for pattern @code{s390x?}. @var{os} is currently supported only for
17976 pattern @code{linux(-gnu)?}.
17979 @chapter @value{GDBN} Files
17981 @value{GDBN} needs to know the file name of the program to be debugged,
17982 both in order to read its symbol table and in order to start your
17983 program. To debug a core dump of a previous run, you must also tell
17984 @value{GDBN} the name of the core dump file.
17987 * Files:: Commands to specify files
17988 * File Caching:: Information about @value{GDBN}'s file caching
17989 * Separate Debug Files:: Debugging information in separate files
17990 * MiniDebugInfo:: Debugging information in a special section
17991 * Index Files:: Index files speed up GDB
17992 * Symbol Errors:: Errors reading symbol files
17993 * Data Files:: GDB data files
17997 @section Commands to Specify Files
17999 @cindex symbol table
18000 @cindex core dump file
18002 You may want to specify executable and core dump file names. The usual
18003 way to do this is at start-up time, using the arguments to
18004 @value{GDBN}'s start-up commands (@pxref{Invocation, , Getting In and
18005 Out of @value{GDBN}}).
18007 Occasionally it is necessary to change to a different file during a
18008 @value{GDBN} session. Or you may run @value{GDBN} and forget to
18009 specify a file you want to use. Or you are debugging a remote target
18010 via @code{gdbserver} (@pxref{Server, file, Using the @code{gdbserver}
18011 Program}). In these situations the @value{GDBN} commands to specify
18012 new files are useful.
18015 @cindex executable file
18017 @item file @var{filename}
18018 Use @var{filename} as the program to be debugged. It is read for its
18019 symbols and for the contents of pure memory. It is also the program
18020 executed when you use the @code{run} command. If you do not specify a
18021 directory and the file is not found in the @value{GDBN} working directory,
18022 @value{GDBN} uses the environment variable @code{PATH} as a list of
18023 directories to search, just as the shell does when looking for a program
18024 to run. You can change the value of this variable, for both @value{GDBN}
18025 and your program, using the @code{path} command.
18027 @cindex unlinked object files
18028 @cindex patching object files
18029 You can load unlinked object @file{.o} files into @value{GDBN} using
18030 the @code{file} command. You will not be able to ``run'' an object
18031 file, but you can disassemble functions and inspect variables. Also,
18032 if the underlying BFD functionality supports it, you could use
18033 @kbd{gdb -write} to patch object files using this technique. Note
18034 that @value{GDBN} can neither interpret nor modify relocations in this
18035 case, so branches and some initialized variables will appear to go to
18036 the wrong place. But this feature is still handy from time to time.
18039 @code{file} with no argument makes @value{GDBN} discard any information it
18040 has on both executable file and the symbol table.
18043 @item exec-file @r{[} @var{filename} @r{]}
18044 Specify that the program to be run (but not the symbol table) is found
18045 in @var{filename}. @value{GDBN} searches the environment variable @code{PATH}
18046 if necessary to locate your program. Omitting @var{filename} means to
18047 discard information on the executable file.
18049 @kindex symbol-file
18050 @item symbol-file @r{[} @var{filename} @r{]}
18051 Read symbol table information from file @var{filename}. @code{PATH} is
18052 searched when necessary. Use the @code{file} command to get both symbol
18053 table and program to run from the same file.
18055 @code{symbol-file} with no argument clears out @value{GDBN} information on your
18056 program's symbol table.
18058 The @code{symbol-file} command causes @value{GDBN} to forget the contents of
18059 some breakpoints and auto-display expressions. This is because they may
18060 contain pointers to the internal data recording symbols and data types,
18061 which are part of the old symbol table data being discarded inside
18064 @code{symbol-file} does not repeat if you press @key{RET} again after
18067 When @value{GDBN} is configured for a particular environment, it
18068 understands debugging information in whatever format is the standard
18069 generated for that environment; you may use either a @sc{gnu} compiler, or
18070 other compilers that adhere to the local conventions.
18071 Best results are usually obtained from @sc{gnu} compilers; for example,
18072 using @code{@value{NGCC}} you can generate debugging information for
18075 For most kinds of object files, with the exception of old SVR3 systems
18076 using COFF, the @code{symbol-file} command does not normally read the
18077 symbol table in full right away. Instead, it scans the symbol table
18078 quickly to find which source files and which symbols are present. The
18079 details are read later, one source file at a time, as they are needed.
18081 The purpose of this two-stage reading strategy is to make @value{GDBN}
18082 start up faster. For the most part, it is invisible except for
18083 occasional pauses while the symbol table details for a particular source
18084 file are being read. (The @code{set verbose} command can turn these
18085 pauses into messages if desired. @xref{Messages/Warnings, ,Optional
18086 Warnings and Messages}.)
18088 We have not implemented the two-stage strategy for COFF yet. When the
18089 symbol table is stored in COFF format, @code{symbol-file} reads the
18090 symbol table data in full right away. Note that ``stabs-in-COFF''
18091 still does the two-stage strategy, since the debug info is actually
18095 @cindex reading symbols immediately
18096 @cindex symbols, reading immediately
18097 @item symbol-file @r{[} -readnow @r{]} @var{filename}
18098 @itemx file @r{[} -readnow @r{]} @var{filename}
18099 You can override the @value{GDBN} two-stage strategy for reading symbol
18100 tables by using the @samp{-readnow} option with any of the commands that
18101 load symbol table information, if you want to be sure @value{GDBN} has the
18102 entire symbol table available.
18104 @c FIXME: for now no mention of directories, since this seems to be in
18105 @c flux. 13mar1992 status is that in theory GDB would look either in
18106 @c current dir or in same dir as myprog; but issues like competing
18107 @c GDB's, or clutter in system dirs, mean that in practice right now
18108 @c only current dir is used. FFish says maybe a special GDB hierarchy
18109 @c (eg rooted in val of env var GDBSYMS) could exist for mappable symbol
18113 @item core-file @r{[}@var{filename}@r{]}
18115 Specify the whereabouts of a core dump file to be used as the ``contents
18116 of memory''. Traditionally, core files contain only some parts of the
18117 address space of the process that generated them; @value{GDBN} can access the
18118 executable file itself for other parts.
18120 @code{core-file} with no argument specifies that no core file is
18123 Note that the core file is ignored when your program is actually running
18124 under @value{GDBN}. So, if you have been running your program and you
18125 wish to debug a core file instead, you must kill the subprocess in which
18126 the program is running. To do this, use the @code{kill} command
18127 (@pxref{Kill Process, ,Killing the Child Process}).
18129 @kindex add-symbol-file
18130 @cindex dynamic linking
18131 @item add-symbol-file @var{filename} @var{address}
18132 @itemx add-symbol-file @var{filename} @var{address} @r{[} -readnow @r{]}
18133 @itemx add-symbol-file @var{filename} @var{address} -s @var{section} @var{address} @dots{}
18134 The @code{add-symbol-file} command reads additional symbol table
18135 information from the file @var{filename}. You would use this command
18136 when @var{filename} has been dynamically loaded (by some other means)
18137 into the program that is running. The @var{address} should give the memory
18138 address at which the file has been loaded; @value{GDBN} cannot figure
18139 this out for itself. You can additionally specify an arbitrary number
18140 of @samp{-s @var{section} @var{address}} pairs, to give an explicit
18141 section name and base address for that section. You can specify any
18142 @var{address} as an expression.
18144 The symbol table of the file @var{filename} is added to the symbol table
18145 originally read with the @code{symbol-file} command. You can use the
18146 @code{add-symbol-file} command any number of times; the new symbol data
18147 thus read is kept in addition to the old.
18149 Changes can be reverted using the command @code{remove-symbol-file}.
18151 @cindex relocatable object files, reading symbols from
18152 @cindex object files, relocatable, reading symbols from
18153 @cindex reading symbols from relocatable object files
18154 @cindex symbols, reading from relocatable object files
18155 @cindex @file{.o} files, reading symbols from
18156 Although @var{filename} is typically a shared library file, an
18157 executable file, or some other object file which has been fully
18158 relocated for loading into a process, you can also load symbolic
18159 information from relocatable @file{.o} files, as long as:
18163 the file's symbolic information refers only to linker symbols defined in
18164 that file, not to symbols defined by other object files,
18166 every section the file's symbolic information refers to has actually
18167 been loaded into the inferior, as it appears in the file, and
18169 you can determine the address at which every section was loaded, and
18170 provide these to the @code{add-symbol-file} command.
18174 Some embedded operating systems, like Sun Chorus and VxWorks, can load
18175 relocatable files into an already running program; such systems
18176 typically make the requirements above easy to meet. However, it's
18177 important to recognize that many native systems use complex link
18178 procedures (@code{.linkonce} section factoring and C@t{++} constructor table
18179 assembly, for example) that make the requirements difficult to meet. In
18180 general, one cannot assume that using @code{add-symbol-file} to read a
18181 relocatable object file's symbolic information will have the same effect
18182 as linking the relocatable object file into the program in the normal
18185 @code{add-symbol-file} does not repeat if you press @key{RET} after using it.
18187 @kindex remove-symbol-file
18188 @item remove-symbol-file @var{filename}
18189 @item remove-symbol-file -a @var{address}
18190 Remove a symbol file added via the @code{add-symbol-file} command. The
18191 file to remove can be identified by its @var{filename} or by an @var{address}
18192 that lies within the boundaries of this symbol file in memory. Example:
18195 (gdb) add-symbol-file /home/user/gdb/mylib.so 0x7ffff7ff9480
18196 add symbol table from file "/home/user/gdb/mylib.so" at
18197 .text_addr = 0x7ffff7ff9480
18199 Reading symbols from /home/user/gdb/mylib.so...done.
18200 (gdb) remove-symbol-file -a 0x7ffff7ff9480
18201 Remove symbol table from file "/home/user/gdb/mylib.so"? (y or n) y
18206 @code{remove-symbol-file} does not repeat if you press @key{RET} after using it.
18208 @kindex add-symbol-file-from-memory
18209 @cindex @code{syscall DSO}
18210 @cindex load symbols from memory
18211 @item add-symbol-file-from-memory @var{address}
18212 Load symbols from the given @var{address} in a dynamically loaded
18213 object file whose image is mapped directly into the inferior's memory.
18214 For example, the Linux kernel maps a @code{syscall DSO} into each
18215 process's address space; this DSO provides kernel-specific code for
18216 some system calls. The argument can be any expression whose
18217 evaluation yields the address of the file's shared object file header.
18218 For this command to work, you must have used @code{symbol-file} or
18219 @code{exec-file} commands in advance.
18222 @item section @var{section} @var{addr}
18223 The @code{section} command changes the base address of the named
18224 @var{section} of the exec file to @var{addr}. This can be used if the
18225 exec file does not contain section addresses, (such as in the
18226 @code{a.out} format), or when the addresses specified in the file
18227 itself are wrong. Each section must be changed separately. The
18228 @code{info files} command, described below, lists all the sections and
18232 @kindex info target
18235 @code{info files} and @code{info target} are synonymous; both print the
18236 current target (@pxref{Targets, ,Specifying a Debugging Target}),
18237 including the names of the executable and core dump files currently in
18238 use by @value{GDBN}, and the files from which symbols were loaded. The
18239 command @code{help target} lists all possible targets rather than
18242 @kindex maint info sections
18243 @item maint info sections
18244 Another command that can give you extra information about program sections
18245 is @code{maint info sections}. In addition to the section information
18246 displayed by @code{info files}, this command displays the flags and file
18247 offset of each section in the executable and core dump files. In addition,
18248 @code{maint info sections} provides the following command options (which
18249 may be arbitrarily combined):
18253 Display sections for all loaded object files, including shared libraries.
18254 @item @var{sections}
18255 Display info only for named @var{sections}.
18256 @item @var{section-flags}
18257 Display info only for sections for which @var{section-flags} are true.
18258 The section flags that @value{GDBN} currently knows about are:
18261 Section will have space allocated in the process when loaded.
18262 Set for all sections except those containing debug information.
18264 Section will be loaded from the file into the child process memory.
18265 Set for pre-initialized code and data, clear for @code{.bss} sections.
18267 Section needs to be relocated before loading.
18269 Section cannot be modified by the child process.
18271 Section contains executable code only.
18273 Section contains data only (no executable code).
18275 Section will reside in ROM.
18277 Section contains data for constructor/destructor lists.
18279 Section is not empty.
18281 An instruction to the linker to not output the section.
18282 @item COFF_SHARED_LIBRARY
18283 A notification to the linker that the section contains
18284 COFF shared library information.
18286 Section contains common symbols.
18289 @kindex set trust-readonly-sections
18290 @cindex read-only sections
18291 @item set trust-readonly-sections on
18292 Tell @value{GDBN} that readonly sections in your object file
18293 really are read-only (i.e.@: that their contents will not change).
18294 In that case, @value{GDBN} can fetch values from these sections
18295 out of the object file, rather than from the target program.
18296 For some targets (notably embedded ones), this can be a significant
18297 enhancement to debugging performance.
18299 The default is off.
18301 @item set trust-readonly-sections off
18302 Tell @value{GDBN} not to trust readonly sections. This means that
18303 the contents of the section might change while the program is running,
18304 and must therefore be fetched from the target when needed.
18306 @item show trust-readonly-sections
18307 Show the current setting of trusting readonly sections.
18310 All file-specifying commands allow both absolute and relative file names
18311 as arguments. @value{GDBN} always converts the file name to an absolute file
18312 name and remembers it that way.
18314 @cindex shared libraries
18315 @anchor{Shared Libraries}
18316 @value{GDBN} supports @sc{gnu}/Linux, MS-Windows, SunOS,
18317 Darwin/Mach-O, SVr4, IBM RS/6000 AIX, QNX Neutrino, FDPIC (FR-V), and
18318 DSBT (TIC6X) shared libraries.
18320 On MS-Windows @value{GDBN} must be linked with the Expat library to support
18321 shared libraries. @xref{Expat}.
18323 @value{GDBN} automatically loads symbol definitions from shared libraries
18324 when you use the @code{run} command, or when you examine a core file.
18325 (Before you issue the @code{run} command, @value{GDBN} does not understand
18326 references to a function in a shared library, however---unless you are
18327 debugging a core file).
18329 @c FIXME: some @value{GDBN} release may permit some refs to undef
18330 @c FIXME...symbols---eg in a break cmd---assuming they are from a shared
18331 @c FIXME...lib; check this from time to time when updating manual
18333 There are times, however, when you may wish to not automatically load
18334 symbol definitions from shared libraries, such as when they are
18335 particularly large or there are many of them.
18337 To control the automatic loading of shared library symbols, use the
18341 @kindex set auto-solib-add
18342 @item set auto-solib-add @var{mode}
18343 If @var{mode} is @code{on}, symbols from all shared object libraries
18344 will be loaded automatically when the inferior begins execution, you
18345 attach to an independently started inferior, or when the dynamic linker
18346 informs @value{GDBN} that a new library has been loaded. If @var{mode}
18347 is @code{off}, symbols must be loaded manually, using the
18348 @code{sharedlibrary} command. The default value is @code{on}.
18350 @cindex memory used for symbol tables
18351 If your program uses lots of shared libraries with debug info that
18352 takes large amounts of memory, you can decrease the @value{GDBN}
18353 memory footprint by preventing it from automatically loading the
18354 symbols from shared libraries. To that end, type @kbd{set
18355 auto-solib-add off} before running the inferior, then load each
18356 library whose debug symbols you do need with @kbd{sharedlibrary
18357 @var{regexp}}, where @var{regexp} is a regular expression that matches
18358 the libraries whose symbols you want to be loaded.
18360 @kindex show auto-solib-add
18361 @item show auto-solib-add
18362 Display the current autoloading mode.
18365 @cindex load shared library
18366 To explicitly load shared library symbols, use the @code{sharedlibrary}
18370 @kindex info sharedlibrary
18372 @item info share @var{regex}
18373 @itemx info sharedlibrary @var{regex}
18374 Print the names of the shared libraries which are currently loaded
18375 that match @var{regex}. If @var{regex} is omitted then print
18376 all shared libraries that are loaded.
18379 @item info dll @var{regex}
18380 This is an alias of @code{info sharedlibrary}.
18382 @kindex sharedlibrary
18384 @item sharedlibrary @var{regex}
18385 @itemx share @var{regex}
18386 Load shared object library symbols for files matching a
18387 Unix regular expression.
18388 As with files loaded automatically, it only loads shared libraries
18389 required by your program for a core file or after typing @code{run}. If
18390 @var{regex} is omitted all shared libraries required by your program are
18393 @item nosharedlibrary
18394 @kindex nosharedlibrary
18395 @cindex unload symbols from shared libraries
18396 Unload all shared object library symbols. This discards all symbols
18397 that have been loaded from all shared libraries. Symbols from shared
18398 libraries that were loaded by explicit user requests are not
18402 Sometimes you may wish that @value{GDBN} stops and gives you control
18403 when any of shared library events happen. The best way to do this is
18404 to use @code{catch load} and @code{catch unload} (@pxref{Set
18407 @value{GDBN} also supports the the @code{set stop-on-solib-events}
18408 command for this. This command exists for historical reasons. It is
18409 less useful than setting a catchpoint, because it does not allow for
18410 conditions or commands as a catchpoint does.
18413 @item set stop-on-solib-events
18414 @kindex set stop-on-solib-events
18415 This command controls whether @value{GDBN} should give you control
18416 when the dynamic linker notifies it about some shared library event.
18417 The most common event of interest is loading or unloading of a new
18420 @item show stop-on-solib-events
18421 @kindex show stop-on-solib-events
18422 Show whether @value{GDBN} stops and gives you control when shared
18423 library events happen.
18426 Shared libraries are also supported in many cross or remote debugging
18427 configurations. @value{GDBN} needs to have access to the target's libraries;
18428 this can be accomplished either by providing copies of the libraries
18429 on the host system, or by asking @value{GDBN} to automatically retrieve the
18430 libraries from the target. If copies of the target libraries are
18431 provided, they need to be the same as the target libraries, although the
18432 copies on the target can be stripped as long as the copies on the host are
18435 @cindex where to look for shared libraries
18436 For remote debugging, you need to tell @value{GDBN} where the target
18437 libraries are, so that it can load the correct copies---otherwise, it
18438 may try to load the host's libraries. @value{GDBN} has two variables
18439 to specify the search directories for target libraries.
18442 @cindex prefix for executable and shared library file names
18443 @cindex system root, alternate
18444 @kindex set solib-absolute-prefix
18445 @kindex set sysroot
18446 @item set sysroot @var{path}
18447 Use @var{path} as the system root for the program being debugged. Any
18448 absolute shared library paths will be prefixed with @var{path}; many
18449 runtime loaders store the absolute paths to the shared library in the
18450 target program's memory. When starting processes remotely, and when
18451 attaching to already-running processes (local or remote), their
18452 executable filenames will be prefixed with @var{path} if reported to
18453 @value{GDBN} as absolute by the operating system. If you use
18454 @code{set sysroot} to find executables and shared libraries, they need
18455 to be laid out in the same way that they are on the target, with
18456 e.g.@: a @file{/bin}, @file{/lib} and @file{/usr/lib} hierarchy under
18459 If @var{path} starts with the sequence @file{target:} and the target
18460 system is remote then @value{GDBN} will retrieve the target binaries
18461 from the remote system. This is only supported when using a remote
18462 target that supports the @code{remote get} command (@pxref{File
18463 Transfer,,Sending files to a remote system}). The part of @var{path}
18464 following the initial @file{target:} (if present) is used as system
18465 root prefix on the remote file system. If @var{path} starts with the
18466 sequence @file{remote:} this is converted to the sequence
18467 @file{target:} by @code{set sysroot}@footnote{Historically the
18468 functionality to retrieve binaries from the remote system was
18469 provided by prefixing @var{path} with @file{remote:}}. If you want
18470 to specify a local system root using a directory that happens to be
18471 named @file{target:} or @file{remote:}, you need to use some
18472 equivalent variant of the name like @file{./target:}.
18474 For targets with an MS-DOS based filesystem, such as MS-Windows and
18475 SymbianOS, @value{GDBN} tries prefixing a few variants of the target
18476 absolute file name with @var{path}. But first, on Unix hosts,
18477 @value{GDBN} converts all backslash directory separators into forward
18478 slashes, because the backslash is not a directory separator on Unix:
18481 c:\foo\bar.dll @result{} c:/foo/bar.dll
18484 Then, @value{GDBN} attempts prefixing the target file name with
18485 @var{path}, and looks for the resulting file name in the host file
18489 c:/foo/bar.dll @result{} /path/to/sysroot/c:/foo/bar.dll
18492 If that does not find the binary, @value{GDBN} tries removing
18493 the @samp{:} character from the drive spec, both for convenience, and,
18494 for the case of the host file system not supporting file names with
18498 c:/foo/bar.dll @result{} /path/to/sysroot/c/foo/bar.dll
18501 This makes it possible to have a system root that mirrors a target
18502 with more than one drive. E.g., you may want to setup your local
18503 copies of the target system shared libraries like so (note @samp{c} vs
18507 @file{/path/to/sysroot/c/sys/bin/foo.dll}
18508 @file{/path/to/sysroot/c/sys/bin/bar.dll}
18509 @file{/path/to/sysroot/z/sys/bin/bar.dll}
18513 and point the system root at @file{/path/to/sysroot}, so that
18514 @value{GDBN} can find the correct copies of both
18515 @file{c:\sys\bin\foo.dll}, and @file{z:\sys\bin\bar.dll}.
18517 If that still does not find the binary, @value{GDBN} tries
18518 removing the whole drive spec from the target file name:
18521 c:/foo/bar.dll @result{} /path/to/sysroot/foo/bar.dll
18524 This last lookup makes it possible to not care about the drive name,
18525 if you don't want or need to.
18527 The @code{set solib-absolute-prefix} command is an alias for @code{set
18530 @cindex default system root
18531 @cindex @samp{--with-sysroot}
18532 You can set the default system root by using the configure-time
18533 @samp{--with-sysroot} option. If the system root is inside
18534 @value{GDBN}'s configured binary prefix (set with @samp{--prefix} or
18535 @samp{--exec-prefix}), then the default system root will be updated
18536 automatically if the installed @value{GDBN} is moved to a new
18539 @kindex show sysroot
18541 Display the current executable and shared library prefix.
18543 @kindex set solib-search-path
18544 @item set solib-search-path @var{path}
18545 If this variable is set, @var{path} is a colon-separated list of
18546 directories to search for shared libraries. @samp{solib-search-path}
18547 is used after @samp{sysroot} fails to locate the library, or if the
18548 path to the library is relative instead of absolute. If you want to
18549 use @samp{solib-search-path} instead of @samp{sysroot}, be sure to set
18550 @samp{sysroot} to a nonexistent directory to prevent @value{GDBN} from
18551 finding your host's libraries. @samp{sysroot} is preferred; setting
18552 it to a nonexistent directory may interfere with automatic loading
18553 of shared library symbols.
18555 @kindex show solib-search-path
18556 @item show solib-search-path
18557 Display the current shared library search path.
18559 @cindex DOS file-name semantics of file names.
18560 @kindex set target-file-system-kind (unix|dos-based|auto)
18561 @kindex show target-file-system-kind
18562 @item set target-file-system-kind @var{kind}
18563 Set assumed file system kind for target reported file names.
18565 Shared library file names as reported by the target system may not
18566 make sense as is on the system @value{GDBN} is running on. For
18567 example, when remote debugging a target that has MS-DOS based file
18568 system semantics, from a Unix host, the target may be reporting to
18569 @value{GDBN} a list of loaded shared libraries with file names such as
18570 @file{c:\Windows\kernel32.dll}. On Unix hosts, there's no concept of
18571 drive letters, so the @samp{c:\} prefix is not normally understood as
18572 indicating an absolute file name, and neither is the backslash
18573 normally considered a directory separator character. In that case,
18574 the native file system would interpret this whole absolute file name
18575 as a relative file name with no directory components. This would make
18576 it impossible to point @value{GDBN} at a copy of the remote target's
18577 shared libraries on the host using @code{set sysroot}, and impractical
18578 with @code{set solib-search-path}. Setting
18579 @code{target-file-system-kind} to @code{dos-based} tells @value{GDBN}
18580 to interpret such file names similarly to how the target would, and to
18581 map them to file names valid on @value{GDBN}'s native file system
18582 semantics. The value of @var{kind} can be @code{"auto"}, in addition
18583 to one of the supported file system kinds. In that case, @value{GDBN}
18584 tries to determine the appropriate file system variant based on the
18585 current target's operating system (@pxref{ABI, ,Configuring the
18586 Current ABI}). The supported file system settings are:
18590 Instruct @value{GDBN} to assume the target file system is of Unix
18591 kind. Only file names starting the forward slash (@samp{/}) character
18592 are considered absolute, and the directory separator character is also
18596 Instruct @value{GDBN} to assume the target file system is DOS based.
18597 File names starting with either a forward slash, or a drive letter
18598 followed by a colon (e.g., @samp{c:}), are considered absolute, and
18599 both the slash (@samp{/}) and the backslash (@samp{\\}) characters are
18600 considered directory separators.
18603 Instruct @value{GDBN} to use the file system kind associated with the
18604 target operating system (@pxref{ABI, ,Configuring the Current ABI}).
18605 This is the default.
18609 @cindex file name canonicalization
18610 @cindex base name differences
18611 When processing file names provided by the user, @value{GDBN}
18612 frequently needs to compare them to the file names recorded in the
18613 program's debug info. Normally, @value{GDBN} compares just the
18614 @dfn{base names} of the files as strings, which is reasonably fast
18615 even for very large programs. (The base name of a file is the last
18616 portion of its name, after stripping all the leading directories.)
18617 This shortcut in comparison is based upon the assumption that files
18618 cannot have more than one base name. This is usually true, but
18619 references to files that use symlinks or similar filesystem
18620 facilities violate that assumption. If your program records files
18621 using such facilities, or if you provide file names to @value{GDBN}
18622 using symlinks etc., you can set @code{basenames-may-differ} to
18623 @code{true} to instruct @value{GDBN} to completely canonicalize each
18624 pair of file names it needs to compare. This will make file-name
18625 comparisons accurate, but at a price of a significant slowdown.
18628 @item set basenames-may-differ
18629 @kindex set basenames-may-differ
18630 Set whether a source file may have multiple base names.
18632 @item show basenames-may-differ
18633 @kindex show basenames-may-differ
18634 Show whether a source file may have multiple base names.
18638 @section File Caching
18639 @cindex caching of opened files
18640 @cindex caching of bfd objects
18642 To speed up file loading, and reduce memory usage, @value{GDBN} will
18643 reuse the @code{bfd} objects used to track open files. @xref{Top, ,
18644 BFD, bfd, The Binary File Descriptor Library}. The following commands
18645 allow visibility and control of the caching behavior.
18648 @kindex maint info bfds
18649 @item maint info bfds
18650 This prints information about each @code{bfd} object that is known to
18653 @kindex maint set bfd-sharing
18654 @kindex maint show bfd-sharing
18655 @kindex bfd caching
18656 @item maint set bfd-sharing
18657 @item maint show bfd-sharing
18658 Control whether @code{bfd} objects can be shared. When sharing is
18659 enabled @value{GDBN} reuses already open @code{bfd} objects rather
18660 than reopening the same file. Turning sharing off does not cause
18661 already shared @code{bfd} objects to be unshared, but all future files
18662 that are opened will create a new @code{bfd} object. Similarly,
18663 re-enabling sharing does not cause multiple existing @code{bfd}
18664 objects to be collapsed into a single shared @code{bfd} object.
18666 @kindex set debug bfd-cache @var{level}
18667 @kindex bfd caching
18668 @item set debug bfd-cache @var{level}
18669 Turns on debugging of the bfd cache, setting the level to @var{level}.
18671 @kindex show debug bfd-cache
18672 @kindex bfd caching
18673 @item show debug bfd-cache
18674 Show the current debugging level of the bfd cache.
18677 @node Separate Debug Files
18678 @section Debugging Information in Separate Files
18679 @cindex separate debugging information files
18680 @cindex debugging information in separate files
18681 @cindex @file{.debug} subdirectories
18682 @cindex debugging information directory, global
18683 @cindex global debugging information directories
18684 @cindex build ID, and separate debugging files
18685 @cindex @file{.build-id} directory
18687 @value{GDBN} allows you to put a program's debugging information in a
18688 file separate from the executable itself, in a way that allows
18689 @value{GDBN} to find and load the debugging information automatically.
18690 Since debugging information can be very large---sometimes larger
18691 than the executable code itself---some systems distribute debugging
18692 information for their executables in separate files, which users can
18693 install only when they need to debug a problem.
18695 @value{GDBN} supports two ways of specifying the separate debug info
18700 The executable contains a @dfn{debug link} that specifies the name of
18701 the separate debug info file. The separate debug file's name is
18702 usually @file{@var{executable}.debug}, where @var{executable} is the
18703 name of the corresponding executable file without leading directories
18704 (e.g., @file{ls.debug} for @file{/usr/bin/ls}). In addition, the
18705 debug link specifies a 32-bit @dfn{Cyclic Redundancy Check} (CRC)
18706 checksum for the debug file, which @value{GDBN} uses to validate that
18707 the executable and the debug file came from the same build.
18710 The executable contains a @dfn{build ID}, a unique bit string that is
18711 also present in the corresponding debug info file. (This is supported
18712 only on some operating systems, when using the ELF or PE file formats
18713 for binary files and the @sc{gnu} Binutils.) For more details about
18714 this feature, see the description of the @option{--build-id}
18715 command-line option in @ref{Options, , Command Line Options, ld.info,
18716 The GNU Linker}. The debug info file's name is not specified
18717 explicitly by the build ID, but can be computed from the build ID, see
18721 Depending on the way the debug info file is specified, @value{GDBN}
18722 uses two different methods of looking for the debug file:
18726 For the ``debug link'' method, @value{GDBN} looks up the named file in
18727 the directory of the executable file, then in a subdirectory of that
18728 directory named @file{.debug}, and finally under each one of the global debug
18729 directories, in a subdirectory whose name is identical to the leading
18730 directories of the executable's absolute file name.
18733 For the ``build ID'' method, @value{GDBN} looks in the
18734 @file{.build-id} subdirectory of each one of the global debug directories for
18735 a file named @file{@var{nn}/@var{nnnnnnnn}.debug}, where @var{nn} are the
18736 first 2 hex characters of the build ID bit string, and @var{nnnnnnnn}
18737 are the rest of the bit string. (Real build ID strings are 32 or more
18738 hex characters, not 10.)
18741 So, for example, suppose you ask @value{GDBN} to debug
18742 @file{/usr/bin/ls}, which has a debug link that specifies the
18743 file @file{ls.debug}, and a build ID whose value in hex is
18744 @code{abcdef1234}. If the list of the global debug directories includes
18745 @file{/usr/lib/debug}, then @value{GDBN} will look for the following
18746 debug information files, in the indicated order:
18750 @file{/usr/lib/debug/.build-id/ab/cdef1234.debug}
18752 @file{/usr/bin/ls.debug}
18754 @file{/usr/bin/.debug/ls.debug}
18756 @file{/usr/lib/debug/usr/bin/ls.debug}.
18759 @anchor{debug-file-directory}
18760 Global debugging info directories default to what is set by @value{GDBN}
18761 configure option @option{--with-separate-debug-dir}. During @value{GDBN} run
18762 you can also set the global debugging info directories, and view the list
18763 @value{GDBN} is currently using.
18767 @kindex set debug-file-directory
18768 @item set debug-file-directory @var{directories}
18769 Set the directories which @value{GDBN} searches for separate debugging
18770 information files to @var{directory}. Multiple path components can be set
18771 concatenating them by a path separator.
18773 @kindex show debug-file-directory
18774 @item show debug-file-directory
18775 Show the directories @value{GDBN} searches for separate debugging
18780 @cindex @code{.gnu_debuglink} sections
18781 @cindex debug link sections
18782 A debug link is a special section of the executable file named
18783 @code{.gnu_debuglink}. The section must contain:
18787 A filename, with any leading directory components removed, followed by
18790 zero to three bytes of padding, as needed to reach the next four-byte
18791 boundary within the section, and
18793 a four-byte CRC checksum, stored in the same endianness used for the
18794 executable file itself. The checksum is computed on the debugging
18795 information file's full contents by the function given below, passing
18796 zero as the @var{crc} argument.
18799 Any executable file format can carry a debug link, as long as it can
18800 contain a section named @code{.gnu_debuglink} with the contents
18803 @cindex @code{.note.gnu.build-id} sections
18804 @cindex build ID sections
18805 The build ID is a special section in the executable file (and in other
18806 ELF binary files that @value{GDBN} may consider). This section is
18807 often named @code{.note.gnu.build-id}, but that name is not mandatory.
18808 It contains unique identification for the built files---the ID remains
18809 the same across multiple builds of the same build tree. The default
18810 algorithm SHA1 produces 160 bits (40 hexadecimal characters) of the
18811 content for the build ID string. The same section with an identical
18812 value is present in the original built binary with symbols, in its
18813 stripped variant, and in the separate debugging information file.
18815 The debugging information file itself should be an ordinary
18816 executable, containing a full set of linker symbols, sections, and
18817 debugging information. The sections of the debugging information file
18818 should have the same names, addresses, and sizes as the original file,
18819 but they need not contain any data---much like a @code{.bss} section
18820 in an ordinary executable.
18822 The @sc{gnu} binary utilities (Binutils) package includes the
18823 @samp{objcopy} utility that can produce
18824 the separated executable / debugging information file pairs using the
18825 following commands:
18828 @kbd{objcopy --only-keep-debug foo foo.debug}
18833 These commands remove the debugging
18834 information from the executable file @file{foo} and place it in the file
18835 @file{foo.debug}. You can use the first, second or both methods to link the
18840 The debug link method needs the following additional command to also leave
18841 behind a debug link in @file{foo}:
18844 @kbd{objcopy --add-gnu-debuglink=foo.debug foo}
18847 Ulrich Drepper's @file{elfutils} package, starting with version 0.53, contains
18848 a version of the @code{strip} command such that the command @kbd{strip foo -f
18849 foo.debug} has the same functionality as the two @code{objcopy} commands and
18850 the @code{ln -s} command above, together.
18853 Build ID gets embedded into the main executable using @code{ld --build-id} or
18854 the @value{NGCC} counterpart @code{gcc -Wl,--build-id}. Build ID support plus
18855 compatibility fixes for debug files separation are present in @sc{gnu} binary
18856 utilities (Binutils) package since version 2.18.
18861 @cindex CRC algorithm definition
18862 The CRC used in @code{.gnu_debuglink} is the CRC-32 defined in
18863 IEEE 802.3 using the polynomial:
18865 @c TexInfo requires naked braces for multi-digit exponents for Tex
18866 @c output, but this causes HTML output to barf. HTML has to be set using
18867 @c raw commands. So we end up having to specify this equation in 2
18872 <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>
18873 + <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
18879 @math{x^{32} + x^{26} + x^{23} + x^{22} + x^{16} + x^{12} + x^{11}}
18880 @math{+ x^{10} + x^8 + x^7 + x^5 + x^4 + x^2 + x + 1}
18884 The function is computed byte at a time, taking the least
18885 significant bit of each byte first. The initial pattern
18886 @code{0xffffffff} is used, to ensure leading zeros affect the CRC and
18887 the final result is inverted to ensure trailing zeros also affect the
18890 @emph{Note:} This is the same CRC polynomial as used in handling the
18891 @dfn{Remote Serial Protocol} @code{qCRC} packet (@pxref{qCRC packet}).
18892 However in the case of the Remote Serial Protocol, the CRC is computed
18893 @emph{most} significant bit first, and the result is not inverted, so
18894 trailing zeros have no effect on the CRC value.
18896 To complete the description, we show below the code of the function
18897 which produces the CRC used in @code{.gnu_debuglink}. Inverting the
18898 initially supplied @code{crc} argument means that an initial call to
18899 this function passing in zero will start computing the CRC using
18902 @kindex gnu_debuglink_crc32
18905 gnu_debuglink_crc32 (unsigned long crc,
18906 unsigned char *buf, size_t len)
18908 static const unsigned long crc32_table[256] =
18910 0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419,
18911 0x706af48f, 0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4,
18912 0xe0d5e91e, 0x97d2d988, 0x09b64c2b, 0x7eb17cbd, 0xe7b82d07,
18913 0x90bf1d91, 0x1db71064, 0x6ab020f2, 0xf3b97148, 0x84be41de,
18914 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7, 0x136c9856,
18915 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9,
18916 0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4,
18917 0xa2677172, 0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b,
18918 0x35b5a8fa, 0x42b2986c, 0xdbbbc9d6, 0xacbcf940, 0x32d86ce3,
18919 0x45df5c75, 0xdcd60dcf, 0xabd13d59, 0x26d930ac, 0x51de003a,
18920 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423, 0xcfba9599,
18921 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
18922 0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190,
18923 0x01db7106, 0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f,
18924 0x9fbfe4a5, 0xe8b8d433, 0x7807c9a2, 0x0f00f934, 0x9609a88e,
18925 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d, 0x91646c97, 0xe6635c01,
18926 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e, 0x6c0695ed,
18927 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950,
18928 0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3,
18929 0xfbd44c65, 0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2,
18930 0x4adfa541, 0x3dd895d7, 0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a,
18931 0x346ed9fc, 0xad678846, 0xda60b8d0, 0x44042d73, 0x33031de5,
18932 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa, 0xbe0b1010,
18933 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
18934 0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17,
18935 0x2eb40d81, 0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6,
18936 0x03b6e20c, 0x74b1d29a, 0xead54739, 0x9dd277af, 0x04db2615,
18937 0x73dc1683, 0xe3630b12, 0x94643b84, 0x0d6d6a3e, 0x7a6a5aa8,
18938 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1, 0xf00f9344,
18939 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb,
18940 0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a,
18941 0x67dd4acc, 0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5,
18942 0xd6d6a3e8, 0xa1d1937e, 0x38d8c2c4, 0x4fdff252, 0xd1bb67f1,
18943 0xa6bc5767, 0x3fb506dd, 0x48b2364b, 0xd80d2bda, 0xaf0a1b4c,
18944 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55, 0x316e8eef,
18945 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236,
18946 0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe,
18947 0xb2bd0b28, 0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31,
18948 0x2cd99e8b, 0x5bdeae1d, 0x9b64c2b0, 0xec63f226, 0x756aa39c,
18949 0x026d930a, 0x9c0906a9, 0xeb0e363f, 0x72076785, 0x05005713,
18950 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38, 0x92d28e9b,
18951 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242,
18952 0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1,
18953 0x18b74777, 0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c,
18954 0x8f659eff, 0xf862ae69, 0x616bffd3, 0x166ccf45, 0xa00ae278,
18955 0xd70dd2ee, 0x4e048354, 0x3903b3c2, 0xa7672661, 0xd06016f7,
18956 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc, 0x40df0b66,
18957 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
18958 0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605,
18959 0xcdd70693, 0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8,
18960 0x5d681b02, 0x2a6f2b94, 0xb40bbe37, 0xc30c8ea1, 0x5a05df1b,
18963 unsigned char *end;
18965 crc = ~crc & 0xffffffff;
18966 for (end = buf + len; buf < end; ++buf)
18967 crc = crc32_table[(crc ^ *buf) & 0xff] ^ (crc >> 8);
18968 return ~crc & 0xffffffff;
18973 This computation does not apply to the ``build ID'' method.
18975 @node MiniDebugInfo
18976 @section Debugging information in a special section
18977 @cindex separate debug sections
18978 @cindex @samp{.gnu_debugdata} section
18980 Some systems ship pre-built executables and libraries that have a
18981 special @samp{.gnu_debugdata} section. This feature is called
18982 @dfn{MiniDebugInfo}. This section holds an LZMA-compressed object and
18983 is used to supply extra symbols for backtraces.
18985 The intent of this section is to provide extra minimal debugging
18986 information for use in simple backtraces. It is not intended to be a
18987 replacement for full separate debugging information (@pxref{Separate
18988 Debug Files}). The example below shows the intended use; however,
18989 @value{GDBN} does not currently put restrictions on what sort of
18990 debugging information might be included in the section.
18992 @value{GDBN} has support for this extension. If the section exists,
18993 then it is used provided that no other source of debugging information
18994 can be found, and that @value{GDBN} was configured with LZMA support.
18996 This section can be easily created using @command{objcopy} and other
18997 standard utilities:
19000 # Extract the dynamic symbols from the main binary, there is no need
19001 # to also have these in the normal symbol table.
19002 nm -D @var{binary} --format=posix --defined-only \
19003 | awk '@{ print $1 @}' | sort > dynsyms
19005 # Extract all the text (i.e. function) symbols from the debuginfo.
19006 # (Note that we actually also accept "D" symbols, for the benefit
19007 # of platforms like PowerPC64 that use function descriptors.)
19008 nm @var{binary} --format=posix --defined-only \
19009 | awk '@{ if ($2 == "T" || $2 == "t" || $2 == "D") print $1 @}' \
19012 # Keep all the function symbols not already in the dynamic symbol
19014 comm -13 dynsyms funcsyms > keep_symbols
19016 # Separate full debug info into debug binary.
19017 objcopy --only-keep-debug @var{binary} debug
19019 # Copy the full debuginfo, keeping only a minimal set of symbols and
19020 # removing some unnecessary sections.
19021 objcopy -S --remove-section .gdb_index --remove-section .comment \
19022 --keep-symbols=keep_symbols debug mini_debuginfo
19024 # Drop the full debug info from the original binary.
19025 strip --strip-all -R .comment @var{binary}
19027 # Inject the compressed data into the .gnu_debugdata section of the
19030 objcopy --add-section .gnu_debugdata=mini_debuginfo.xz @var{binary}
19034 @section Index Files Speed Up @value{GDBN}
19035 @cindex index files
19036 @cindex @samp{.gdb_index} section
19038 When @value{GDBN} finds a symbol file, it scans the symbols in the
19039 file in order to construct an internal symbol table. This lets most
19040 @value{GDBN} operations work quickly---at the cost of a delay early
19041 on. For large programs, this delay can be quite lengthy, so
19042 @value{GDBN} provides a way to build an index, which speeds up
19045 The index is stored as a section in the symbol file. @value{GDBN} can
19046 write the index to a file, then you can put it into the symbol file
19047 using @command{objcopy}.
19049 To create an index file, use the @code{save gdb-index} command:
19052 @item save gdb-index @var{directory}
19053 @kindex save gdb-index
19054 Create an index file for each symbol file currently known by
19055 @value{GDBN}. Each file is named after its corresponding symbol file,
19056 with @samp{.gdb-index} appended, and is written into the given
19060 Once you have created an index file you can merge it into your symbol
19061 file, here named @file{symfile}, using @command{objcopy}:
19064 $ objcopy --add-section .gdb_index=symfile.gdb-index \
19065 --set-section-flags .gdb_index=readonly symfile symfile
19068 @value{GDBN} will normally ignore older versions of @file{.gdb_index}
19069 sections that have been deprecated. Usually they are deprecated because
19070 they are missing a new feature or have performance issues.
19071 To tell @value{GDBN} to use a deprecated index section anyway
19072 specify @code{set use-deprecated-index-sections on}.
19073 The default is @code{off}.
19074 This can speed up startup, but may result in some functionality being lost.
19075 @xref{Index Section Format}.
19077 @emph{Warning:} Setting @code{use-deprecated-index-sections} to @code{on}
19078 must be done before gdb reads the file. The following will not work:
19081 $ gdb -ex "set use-deprecated-index-sections on" <program>
19084 Instead you must do, for example,
19087 $ gdb -iex "set use-deprecated-index-sections on" <program>
19090 There are currently some limitation on indices. They only work when
19091 for DWARF debugging information, not stabs. And, they do not
19092 currently work for programs using Ada.
19094 @node Symbol Errors
19095 @section Errors Reading Symbol Files
19097 While reading a symbol file, @value{GDBN} occasionally encounters problems,
19098 such as symbol types it does not recognize, or known bugs in compiler
19099 output. By default, @value{GDBN} does not notify you of such problems, since
19100 they are relatively common and primarily of interest to people
19101 debugging compilers. If you are interested in seeing information
19102 about ill-constructed symbol tables, you can either ask @value{GDBN} to print
19103 only one message about each such type of problem, no matter how many
19104 times the problem occurs; or you can ask @value{GDBN} to print more messages,
19105 to see how many times the problems occur, with the @code{set
19106 complaints} command (@pxref{Messages/Warnings, ,Optional Warnings and
19109 The messages currently printed, and their meanings, include:
19112 @item inner block not inside outer block in @var{symbol}
19114 The symbol information shows where symbol scopes begin and end
19115 (such as at the start of a function or a block of statements). This
19116 error indicates that an inner scope block is not fully contained
19117 in its outer scope blocks.
19119 @value{GDBN} circumvents the problem by treating the inner block as if it had
19120 the same scope as the outer block. In the error message, @var{symbol}
19121 may be shown as ``@code{(don't know)}'' if the outer block is not a
19124 @item block at @var{address} out of order
19126 The symbol information for symbol scope blocks should occur in
19127 order of increasing addresses. This error indicates that it does not
19130 @value{GDBN} does not circumvent this problem, and has trouble
19131 locating symbols in the source file whose symbols it is reading. (You
19132 can often determine what source file is affected by specifying
19133 @code{set verbose on}. @xref{Messages/Warnings, ,Optional Warnings and
19136 @item bad block start address patched
19138 The symbol information for a symbol scope block has a start address
19139 smaller than the address of the preceding source line. This is known
19140 to occur in the SunOS 4.1.1 (and earlier) C compiler.
19142 @value{GDBN} circumvents the problem by treating the symbol scope block as
19143 starting on the previous source line.
19145 @item bad string table offset in symbol @var{n}
19148 Symbol number @var{n} contains a pointer into the string table which is
19149 larger than the size of the string table.
19151 @value{GDBN} circumvents the problem by considering the symbol to have the
19152 name @code{foo}, which may cause other problems if many symbols end up
19155 @item unknown symbol type @code{0x@var{nn}}
19157 The symbol information contains new data types that @value{GDBN} does
19158 not yet know how to read. @code{0x@var{nn}} is the symbol type of the
19159 uncomprehended information, in hexadecimal.
19161 @value{GDBN} circumvents the error by ignoring this symbol information.
19162 This usually allows you to debug your program, though certain symbols
19163 are not accessible. If you encounter such a problem and feel like
19164 debugging it, you can debug @code{@value{GDBP}} with itself, breakpoint
19165 on @code{complain}, then go up to the function @code{read_dbx_symtab}
19166 and examine @code{*bufp} to see the symbol.
19168 @item stub type has NULL name
19170 @value{GDBN} could not find the full definition for a struct or class.
19172 @item const/volatile indicator missing (ok if using g++ v1.x), got@dots{}
19173 The symbol information for a C@t{++} member function is missing some
19174 information that recent versions of the compiler should have output for
19177 @item info mismatch between compiler and debugger
19179 @value{GDBN} could not parse a type specification output by the compiler.
19184 @section GDB Data Files
19186 @cindex prefix for data files
19187 @value{GDBN} will sometimes read an auxiliary data file. These files
19188 are kept in a directory known as the @dfn{data directory}.
19190 You can set the data directory's name, and view the name @value{GDBN}
19191 is currently using.
19194 @kindex set data-directory
19195 @item set data-directory @var{directory}
19196 Set the directory which @value{GDBN} searches for auxiliary data files
19197 to @var{directory}.
19199 @kindex show data-directory
19200 @item show data-directory
19201 Show the directory @value{GDBN} searches for auxiliary data files.
19204 @cindex default data directory
19205 @cindex @samp{--with-gdb-datadir}
19206 You can set the default data directory by using the configure-time
19207 @samp{--with-gdb-datadir} option. If the data directory is inside
19208 @value{GDBN}'s configured binary prefix (set with @samp{--prefix} or
19209 @samp{--exec-prefix}), then the default data directory will be updated
19210 automatically if the installed @value{GDBN} is moved to a new
19213 The data directory may also be specified with the
19214 @code{--data-directory} command line option.
19215 @xref{Mode Options}.
19218 @chapter Specifying a Debugging Target
19220 @cindex debugging target
19221 A @dfn{target} is the execution environment occupied by your program.
19223 Often, @value{GDBN} runs in the same host environment as your program;
19224 in that case, the debugging target is specified as a side effect when
19225 you use the @code{file} or @code{core} commands. When you need more
19226 flexibility---for example, running @value{GDBN} on a physically separate
19227 host, or controlling a standalone system over a serial port or a
19228 realtime system over a TCP/IP connection---you can use the @code{target}
19229 command to specify one of the target types configured for @value{GDBN}
19230 (@pxref{Target Commands, ,Commands for Managing Targets}).
19232 @cindex target architecture
19233 It is possible to build @value{GDBN} for several different @dfn{target
19234 architectures}. When @value{GDBN} is built like that, you can choose
19235 one of the available architectures with the @kbd{set architecture}
19239 @kindex set architecture
19240 @kindex show architecture
19241 @item set architecture @var{arch}
19242 This command sets the current target architecture to @var{arch}. The
19243 value of @var{arch} can be @code{"auto"}, in addition to one of the
19244 supported architectures.
19246 @item show architecture
19247 Show the current target architecture.
19249 @item set processor
19251 @kindex set processor
19252 @kindex show processor
19253 These are alias commands for, respectively, @code{set architecture}
19254 and @code{show architecture}.
19258 * Active Targets:: Active targets
19259 * Target Commands:: Commands for managing targets
19260 * Byte Order:: Choosing target byte order
19263 @node Active Targets
19264 @section Active Targets
19266 @cindex stacking targets
19267 @cindex active targets
19268 @cindex multiple targets
19270 There are multiple classes of targets such as: processes, executable files or
19271 recording sessions. Core files belong to the process class, making core file
19272 and process mutually exclusive. Otherwise, @value{GDBN} can work concurrently
19273 on multiple active targets, one in each class. This allows you to (for
19274 example) start a process and inspect its activity, while still having access to
19275 the executable file after the process finishes. Or if you start process
19276 recording (@pxref{Reverse Execution}) and @code{reverse-step} there, you are
19277 presented a virtual layer of the recording target, while the process target
19278 remains stopped at the chronologically last point of the process execution.
19280 Use the @code{core-file} and @code{exec-file} commands to select a new core
19281 file or executable target (@pxref{Files, ,Commands to Specify Files}). To
19282 specify as a target a process that is already running, use the @code{attach}
19283 command (@pxref{Attach, ,Debugging an Already-running Process}).
19285 @node Target Commands
19286 @section Commands for Managing Targets
19289 @item target @var{type} @var{parameters}
19290 Connects the @value{GDBN} host environment to a target machine or
19291 process. A target is typically a protocol for talking to debugging
19292 facilities. You use the argument @var{type} to specify the type or
19293 protocol of the target machine.
19295 Further @var{parameters} are interpreted by the target protocol, but
19296 typically include things like device names or host names to connect
19297 with, process numbers, and baud rates.
19299 The @code{target} command does not repeat if you press @key{RET} again
19300 after executing the command.
19302 @kindex help target
19304 Displays the names of all targets available. To display targets
19305 currently selected, use either @code{info target} or @code{info files}
19306 (@pxref{Files, ,Commands to Specify Files}).
19308 @item help target @var{name}
19309 Describe a particular target, including any parameters necessary to
19312 @kindex set gnutarget
19313 @item set gnutarget @var{args}
19314 @value{GDBN} uses its own library BFD to read your files. @value{GDBN}
19315 knows whether it is reading an @dfn{executable},
19316 a @dfn{core}, or a @dfn{.o} file; however, you can specify the file format
19317 with the @code{set gnutarget} command. Unlike most @code{target} commands,
19318 with @code{gnutarget} the @code{target} refers to a program, not a machine.
19321 @emph{Warning:} To specify a file format with @code{set gnutarget},
19322 you must know the actual BFD name.
19326 @xref{Files, , Commands to Specify Files}.
19328 @kindex show gnutarget
19329 @item show gnutarget
19330 Use the @code{show gnutarget} command to display what file format
19331 @code{gnutarget} is set to read. If you have not set @code{gnutarget},
19332 @value{GDBN} will determine the file format for each file automatically,
19333 and @code{show gnutarget} displays @samp{The current BFD target is "auto"}.
19336 @cindex common targets
19337 Here are some common targets (available, or not, depending on the GDB
19342 @item target exec @var{program}
19343 @cindex executable file target
19344 An executable file. @samp{target exec @var{program}} is the same as
19345 @samp{exec-file @var{program}}.
19347 @item target core @var{filename}
19348 @cindex core dump file target
19349 A core dump file. @samp{target core @var{filename}} is the same as
19350 @samp{core-file @var{filename}}.
19352 @item target remote @var{medium}
19353 @cindex remote target
19354 A remote system connected to @value{GDBN} via a serial line or network
19355 connection. This command tells @value{GDBN} to use its own remote
19356 protocol over @var{medium} for debugging. @xref{Remote Debugging}.
19358 For example, if you have a board connected to @file{/dev/ttya} on the
19359 machine running @value{GDBN}, you could say:
19362 target remote /dev/ttya
19365 @code{target remote} supports the @code{load} command. This is only
19366 useful if you have some other way of getting the stub to the target
19367 system, and you can put it somewhere in memory where it won't get
19368 clobbered by the download.
19370 @item target sim @r{[}@var{simargs}@r{]} @dots{}
19371 @cindex built-in simulator target
19372 Builtin CPU simulator. @value{GDBN} includes simulators for most architectures.
19380 works; however, you cannot assume that a specific memory map, device
19381 drivers, or even basic I/O is available, although some simulators do
19382 provide these. For info about any processor-specific simulator details,
19383 see the appropriate section in @ref{Embedded Processors, ,Embedded
19386 @item target native
19387 @cindex native target
19388 Setup for local/native process debugging. Useful to make the
19389 @code{run} command spawn native processes (likewise @code{attach},
19390 etc.@:) even when @code{set auto-connect-native-target} is @code{off}
19391 (@pxref{set auto-connect-native-target}).
19395 Different targets are available on different configurations of @value{GDBN};
19396 your configuration may have more or fewer targets.
19398 Many remote targets require you to download the executable's code once
19399 you've successfully established a connection. You may wish to control
19400 various aspects of this process.
19405 @kindex set hash@r{, for remote monitors}
19406 @cindex hash mark while downloading
19407 This command controls whether a hash mark @samp{#} is displayed while
19408 downloading a file to the remote monitor. If on, a hash mark is
19409 displayed after each S-record is successfully downloaded to the
19413 @kindex show hash@r{, for remote monitors}
19414 Show the current status of displaying the hash mark.
19416 @item set debug monitor
19417 @kindex set debug monitor
19418 @cindex display remote monitor communications
19419 Enable or disable display of communications messages between
19420 @value{GDBN} and the remote monitor.
19422 @item show debug monitor
19423 @kindex show debug monitor
19424 Show the current status of displaying communications between
19425 @value{GDBN} and the remote monitor.
19430 @kindex load @var{filename}
19431 @item load @var{filename}
19433 Depending on what remote debugging facilities are configured into
19434 @value{GDBN}, the @code{load} command may be available. Where it exists, it
19435 is meant to make @var{filename} (an executable) available for debugging
19436 on the remote system---by downloading, or dynamic linking, for example.
19437 @code{load} also records the @var{filename} symbol table in @value{GDBN}, like
19438 the @code{add-symbol-file} command.
19440 If your @value{GDBN} does not have a @code{load} command, attempting to
19441 execute it gets the error message ``@code{You can't do that when your
19442 target is @dots{}}''
19444 The file is loaded at whatever address is specified in the executable.
19445 For some object file formats, you can specify the load address when you
19446 link the program; for other formats, like a.out, the object file format
19447 specifies a fixed address.
19448 @c FIXME! This would be a good place for an xref to the GNU linker doc.
19450 Depending on the remote side capabilities, @value{GDBN} may be able to
19451 load programs into flash memory.
19453 @code{load} does not repeat if you press @key{RET} again after using it.
19457 @section Choosing Target Byte Order
19459 @cindex choosing target byte order
19460 @cindex target byte order
19462 Some types of processors, such as the @acronym{MIPS}, PowerPC, and Renesas SH,
19463 offer the ability to run either big-endian or little-endian byte
19464 orders. Usually the executable or symbol will include a bit to
19465 designate the endian-ness, and you will not need to worry about
19466 which to use. However, you may still find it useful to adjust
19467 @value{GDBN}'s idea of processor endian-ness manually.
19471 @item set endian big
19472 Instruct @value{GDBN} to assume the target is big-endian.
19474 @item set endian little
19475 Instruct @value{GDBN} to assume the target is little-endian.
19477 @item set endian auto
19478 Instruct @value{GDBN} to use the byte order associated with the
19482 Display @value{GDBN}'s current idea of the target byte order.
19486 Note that these commands merely adjust interpretation of symbolic
19487 data on the host, and that they have absolutely no effect on the
19491 @node Remote Debugging
19492 @chapter Debugging Remote Programs
19493 @cindex remote debugging
19495 If you are trying to debug a program running on a machine that cannot run
19496 @value{GDBN} in the usual way, it is often useful to use remote debugging.
19497 For example, you might use remote debugging on an operating system kernel,
19498 or on a small system which does not have a general purpose operating system
19499 powerful enough to run a full-featured debugger.
19501 Some configurations of @value{GDBN} have special serial or TCP/IP interfaces
19502 to make this work with particular debugging targets. In addition,
19503 @value{GDBN} comes with a generic serial protocol (specific to @value{GDBN},
19504 but not specific to any particular target system) which you can use if you
19505 write the remote stubs---the code that runs on the remote system to
19506 communicate with @value{GDBN}.
19508 Other remote targets may be available in your
19509 configuration of @value{GDBN}; use @code{help target} to list them.
19512 * Connecting:: Connecting to a remote target
19513 * File Transfer:: Sending files to a remote system
19514 * Server:: Using the gdbserver program
19515 * Remote Configuration:: Remote configuration
19516 * Remote Stub:: Implementing a remote stub
19520 @section Connecting to a Remote Target
19521 @cindex remote debugging, connecting
19522 @cindex @code{gdbserver}, connecting
19523 @cindex remote debugging, types of connections
19524 @cindex @code{gdbserver}, types of connections
19525 @cindex @code{gdbserver}, @code{target remote} mode
19526 @cindex @code{gdbserver}, @code{target extended-remote} mode
19528 This section describes how to connect to a remote target, including the
19529 types of connections and their differences, how to set up executable and
19530 symbol files on the host and target, and the commands used for
19531 connecting to and disconnecting from the remote target.
19533 @subsection Types of Remote Connections
19535 @value{GDBN} supports two types of remote connections, @code{target remote}
19536 mode and @code{target extended-remote} mode. Note that many remote targets
19537 support only @code{target remote} mode. There are several major
19538 differences between the two types of connections, enumerated here:
19542 @cindex remote debugging, detach and program exit
19543 @item Result of detach or program exit
19544 @strong{With target remote mode:} When the debugged program exits or you
19545 detach from it, @value{GDBN} disconnects from the target. When using
19546 @code{gdbserver}, @code{gdbserver} will exit.
19548 @strong{With target extended-remote mode:} When the debugged program exits or
19549 you detach from it, @value{GDBN} remains connected to the target, even
19550 though no program is running. You can rerun the program, attach to a
19551 running program, or use @code{monitor} commands specific to the target.
19553 When using @code{gdbserver} in this case, it does not exit unless it was
19554 invoked using the @option{--once} option. If the @option{--once} option
19555 was not used, you can ask @code{gdbserver} to exit using the
19556 @code{monitor exit} command (@pxref{Monitor Commands for gdbserver}).
19558 @item Specifying the program to debug
19559 For both connection types you use the @code{file} command to specify the
19560 program on the host system. If you are using @code{gdbserver} there are
19561 some differences in how to specify the location of the program on the
19564 @strong{With target remote mode:} You must either specify the program to debug
19565 on the @code{gdbserver} command line or use the @option{--attach} option
19566 (@pxref{Attaching to a program,,Attaching to a Running Program}).
19568 @cindex @option{--multi}, @code{gdbserver} option
19569 @strong{With target extended-remote mode:} You may specify the program to debug
19570 on the @code{gdbserver} command line, or you can load the program or attach
19571 to it using @value{GDBN} commands after connecting to @code{gdbserver}.
19573 @anchor{--multi Option in Types of Remote Connnections}
19574 You can start @code{gdbserver} without supplying an initial command to run
19575 or process ID to attach. To do this, use the @option{--multi} command line
19576 option. Then you can connect using @code{target extended-remote} and start
19577 the program you want to debug (see below for details on using the
19578 @code{run} command in this scenario). Note that the conditions under which
19579 @code{gdbserver} terminates depend on how @value{GDBN} connects to it
19580 (@code{target remote} or @code{target extended-remote}). The
19581 @option{--multi} option to @code{gdbserver} has no influence on that.
19583 @item The @code{run} command
19584 @strong{With target remote mode:} The @code{run} command is not
19585 supported. Once a connection has been established, you can use all
19586 the usual @value{GDBN} commands to examine and change data. The
19587 remote program is already running, so you can use commands like
19588 @kbd{step} and @kbd{continue}.
19590 @strong{With target extended-remote mode:} The @code{run} command is
19591 supported. The @code{run} command uses the value set by
19592 @code{set remote exec-file} (@pxref{set remote exec-file}) to select
19593 the program to run. Command line arguments are supported, except for
19594 wildcard expansion and I/O redirection (@pxref{Arguments}).
19596 If you specify the program to debug on the command line, then the
19597 @code{run} command is not required to start execution, and you can
19598 resume using commands like @kbd{step} and @kbd{continue} as with
19599 @code{target remote} mode.
19601 @anchor{Attaching in Types of Remote Connections}
19603 @strong{With target remote mode:} The @value{GDBN} command @code{attach} is
19604 not supported. To attach to a running program using @code{gdbserver}, you
19605 must use the @option{--attach} option (@pxref{Running gdbserver}).
19607 @strong{With target extended-remote mode:} To attach to a running program,
19608 you may use the @code{attach} command after the connection has been
19609 established. If you are using @code{gdbserver}, you may also invoke
19610 @code{gdbserver} using the @option{--attach} option
19611 (@pxref{Running gdbserver}).
19615 @anchor{Host and target files}
19616 @subsection Host and Target Files
19617 @cindex remote debugging, symbol files
19618 @cindex symbol files, remote debugging
19620 @value{GDBN}, running on the host, needs access to symbol and debugging
19621 information for your program running on the target. This requires
19622 access to an unstripped copy of your program, and possibly any associated
19623 symbol files. Note that this section applies equally to both @code{target
19624 remote} mode and @code{target extended-remote} mode.
19626 Some remote targets (@pxref{qXfer executable filename read}, and
19627 @pxref{Host I/O Packets}) allow @value{GDBN} to access program files over
19628 the same connection used to communicate with @value{GDBN}. With such a
19629 target, if the remote program is unstripped, the only command you need is
19630 @code{target remote} (or @code{target extended-remote}).
19632 If the remote program is stripped, or the target does not support remote
19633 program file access, start up @value{GDBN} using the name of the local
19634 unstripped copy of your program as the first argument, or use the
19635 @code{file} command. Use @code{set sysroot} to specify the location (on
19636 the host) of target libraries (unless your @value{GDBN} was compiled with
19637 the correct sysroot using @code{--with-sysroot}). Alternatively, you
19638 may use @code{set solib-search-path} to specify how @value{GDBN} locates
19641 The symbol file and target libraries must exactly match the executable
19642 and libraries on the target, with one exception: the files on the host
19643 system should not be stripped, even if the files on the target system
19644 are. Mismatched or missing files will lead to confusing results
19645 during debugging. On @sc{gnu}/Linux targets, mismatched or missing
19646 files may also prevent @code{gdbserver} from debugging multi-threaded
19649 @subsection Remote Connection Commands
19650 @cindex remote connection commands
19651 @value{GDBN} can communicate with the target over a serial line, or
19652 over an @acronym{IP} network using @acronym{TCP} or @acronym{UDP}. In
19653 each case, @value{GDBN} uses the same protocol for debugging your
19654 program; only the medium carrying the debugging packets varies. The
19655 @code{target remote} and @code{target extended-remote} commands
19656 establish a connection to the target. Both commands accept the same
19657 arguments, which indicate the medium to use:
19661 @item target remote @var{serial-device}
19662 @itemx target extended-remote @var{serial-device}
19663 @cindex serial line, @code{target remote}
19664 Use @var{serial-device} to communicate with the target. For example,
19665 to use a serial line connected to the device named @file{/dev/ttyb}:
19668 target remote /dev/ttyb
19671 If you're using a serial line, you may want to give @value{GDBN} the
19672 @samp{--baud} option, or use the @code{set serial baud} command
19673 (@pxref{Remote Configuration, set serial baud}) before the
19674 @code{target} command.
19676 @item target remote @code{@var{host}:@var{port}}
19677 @itemx target remote @code{tcp:@var{host}:@var{port}}
19678 @itemx target extended-remote @code{@var{host}:@var{port}}
19679 @itemx target extended-remote @code{tcp:@var{host}:@var{port}}
19680 @cindex @acronym{TCP} port, @code{target remote}
19681 Debug using a @acronym{TCP} connection to @var{port} on @var{host}.
19682 The @var{host} may be either a host name or a numeric @acronym{IP}
19683 address; @var{port} must be a decimal number. The @var{host} could be
19684 the target machine itself, if it is directly connected to the net, or
19685 it might be a terminal server which in turn has a serial line to the
19688 For example, to connect to port 2828 on a terminal server named
19692 target remote manyfarms:2828
19695 If your remote target is actually running on the same machine as your
19696 debugger session (e.g.@: a simulator for your target running on the
19697 same host), you can omit the hostname. For example, to connect to
19698 port 1234 on your local machine:
19701 target remote :1234
19705 Note that the colon is still required here.
19707 @item target remote @code{udp:@var{host}:@var{port}}
19708 @itemx target extended-remote @code{udp:@var{host}:@var{port}}
19709 @cindex @acronym{UDP} port, @code{target remote}
19710 Debug using @acronym{UDP} packets to @var{port} on @var{host}. For example, to
19711 connect to @acronym{UDP} port 2828 on a terminal server named @code{manyfarms}:
19714 target remote udp:manyfarms:2828
19717 When using a @acronym{UDP} connection for remote debugging, you should
19718 keep in mind that the `U' stands for ``Unreliable''. @acronym{UDP}
19719 can silently drop packets on busy or unreliable networks, which will
19720 cause havoc with your debugging session.
19722 @item target remote | @var{command}
19723 @itemx target extended-remote | @var{command}
19724 @cindex pipe, @code{target remote} to
19725 Run @var{command} in the background and communicate with it using a
19726 pipe. The @var{command} is a shell command, to be parsed and expanded
19727 by the system's command shell, @code{/bin/sh}; it should expect remote
19728 protocol packets on its standard input, and send replies on its
19729 standard output. You could use this to run a stand-alone simulator
19730 that speaks the remote debugging protocol, to make net connections
19731 using programs like @code{ssh}, or for other similar tricks.
19733 If @var{command} closes its standard output (perhaps by exiting),
19734 @value{GDBN} will try to send it a @code{SIGTERM} signal. (If the
19735 program has already exited, this will have no effect.)
19739 @cindex interrupting remote programs
19740 @cindex remote programs, interrupting
19741 Whenever @value{GDBN} is waiting for the remote program, if you type the
19742 interrupt character (often @kbd{Ctrl-c}), @value{GDBN} attempts to stop the
19743 program. This may or may not succeed, depending in part on the hardware
19744 and the serial drivers the remote system uses. If you type the
19745 interrupt character once again, @value{GDBN} displays this prompt:
19748 Interrupted while waiting for the program.
19749 Give up (and stop debugging it)? (y or n)
19752 In @code{target remote} mode, if you type @kbd{y}, @value{GDBN} abandons
19753 the remote debugging session. (If you decide you want to try again later,
19754 you can use @kbd{target remote} again to connect once more.) If you type
19755 @kbd{n}, @value{GDBN} goes back to waiting.
19757 In @code{target extended-remote} mode, typing @kbd{n} will leave
19758 @value{GDBN} connected to the target.
19761 @kindex detach (remote)
19763 When you have finished debugging the remote program, you can use the
19764 @code{detach} command to release it from @value{GDBN} control.
19765 Detaching from the target normally resumes its execution, but the results
19766 will depend on your particular remote stub. After the @code{detach}
19767 command in @code{target remote} mode, @value{GDBN} is free to connect to
19768 another target. In @code{target extended-remote} mode, @value{GDBN} is
19769 still connected to the target.
19773 The @code{disconnect} command closes the connection to the target, and
19774 the target is generally not resumed. It will wait for @value{GDBN}
19775 (this instance or another one) to connect and continue debugging. After
19776 the @code{disconnect} command, @value{GDBN} is again free to connect to
19779 @cindex send command to remote monitor
19780 @cindex extend @value{GDBN} for remote targets
19781 @cindex add new commands for external monitor
19783 @item monitor @var{cmd}
19784 This command allows you to send arbitrary commands directly to the
19785 remote monitor. Since @value{GDBN} doesn't care about the commands it
19786 sends like this, this command is the way to extend @value{GDBN}---you
19787 can add new commands that only the external monitor will understand
19791 @node File Transfer
19792 @section Sending files to a remote system
19793 @cindex remote target, file transfer
19794 @cindex file transfer
19795 @cindex sending files to remote systems
19797 Some remote targets offer the ability to transfer files over the same
19798 connection used to communicate with @value{GDBN}. This is convenient
19799 for targets accessible through other means, e.g.@: @sc{gnu}/Linux systems
19800 running @code{gdbserver} over a network interface. For other targets,
19801 e.g.@: embedded devices with only a single serial port, this may be
19802 the only way to upload or download files.
19804 Not all remote targets support these commands.
19808 @item remote put @var{hostfile} @var{targetfile}
19809 Copy file @var{hostfile} from the host system (the machine running
19810 @value{GDBN}) to @var{targetfile} on the target system.
19813 @item remote get @var{targetfile} @var{hostfile}
19814 Copy file @var{targetfile} from the target system to @var{hostfile}
19815 on the host system.
19817 @kindex remote delete
19818 @item remote delete @var{targetfile}
19819 Delete @var{targetfile} from the target system.
19824 @section Using the @code{gdbserver} Program
19827 @cindex remote connection without stubs
19828 @code{gdbserver} is a control program for Unix-like systems, which
19829 allows you to connect your program with a remote @value{GDBN} via
19830 @code{target remote} or @code{target extended-remote}---but without
19831 linking in the usual debugging stub.
19833 @code{gdbserver} is not a complete replacement for the debugging stubs,
19834 because it requires essentially the same operating-system facilities
19835 that @value{GDBN} itself does. In fact, a system that can run
19836 @code{gdbserver} to connect to a remote @value{GDBN} could also run
19837 @value{GDBN} locally! @code{gdbserver} is sometimes useful nevertheless,
19838 because it is a much smaller program than @value{GDBN} itself. It is
19839 also easier to port than all of @value{GDBN}, so you may be able to get
19840 started more quickly on a new system by using @code{gdbserver}.
19841 Finally, if you develop code for real-time systems, you may find that
19842 the tradeoffs involved in real-time operation make it more convenient to
19843 do as much development work as possible on another system, for example
19844 by cross-compiling. You can use @code{gdbserver} to make a similar
19845 choice for debugging.
19847 @value{GDBN} and @code{gdbserver} communicate via either a serial line
19848 or a TCP connection, using the standard @value{GDBN} remote serial
19852 @emph{Warning:} @code{gdbserver} does not have any built-in security.
19853 Do not run @code{gdbserver} connected to any public network; a
19854 @value{GDBN} connection to @code{gdbserver} provides access to the
19855 target system with the same privileges as the user running
19859 @anchor{Running gdbserver}
19860 @subsection Running @code{gdbserver}
19861 @cindex arguments, to @code{gdbserver}
19862 @cindex @code{gdbserver}, command-line arguments
19864 Run @code{gdbserver} on the target system. You need a copy of the
19865 program you want to debug, including any libraries it requires.
19866 @code{gdbserver} does not need your program's symbol table, so you can
19867 strip the program if necessary to save space. @value{GDBN} on the host
19868 system does all the symbol handling.
19870 To use the server, you must tell it how to communicate with @value{GDBN};
19871 the name of your program; and the arguments for your program. The usual
19875 target> gdbserver @var{comm} @var{program} [ @var{args} @dots{} ]
19878 @var{comm} is either a device name (to use a serial line), or a TCP
19879 hostname and portnumber, or @code{-} or @code{stdio} to use
19880 stdin/stdout of @code{gdbserver}.
19881 For example, to debug Emacs with the argument
19882 @samp{foo.txt} and communicate with @value{GDBN} over the serial port
19886 target> gdbserver /dev/com1 emacs foo.txt
19889 @code{gdbserver} waits passively for the host @value{GDBN} to communicate
19892 To use a TCP connection instead of a serial line:
19895 target> gdbserver host:2345 emacs foo.txt
19898 The only difference from the previous example is the first argument,
19899 specifying that you are communicating with the host @value{GDBN} via
19900 TCP. The @samp{host:2345} argument means that @code{gdbserver} is to
19901 expect a TCP connection from machine @samp{host} to local TCP port 2345.
19902 (Currently, the @samp{host} part is ignored.) You can choose any number
19903 you want for the port number as long as it does not conflict with any
19904 TCP ports already in use on the target system (for example, @code{23} is
19905 reserved for @code{telnet}).@footnote{If you choose a port number that
19906 conflicts with another service, @code{gdbserver} prints an error message
19907 and exits.} You must use the same port number with the host @value{GDBN}
19908 @code{target remote} command.
19910 The @code{stdio} connection is useful when starting @code{gdbserver}
19914 (gdb) target remote | ssh -T hostname gdbserver - hello
19917 The @samp{-T} option to ssh is provided because we don't need a remote pty,
19918 and we don't want escape-character handling. Ssh does this by default when
19919 a command is provided, the flag is provided to make it explicit.
19920 You could elide it if you want to.
19922 Programs started with stdio-connected gdbserver have @file{/dev/null} for
19923 @code{stdin}, and @code{stdout},@code{stderr} are sent back to gdb for
19924 display through a pipe connected to gdbserver.
19925 Both @code{stdout} and @code{stderr} use the same pipe.
19927 @anchor{Attaching to a program}
19928 @subsubsection Attaching to a Running Program
19929 @cindex attach to a program, @code{gdbserver}
19930 @cindex @option{--attach}, @code{gdbserver} option
19932 On some targets, @code{gdbserver} can also attach to running programs.
19933 This is accomplished via the @code{--attach} argument. The syntax is:
19936 target> gdbserver --attach @var{comm} @var{pid}
19939 @var{pid} is the process ID of a currently running process. It isn't
19940 necessary to point @code{gdbserver} at a binary for the running process.
19942 In @code{target extended-remote} mode, you can also attach using the
19943 @value{GDBN} attach command
19944 (@pxref{Attaching in Types of Remote Connections}).
19947 You can debug processes by name instead of process ID if your target has the
19948 @code{pidof} utility:
19951 target> gdbserver --attach @var{comm} `pidof @var{program}`
19954 In case more than one copy of @var{program} is running, or @var{program}
19955 has multiple threads, most versions of @code{pidof} support the
19956 @code{-s} option to only return the first process ID.
19958 @subsubsection TCP port allocation lifecycle of @code{gdbserver}
19960 This section applies only when @code{gdbserver} is run to listen on a TCP
19963 @code{gdbserver} normally terminates after all of its debugged processes have
19964 terminated in @kbd{target remote} mode. On the other hand, for @kbd{target
19965 extended-remote}, @code{gdbserver} stays running even with no processes left.
19966 @value{GDBN} normally terminates the spawned debugged process on its exit,
19967 which normally also terminates @code{gdbserver} in the @kbd{target remote}
19968 mode. Therefore, when the connection drops unexpectedly, and @value{GDBN}
19969 cannot ask @code{gdbserver} to kill its debugged processes, @code{gdbserver}
19970 stays running even in the @kbd{target remote} mode.
19972 When @code{gdbserver} stays running, @value{GDBN} can connect to it again later.
19973 Such reconnecting is useful for features like @ref{disconnected tracing}. For
19974 completeness, at most one @value{GDBN} can be connected at a time.
19976 @cindex @option{--once}, @code{gdbserver} option
19977 By default, @code{gdbserver} keeps the listening TCP port open, so that
19978 subsequent connections are possible. However, if you start @code{gdbserver}
19979 with the @option{--once} option, it will stop listening for any further
19980 connection attempts after connecting to the first @value{GDBN} session. This
19981 means no further connections to @code{gdbserver} will be possible after the
19982 first one. It also means @code{gdbserver} will terminate after the first
19983 connection with remote @value{GDBN} has closed, even for unexpectedly closed
19984 connections and even in the @kbd{target extended-remote} mode. The
19985 @option{--once} option allows reusing the same port number for connecting to
19986 multiple instances of @code{gdbserver} running on the same host, since each
19987 instance closes its port after the first connection.
19989 @anchor{Other Command-Line Arguments for gdbserver}
19990 @subsubsection Other Command-Line Arguments for @code{gdbserver}
19992 You can use the @option{--multi} option to start @code{gdbserver} without
19993 specifying a program to debug or a process to attach to. Then you can
19994 attach in @code{target extended-remote} mode and run or attach to a
19995 program. For more information,
19996 @pxref{--multi Option in Types of Remote Connnections}.
19998 @cindex @option{--debug}, @code{gdbserver} option
19999 The @option{--debug} option tells @code{gdbserver} to display extra
20000 status information about the debugging process.
20001 @cindex @option{--remote-debug}, @code{gdbserver} option
20002 The @option{--remote-debug} option tells @code{gdbserver} to display
20003 remote protocol debug output. These options are intended for
20004 @code{gdbserver} development and for bug reports to the developers.
20006 @cindex @option{--debug-format}, @code{gdbserver} option
20007 The @option{--debug-format=option1[,option2,...]} option tells
20008 @code{gdbserver} to include additional information in each output.
20009 Possible options are:
20013 Turn off all extra information in debugging output.
20015 Turn on all extra information in debugging output.
20017 Include a timestamp in each line of debugging output.
20020 Options are processed in order. Thus, for example, if @option{none}
20021 appears last then no additional information is added to debugging output.
20023 @cindex @option{--wrapper}, @code{gdbserver} option
20024 The @option{--wrapper} option specifies a wrapper to launch programs
20025 for debugging. The option should be followed by the name of the
20026 wrapper, then any command-line arguments to pass to the wrapper, then
20027 @kbd{--} indicating the end of the wrapper arguments.
20029 @code{gdbserver} runs the specified wrapper program with a combined
20030 command line including the wrapper arguments, then the name of the
20031 program to debug, then any arguments to the program. The wrapper
20032 runs until it executes your program, and then @value{GDBN} gains control.
20034 You can use any program that eventually calls @code{execve} with
20035 its arguments as a wrapper. Several standard Unix utilities do
20036 this, e.g.@: @code{env} and @code{nohup}. Any Unix shell script ending
20037 with @code{exec "$@@"} will also work.
20039 For example, you can use @code{env} to pass an environment variable to
20040 the debugged program, without setting the variable in @code{gdbserver}'s
20044 $ gdbserver --wrapper env LD_PRELOAD=libtest.so -- :2222 ./testprog
20047 @subsection Connecting to @code{gdbserver}
20049 The basic procedure for connecting to the remote target is:
20053 Run @value{GDBN} on the host system.
20056 Make sure you have the necessary symbol files
20057 (@pxref{Host and target files}).
20058 Load symbols for your application using the @code{file} command before you
20059 connect. Use @code{set sysroot} to locate target libraries (unless your
20060 @value{GDBN} was compiled with the correct sysroot using
20061 @code{--with-sysroot}).
20064 Connect to your target (@pxref{Connecting,,Connecting to a Remote Target}).
20065 For TCP connections, you must start up @code{gdbserver} prior to using
20066 the @code{target} command. Otherwise you may get an error whose
20067 text depends on the host system, but which usually looks something like
20068 @samp{Connection refused}. Don't use the @code{load}
20069 command in @value{GDBN} when using @code{target remote} mode, since the
20070 program is already on the target.
20074 @anchor{Monitor Commands for gdbserver}
20075 @subsection Monitor Commands for @code{gdbserver}
20076 @cindex monitor commands, for @code{gdbserver}
20078 During a @value{GDBN} session using @code{gdbserver}, you can use the
20079 @code{monitor} command to send special requests to @code{gdbserver}.
20080 Here are the available commands.
20084 List the available monitor commands.
20086 @item monitor set debug 0
20087 @itemx monitor set debug 1
20088 Disable or enable general debugging messages.
20090 @item monitor set remote-debug 0
20091 @itemx monitor set remote-debug 1
20092 Disable or enable specific debugging messages associated with the remote
20093 protocol (@pxref{Remote Protocol}).
20095 @item monitor set debug-format option1@r{[},option2,...@r{]}
20096 Specify additional text to add to debugging messages.
20097 Possible options are:
20101 Turn off all extra information in debugging output.
20103 Turn on all extra information in debugging output.
20105 Include a timestamp in each line of debugging output.
20108 Options are processed in order. Thus, for example, if @option{none}
20109 appears last then no additional information is added to debugging output.
20111 @item monitor set libthread-db-search-path [PATH]
20112 @cindex gdbserver, search path for @code{libthread_db}
20113 When this command is issued, @var{path} is a colon-separated list of
20114 directories to search for @code{libthread_db} (@pxref{Threads,,set
20115 libthread-db-search-path}). If you omit @var{path},
20116 @samp{libthread-db-search-path} will be reset to its default value.
20118 The special entry @samp{$pdir} for @samp{libthread-db-search-path} is
20119 not supported in @code{gdbserver}.
20122 Tell gdbserver to exit immediately. This command should be followed by
20123 @code{disconnect} to close the debugging session. @code{gdbserver} will
20124 detach from any attached processes and kill any processes it created.
20125 Use @code{monitor exit} to terminate @code{gdbserver} at the end
20126 of a multi-process mode debug session.
20130 @subsection Tracepoints support in @code{gdbserver}
20131 @cindex tracepoints support in @code{gdbserver}
20133 On some targets, @code{gdbserver} supports tracepoints, fast
20134 tracepoints and static tracepoints.
20136 For fast or static tracepoints to work, a special library called the
20137 @dfn{in-process agent} (IPA), must be loaded in the inferior process.
20138 This library is built and distributed as an integral part of
20139 @code{gdbserver}. In addition, support for static tracepoints
20140 requires building the in-process agent library with static tracepoints
20141 support. At present, the UST (LTTng Userspace Tracer,
20142 @url{http://lttng.org/ust}) tracing engine is supported. This support
20143 is automatically available if UST development headers are found in the
20144 standard include path when @code{gdbserver} is built, or if
20145 @code{gdbserver} was explicitly configured using @option{--with-ust}
20146 to point at such headers. You can explicitly disable the support
20147 using @option{--with-ust=no}.
20149 There are several ways to load the in-process agent in your program:
20152 @item Specifying it as dependency at link time
20154 You can link your program dynamically with the in-process agent
20155 library. On most systems, this is accomplished by adding
20156 @code{-linproctrace} to the link command.
20158 @item Using the system's preloading mechanisms
20160 You can force loading the in-process agent at startup time by using
20161 your system's support for preloading shared libraries. Many Unixes
20162 support the concept of preloading user defined libraries. In most
20163 cases, you do that by specifying @code{LD_PRELOAD=libinproctrace.so}
20164 in the environment. See also the description of @code{gdbserver}'s
20165 @option{--wrapper} command line option.
20167 @item Using @value{GDBN} to force loading the agent at run time
20169 On some systems, you can force the inferior to load a shared library,
20170 by calling a dynamic loader function in the inferior that takes care
20171 of dynamically looking up and loading a shared library. On most Unix
20172 systems, the function is @code{dlopen}. You'll use the @code{call}
20173 command for that. For example:
20176 (@value{GDBP}) call dlopen ("libinproctrace.so", ...)
20179 Note that on most Unix systems, for the @code{dlopen} function to be
20180 available, the program needs to be linked with @code{-ldl}.
20183 On systems that have a userspace dynamic loader, like most Unix
20184 systems, when you connect to @code{gdbserver} using @code{target
20185 remote}, you'll find that the program is stopped at the dynamic
20186 loader's entry point, and no shared library has been loaded in the
20187 program's address space yet, including the in-process agent. In that
20188 case, before being able to use any of the fast or static tracepoints
20189 features, you need to let the loader run and load the shared
20190 libraries. The simplest way to do that is to run the program to the
20191 main procedure. E.g., if debugging a C or C@t{++} program, start
20192 @code{gdbserver} like so:
20195 $ gdbserver :9999 myprogram
20198 Start GDB and connect to @code{gdbserver} like so, and run to main:
20202 (@value{GDBP}) target remote myhost:9999
20203 0x00007f215893ba60 in ?? () from /lib64/ld-linux-x86-64.so.2
20204 (@value{GDBP}) b main
20205 (@value{GDBP}) continue
20208 The in-process tracing agent library should now be loaded into the
20209 process; you can confirm it with the @code{info sharedlibrary}
20210 command, which will list @file{libinproctrace.so} as loaded in the
20211 process. You are now ready to install fast tracepoints, list static
20212 tracepoint markers, probe static tracepoints markers, and start
20215 @node Remote Configuration
20216 @section Remote Configuration
20219 @kindex show remote
20220 This section documents the configuration options available when
20221 debugging remote programs. For the options related to the File I/O
20222 extensions of the remote protocol, see @ref{system,
20223 system-call-allowed}.
20226 @item set remoteaddresssize @var{bits}
20227 @cindex address size for remote targets
20228 @cindex bits in remote address
20229 Set the maximum size of address in a memory packet to the specified
20230 number of bits. @value{GDBN} will mask off the address bits above
20231 that number, when it passes addresses to the remote target. The
20232 default value is the number of bits in the target's address.
20234 @item show remoteaddresssize
20235 Show the current value of remote address size in bits.
20237 @item set serial baud @var{n}
20238 @cindex baud rate for remote targets
20239 Set the baud rate for the remote serial I/O to @var{n} baud. The
20240 value is used to set the speed of the serial port used for debugging
20243 @item show serial baud
20244 Show the current speed of the remote connection.
20246 @item set serial parity @var{parity}
20247 Set the parity for the remote serial I/O. Supported values of @var{parity} are:
20248 @code{even}, @code{none}, and @code{odd}. The default is @code{none}.
20250 @item show serial parity
20251 Show the current parity of the serial port.
20253 @item set remotebreak
20254 @cindex interrupt remote programs
20255 @cindex BREAK signal instead of Ctrl-C
20256 @anchor{set remotebreak}
20257 If set to on, @value{GDBN} sends a @code{BREAK} signal to the remote
20258 when you type @kbd{Ctrl-c} to interrupt the program running
20259 on the remote. If set to off, @value{GDBN} sends the @samp{Ctrl-C}
20260 character instead. The default is off, since most remote systems
20261 expect to see @samp{Ctrl-C} as the interrupt signal.
20263 @item show remotebreak
20264 Show whether @value{GDBN} sends @code{BREAK} or @samp{Ctrl-C} to
20265 interrupt the remote program.
20267 @item set remoteflow on
20268 @itemx set remoteflow off
20269 @kindex set remoteflow
20270 Enable or disable hardware flow control (@code{RTS}/@code{CTS})
20271 on the serial port used to communicate to the remote target.
20273 @item show remoteflow
20274 @kindex show remoteflow
20275 Show the current setting of hardware flow control.
20277 @item set remotelogbase @var{base}
20278 Set the base (a.k.a.@: radix) of logging serial protocol
20279 communications to @var{base}. Supported values of @var{base} are:
20280 @code{ascii}, @code{octal}, and @code{hex}. The default is
20283 @item show remotelogbase
20284 Show the current setting of the radix for logging remote serial
20287 @item set remotelogfile @var{file}
20288 @cindex record serial communications on file
20289 Record remote serial communications on the named @var{file}. The
20290 default is not to record at all.
20292 @item show remotelogfile.
20293 Show the current setting of the file name on which to record the
20294 serial communications.
20296 @item set remotetimeout @var{num}
20297 @cindex timeout for serial communications
20298 @cindex remote timeout
20299 Set the timeout limit to wait for the remote target to respond to
20300 @var{num} seconds. The default is 2 seconds.
20302 @item show remotetimeout
20303 Show the current number of seconds to wait for the remote target
20306 @cindex limit hardware breakpoints and watchpoints
20307 @cindex remote target, limit break- and watchpoints
20308 @anchor{set remote hardware-watchpoint-limit}
20309 @anchor{set remote hardware-breakpoint-limit}
20310 @item set remote hardware-watchpoint-limit @var{limit}
20311 @itemx set remote hardware-breakpoint-limit @var{limit}
20312 Restrict @value{GDBN} to using @var{limit} remote hardware breakpoint or
20313 watchpoints. A limit of -1, the default, is treated as unlimited.
20315 @cindex limit hardware watchpoints length
20316 @cindex remote target, limit watchpoints length
20317 @anchor{set remote hardware-watchpoint-length-limit}
20318 @item set remote hardware-watchpoint-length-limit @var{limit}
20319 Restrict @value{GDBN} to using @var{limit} bytes for the maximum length of
20320 a remote hardware watchpoint. A limit of -1, the default, is treated
20323 @item show remote hardware-watchpoint-length-limit
20324 Show the current limit (in bytes) of the maximum length of
20325 a remote hardware watchpoint.
20327 @item set remote exec-file @var{filename}
20328 @itemx show remote exec-file
20329 @anchor{set remote exec-file}
20330 @cindex executable file, for remote target
20331 Select the file used for @code{run} with @code{target
20332 extended-remote}. This should be set to a filename valid on the
20333 target system. If it is not set, the target will use a default
20334 filename (e.g.@: the last program run).
20336 @item set remote interrupt-sequence
20337 @cindex interrupt remote programs
20338 @cindex select Ctrl-C, BREAK or BREAK-g
20339 Allow the user to select one of @samp{Ctrl-C}, a @code{BREAK} or
20340 @samp{BREAK-g} as the
20341 sequence to the remote target in order to interrupt the execution.
20342 @samp{Ctrl-C} is a default. Some system prefers @code{BREAK} which
20343 is high level of serial line for some certain time.
20344 Linux kernel prefers @samp{BREAK-g}, a.k.a Magic SysRq g.
20345 It is @code{BREAK} signal followed by character @code{g}.
20347 @item show interrupt-sequence
20348 Show which of @samp{Ctrl-C}, @code{BREAK} or @code{BREAK-g}
20349 is sent by @value{GDBN} to interrupt the remote program.
20350 @code{BREAK-g} is BREAK signal followed by @code{g} and
20351 also known as Magic SysRq g.
20353 @item set remote interrupt-on-connect
20354 @cindex send interrupt-sequence on start
20355 Specify whether interrupt-sequence is sent to remote target when
20356 @value{GDBN} connects to it. This is mostly needed when you debug
20357 Linux kernel. Linux kernel expects @code{BREAK} followed by @code{g}
20358 which is known as Magic SysRq g in order to connect @value{GDBN}.
20360 @item show interrupt-on-connect
20361 Show whether interrupt-sequence is sent
20362 to remote target when @value{GDBN} connects to it.
20366 @item set tcp auto-retry on
20367 @cindex auto-retry, for remote TCP target
20368 Enable auto-retry for remote TCP connections. This is useful if the remote
20369 debugging agent is launched in parallel with @value{GDBN}; there is a race
20370 condition because the agent may not become ready to accept the connection
20371 before @value{GDBN} attempts to connect. When auto-retry is
20372 enabled, if the initial attempt to connect fails, @value{GDBN} reattempts
20373 to establish the connection using the timeout specified by
20374 @code{set tcp connect-timeout}.
20376 @item set tcp auto-retry off
20377 Do not auto-retry failed TCP connections.
20379 @item show tcp auto-retry
20380 Show the current auto-retry setting.
20382 @item set tcp connect-timeout @var{seconds}
20383 @itemx set tcp connect-timeout unlimited
20384 @cindex connection timeout, for remote TCP target
20385 @cindex timeout, for remote target connection
20386 Set the timeout for establishing a TCP connection to the remote target to
20387 @var{seconds}. The timeout affects both polling to retry failed connections
20388 (enabled by @code{set tcp auto-retry on}) and waiting for connections
20389 that are merely slow to complete, and represents an approximate cumulative
20390 value. If @var{seconds} is @code{unlimited}, there is no timeout and
20391 @value{GDBN} will keep attempting to establish a connection forever,
20392 unless interrupted with @kbd{Ctrl-c}. The default is 15 seconds.
20394 @item show tcp connect-timeout
20395 Show the current connection timeout setting.
20398 @cindex remote packets, enabling and disabling
20399 The @value{GDBN} remote protocol autodetects the packets supported by
20400 your debugging stub. If you need to override the autodetection, you
20401 can use these commands to enable or disable individual packets. Each
20402 packet can be set to @samp{on} (the remote target supports this
20403 packet), @samp{off} (the remote target does not support this packet),
20404 or @samp{auto} (detect remote target support for this packet). They
20405 all default to @samp{auto}. For more information about each packet,
20406 see @ref{Remote Protocol}.
20408 During normal use, you should not have to use any of these commands.
20409 If you do, that may be a bug in your remote debugging stub, or a bug
20410 in @value{GDBN}. You may want to report the problem to the
20411 @value{GDBN} developers.
20413 For each packet @var{name}, the command to enable or disable the
20414 packet is @code{set remote @var{name}-packet}. The available settings
20417 @multitable @columnfractions 0.28 0.32 0.25
20420 @tab Related Features
20422 @item @code{fetch-register}
20424 @tab @code{info registers}
20426 @item @code{set-register}
20430 @item @code{binary-download}
20432 @tab @code{load}, @code{set}
20434 @item @code{read-aux-vector}
20435 @tab @code{qXfer:auxv:read}
20436 @tab @code{info auxv}
20438 @item @code{symbol-lookup}
20439 @tab @code{qSymbol}
20440 @tab Detecting multiple threads
20442 @item @code{attach}
20443 @tab @code{vAttach}
20446 @item @code{verbose-resume}
20448 @tab Stepping or resuming multiple threads
20454 @item @code{software-breakpoint}
20458 @item @code{hardware-breakpoint}
20462 @item @code{write-watchpoint}
20466 @item @code{read-watchpoint}
20470 @item @code{access-watchpoint}
20474 @item @code{pid-to-exec-file}
20475 @tab @code{qXfer:exec-file:read}
20476 @tab @code{attach}, @code{run}
20478 @item @code{target-features}
20479 @tab @code{qXfer:features:read}
20480 @tab @code{set architecture}
20482 @item @code{library-info}
20483 @tab @code{qXfer:libraries:read}
20484 @tab @code{info sharedlibrary}
20486 @item @code{memory-map}
20487 @tab @code{qXfer:memory-map:read}
20488 @tab @code{info mem}
20490 @item @code{read-sdata-object}
20491 @tab @code{qXfer:sdata:read}
20492 @tab @code{print $_sdata}
20494 @item @code{read-spu-object}
20495 @tab @code{qXfer:spu:read}
20496 @tab @code{info spu}
20498 @item @code{write-spu-object}
20499 @tab @code{qXfer:spu:write}
20500 @tab @code{info spu}
20502 @item @code{read-siginfo-object}
20503 @tab @code{qXfer:siginfo:read}
20504 @tab @code{print $_siginfo}
20506 @item @code{write-siginfo-object}
20507 @tab @code{qXfer:siginfo:write}
20508 @tab @code{set $_siginfo}
20510 @item @code{threads}
20511 @tab @code{qXfer:threads:read}
20512 @tab @code{info threads}
20514 @item @code{get-thread-local-@*storage-address}
20515 @tab @code{qGetTLSAddr}
20516 @tab Displaying @code{__thread} variables
20518 @item @code{get-thread-information-block-address}
20519 @tab @code{qGetTIBAddr}
20520 @tab Display MS-Windows Thread Information Block.
20522 @item @code{search-memory}
20523 @tab @code{qSearch:memory}
20526 @item @code{supported-packets}
20527 @tab @code{qSupported}
20528 @tab Remote communications parameters
20530 @item @code{catch-syscalls}
20531 @tab @code{QCatchSyscalls}
20532 @tab @code{catch syscall}
20534 @item @code{pass-signals}
20535 @tab @code{QPassSignals}
20536 @tab @code{handle @var{signal}}
20538 @item @code{program-signals}
20539 @tab @code{QProgramSignals}
20540 @tab @code{handle @var{signal}}
20542 @item @code{hostio-close-packet}
20543 @tab @code{vFile:close}
20544 @tab @code{remote get}, @code{remote put}
20546 @item @code{hostio-open-packet}
20547 @tab @code{vFile:open}
20548 @tab @code{remote get}, @code{remote put}
20550 @item @code{hostio-pread-packet}
20551 @tab @code{vFile:pread}
20552 @tab @code{remote get}, @code{remote put}
20554 @item @code{hostio-pwrite-packet}
20555 @tab @code{vFile:pwrite}
20556 @tab @code{remote get}, @code{remote put}
20558 @item @code{hostio-unlink-packet}
20559 @tab @code{vFile:unlink}
20560 @tab @code{remote delete}
20562 @item @code{hostio-readlink-packet}
20563 @tab @code{vFile:readlink}
20566 @item @code{hostio-fstat-packet}
20567 @tab @code{vFile:fstat}
20570 @item @code{hostio-setfs-packet}
20571 @tab @code{vFile:setfs}
20574 @item @code{noack-packet}
20575 @tab @code{QStartNoAckMode}
20576 @tab Packet acknowledgment
20578 @item @code{osdata}
20579 @tab @code{qXfer:osdata:read}
20580 @tab @code{info os}
20582 @item @code{query-attached}
20583 @tab @code{qAttached}
20584 @tab Querying remote process attach state.
20586 @item @code{trace-buffer-size}
20587 @tab @code{QTBuffer:size}
20588 @tab @code{set trace-buffer-size}
20590 @item @code{trace-status}
20591 @tab @code{qTStatus}
20592 @tab @code{tstatus}
20594 @item @code{traceframe-info}
20595 @tab @code{qXfer:traceframe-info:read}
20596 @tab Traceframe info
20598 @item @code{install-in-trace}
20599 @tab @code{InstallInTrace}
20600 @tab Install tracepoint in tracing
20602 @item @code{disable-randomization}
20603 @tab @code{QDisableRandomization}
20604 @tab @code{set disable-randomization}
20606 @item @code{conditional-breakpoints-packet}
20607 @tab @code{Z0 and Z1}
20608 @tab @code{Support for target-side breakpoint condition evaluation}
20610 @item @code{multiprocess-extensions}
20611 @tab @code{multiprocess extensions}
20612 @tab Debug multiple processes and remote process PID awareness
20614 @item @code{swbreak-feature}
20615 @tab @code{swbreak stop reason}
20618 @item @code{hwbreak-feature}
20619 @tab @code{hwbreak stop reason}
20622 @item @code{fork-event-feature}
20623 @tab @code{fork stop reason}
20626 @item @code{vfork-event-feature}
20627 @tab @code{vfork stop reason}
20630 @item @code{exec-event-feature}
20631 @tab @code{exec stop reason}
20634 @item @code{thread-events}
20635 @tab @code{QThreadEvents}
20636 @tab Tracking thread lifetime.
20638 @item @code{no-resumed-stop-reply}
20639 @tab @code{no resumed thread left stop reply}
20640 @tab Tracking thread lifetime.
20645 @section Implementing a Remote Stub
20647 @cindex debugging stub, example
20648 @cindex remote stub, example
20649 @cindex stub example, remote debugging
20650 The stub files provided with @value{GDBN} implement the target side of the
20651 communication protocol, and the @value{GDBN} side is implemented in the
20652 @value{GDBN} source file @file{remote.c}. Normally, you can simply allow
20653 these subroutines to communicate, and ignore the details. (If you're
20654 implementing your own stub file, you can still ignore the details: start
20655 with one of the existing stub files. @file{sparc-stub.c} is the best
20656 organized, and therefore the easiest to read.)
20658 @cindex remote serial debugging, overview
20659 To debug a program running on another machine (the debugging
20660 @dfn{target} machine), you must first arrange for all the usual
20661 prerequisites for the program to run by itself. For example, for a C
20666 A startup routine to set up the C runtime environment; these usually
20667 have a name like @file{crt0}. The startup routine may be supplied by
20668 your hardware supplier, or you may have to write your own.
20671 A C subroutine library to support your program's
20672 subroutine calls, notably managing input and output.
20675 A way of getting your program to the other machine---for example, a
20676 download program. These are often supplied by the hardware
20677 manufacturer, but you may have to write your own from hardware
20681 The next step is to arrange for your program to use a serial port to
20682 communicate with the machine where @value{GDBN} is running (the @dfn{host}
20683 machine). In general terms, the scheme looks like this:
20687 @value{GDBN} already understands how to use this protocol; when everything
20688 else is set up, you can simply use the @samp{target remote} command
20689 (@pxref{Targets,,Specifying a Debugging Target}).
20691 @item On the target,
20692 you must link with your program a few special-purpose subroutines that
20693 implement the @value{GDBN} remote serial protocol. The file containing these
20694 subroutines is called a @dfn{debugging stub}.
20696 On certain remote targets, you can use an auxiliary program
20697 @code{gdbserver} instead of linking a stub into your program.
20698 @xref{Server,,Using the @code{gdbserver} Program}, for details.
20701 The debugging stub is specific to the architecture of the remote
20702 machine; for example, use @file{sparc-stub.c} to debug programs on
20705 @cindex remote serial stub list
20706 These working remote stubs are distributed with @value{GDBN}:
20711 @cindex @file{i386-stub.c}
20714 For Intel 386 and compatible architectures.
20717 @cindex @file{m68k-stub.c}
20718 @cindex Motorola 680x0
20720 For Motorola 680x0 architectures.
20723 @cindex @file{sh-stub.c}
20726 For Renesas SH architectures.
20729 @cindex @file{sparc-stub.c}
20731 For @sc{sparc} architectures.
20733 @item sparcl-stub.c
20734 @cindex @file{sparcl-stub.c}
20737 For Fujitsu @sc{sparclite} architectures.
20741 The @file{README} file in the @value{GDBN} distribution may list other
20742 recently added stubs.
20745 * Stub Contents:: What the stub can do for you
20746 * Bootstrapping:: What you must do for the stub
20747 * Debug Session:: Putting it all together
20750 @node Stub Contents
20751 @subsection What the Stub Can Do for You
20753 @cindex remote serial stub
20754 The debugging stub for your architecture supplies these three
20758 @item set_debug_traps
20759 @findex set_debug_traps
20760 @cindex remote serial stub, initialization
20761 This routine arranges for @code{handle_exception} to run when your
20762 program stops. You must call this subroutine explicitly in your
20763 program's startup code.
20765 @item handle_exception
20766 @findex handle_exception
20767 @cindex remote serial stub, main routine
20768 This is the central workhorse, but your program never calls it
20769 explicitly---the setup code arranges for @code{handle_exception} to
20770 run when a trap is triggered.
20772 @code{handle_exception} takes control when your program stops during
20773 execution (for example, on a breakpoint), and mediates communications
20774 with @value{GDBN} on the host machine. This is where the communications
20775 protocol is implemented; @code{handle_exception} acts as the @value{GDBN}
20776 representative on the target machine. It begins by sending summary
20777 information on the state of your program, then continues to execute,
20778 retrieving and transmitting any information @value{GDBN} needs, until you
20779 execute a @value{GDBN} command that makes your program resume; at that point,
20780 @code{handle_exception} returns control to your own code on the target
20784 @cindex @code{breakpoint} subroutine, remote
20785 Use this auxiliary subroutine to make your program contain a
20786 breakpoint. Depending on the particular situation, this may be the only
20787 way for @value{GDBN} to get control. For instance, if your target
20788 machine has some sort of interrupt button, you won't need to call this;
20789 pressing the interrupt button transfers control to
20790 @code{handle_exception}---in effect, to @value{GDBN}. On some machines,
20791 simply receiving characters on the serial port may also trigger a trap;
20792 again, in that situation, you don't need to call @code{breakpoint} from
20793 your own program---simply running @samp{target remote} from the host
20794 @value{GDBN} session gets control.
20796 Call @code{breakpoint} if none of these is true, or if you simply want
20797 to make certain your program stops at a predetermined point for the
20798 start of your debugging session.
20801 @node Bootstrapping
20802 @subsection What You Must Do for the Stub
20804 @cindex remote stub, support routines
20805 The debugging stubs that come with @value{GDBN} are set up for a particular
20806 chip architecture, but they have no information about the rest of your
20807 debugging target machine.
20809 First of all you need to tell the stub how to communicate with the
20813 @item int getDebugChar()
20814 @findex getDebugChar
20815 Write this subroutine to read a single character from the serial port.
20816 It may be identical to @code{getchar} for your target system; a
20817 different name is used to allow you to distinguish the two if you wish.
20819 @item void putDebugChar(int)
20820 @findex putDebugChar
20821 Write this subroutine to write a single character to the serial port.
20822 It may be identical to @code{putchar} for your target system; a
20823 different name is used to allow you to distinguish the two if you wish.
20826 @cindex control C, and remote debugging
20827 @cindex interrupting remote targets
20828 If you want @value{GDBN} to be able to stop your program while it is
20829 running, you need to use an interrupt-driven serial driver, and arrange
20830 for it to stop when it receives a @code{^C} (@samp{\003}, the control-C
20831 character). That is the character which @value{GDBN} uses to tell the
20832 remote system to stop.
20834 Getting the debugging target to return the proper status to @value{GDBN}
20835 probably requires changes to the standard stub; one quick and dirty way
20836 is to just execute a breakpoint instruction (the ``dirty'' part is that
20837 @value{GDBN} reports a @code{SIGTRAP} instead of a @code{SIGINT}).
20839 Other routines you need to supply are:
20842 @item void exceptionHandler (int @var{exception_number}, void *@var{exception_address})
20843 @findex exceptionHandler
20844 Write this function to install @var{exception_address} in the exception
20845 handling tables. You need to do this because the stub does not have any
20846 way of knowing what the exception handling tables on your target system
20847 are like (for example, the processor's table might be in @sc{rom},
20848 containing entries which point to a table in @sc{ram}).
20849 The @var{exception_number} specifies the exception which should be changed;
20850 its meaning is architecture-dependent (for example, different numbers
20851 might represent divide by zero, misaligned access, etc). When this
20852 exception occurs, control should be transferred directly to
20853 @var{exception_address}, and the processor state (stack, registers,
20854 and so on) should be just as it is when a processor exception occurs. So if
20855 you want to use a jump instruction to reach @var{exception_address}, it
20856 should be a simple jump, not a jump to subroutine.
20858 For the 386, @var{exception_address} should be installed as an interrupt
20859 gate so that interrupts are masked while the handler runs. The gate
20860 should be at privilege level 0 (the most privileged level). The
20861 @sc{sparc} and 68k stubs are able to mask interrupts themselves without
20862 help from @code{exceptionHandler}.
20864 @item void flush_i_cache()
20865 @findex flush_i_cache
20866 On @sc{sparc} and @sc{sparclite} only, write this subroutine to flush the
20867 instruction cache, if any, on your target machine. If there is no
20868 instruction cache, this subroutine may be a no-op.
20870 On target machines that have instruction caches, @value{GDBN} requires this
20871 function to make certain that the state of your program is stable.
20875 You must also make sure this library routine is available:
20878 @item void *memset(void *, int, int)
20880 This is the standard library function @code{memset} that sets an area of
20881 memory to a known value. If you have one of the free versions of
20882 @code{libc.a}, @code{memset} can be found there; otherwise, you must
20883 either obtain it from your hardware manufacturer, or write your own.
20886 If you do not use the GNU C compiler, you may need other standard
20887 library subroutines as well; this varies from one stub to another,
20888 but in general the stubs are likely to use any of the common library
20889 subroutines which @code{@value{NGCC}} generates as inline code.
20892 @node Debug Session
20893 @subsection Putting it All Together
20895 @cindex remote serial debugging summary
20896 In summary, when your program is ready to debug, you must follow these
20901 Make sure you have defined the supporting low-level routines
20902 (@pxref{Bootstrapping,,What You Must Do for the Stub}):
20904 @code{getDebugChar}, @code{putDebugChar},
20905 @code{flush_i_cache}, @code{memset}, @code{exceptionHandler}.
20909 Insert these lines in your program's startup code, before the main
20910 procedure is called:
20917 On some machines, when a breakpoint trap is raised, the hardware
20918 automatically makes the PC point to the instruction after the
20919 breakpoint. If your machine doesn't do that, you may need to adjust
20920 @code{handle_exception} to arrange for it to return to the instruction
20921 after the breakpoint on this first invocation, so that your program
20922 doesn't keep hitting the initial breakpoint instead of making
20926 For the 680x0 stub only, you need to provide a variable called
20927 @code{exceptionHook}. Normally you just use:
20930 void (*exceptionHook)() = 0;
20934 but if before calling @code{set_debug_traps}, you set it to point to a
20935 function in your program, that function is called when
20936 @code{@value{GDBN}} continues after stopping on a trap (for example, bus
20937 error). The function indicated by @code{exceptionHook} is called with
20938 one parameter: an @code{int} which is the exception number.
20941 Compile and link together: your program, the @value{GDBN} debugging stub for
20942 your target architecture, and the supporting subroutines.
20945 Make sure you have a serial connection between your target machine and
20946 the @value{GDBN} host, and identify the serial port on the host.
20949 @c The "remote" target now provides a `load' command, so we should
20950 @c document that. FIXME.
20951 Download your program to your target machine (or get it there by
20952 whatever means the manufacturer provides), and start it.
20955 Start @value{GDBN} on the host, and connect to the target
20956 (@pxref{Connecting,,Connecting to a Remote Target}).
20960 @node Configurations
20961 @chapter Configuration-Specific Information
20963 While nearly all @value{GDBN} commands are available for all native and
20964 cross versions of the debugger, there are some exceptions. This chapter
20965 describes things that are only available in certain configurations.
20967 There are three major categories of configurations: native
20968 configurations, where the host and target are the same, embedded
20969 operating system configurations, which are usually the same for several
20970 different processor architectures, and bare embedded processors, which
20971 are quite different from each other.
20976 * Embedded Processors::
20983 This section describes details specific to particular native
20987 * BSD libkvm Interface:: Debugging BSD kernel memory images
20988 * SVR4 Process Information:: SVR4 process information
20989 * DJGPP Native:: Features specific to the DJGPP port
20990 * Cygwin Native:: Features specific to the Cygwin port
20991 * Hurd Native:: Features specific to @sc{gnu} Hurd
20992 * Darwin:: Features specific to Darwin
20995 @node BSD libkvm Interface
20996 @subsection BSD libkvm Interface
20999 @cindex kernel memory image
21000 @cindex kernel crash dump
21002 BSD-derived systems (FreeBSD/NetBSD/OpenBSD) have a kernel memory
21003 interface that provides a uniform interface for accessing kernel virtual
21004 memory images, including live systems and crash dumps. @value{GDBN}
21005 uses this interface to allow you to debug live kernels and kernel crash
21006 dumps on many native BSD configurations. This is implemented as a
21007 special @code{kvm} debugging target. For debugging a live system, load
21008 the currently running kernel into @value{GDBN} and connect to the
21012 (@value{GDBP}) @b{target kvm}
21015 For debugging crash dumps, provide the file name of the crash dump as an
21019 (@value{GDBP}) @b{target kvm /var/crash/bsd.0}
21022 Once connected to the @code{kvm} target, the following commands are
21028 Set current context from the @dfn{Process Control Block} (PCB) address.
21031 Set current context from proc address. This command isn't available on
21032 modern FreeBSD systems.
21035 @node SVR4 Process Information
21036 @subsection SVR4 Process Information
21038 @cindex examine process image
21039 @cindex process info via @file{/proc}
21041 Many versions of SVR4 and compatible systems provide a facility called
21042 @samp{/proc} that can be used to examine the image of a running
21043 process using file-system subroutines.
21045 If @value{GDBN} is configured for an operating system with this
21046 facility, the command @code{info proc} is available to report
21047 information about the process running your program, or about any
21048 process running on your system. This includes, as of this writing,
21049 @sc{gnu}/Linux and Solaris, for example.
21051 This command may also work on core files that were created on a system
21052 that has the @samp{/proc} facility.
21058 @itemx info proc @var{process-id}
21059 Summarize available information about any running process. If a
21060 process ID is specified by @var{process-id}, display information about
21061 that process; otherwise display information about the program being
21062 debugged. The summary includes the debugged process ID, the command
21063 line used to invoke it, its current working directory, and its
21064 executable file's absolute file name.
21066 On some systems, @var{process-id} can be of the form
21067 @samp{[@var{pid}]/@var{tid}} which specifies a certain thread ID
21068 within a process. If the optional @var{pid} part is missing, it means
21069 a thread from the process being debugged (the leading @samp{/} still
21070 needs to be present, or else @value{GDBN} will interpret the number as
21071 a process ID rather than a thread ID).
21073 @item info proc cmdline
21074 @cindex info proc cmdline
21075 Show the original command line of the process. This command is
21076 specific to @sc{gnu}/Linux.
21078 @item info proc cwd
21079 @cindex info proc cwd
21080 Show the current working directory of the process. This command is
21081 specific to @sc{gnu}/Linux.
21083 @item info proc exe
21084 @cindex info proc exe
21085 Show the name of executable of the process. This command is specific
21088 @item info proc mappings
21089 @cindex memory address space mappings
21090 Report the memory address space ranges accessible in the program, with
21091 information on whether the process has read, write, or execute access
21092 rights to each range. On @sc{gnu}/Linux systems, each memory range
21093 includes the object file which is mapped to that range, instead of the
21094 memory access rights to that range.
21096 @item info proc stat
21097 @itemx info proc status
21098 @cindex process detailed status information
21099 These subcommands are specific to @sc{gnu}/Linux systems. They show
21100 the process-related information, including the user ID and group ID;
21101 how many threads are there in the process; its virtual memory usage;
21102 the signals that are pending, blocked, and ignored; its TTY; its
21103 consumption of system and user time; its stack size; its @samp{nice}
21104 value; etc. For more information, see the @samp{proc} man page
21105 (type @kbd{man 5 proc} from your shell prompt).
21107 @item info proc all
21108 Show all the information about the process described under all of the
21109 above @code{info proc} subcommands.
21112 @comment These sub-options of 'info proc' were not included when
21113 @comment procfs.c was re-written. Keep their descriptions around
21114 @comment against the day when someone finds the time to put them back in.
21115 @kindex info proc times
21116 @item info proc times
21117 Starting time, user CPU time, and system CPU time for your program and
21120 @kindex info proc id
21122 Report on the process IDs related to your program: its own process ID,
21123 the ID of its parent, the process group ID, and the session ID.
21126 @item set procfs-trace
21127 @kindex set procfs-trace
21128 @cindex @code{procfs} API calls
21129 This command enables and disables tracing of @code{procfs} API calls.
21131 @item show procfs-trace
21132 @kindex show procfs-trace
21133 Show the current state of @code{procfs} API call tracing.
21135 @item set procfs-file @var{file}
21136 @kindex set procfs-file
21137 Tell @value{GDBN} to write @code{procfs} API trace to the named
21138 @var{file}. @value{GDBN} appends the trace info to the previous
21139 contents of the file. The default is to display the trace on the
21142 @item show procfs-file
21143 @kindex show procfs-file
21144 Show the file to which @code{procfs} API trace is written.
21146 @item proc-trace-entry
21147 @itemx proc-trace-exit
21148 @itemx proc-untrace-entry
21149 @itemx proc-untrace-exit
21150 @kindex proc-trace-entry
21151 @kindex proc-trace-exit
21152 @kindex proc-untrace-entry
21153 @kindex proc-untrace-exit
21154 These commands enable and disable tracing of entries into and exits
21155 from the @code{syscall} interface.
21158 @kindex info pidlist
21159 @cindex process list, QNX Neutrino
21160 For QNX Neutrino only, this command displays the list of all the
21161 processes and all the threads within each process.
21164 @kindex info meminfo
21165 @cindex mapinfo list, QNX Neutrino
21166 For QNX Neutrino only, this command displays the list of all mapinfos.
21170 @subsection Features for Debugging @sc{djgpp} Programs
21171 @cindex @sc{djgpp} debugging
21172 @cindex native @sc{djgpp} debugging
21173 @cindex MS-DOS-specific commands
21176 @sc{djgpp} is a port of the @sc{gnu} development tools to MS-DOS and
21177 MS-Windows. @sc{djgpp} programs are 32-bit protected-mode programs
21178 that use the @dfn{DPMI} (DOS Protected-Mode Interface) API to run on
21179 top of real-mode DOS systems and their emulations.
21181 @value{GDBN} supports native debugging of @sc{djgpp} programs, and
21182 defines a few commands specific to the @sc{djgpp} port. This
21183 subsection describes those commands.
21188 This is a prefix of @sc{djgpp}-specific commands which print
21189 information about the target system and important OS structures.
21192 @cindex MS-DOS system info
21193 @cindex free memory information (MS-DOS)
21194 @item info dos sysinfo
21195 This command displays assorted information about the underlying
21196 platform: the CPU type and features, the OS version and flavor, the
21197 DPMI version, and the available conventional and DPMI memory.
21202 @cindex segment descriptor tables
21203 @cindex descriptor tables display
21205 @itemx info dos ldt
21206 @itemx info dos idt
21207 These 3 commands display entries from, respectively, Global, Local,
21208 and Interrupt Descriptor Tables (GDT, LDT, and IDT). The descriptor
21209 tables are data structures which store a descriptor for each segment
21210 that is currently in use. The segment's selector is an index into a
21211 descriptor table; the table entry for that index holds the
21212 descriptor's base address and limit, and its attributes and access
21215 A typical @sc{djgpp} program uses 3 segments: a code segment, a data
21216 segment (used for both data and the stack), and a DOS segment (which
21217 allows access to DOS/BIOS data structures and absolute addresses in
21218 conventional memory). However, the DPMI host will usually define
21219 additional segments in order to support the DPMI environment.
21221 @cindex garbled pointers
21222 These commands allow to display entries from the descriptor tables.
21223 Without an argument, all entries from the specified table are
21224 displayed. An argument, which should be an integer expression, means
21225 display a single entry whose index is given by the argument. For
21226 example, here's a convenient way to display information about the
21227 debugged program's data segment:
21230 @exdent @code{(@value{GDBP}) info dos ldt $ds}
21231 @exdent @code{0x13f: base=0x11970000 limit=0x0009ffff 32-Bit Data (Read/Write, Exp-up)}
21235 This comes in handy when you want to see whether a pointer is outside
21236 the data segment's limit (i.e.@: @dfn{garbled}).
21238 @cindex page tables display (MS-DOS)
21240 @itemx info dos pte
21241 These two commands display entries from, respectively, the Page
21242 Directory and the Page Tables. Page Directories and Page Tables are
21243 data structures which control how virtual memory addresses are mapped
21244 into physical addresses. A Page Table includes an entry for every
21245 page of memory that is mapped into the program's address space; there
21246 may be several Page Tables, each one holding up to 4096 entries. A
21247 Page Directory has up to 4096 entries, one each for every Page Table
21248 that is currently in use.
21250 Without an argument, @kbd{info dos pde} displays the entire Page
21251 Directory, and @kbd{info dos pte} displays all the entries in all of
21252 the Page Tables. An argument, an integer expression, given to the
21253 @kbd{info dos pde} command means display only that entry from the Page
21254 Directory table. An argument given to the @kbd{info dos pte} command
21255 means display entries from a single Page Table, the one pointed to by
21256 the specified entry in the Page Directory.
21258 @cindex direct memory access (DMA) on MS-DOS
21259 These commands are useful when your program uses @dfn{DMA} (Direct
21260 Memory Access), which needs physical addresses to program the DMA
21263 These commands are supported only with some DPMI servers.
21265 @cindex physical address from linear address
21266 @item info dos address-pte @var{addr}
21267 This command displays the Page Table entry for a specified linear
21268 address. The argument @var{addr} is a linear address which should
21269 already have the appropriate segment's base address added to it,
21270 because this command accepts addresses which may belong to @emph{any}
21271 segment. For example, here's how to display the Page Table entry for
21272 the page where a variable @code{i} is stored:
21275 @exdent @code{(@value{GDBP}) info dos address-pte __djgpp_base_address + (char *)&i}
21276 @exdent @code{Page Table entry for address 0x11a00d30:}
21277 @exdent @code{Base=0x02698000 Dirty Acc. Not-Cached Write-Back Usr Read-Write +0xd30}
21281 This says that @code{i} is stored at offset @code{0xd30} from the page
21282 whose physical base address is @code{0x02698000}, and shows all the
21283 attributes of that page.
21285 Note that you must cast the addresses of variables to a @code{char *},
21286 since otherwise the value of @code{__djgpp_base_address}, the base
21287 address of all variables and functions in a @sc{djgpp} program, will
21288 be added using the rules of C pointer arithmetics: if @code{i} is
21289 declared an @code{int}, @value{GDBN} will add 4 times the value of
21290 @code{__djgpp_base_address} to the address of @code{i}.
21292 Here's another example, it displays the Page Table entry for the
21296 @exdent @code{(@value{GDBP}) info dos address-pte *((unsigned *)&_go32_info_block + 3)}
21297 @exdent @code{Page Table entry for address 0x29110:}
21298 @exdent @code{Base=0x00029000 Dirty Acc. Not-Cached Write-Back Usr Read-Write +0x110}
21302 (The @code{+ 3} offset is because the transfer buffer's address is the
21303 3rd member of the @code{_go32_info_block} structure.) The output
21304 clearly shows that this DPMI server maps the addresses in conventional
21305 memory 1:1, i.e.@: the physical (@code{0x00029000} + @code{0x110}) and
21306 linear (@code{0x29110}) addresses are identical.
21308 This command is supported only with some DPMI servers.
21311 @cindex DOS serial data link, remote debugging
21312 In addition to native debugging, the DJGPP port supports remote
21313 debugging via a serial data link. The following commands are specific
21314 to remote serial debugging in the DJGPP port of @value{GDBN}.
21317 @kindex set com1base
21318 @kindex set com1irq
21319 @kindex set com2base
21320 @kindex set com2irq
21321 @kindex set com3base
21322 @kindex set com3irq
21323 @kindex set com4base
21324 @kindex set com4irq
21325 @item set com1base @var{addr}
21326 This command sets the base I/O port address of the @file{COM1} serial
21329 @item set com1irq @var{irq}
21330 This command sets the @dfn{Interrupt Request} (@code{IRQ}) line to use
21331 for the @file{COM1} serial port.
21333 There are similar commands @samp{set com2base}, @samp{set com3irq},
21334 etc.@: for setting the port address and the @code{IRQ} lines for the
21337 @kindex show com1base
21338 @kindex show com1irq
21339 @kindex show com2base
21340 @kindex show com2irq
21341 @kindex show com3base
21342 @kindex show com3irq
21343 @kindex show com4base
21344 @kindex show com4irq
21345 The related commands @samp{show com1base}, @samp{show com1irq} etc.@:
21346 display the current settings of the base address and the @code{IRQ}
21347 lines used by the COM ports.
21350 @kindex info serial
21351 @cindex DOS serial port status
21352 This command prints the status of the 4 DOS serial ports. For each
21353 port, it prints whether it's active or not, its I/O base address and
21354 IRQ number, whether it uses a 16550-style FIFO, its baudrate, and the
21355 counts of various errors encountered so far.
21359 @node Cygwin Native
21360 @subsection Features for Debugging MS Windows PE Executables
21361 @cindex MS Windows debugging
21362 @cindex native Cygwin debugging
21363 @cindex Cygwin-specific commands
21365 @value{GDBN} supports native debugging of MS Windows programs, including
21366 DLLs with and without symbolic debugging information.
21368 @cindex Ctrl-BREAK, MS-Windows
21369 @cindex interrupt debuggee on MS-Windows
21370 MS-Windows programs that call @code{SetConsoleMode} to switch off the
21371 special meaning of the @samp{Ctrl-C} keystroke cannot be interrupted
21372 by typing @kbd{C-c}. For this reason, @value{GDBN} on MS-Windows
21373 supports @kbd{C-@key{BREAK}} as an alternative interrupt key
21374 sequence, which can be used to interrupt the debuggee even if it
21377 There are various additional Cygwin-specific commands, described in
21378 this section. Working with DLLs that have no debugging symbols is
21379 described in @ref{Non-debug DLL Symbols}.
21384 This is a prefix of MS Windows-specific commands which print
21385 information about the target system and important OS structures.
21387 @item info w32 selector
21388 This command displays information returned by
21389 the Win32 API @code{GetThreadSelectorEntry} function.
21390 It takes an optional argument that is evaluated to
21391 a long value to give the information about this given selector.
21392 Without argument, this command displays information
21393 about the six segment registers.
21395 @item info w32 thread-information-block
21396 This command displays thread specific information stored in the
21397 Thread Information Block (readable on the X86 CPU family using @code{$fs}
21398 selector for 32-bit programs and @code{$gs} for 64-bit programs).
21400 @kindex set cygwin-exceptions
21401 @cindex debugging the Cygwin DLL
21402 @cindex Cygwin DLL, debugging
21403 @item set cygwin-exceptions @var{mode}
21404 If @var{mode} is @code{on}, @value{GDBN} will break on exceptions that
21405 happen inside the Cygwin DLL. If @var{mode} is @code{off},
21406 @value{GDBN} will delay recognition of exceptions, and may ignore some
21407 exceptions which seem to be caused by internal Cygwin DLL
21408 ``bookkeeping''. This option is meant primarily for debugging the
21409 Cygwin DLL itself; the default value is @code{off} to avoid annoying
21410 @value{GDBN} users with false @code{SIGSEGV} signals.
21412 @kindex show cygwin-exceptions
21413 @item show cygwin-exceptions
21414 Displays whether @value{GDBN} will break on exceptions that happen
21415 inside the Cygwin DLL itself.
21417 @kindex set new-console
21418 @item set new-console @var{mode}
21419 If @var{mode} is @code{on} the debuggee will
21420 be started in a new console on next start.
21421 If @var{mode} is @code{off}, the debuggee will
21422 be started in the same console as the debugger.
21424 @kindex show new-console
21425 @item show new-console
21426 Displays whether a new console is used
21427 when the debuggee is started.
21429 @kindex set new-group
21430 @item set new-group @var{mode}
21431 This boolean value controls whether the debuggee should
21432 start a new group or stay in the same group as the debugger.
21433 This affects the way the Windows OS handles
21436 @kindex show new-group
21437 @item show new-group
21438 Displays current value of new-group boolean.
21440 @kindex set debugevents
21441 @item set debugevents
21442 This boolean value adds debug output concerning kernel events related
21443 to the debuggee seen by the debugger. This includes events that
21444 signal thread and process creation and exit, DLL loading and
21445 unloading, console interrupts, and debugging messages produced by the
21446 Windows @code{OutputDebugString} API call.
21448 @kindex set debugexec
21449 @item set debugexec
21450 This boolean value adds debug output concerning execute events
21451 (such as resume thread) seen by the debugger.
21453 @kindex set debugexceptions
21454 @item set debugexceptions
21455 This boolean value adds debug output concerning exceptions in the
21456 debuggee seen by the debugger.
21458 @kindex set debugmemory
21459 @item set debugmemory
21460 This boolean value adds debug output concerning debuggee memory reads
21461 and writes by the debugger.
21465 This boolean values specifies whether the debuggee is called
21466 via a shell or directly (default value is on).
21470 Displays if the debuggee will be started with a shell.
21475 * Non-debug DLL Symbols:: Support for DLLs without debugging symbols
21478 @node Non-debug DLL Symbols
21479 @subsubsection Support for DLLs without Debugging Symbols
21480 @cindex DLLs with no debugging symbols
21481 @cindex Minimal symbols and DLLs
21483 Very often on windows, some of the DLLs that your program relies on do
21484 not include symbolic debugging information (for example,
21485 @file{kernel32.dll}). When @value{GDBN} doesn't recognize any debugging
21486 symbols in a DLL, it relies on the minimal amount of symbolic
21487 information contained in the DLL's export table. This section
21488 describes working with such symbols, known internally to @value{GDBN} as
21489 ``minimal symbols''.
21491 Note that before the debugged program has started execution, no DLLs
21492 will have been loaded. The easiest way around this problem is simply to
21493 start the program --- either by setting a breakpoint or letting the
21494 program run once to completion.
21496 @subsubsection DLL Name Prefixes
21498 In keeping with the naming conventions used by the Microsoft debugging
21499 tools, DLL export symbols are made available with a prefix based on the
21500 DLL name, for instance @code{KERNEL32!CreateFileA}. The plain name is
21501 also entered into the symbol table, so @code{CreateFileA} is often
21502 sufficient. In some cases there will be name clashes within a program
21503 (particularly if the executable itself includes full debugging symbols)
21504 necessitating the use of the fully qualified name when referring to the
21505 contents of the DLL. Use single-quotes around the name to avoid the
21506 exclamation mark (``!'') being interpreted as a language operator.
21508 Note that the internal name of the DLL may be all upper-case, even
21509 though the file name of the DLL is lower-case, or vice-versa. Since
21510 symbols within @value{GDBN} are @emph{case-sensitive} this may cause
21511 some confusion. If in doubt, try the @code{info functions} and
21512 @code{info variables} commands or even @code{maint print msymbols}
21513 (@pxref{Symbols}). Here's an example:
21516 (@value{GDBP}) info function CreateFileA
21517 All functions matching regular expression "CreateFileA":
21519 Non-debugging symbols:
21520 0x77e885f4 CreateFileA
21521 0x77e885f4 KERNEL32!CreateFileA
21525 (@value{GDBP}) info function !
21526 All functions matching regular expression "!":
21528 Non-debugging symbols:
21529 0x6100114c cygwin1!__assert
21530 0x61004034 cygwin1!_dll_crt0@@0
21531 0x61004240 cygwin1!dll_crt0(per_process *)
21535 @subsubsection Working with Minimal Symbols
21537 Symbols extracted from a DLL's export table do not contain very much
21538 type information. All that @value{GDBN} can do is guess whether a symbol
21539 refers to a function or variable depending on the linker section that
21540 contains the symbol. Also note that the actual contents of the memory
21541 contained in a DLL are not available unless the program is running. This
21542 means that you cannot examine the contents of a variable or disassemble
21543 a function within a DLL without a running program.
21545 Variables are generally treated as pointers and dereferenced
21546 automatically. For this reason, it is often necessary to prefix a
21547 variable name with the address-of operator (``&'') and provide explicit
21548 type information in the command. Here's an example of the type of
21552 (@value{GDBP}) print 'cygwin1!__argv'
21557 (@value{GDBP}) x 'cygwin1!__argv'
21558 0x10021610: "\230y\""
21561 And two possible solutions:
21564 (@value{GDBP}) print ((char **)'cygwin1!__argv')[0]
21565 $2 = 0x22fd98 "/cygdrive/c/mydirectory/myprogram"
21569 (@value{GDBP}) x/2x &'cygwin1!__argv'
21570 0x610c0aa8 <cygwin1!__argv>: 0x10021608 0x00000000
21571 (@value{GDBP}) x/x 0x10021608
21572 0x10021608: 0x0022fd98
21573 (@value{GDBP}) x/s 0x0022fd98
21574 0x22fd98: "/cygdrive/c/mydirectory/myprogram"
21577 Setting a break point within a DLL is possible even before the program
21578 starts execution. However, under these circumstances, @value{GDBN} can't
21579 examine the initial instructions of the function in order to skip the
21580 function's frame set-up code. You can work around this by using ``*&''
21581 to set the breakpoint at a raw memory address:
21584 (@value{GDBP}) break *&'python22!PyOS_Readline'
21585 Breakpoint 1 at 0x1e04eff0
21588 The author of these extensions is not entirely convinced that setting a
21589 break point within a shared DLL like @file{kernel32.dll} is completely
21593 @subsection Commands Specific to @sc{gnu} Hurd Systems
21594 @cindex @sc{gnu} Hurd debugging
21596 This subsection describes @value{GDBN} commands specific to the
21597 @sc{gnu} Hurd native debugging.
21602 @kindex set signals@r{, Hurd command}
21603 @kindex set sigs@r{, Hurd command}
21604 This command toggles the state of inferior signal interception by
21605 @value{GDBN}. Mach exceptions, such as breakpoint traps, are not
21606 affected by this command. @code{sigs} is a shorthand alias for
21611 @kindex show signals@r{, Hurd command}
21612 @kindex show sigs@r{, Hurd command}
21613 Show the current state of intercepting inferior's signals.
21615 @item set signal-thread
21616 @itemx set sigthread
21617 @kindex set signal-thread
21618 @kindex set sigthread
21619 This command tells @value{GDBN} which thread is the @code{libc} signal
21620 thread. That thread is run when a signal is delivered to a running
21621 process. @code{set sigthread} is the shorthand alias of @code{set
21624 @item show signal-thread
21625 @itemx show sigthread
21626 @kindex show signal-thread
21627 @kindex show sigthread
21628 These two commands show which thread will run when the inferior is
21629 delivered a signal.
21632 @kindex set stopped@r{, Hurd command}
21633 This commands tells @value{GDBN} that the inferior process is stopped,
21634 as with the @code{SIGSTOP} signal. The stopped process can be
21635 continued by delivering a signal to it.
21638 @kindex show stopped@r{, Hurd command}
21639 This command shows whether @value{GDBN} thinks the debuggee is
21642 @item set exceptions
21643 @kindex set exceptions@r{, Hurd command}
21644 Use this command to turn off trapping of exceptions in the inferior.
21645 When exception trapping is off, neither breakpoints nor
21646 single-stepping will work. To restore the default, set exception
21649 @item show exceptions
21650 @kindex show exceptions@r{, Hurd command}
21651 Show the current state of trapping exceptions in the inferior.
21653 @item set task pause
21654 @kindex set task@r{, Hurd commands}
21655 @cindex task attributes (@sc{gnu} Hurd)
21656 @cindex pause current task (@sc{gnu} Hurd)
21657 This command toggles task suspension when @value{GDBN} has control.
21658 Setting it to on takes effect immediately, and the task is suspended
21659 whenever @value{GDBN} gets control. Setting it to off will take
21660 effect the next time the inferior is continued. If this option is set
21661 to off, you can use @code{set thread default pause on} or @code{set
21662 thread pause on} (see below) to pause individual threads.
21664 @item show task pause
21665 @kindex show task@r{, Hurd commands}
21666 Show the current state of task suspension.
21668 @item set task detach-suspend-count
21669 @cindex task suspend count
21670 @cindex detach from task, @sc{gnu} Hurd
21671 This command sets the suspend count the task will be left with when
21672 @value{GDBN} detaches from it.
21674 @item show task detach-suspend-count
21675 Show the suspend count the task will be left with when detaching.
21677 @item set task exception-port
21678 @itemx set task excp
21679 @cindex task exception port, @sc{gnu} Hurd
21680 This command sets the task exception port to which @value{GDBN} will
21681 forward exceptions. The argument should be the value of the @dfn{send
21682 rights} of the task. @code{set task excp} is a shorthand alias.
21684 @item set noninvasive
21685 @cindex noninvasive task options
21686 This command switches @value{GDBN} to a mode that is the least
21687 invasive as far as interfering with the inferior is concerned. This
21688 is the same as using @code{set task pause}, @code{set exceptions}, and
21689 @code{set signals} to values opposite to the defaults.
21691 @item info send-rights
21692 @itemx info receive-rights
21693 @itemx info port-rights
21694 @itemx info port-sets
21695 @itemx info dead-names
21698 @cindex send rights, @sc{gnu} Hurd
21699 @cindex receive rights, @sc{gnu} Hurd
21700 @cindex port rights, @sc{gnu} Hurd
21701 @cindex port sets, @sc{gnu} Hurd
21702 @cindex dead names, @sc{gnu} Hurd
21703 These commands display information about, respectively, send rights,
21704 receive rights, port rights, port sets, and dead names of a task.
21705 There are also shorthand aliases: @code{info ports} for @code{info
21706 port-rights} and @code{info psets} for @code{info port-sets}.
21708 @item set thread pause
21709 @kindex set thread@r{, Hurd command}
21710 @cindex thread properties, @sc{gnu} Hurd
21711 @cindex pause current thread (@sc{gnu} Hurd)
21712 This command toggles current thread suspension when @value{GDBN} has
21713 control. Setting it to on takes effect immediately, and the current
21714 thread is suspended whenever @value{GDBN} gets control. Setting it to
21715 off will take effect the next time the inferior is continued.
21716 Normally, this command has no effect, since when @value{GDBN} has
21717 control, the whole task is suspended. However, if you used @code{set
21718 task pause off} (see above), this command comes in handy to suspend
21719 only the current thread.
21721 @item show thread pause
21722 @kindex show thread@r{, Hurd command}
21723 This command shows the state of current thread suspension.
21725 @item set thread run
21726 This command sets whether the current thread is allowed to run.
21728 @item show thread run
21729 Show whether the current thread is allowed to run.
21731 @item set thread detach-suspend-count
21732 @cindex thread suspend count, @sc{gnu} Hurd
21733 @cindex detach from thread, @sc{gnu} Hurd
21734 This command sets the suspend count @value{GDBN} will leave on a
21735 thread when detaching. This number is relative to the suspend count
21736 found by @value{GDBN} when it notices the thread; use @code{set thread
21737 takeover-suspend-count} to force it to an absolute value.
21739 @item show thread detach-suspend-count
21740 Show the suspend count @value{GDBN} will leave on the thread when
21743 @item set thread exception-port
21744 @itemx set thread excp
21745 Set the thread exception port to which to forward exceptions. This
21746 overrides the port set by @code{set task exception-port} (see above).
21747 @code{set thread excp} is the shorthand alias.
21749 @item set thread takeover-suspend-count
21750 Normally, @value{GDBN}'s thread suspend counts are relative to the
21751 value @value{GDBN} finds when it notices each thread. This command
21752 changes the suspend counts to be absolute instead.
21754 @item set thread default
21755 @itemx show thread default
21756 @cindex thread default settings, @sc{gnu} Hurd
21757 Each of the above @code{set thread} commands has a @code{set thread
21758 default} counterpart (e.g., @code{set thread default pause}, @code{set
21759 thread default exception-port}, etc.). The @code{thread default}
21760 variety of commands sets the default thread properties for all
21761 threads; you can then change the properties of individual threads with
21762 the non-default commands.
21769 @value{GDBN} provides the following commands specific to the Darwin target:
21772 @item set debug darwin @var{num}
21773 @kindex set debug darwin
21774 When set to a non zero value, enables debugging messages specific to
21775 the Darwin support. Higher values produce more verbose output.
21777 @item show debug darwin
21778 @kindex show debug darwin
21779 Show the current state of Darwin messages.
21781 @item set debug mach-o @var{num}
21782 @kindex set debug mach-o
21783 When set to a non zero value, enables debugging messages while
21784 @value{GDBN} is reading Darwin object files. (@dfn{Mach-O} is the
21785 file format used on Darwin for object and executable files.) Higher
21786 values produce more verbose output. This is a command to diagnose
21787 problems internal to @value{GDBN} and should not be needed in normal
21790 @item show debug mach-o
21791 @kindex show debug mach-o
21792 Show the current state of Mach-O file messages.
21794 @item set mach-exceptions on
21795 @itemx set mach-exceptions off
21796 @kindex set mach-exceptions
21797 On Darwin, faults are first reported as a Mach exception and are then
21798 mapped to a Posix signal. Use this command to turn on trapping of
21799 Mach exceptions in the inferior. This might be sometimes useful to
21800 better understand the cause of a fault. The default is off.
21802 @item show mach-exceptions
21803 @kindex show mach-exceptions
21804 Show the current state of exceptions trapping.
21809 @section Embedded Operating Systems
21811 This section describes configurations involving the debugging of
21812 embedded operating systems that are available for several different
21815 @value{GDBN} includes the ability to debug programs running on
21816 various real-time operating systems.
21818 @node Embedded Processors
21819 @section Embedded Processors
21821 This section goes into details specific to particular embedded
21824 @cindex send command to simulator
21825 Whenever a specific embedded processor has a simulator, @value{GDBN}
21826 allows to send an arbitrary command to the simulator.
21829 @item sim @var{command}
21830 @kindex sim@r{, a command}
21831 Send an arbitrary @var{command} string to the simulator. Consult the
21832 documentation for the specific simulator in use for information about
21833 acceptable commands.
21839 * M32R/SDI:: Renesas M32R/SDI
21840 * M68K:: Motorola M68K
21841 * MicroBlaze:: Xilinx MicroBlaze
21842 * MIPS Embedded:: MIPS Embedded
21843 * PowerPC Embedded:: PowerPC Embedded
21846 * Super-H:: Renesas Super-H
21852 @value{GDBN} provides the following ARM-specific commands:
21855 @item set arm disassembler
21857 This commands selects from a list of disassembly styles. The
21858 @code{"std"} style is the standard style.
21860 @item show arm disassembler
21862 Show the current disassembly style.
21864 @item set arm apcs32
21865 @cindex ARM 32-bit mode
21866 This command toggles ARM operation mode between 32-bit and 26-bit.
21868 @item show arm apcs32
21869 Display the current usage of the ARM 32-bit mode.
21871 @item set arm fpu @var{fputype}
21872 This command sets the ARM floating-point unit (FPU) type. The
21873 argument @var{fputype} can be one of these:
21877 Determine the FPU type by querying the OS ABI.
21879 Software FPU, with mixed-endian doubles on little-endian ARM
21882 GCC-compiled FPA co-processor.
21884 Software FPU with pure-endian doubles.
21890 Show the current type of the FPU.
21893 This command forces @value{GDBN} to use the specified ABI.
21896 Show the currently used ABI.
21898 @item set arm fallback-mode (arm|thumb|auto)
21899 @value{GDBN} uses the symbol table, when available, to determine
21900 whether instructions are ARM or Thumb. This command controls
21901 @value{GDBN}'s default behavior when the symbol table is not
21902 available. The default is @samp{auto}, which causes @value{GDBN} to
21903 use the current execution mode (from the @code{T} bit in the @code{CPSR}
21906 @item show arm fallback-mode
21907 Show the current fallback instruction mode.
21909 @item set arm force-mode (arm|thumb|auto)
21910 This command overrides use of the symbol table to determine whether
21911 instructions are ARM or Thumb. The default is @samp{auto}, which
21912 causes @value{GDBN} to use the symbol table and then the setting
21913 of @samp{set arm fallback-mode}.
21915 @item show arm force-mode
21916 Show the current forced instruction mode.
21918 @item set debug arm
21919 Toggle whether to display ARM-specific debugging messages from the ARM
21920 target support subsystem.
21922 @item show debug arm
21923 Show whether ARM-specific debugging messages are enabled.
21927 @item target sim @r{[}@var{simargs}@r{]} @dots{}
21928 The @value{GDBN} ARM simulator accepts the following optional arguments.
21931 @item --swi-support=@var{type}
21932 Tell the simulator which SWI interfaces to support. The argument
21933 @var{type} may be a comma separated list of the following values.
21934 The default value is @code{all}.
21947 @subsection Renesas M32R/SDI
21949 The following commands are available for M32R/SDI:
21954 @cindex reset SDI connection, M32R
21955 This command resets the SDI connection.
21959 This command shows the SDI connection status.
21962 @kindex debug_chaos
21963 @cindex M32R/Chaos debugging
21964 Instructs the remote that M32R/Chaos debugging is to be used.
21966 @item use_debug_dma
21967 @kindex use_debug_dma
21968 Instructs the remote to use the DEBUG_DMA method of accessing memory.
21971 @kindex use_mon_code
21972 Instructs the remote to use the MON_CODE method of accessing memory.
21975 @kindex use_ib_break
21976 Instructs the remote to set breakpoints by IB break.
21978 @item use_dbt_break
21979 @kindex use_dbt_break
21980 Instructs the remote to set breakpoints by DBT.
21986 The Motorola m68k configuration includes ColdFire support.
21989 @subsection MicroBlaze
21990 @cindex Xilinx MicroBlaze
21991 @cindex XMD, Xilinx Microprocessor Debugger
21993 The MicroBlaze is a soft-core processor supported on various Xilinx
21994 FPGAs, such as Spartan or Virtex series. Boards with these processors
21995 usually have JTAG ports which connect to a host system running the Xilinx
21996 Embedded Development Kit (EDK) or Software Development Kit (SDK).
21997 This host system is used to download the configuration bitstream to
21998 the target FPGA. The Xilinx Microprocessor Debugger (XMD) program
21999 communicates with the target board using the JTAG interface and
22000 presents a @code{gdbserver} interface to the board. By default
22001 @code{xmd} uses port @code{1234}. (While it is possible to change
22002 this default port, it requires the use of undocumented @code{xmd}
22003 commands. Contact Xilinx support if you need to do this.)
22005 Use these GDB commands to connect to the MicroBlaze target processor.
22008 @item target remote :1234
22009 Use this command to connect to the target if you are running @value{GDBN}
22010 on the same system as @code{xmd}.
22012 @item target remote @var{xmd-host}:1234
22013 Use this command to connect to the target if it is connected to @code{xmd}
22014 running on a different system named @var{xmd-host}.
22017 Use this command to download a program to the MicroBlaze target.
22019 @item set debug microblaze @var{n}
22020 Enable MicroBlaze-specific debugging messages if non-zero.
22022 @item show debug microblaze @var{n}
22023 Show MicroBlaze-specific debugging level.
22026 @node MIPS Embedded
22027 @subsection @acronym{MIPS} Embedded
22029 @cindex @acronym{MIPS} boards
22030 @value{GDBN} can use the @acronym{MIPS} remote debugging protocol to talk to a
22031 @acronym{MIPS} board attached to a serial line. This is available when
22032 you configure @value{GDBN} with @samp{--target=mips-elf}.
22035 Use these @value{GDBN} commands to specify the connection to your target board:
22038 @item target mips @var{port}
22039 @kindex target mips @var{port}
22040 To run a program on the board, start up @code{@value{GDBP}} with the
22041 name of your program as the argument. To connect to the board, use the
22042 command @samp{target mips @var{port}}, where @var{port} is the name of
22043 the serial port connected to the board. If the program has not already
22044 been downloaded to the board, you may use the @code{load} command to
22045 download it. You can then use all the usual @value{GDBN} commands.
22047 For example, this sequence connects to the target board through a serial
22048 port, and loads and runs a program called @var{prog} through the
22052 host$ @value{GDBP} @var{prog}
22053 @value{GDBN} is free software and @dots{}
22054 (@value{GDBP}) target mips /dev/ttyb
22055 (@value{GDBP}) load @var{prog}
22059 @item target mips @var{hostname}:@var{portnumber}
22060 On some @value{GDBN} host configurations, you can specify a TCP
22061 connection (for instance, to a serial line managed by a terminal
22062 concentrator) instead of a serial port, using the syntax
22063 @samp{@var{hostname}:@var{portnumber}}.
22065 @item target pmon @var{port}
22066 @kindex target pmon @var{port}
22069 @item target ddb @var{port}
22070 @kindex target ddb @var{port}
22071 NEC's DDB variant of PMON for Vr4300.
22073 @item target lsi @var{port}
22074 @kindex target lsi @var{port}
22075 LSI variant of PMON.
22081 @value{GDBN} also supports these special commands for @acronym{MIPS} targets:
22084 @item set mipsfpu double
22085 @itemx set mipsfpu single
22086 @itemx set mipsfpu none
22087 @itemx set mipsfpu auto
22088 @itemx show mipsfpu
22089 @kindex set mipsfpu
22090 @kindex show mipsfpu
22091 @cindex @acronym{MIPS} remote floating point
22092 @cindex floating point, @acronym{MIPS} remote
22093 If your target board does not support the @acronym{MIPS} floating point
22094 coprocessor, you should use the command @samp{set mipsfpu none} (if you
22095 need this, you may wish to put the command in your @value{GDBN} init
22096 file). This tells @value{GDBN} how to find the return value of
22097 functions which return floating point values. It also allows
22098 @value{GDBN} to avoid saving the floating point registers when calling
22099 functions on the board. If you are using a floating point coprocessor
22100 with only single precision floating point support, as on the @sc{r4650}
22101 processor, use the command @samp{set mipsfpu single}. The default
22102 double precision floating point coprocessor may be selected using
22103 @samp{set mipsfpu double}.
22105 In previous versions the only choices were double precision or no
22106 floating point, so @samp{set mipsfpu on} will select double precision
22107 and @samp{set mipsfpu off} will select no floating point.
22109 As usual, you can inquire about the @code{mipsfpu} variable with
22110 @samp{show mipsfpu}.
22112 @item set timeout @var{seconds}
22113 @itemx set retransmit-timeout @var{seconds}
22114 @itemx show timeout
22115 @itemx show retransmit-timeout
22116 @cindex @code{timeout}, @acronym{MIPS} protocol
22117 @cindex @code{retransmit-timeout}, @acronym{MIPS} protocol
22118 @kindex set timeout
22119 @kindex show timeout
22120 @kindex set retransmit-timeout
22121 @kindex show retransmit-timeout
22122 You can control the timeout used while waiting for a packet, in the @acronym{MIPS}
22123 remote protocol, with the @code{set timeout @var{seconds}} command. The
22124 default is 5 seconds. Similarly, you can control the timeout used while
22125 waiting for an acknowledgment of a packet with the @code{set
22126 retransmit-timeout @var{seconds}} command. The default is 3 seconds.
22127 You can inspect both values with @code{show timeout} and @code{show
22128 retransmit-timeout}. (These commands are @emph{only} available when
22129 @value{GDBN} is configured for @samp{--target=mips-elf}.)
22131 The timeout set by @code{set timeout} does not apply when @value{GDBN}
22132 is waiting for your program to stop. In that case, @value{GDBN} waits
22133 forever because it has no way of knowing how long the program is going
22134 to run before stopping.
22136 @item set syn-garbage-limit @var{num}
22137 @kindex set syn-garbage-limit@r{, @acronym{MIPS} remote}
22138 @cindex synchronize with remote @acronym{MIPS} target
22139 Limit the maximum number of characters @value{GDBN} should ignore when
22140 it tries to synchronize with the remote target. The default is 10
22141 characters. Setting the limit to -1 means there's no limit.
22143 @item show syn-garbage-limit
22144 @kindex show syn-garbage-limit@r{, @acronym{MIPS} remote}
22145 Show the current limit on the number of characters to ignore when
22146 trying to synchronize with the remote system.
22148 @item set monitor-prompt @var{prompt}
22149 @kindex set monitor-prompt@r{, @acronym{MIPS} remote}
22150 @cindex remote monitor prompt
22151 Tell @value{GDBN} to expect the specified @var{prompt} string from the
22152 remote monitor. The default depends on the target:
22162 @item show monitor-prompt
22163 @kindex show monitor-prompt@r{, @acronym{MIPS} remote}
22164 Show the current strings @value{GDBN} expects as the prompt from the
22167 @item set monitor-warnings
22168 @kindex set monitor-warnings@r{, @acronym{MIPS} remote}
22169 Enable or disable monitor warnings about hardware breakpoints. This
22170 has effect only for the @code{lsi} target. When on, @value{GDBN} will
22171 display warning messages whose codes are returned by the @code{lsi}
22172 PMON monitor for breakpoint commands.
22174 @item show monitor-warnings
22175 @kindex show monitor-warnings@r{, @acronym{MIPS} remote}
22176 Show the current setting of printing monitor warnings.
22178 @item pmon @var{command}
22179 @kindex pmon@r{, @acronym{MIPS} remote}
22180 @cindex send PMON command
22181 This command allows sending an arbitrary @var{command} string to the
22182 monitor. The monitor must be in debug mode for this to work.
22185 @node PowerPC Embedded
22186 @subsection PowerPC Embedded
22188 @cindex DVC register
22189 @value{GDBN} supports using the DVC (Data Value Compare) register to
22190 implement in hardware simple hardware watchpoint conditions of the form:
22193 (@value{GDBP}) watch @var{ADDRESS|VARIABLE} \
22194 if @var{ADDRESS|VARIABLE} == @var{CONSTANT EXPRESSION}
22197 The DVC register will be automatically used when @value{GDBN} detects
22198 such pattern in a condition expression, and the created watchpoint uses one
22199 debug register (either the @code{exact-watchpoints} option is on and the
22200 variable is scalar, or the variable has a length of one byte). This feature
22201 is available in native @value{GDBN} running on a Linux kernel version 2.6.34
22204 When running on PowerPC embedded processors, @value{GDBN} automatically uses
22205 ranged hardware watchpoints, unless the @code{exact-watchpoints} option is on,
22206 in which case watchpoints using only one debug register are created when
22207 watching variables of scalar types.
22209 You can create an artificial array to watch an arbitrary memory
22210 region using one of the following commands (@pxref{Expressions}):
22213 (@value{GDBP}) watch *((char *) @var{address})@@@var{length}
22214 (@value{GDBP}) watch @{char[@var{length}]@} @var{address}
22217 PowerPC embedded processors support masked watchpoints. See the discussion
22218 about the @code{mask} argument in @ref{Set Watchpoints}.
22220 @cindex ranged breakpoint
22221 PowerPC embedded processors support hardware accelerated
22222 @dfn{ranged breakpoints}. A ranged breakpoint stops execution of
22223 the inferior whenever it executes an instruction at any address within
22224 the range it specifies. To set a ranged breakpoint in @value{GDBN},
22225 use the @code{break-range} command.
22227 @value{GDBN} provides the following PowerPC-specific commands:
22230 @kindex break-range
22231 @item break-range @var{start-location}, @var{end-location}
22232 Set a breakpoint for an address range given by
22233 @var{start-location} and @var{end-location}, which can specify a function name,
22234 a line number, an offset of lines from the current line or from the start
22235 location, or an address of an instruction (see @ref{Specify Location},
22236 for a list of all the possible ways to specify a @var{location}.)
22237 The breakpoint will stop execution of the inferior whenever it
22238 executes an instruction at any address within the specified range,
22239 (including @var{start-location} and @var{end-location}.)
22241 @kindex set powerpc
22242 @item set powerpc soft-float
22243 @itemx show powerpc soft-float
22244 Force @value{GDBN} to use (or not use) a software floating point calling
22245 convention. By default, @value{GDBN} selects the calling convention based
22246 on the selected architecture and the provided executable file.
22248 @item set powerpc vector-abi
22249 @itemx show powerpc vector-abi
22250 Force @value{GDBN} to use the specified calling convention for vector
22251 arguments and return values. The valid options are @samp{auto};
22252 @samp{generic}, to avoid vector registers even if they are present;
22253 @samp{altivec}, to use AltiVec registers; and @samp{spe} to use SPE
22254 registers. By default, @value{GDBN} selects the calling convention
22255 based on the selected architecture and the provided executable file.
22257 @item set powerpc exact-watchpoints
22258 @itemx show powerpc exact-watchpoints
22259 Allow @value{GDBN} to use only one debug register when watching a variable
22260 of scalar type, thus assuming that the variable is accessed through the
22261 address of its first byte.
22266 @subsection Atmel AVR
22269 When configured for debugging the Atmel AVR, @value{GDBN} supports the
22270 following AVR-specific commands:
22273 @item info io_registers
22274 @kindex info io_registers@r{, AVR}
22275 @cindex I/O registers (Atmel AVR)
22276 This command displays information about the AVR I/O registers. For
22277 each register, @value{GDBN} prints its number and value.
22284 When configured for debugging CRIS, @value{GDBN} provides the
22285 following CRIS-specific commands:
22288 @item set cris-version @var{ver}
22289 @cindex CRIS version
22290 Set the current CRIS version to @var{ver}, either @samp{10} or @samp{32}.
22291 The CRIS version affects register names and sizes. This command is useful in
22292 case autodetection of the CRIS version fails.
22294 @item show cris-version
22295 Show the current CRIS version.
22297 @item set cris-dwarf2-cfi
22298 @cindex DWARF-2 CFI and CRIS
22299 Set the usage of DWARF-2 CFI for CRIS debugging. The default is @samp{on}.
22300 Change to @samp{off} when using @code{gcc-cris} whose version is below
22303 @item show cris-dwarf2-cfi
22304 Show the current state of using DWARF-2 CFI.
22306 @item set cris-mode @var{mode}
22308 Set the current CRIS mode to @var{mode}. It should only be changed when
22309 debugging in guru mode, in which case it should be set to
22310 @samp{guru} (the default is @samp{normal}).
22312 @item show cris-mode
22313 Show the current CRIS mode.
22317 @subsection Renesas Super-H
22320 For the Renesas Super-H processor, @value{GDBN} provides these
22324 @item set sh calling-convention @var{convention}
22325 @kindex set sh calling-convention
22326 Set the calling-convention used when calling functions from @value{GDBN}.
22327 Allowed values are @samp{gcc}, which is the default setting, and @samp{renesas}.
22328 With the @samp{gcc} setting, functions are called using the @value{NGCC} calling
22329 convention. If the DWARF-2 information of the called function specifies
22330 that the function follows the Renesas calling convention, the function
22331 is called using the Renesas calling convention. If the calling convention
22332 is set to @samp{renesas}, the Renesas calling convention is always used,
22333 regardless of the DWARF-2 information. This can be used to override the
22334 default of @samp{gcc} if debug information is missing, or the compiler
22335 does not emit the DWARF-2 calling convention entry for a function.
22337 @item show sh calling-convention
22338 @kindex show sh calling-convention
22339 Show the current calling convention setting.
22344 @node Architectures
22345 @section Architectures
22347 This section describes characteristics of architectures that affect
22348 all uses of @value{GDBN} with the architecture, both native and cross.
22355 * HPPA:: HP PA architecture
22356 * SPU:: Cell Broadband Engine SPU architecture
22362 @subsection AArch64
22363 @cindex AArch64 support
22365 When @value{GDBN} is debugging the AArch64 architecture, it provides the
22366 following special commands:
22369 @item set debug aarch64
22370 @kindex set debug aarch64
22371 This command determines whether AArch64 architecture-specific debugging
22372 messages are to be displayed.
22374 @item show debug aarch64
22375 Show whether AArch64 debugging messages are displayed.
22380 @subsection x86 Architecture-specific Issues
22383 @item set struct-convention @var{mode}
22384 @kindex set struct-convention
22385 @cindex struct return convention
22386 @cindex struct/union returned in registers
22387 Set the convention used by the inferior to return @code{struct}s and
22388 @code{union}s from functions to @var{mode}. Possible values of
22389 @var{mode} are @code{"pcc"}, @code{"reg"}, and @code{"default"} (the
22390 default). @code{"default"} or @code{"pcc"} means that @code{struct}s
22391 are returned on the stack, while @code{"reg"} means that a
22392 @code{struct} or a @code{union} whose size is 1, 2, 4, or 8 bytes will
22393 be returned in a register.
22395 @item show struct-convention
22396 @kindex show struct-convention
22397 Show the current setting of the convention to return @code{struct}s
22402 @subsubsection Intel @dfn{Memory Protection Extensions} (MPX).
22403 @cindex Intel Memory Protection Extensions (MPX).
22405 Memory Protection Extension (MPX) adds the bound registers @samp{BND0}
22406 @footnote{The register named with capital letters represent the architecture
22407 registers.} through @samp{BND3}. Bound registers store a pair of 64-bit values
22408 which are the lower bound and upper bound. Bounds are effective addresses or
22409 memory locations. The upper bounds are architecturally represented in 1's
22410 complement form. A bound having lower bound = 0, and upper bound = 0
22411 (1's complement of all bits set) will allow access to the entire address space.
22413 @samp{BND0} through @samp{BND3} are represented in @value{GDBN} as @samp{bnd0raw}
22414 through @samp{bnd3raw}. Pseudo registers @samp{bnd0} through @samp{bnd3}
22415 display the upper bound performing the complement of one operation on the
22416 upper bound value, i.e.@ when upper bound in @samp{bnd0raw} is 0 in the
22417 @value{GDBN} @samp{bnd0} it will be @code{0xfff@dots{}}. In this sense it
22418 can also be noted that the upper bounds are inclusive.
22420 As an example, assume that the register BND0 holds bounds for a pointer having
22421 access allowed for the range between 0x32 and 0x71. The values present on
22422 bnd0raw and bnd registers are presented as follows:
22425 bnd0raw = @{0x32, 0xffffffff8e@}
22426 bnd0 = @{lbound = 0x32, ubound = 0x71@} : size 64
22429 This way the raw value can be accessed via bnd0raw@dots{}bnd3raw. Any
22430 change on bnd0@dots{}bnd3 or bnd0raw@dots{}bnd3raw is reflect on its
22431 counterpart. When the bnd0@dots{}bnd3 registers are displayed via
22432 Python, the display includes the memory size, in bits, accessible to
22435 Bounds can also be stored in bounds tables, which are stored in
22436 application memory. These tables store bounds for pointers by specifying
22437 the bounds pointer's value along with its bounds. Evaluating and changing
22438 bounds located in bound tables is therefore interesting while investigating
22439 bugs on MPX context. @value{GDBN} provides commands for this purpose:
22442 @item show mpx bound @var{pointer}
22443 @kindex show mpx bound
22444 Display bounds of the given @var{pointer}.
22446 @item set mpx bound @var{pointer}, @var{lbound}, @var{ubound}
22447 @kindex set mpx bound
22448 Set the bounds of a pointer in the bound table.
22449 This command takes three parameters: @var{pointer} is the pointers
22450 whose bounds are to be changed, @var{lbound} and @var{ubound} are new values
22451 for lower and upper bounds respectively.
22457 See the following section.
22460 @subsection @acronym{MIPS}
22462 @cindex stack on Alpha
22463 @cindex stack on @acronym{MIPS}
22464 @cindex Alpha stack
22465 @cindex @acronym{MIPS} stack
22466 Alpha- and @acronym{MIPS}-based computers use an unusual stack frame, which
22467 sometimes requires @value{GDBN} to search backward in the object code to
22468 find the beginning of a function.
22470 @cindex response time, @acronym{MIPS} debugging
22471 To improve response time (especially for embedded applications, where
22472 @value{GDBN} may be restricted to a slow serial line for this search)
22473 you may want to limit the size of this search, using one of these
22477 @cindex @code{heuristic-fence-post} (Alpha, @acronym{MIPS})
22478 @item set heuristic-fence-post @var{limit}
22479 Restrict @value{GDBN} to examining at most @var{limit} bytes in its
22480 search for the beginning of a function. A value of @var{0} (the
22481 default) means there is no limit. However, except for @var{0}, the
22482 larger the limit the more bytes @code{heuristic-fence-post} must search
22483 and therefore the longer it takes to run. You should only need to use
22484 this command when debugging a stripped executable.
22486 @item show heuristic-fence-post
22487 Display the current limit.
22491 These commands are available @emph{only} when @value{GDBN} is configured
22492 for debugging programs on Alpha or @acronym{MIPS} processors.
22494 Several @acronym{MIPS}-specific commands are available when debugging @acronym{MIPS}
22498 @item set mips abi @var{arg}
22499 @kindex set mips abi
22500 @cindex set ABI for @acronym{MIPS}
22501 Tell @value{GDBN} which @acronym{MIPS} ABI is used by the inferior. Possible
22502 values of @var{arg} are:
22506 The default ABI associated with the current binary (this is the
22516 @item show mips abi
22517 @kindex show mips abi
22518 Show the @acronym{MIPS} ABI used by @value{GDBN} to debug the inferior.
22520 @item set mips compression @var{arg}
22521 @kindex set mips compression
22522 @cindex code compression, @acronym{MIPS}
22523 Tell @value{GDBN} which @acronym{MIPS} compressed
22524 @acronym{ISA, Instruction Set Architecture} encoding is used by the
22525 inferior. @value{GDBN} uses this for code disassembly and other
22526 internal interpretation purposes. This setting is only referred to
22527 when no executable has been associated with the debugging session or
22528 the executable does not provide information about the encoding it uses.
22529 Otherwise this setting is automatically updated from information
22530 provided by the executable.
22532 Possible values of @var{arg} are @samp{mips16} and @samp{micromips}.
22533 The default compressed @acronym{ISA} encoding is @samp{mips16}, as
22534 executables containing @acronym{MIPS16} code frequently are not
22535 identified as such.
22537 This setting is ``sticky''; that is, it retains its value across
22538 debugging sessions until reset either explicitly with this command or
22539 implicitly from an executable.
22541 The compiler and/or assembler typically add symbol table annotations to
22542 identify functions compiled for the @acronym{MIPS16} or
22543 @acronym{microMIPS} @acronym{ISA}s. If these function-scope annotations
22544 are present, @value{GDBN} uses them in preference to the global
22545 compressed @acronym{ISA} encoding setting.
22547 @item show mips compression
22548 @kindex show mips compression
22549 Show the @acronym{MIPS} compressed @acronym{ISA} encoding used by
22550 @value{GDBN} to debug the inferior.
22553 @itemx show mipsfpu
22554 @xref{MIPS Embedded, set mipsfpu}.
22556 @item set mips mask-address @var{arg}
22557 @kindex set mips mask-address
22558 @cindex @acronym{MIPS} addresses, masking
22559 This command determines whether the most-significant 32 bits of 64-bit
22560 @acronym{MIPS} addresses are masked off. The argument @var{arg} can be
22561 @samp{on}, @samp{off}, or @samp{auto}. The latter is the default
22562 setting, which lets @value{GDBN} determine the correct value.
22564 @item show mips mask-address
22565 @kindex show mips mask-address
22566 Show whether the upper 32 bits of @acronym{MIPS} addresses are masked off or
22569 @item set remote-mips64-transfers-32bit-regs
22570 @kindex set remote-mips64-transfers-32bit-regs
22571 This command controls compatibility with 64-bit @acronym{MIPS} targets that
22572 transfer data in 32-bit quantities. If you have an old @acronym{MIPS} 64 target
22573 that transfers 32 bits for some registers, like @sc{sr} and @sc{fsr},
22574 and 64 bits for other registers, set this option to @samp{on}.
22576 @item show remote-mips64-transfers-32bit-regs
22577 @kindex show remote-mips64-transfers-32bit-regs
22578 Show the current setting of compatibility with older @acronym{MIPS} 64 targets.
22580 @item set debug mips
22581 @kindex set debug mips
22582 This command turns on and off debugging messages for the @acronym{MIPS}-specific
22583 target code in @value{GDBN}.
22585 @item show debug mips
22586 @kindex show debug mips
22587 Show the current setting of @acronym{MIPS} debugging messages.
22593 @cindex HPPA support
22595 When @value{GDBN} is debugging the HP PA architecture, it provides the
22596 following special commands:
22599 @item set debug hppa
22600 @kindex set debug hppa
22601 This command determines whether HPPA architecture-specific debugging
22602 messages are to be displayed.
22604 @item show debug hppa
22605 Show whether HPPA debugging messages are displayed.
22607 @item maint print unwind @var{address}
22608 @kindex maint print unwind@r{, HPPA}
22609 This command displays the contents of the unwind table entry at the
22610 given @var{address}.
22616 @subsection Cell Broadband Engine SPU architecture
22617 @cindex Cell Broadband Engine
22620 When @value{GDBN} is debugging the Cell Broadband Engine SPU architecture,
22621 it provides the following special commands:
22624 @item info spu event
22626 Display SPU event facility status. Shows current event mask
22627 and pending event status.
22629 @item info spu signal
22630 Display SPU signal notification facility status. Shows pending
22631 signal-control word and signal notification mode of both signal
22632 notification channels.
22634 @item info spu mailbox
22635 Display SPU mailbox facility status. Shows all pending entries,
22636 in order of processing, in each of the SPU Write Outbound,
22637 SPU Write Outbound Interrupt, and SPU Read Inbound mailboxes.
22640 Display MFC DMA status. Shows all pending commands in the MFC
22641 DMA queue. For each entry, opcode, tag, class IDs, effective
22642 and local store addresses and transfer size are shown.
22644 @item info spu proxydma
22645 Display MFC Proxy-DMA status. Shows all pending commands in the MFC
22646 Proxy-DMA queue. For each entry, opcode, tag, class IDs, effective
22647 and local store addresses and transfer size are shown.
22651 When @value{GDBN} is debugging a combined PowerPC/SPU application
22652 on the Cell Broadband Engine, it provides in addition the following
22656 @item set spu stop-on-load @var{arg}
22658 Set whether to stop for new SPE threads. When set to @code{on}, @value{GDBN}
22659 will give control to the user when a new SPE thread enters its @code{main}
22660 function. The default is @code{off}.
22662 @item show spu stop-on-load
22664 Show whether to stop for new SPE threads.
22666 @item set spu auto-flush-cache @var{arg}
22667 Set whether to automatically flush the software-managed cache. When set to
22668 @code{on}, @value{GDBN} will automatically cause the SPE software-managed
22669 cache to be flushed whenever SPE execution stops. This provides a consistent
22670 view of PowerPC memory that is accessed via the cache. If an application
22671 does not use the software-managed cache, this option has no effect.
22673 @item show spu auto-flush-cache
22674 Show whether to automatically flush the software-managed cache.
22679 @subsection PowerPC
22680 @cindex PowerPC architecture
22682 When @value{GDBN} is debugging the PowerPC architecture, it provides a set of
22683 pseudo-registers to enable inspection of 128-bit wide Decimal Floating Point
22684 numbers stored in the floating point registers. These values must be stored
22685 in two consecutive registers, always starting at an even register like
22686 @code{f0} or @code{f2}.
22688 The pseudo-registers go from @code{$dl0} through @code{$dl15}, and are formed
22689 by joining the even/odd register pairs @code{f0} and @code{f1} for @code{$dl0},
22690 @code{f2} and @code{f3} for @code{$dl1} and so on.
22692 For POWER7 processors, @value{GDBN} provides a set of pseudo-registers, the 64-bit
22693 wide Extended Floating Point Registers (@samp{f32} through @samp{f63}).
22696 @subsection Nios II
22697 @cindex Nios II architecture
22699 When @value{GDBN} is debugging the Nios II architecture,
22700 it provides the following special commands:
22704 @item set debug nios2
22705 @kindex set debug nios2
22706 This command turns on and off debugging messages for the Nios II
22707 target code in @value{GDBN}.
22709 @item show debug nios2
22710 @kindex show debug nios2
22711 Show the current setting of Nios II debugging messages.
22714 @node Controlling GDB
22715 @chapter Controlling @value{GDBN}
22717 You can alter the way @value{GDBN} interacts with you by using the
22718 @code{set} command. For commands controlling how @value{GDBN} displays
22719 data, see @ref{Print Settings, ,Print Settings}. Other settings are
22724 * Editing:: Command editing
22725 * Command History:: Command history
22726 * Screen Size:: Screen size
22727 * Numbers:: Numbers
22728 * ABI:: Configuring the current ABI
22729 * Auto-loading:: Automatically loading associated files
22730 * Messages/Warnings:: Optional warnings and messages
22731 * Debugging Output:: Optional messages about internal happenings
22732 * Other Misc Settings:: Other Miscellaneous Settings
22740 @value{GDBN} indicates its readiness to read a command by printing a string
22741 called the @dfn{prompt}. This string is normally @samp{(@value{GDBP})}. You
22742 can change the prompt string with the @code{set prompt} command. For
22743 instance, when debugging @value{GDBN} with @value{GDBN}, it is useful to change
22744 the prompt in one of the @value{GDBN} sessions so that you can always tell
22745 which one you are talking to.
22747 @emph{Note:} @code{set prompt} does not add a space for you after the
22748 prompt you set. This allows you to set a prompt which ends in a space
22749 or a prompt that does not.
22753 @item set prompt @var{newprompt}
22754 Directs @value{GDBN} to use @var{newprompt} as its prompt string henceforth.
22756 @kindex show prompt
22758 Prints a line of the form: @samp{Gdb's prompt is: @var{your-prompt}}
22761 Versions of @value{GDBN} that ship with Python scripting enabled have
22762 prompt extensions. The commands for interacting with these extensions
22766 @kindex set extended-prompt
22767 @item set extended-prompt @var{prompt}
22768 Set an extended prompt that allows for substitutions.
22769 @xref{gdb.prompt}, for a list of escape sequences that can be used for
22770 substitution. Any escape sequences specified as part of the prompt
22771 string are replaced with the corresponding strings each time the prompt
22777 set extended-prompt Current working directory: \w (gdb)
22780 Note that when an extended-prompt is set, it takes control of the
22781 @var{prompt_hook} hook. @xref{prompt_hook}, for further information.
22783 @kindex show extended-prompt
22784 @item show extended-prompt
22785 Prints the extended prompt. Any escape sequences specified as part of
22786 the prompt string with @code{set extended-prompt}, are replaced with the
22787 corresponding strings each time the prompt is displayed.
22791 @section Command Editing
22793 @cindex command line editing
22795 @value{GDBN} reads its input commands via the @dfn{Readline} interface. This
22796 @sc{gnu} library provides consistent behavior for programs which provide a
22797 command line interface to the user. Advantages are @sc{gnu} Emacs-style
22798 or @dfn{vi}-style inline editing of commands, @code{csh}-like history
22799 substitution, and a storage and recall of command history across
22800 debugging sessions.
22802 You may control the behavior of command line editing in @value{GDBN} with the
22803 command @code{set}.
22806 @kindex set editing
22809 @itemx set editing on
22810 Enable command line editing (enabled by default).
22812 @item set editing off
22813 Disable command line editing.
22815 @kindex show editing
22817 Show whether command line editing is enabled.
22820 @ifset SYSTEM_READLINE
22821 @xref{Command Line Editing, , , rluserman, GNU Readline Library},
22823 @ifclear SYSTEM_READLINE
22824 @xref{Command Line Editing},
22826 for more details about the Readline
22827 interface. Users unfamiliar with @sc{gnu} Emacs or @code{vi} are
22828 encouraged to read that chapter.
22830 @node Command History
22831 @section Command History
22832 @cindex command history
22834 @value{GDBN} can keep track of the commands you type during your
22835 debugging sessions, so that you can be certain of precisely what
22836 happened. Use these commands to manage the @value{GDBN} command
22839 @value{GDBN} uses the @sc{gnu} History library, a part of the Readline
22840 package, to provide the history facility.
22841 @ifset SYSTEM_READLINE
22842 @xref{Using History Interactively, , , history, GNU History Library},
22844 @ifclear SYSTEM_READLINE
22845 @xref{Using History Interactively},
22847 for the detailed description of the History library.
22849 To issue a command to @value{GDBN} without affecting certain aspects of
22850 the state which is seen by users, prefix it with @samp{server }
22851 (@pxref{Server Prefix}). This
22852 means that this command will not affect the command history, nor will it
22853 affect @value{GDBN}'s notion of which command to repeat if @key{RET} is
22854 pressed on a line by itself.
22856 @cindex @code{server}, command prefix
22857 The server prefix does not affect the recording of values into the value
22858 history; to print a value without recording it into the value history,
22859 use the @code{output} command instead of the @code{print} command.
22861 Here is the description of @value{GDBN} commands related to command
22865 @cindex history substitution
22866 @cindex history file
22867 @kindex set history filename
22868 @cindex @env{GDBHISTFILE}, environment variable
22869 @item set history filename @var{fname}
22870 Set the name of the @value{GDBN} command history file to @var{fname}.
22871 This is the file where @value{GDBN} reads an initial command history
22872 list, and where it writes the command history from this session when it
22873 exits. You can access this list through history expansion or through
22874 the history command editing characters listed below. This file defaults
22875 to the value of the environment variable @code{GDBHISTFILE}, or to
22876 @file{./.gdb_history} (@file{./_gdb_history} on MS-DOS) if this variable
22879 @cindex save command history
22880 @kindex set history save
22881 @item set history save
22882 @itemx set history save on
22883 Record command history in a file, whose name may be specified with the
22884 @code{set history filename} command. By default, this option is disabled.
22886 @item set history save off
22887 Stop recording command history in a file.
22889 @cindex history size
22890 @kindex set history size
22891 @cindex @env{GDBHISTSIZE}, environment variable
22892 @item set history size @var{size}
22893 @itemx set history size unlimited
22894 Set the number of commands which @value{GDBN} keeps in its history list.
22895 This defaults to the value of the environment variable @env{GDBHISTSIZE}, or
22896 to 256 if this variable is not set. Non-numeric values of @env{GDBHISTSIZE}
22897 are ignored. If @var{size} is @code{unlimited} or if @env{GDBHISTSIZE} is
22898 either a negative number or the empty string, then the number of commands
22899 @value{GDBN} keeps in the history list is unlimited.
22901 @cindex remove duplicate history
22902 @kindex set history remove-duplicates
22903 @item set history remove-duplicates @var{count}
22904 @itemx set history remove-duplicates unlimited
22905 Control the removal of duplicate history entries in the command history list.
22906 If @var{count} is non-zero, @value{GDBN} will look back at the last @var{count}
22907 history entries and remove the first entry that is a duplicate of the current
22908 entry being added to the command history list. If @var{count} is
22909 @code{unlimited} then this lookbehind is unbounded. If @var{count} is 0, then
22910 removal of duplicate history entries is disabled.
22912 Only history entries added during the current session are considered for
22913 removal. This option is set to 0 by default.
22917 History expansion assigns special meaning to the character @kbd{!}.
22918 @ifset SYSTEM_READLINE
22919 @xref{Event Designators, , , history, GNU History Library},
22921 @ifclear SYSTEM_READLINE
22922 @xref{Event Designators},
22926 @cindex history expansion, turn on/off
22927 Since @kbd{!} is also the logical not operator in C, history expansion
22928 is off by default. If you decide to enable history expansion with the
22929 @code{set history expansion on} command, you may sometimes need to
22930 follow @kbd{!} (when it is used as logical not, in an expression) with
22931 a space or a tab to prevent it from being expanded. The readline
22932 history facilities do not attempt substitution on the strings
22933 @kbd{!=} and @kbd{!(}, even when history expansion is enabled.
22935 The commands to control history expansion are:
22938 @item set history expansion on
22939 @itemx set history expansion
22940 @kindex set history expansion
22941 Enable history expansion. History expansion is off by default.
22943 @item set history expansion off
22944 Disable history expansion.
22947 @kindex show history
22949 @itemx show history filename
22950 @itemx show history save
22951 @itemx show history size
22952 @itemx show history expansion
22953 These commands display the state of the @value{GDBN} history parameters.
22954 @code{show history} by itself displays all four states.
22959 @kindex show commands
22960 @cindex show last commands
22961 @cindex display command history
22962 @item show commands
22963 Display the last ten commands in the command history.
22965 @item show commands @var{n}
22966 Print ten commands centered on command number @var{n}.
22968 @item show commands +
22969 Print ten commands just after the commands last printed.
22973 @section Screen Size
22974 @cindex size of screen
22975 @cindex screen size
22978 @cindex pauses in output
22980 Certain commands to @value{GDBN} may produce large amounts of
22981 information output to the screen. To help you read all of it,
22982 @value{GDBN} pauses and asks you for input at the end of each page of
22983 output. Type @key{RET} when you want to continue the output, or @kbd{q}
22984 to discard the remaining output. Also, the screen width setting
22985 determines when to wrap lines of output. Depending on what is being
22986 printed, @value{GDBN} tries to break the line at a readable place,
22987 rather than simply letting it overflow onto the following line.
22989 Normally @value{GDBN} knows the size of the screen from the terminal
22990 driver software. For example, on Unix @value{GDBN} uses the termcap data base
22991 together with the value of the @code{TERM} environment variable and the
22992 @code{stty rows} and @code{stty cols} settings. If this is not correct,
22993 you can override it with the @code{set height} and @code{set
23000 @kindex show height
23001 @item set height @var{lpp}
23002 @itemx set height unlimited
23004 @itemx set width @var{cpl}
23005 @itemx set width unlimited
23007 These @code{set} commands specify a screen height of @var{lpp} lines and
23008 a screen width of @var{cpl} characters. The associated @code{show}
23009 commands display the current settings.
23011 If you specify a height of either @code{unlimited} or zero lines,
23012 @value{GDBN} does not pause during output no matter how long the
23013 output is. This is useful if output is to a file or to an editor
23016 Likewise, you can specify @samp{set width unlimited} or @samp{set
23017 width 0} to prevent @value{GDBN} from wrapping its output.
23019 @item set pagination on
23020 @itemx set pagination off
23021 @kindex set pagination
23022 Turn the output pagination on or off; the default is on. Turning
23023 pagination off is the alternative to @code{set height unlimited}. Note that
23024 running @value{GDBN} with the @option{--batch} option (@pxref{Mode
23025 Options, -batch}) also automatically disables pagination.
23027 @item show pagination
23028 @kindex show pagination
23029 Show the current pagination mode.
23034 @cindex number representation
23035 @cindex entering numbers
23037 You can always enter numbers in octal, decimal, or hexadecimal in
23038 @value{GDBN} by the usual conventions: octal numbers begin with
23039 @samp{0}, decimal numbers end with @samp{.}, and hexadecimal numbers
23040 begin with @samp{0x}. Numbers that neither begin with @samp{0} or
23041 @samp{0x}, nor end with a @samp{.} are, by default, entered in base
23042 10; likewise, the default display for numbers---when no particular
23043 format is specified---is base 10. You can change the default base for
23044 both input and output with the commands described below.
23047 @kindex set input-radix
23048 @item set input-radix @var{base}
23049 Set the default base for numeric input. Supported choices
23050 for @var{base} are decimal 8, 10, or 16. The base must itself be
23051 specified either unambiguously or using the current input radix; for
23055 set input-radix 012
23056 set input-radix 10.
23057 set input-radix 0xa
23061 sets the input base to decimal. On the other hand, @samp{set input-radix 10}
23062 leaves the input radix unchanged, no matter what it was, since
23063 @samp{10}, being without any leading or trailing signs of its base, is
23064 interpreted in the current radix. Thus, if the current radix is 16,
23065 @samp{10} is interpreted in hex, i.e.@: as 16 decimal, which doesn't
23068 @kindex set output-radix
23069 @item set output-radix @var{base}
23070 Set the default base for numeric display. Supported choices
23071 for @var{base} are decimal 8, 10, or 16. The base must itself be
23072 specified either unambiguously or using the current input radix.
23074 @kindex show input-radix
23075 @item show input-radix
23076 Display the current default base for numeric input.
23078 @kindex show output-radix
23079 @item show output-radix
23080 Display the current default base for numeric display.
23082 @item set radix @r{[}@var{base}@r{]}
23086 These commands set and show the default base for both input and output
23087 of numbers. @code{set radix} sets the radix of input and output to
23088 the same base; without an argument, it resets the radix back to its
23089 default value of 10.
23094 @section Configuring the Current ABI
23096 @value{GDBN} can determine the @dfn{ABI} (Application Binary Interface) of your
23097 application automatically. However, sometimes you need to override its
23098 conclusions. Use these commands to manage @value{GDBN}'s view of the
23104 @cindex Newlib OS ABI and its influence on the longjmp handling
23106 One @value{GDBN} configuration can debug binaries for multiple operating
23107 system targets, either via remote debugging or native emulation.
23108 @value{GDBN} will autodetect the @dfn{OS ABI} (Operating System ABI) in use,
23109 but you can override its conclusion using the @code{set osabi} command.
23110 One example where this is useful is in debugging of binaries which use
23111 an alternate C library (e.g.@: @sc{uClibc} for @sc{gnu}/Linux) which does
23112 not have the same identifying marks that the standard C library for your
23115 When @value{GDBN} is debugging the AArch64 architecture, it provides a
23116 ``Newlib'' OS ABI. This is useful for handling @code{setjmp} and
23117 @code{longjmp} when debugging binaries that use the @sc{newlib} C library.
23118 The ``Newlib'' OS ABI can be selected by @code{set osabi Newlib}.
23122 Show the OS ABI currently in use.
23125 With no argument, show the list of registered available OS ABI's.
23127 @item set osabi @var{abi}
23128 Set the current OS ABI to @var{abi}.
23131 @cindex float promotion
23133 Generally, the way that an argument of type @code{float} is passed to a
23134 function depends on whether the function is prototyped. For a prototyped
23135 (i.e.@: ANSI/ISO style) function, @code{float} arguments are passed unchanged,
23136 according to the architecture's convention for @code{float}. For unprototyped
23137 (i.e.@: K&R style) functions, @code{float} arguments are first promoted to type
23138 @code{double} and then passed.
23140 Unfortunately, some forms of debug information do not reliably indicate whether
23141 a function is prototyped. If @value{GDBN} calls a function that is not marked
23142 as prototyped, it consults @kbd{set coerce-float-to-double}.
23145 @kindex set coerce-float-to-double
23146 @item set coerce-float-to-double
23147 @itemx set coerce-float-to-double on
23148 Arguments of type @code{float} will be promoted to @code{double} when passed
23149 to an unprototyped function. This is the default setting.
23151 @item set coerce-float-to-double off
23152 Arguments of type @code{float} will be passed directly to unprototyped
23155 @kindex show coerce-float-to-double
23156 @item show coerce-float-to-double
23157 Show the current setting of promoting @code{float} to @code{double}.
23161 @kindex show cp-abi
23162 @value{GDBN} needs to know the ABI used for your program's C@t{++}
23163 objects. The correct C@t{++} ABI depends on which C@t{++} compiler was
23164 used to build your application. @value{GDBN} only fully supports
23165 programs with a single C@t{++} ABI; if your program contains code using
23166 multiple C@t{++} ABI's or if @value{GDBN} can not identify your
23167 program's ABI correctly, you can tell @value{GDBN} which ABI to use.
23168 Currently supported ABI's include ``gnu-v2'', for @code{g++} versions
23169 before 3.0, ``gnu-v3'', for @code{g++} versions 3.0 and later, and
23170 ``hpaCC'' for the HP ANSI C@t{++} compiler. Other C@t{++} compilers may
23171 use the ``gnu-v2'' or ``gnu-v3'' ABI's as well. The default setting is
23176 Show the C@t{++} ABI currently in use.
23179 With no argument, show the list of supported C@t{++} ABI's.
23181 @item set cp-abi @var{abi}
23182 @itemx set cp-abi auto
23183 Set the current C@t{++} ABI to @var{abi}, or return to automatic detection.
23187 @section Automatically loading associated files
23188 @cindex auto-loading
23190 @value{GDBN} sometimes reads files with commands and settings automatically,
23191 without being explicitly told so by the user. We call this feature
23192 @dfn{auto-loading}. While auto-loading is useful for automatically adapting
23193 @value{GDBN} to the needs of your project, it can sometimes produce unexpected
23194 results or introduce security risks (e.g., if the file comes from untrusted
23198 * Init File in the Current Directory:: @samp{set/show/info auto-load local-gdbinit}
23199 * libthread_db.so.1 file:: @samp{set/show/info auto-load libthread-db}
23201 * Auto-loading safe path:: @samp{set/show/info auto-load safe-path}
23202 * Auto-loading verbose mode:: @samp{set/show debug auto-load}
23205 There are various kinds of files @value{GDBN} can automatically load.
23206 In addition to these files, @value{GDBN} supports auto-loading code written
23207 in various extension languages. @xref{Auto-loading extensions}.
23209 Note that loading of these associated files (including the local @file{.gdbinit}
23210 file) requires accordingly configured @code{auto-load safe-path}
23211 (@pxref{Auto-loading safe path}).
23213 For these reasons, @value{GDBN} includes commands and options to let you
23214 control when to auto-load files and which files should be auto-loaded.
23217 @anchor{set auto-load off}
23218 @kindex set auto-load off
23219 @item set auto-load off
23220 Globally disable loading of all auto-loaded files.
23221 You may want to use this command with the @samp{-iex} option
23222 (@pxref{Option -init-eval-command}) such as:
23224 $ @kbd{gdb -iex "set auto-load off" untrusted-executable corefile}
23227 Be aware that system init file (@pxref{System-wide configuration})
23228 and init files from your home directory (@pxref{Home Directory Init File})
23229 still get read (as they come from generally trusted directories).
23230 To prevent @value{GDBN} from auto-loading even those init files, use the
23231 @option{-nx} option (@pxref{Mode Options}), in addition to
23232 @code{set auto-load no}.
23234 @anchor{show auto-load}
23235 @kindex show auto-load
23236 @item show auto-load
23237 Show whether auto-loading of each specific @samp{auto-load} file(s) is enabled
23241 (gdb) show auto-load
23242 gdb-scripts: Auto-loading of canned sequences of commands scripts is on.
23243 libthread-db: Auto-loading of inferior specific libthread_db is on.
23244 local-gdbinit: Auto-loading of .gdbinit script from current directory
23246 python-scripts: Auto-loading of Python scripts is on.
23247 safe-path: List of directories from which it is safe to auto-load files
23248 is $debugdir:$datadir/auto-load.
23249 scripts-directory: List of directories from which to load auto-loaded scripts
23250 is $debugdir:$datadir/auto-load.
23253 @anchor{info auto-load}
23254 @kindex info auto-load
23255 @item info auto-load
23256 Print whether each specific @samp{auto-load} file(s) have been auto-loaded or
23260 (gdb) info auto-load
23263 Yes /home/user/gdb/gdb-gdb.gdb
23264 libthread-db: No auto-loaded libthread-db.
23265 local-gdbinit: Local .gdbinit file "/home/user/gdb/.gdbinit" has been
23269 Yes /home/user/gdb/gdb-gdb.py
23273 These are @value{GDBN} control commands for the auto-loading:
23275 @multitable @columnfractions .5 .5
23276 @item @xref{set auto-load off}.
23277 @tab Disable auto-loading globally.
23278 @item @xref{show auto-load}.
23279 @tab Show setting of all kinds of files.
23280 @item @xref{info auto-load}.
23281 @tab Show state of all kinds of files.
23282 @item @xref{set auto-load gdb-scripts}.
23283 @tab Control for @value{GDBN} command scripts.
23284 @item @xref{show auto-load gdb-scripts}.
23285 @tab Show setting of @value{GDBN} command scripts.
23286 @item @xref{info auto-load gdb-scripts}.
23287 @tab Show state of @value{GDBN} command scripts.
23288 @item @xref{set auto-load python-scripts}.
23289 @tab Control for @value{GDBN} Python scripts.
23290 @item @xref{show auto-load python-scripts}.
23291 @tab Show setting of @value{GDBN} Python scripts.
23292 @item @xref{info auto-load python-scripts}.
23293 @tab Show state of @value{GDBN} Python scripts.
23294 @item @xref{set auto-load guile-scripts}.
23295 @tab Control for @value{GDBN} Guile scripts.
23296 @item @xref{show auto-load guile-scripts}.
23297 @tab Show setting of @value{GDBN} Guile scripts.
23298 @item @xref{info auto-load guile-scripts}.
23299 @tab Show state of @value{GDBN} Guile scripts.
23300 @item @xref{set auto-load scripts-directory}.
23301 @tab Control for @value{GDBN} auto-loaded scripts location.
23302 @item @xref{show auto-load scripts-directory}.
23303 @tab Show @value{GDBN} auto-loaded scripts location.
23304 @item @xref{add-auto-load-scripts-directory}.
23305 @tab Add directory for auto-loaded scripts location list.
23306 @item @xref{set auto-load local-gdbinit}.
23307 @tab Control for init file in the current directory.
23308 @item @xref{show auto-load local-gdbinit}.
23309 @tab Show setting of init file in the current directory.
23310 @item @xref{info auto-load local-gdbinit}.
23311 @tab Show state of init file in the current directory.
23312 @item @xref{set auto-load libthread-db}.
23313 @tab Control for thread debugging library.
23314 @item @xref{show auto-load libthread-db}.
23315 @tab Show setting of thread debugging library.
23316 @item @xref{info auto-load libthread-db}.
23317 @tab Show state of thread debugging library.
23318 @item @xref{set auto-load safe-path}.
23319 @tab Control directories trusted for automatic loading.
23320 @item @xref{show auto-load safe-path}.
23321 @tab Show directories trusted for automatic loading.
23322 @item @xref{add-auto-load-safe-path}.
23323 @tab Add directory trusted for automatic loading.
23326 @node Init File in the Current Directory
23327 @subsection Automatically loading init file in the current directory
23328 @cindex auto-loading init file in the current directory
23330 By default, @value{GDBN} reads and executes the canned sequences of commands
23331 from init file (if any) in the current working directory,
23332 see @ref{Init File in the Current Directory during Startup}.
23334 Note that loading of this local @file{.gdbinit} file also requires accordingly
23335 configured @code{auto-load safe-path} (@pxref{Auto-loading safe path}).
23338 @anchor{set auto-load local-gdbinit}
23339 @kindex set auto-load local-gdbinit
23340 @item set auto-load local-gdbinit [on|off]
23341 Enable or disable the auto-loading of canned sequences of commands
23342 (@pxref{Sequences}) found in init file in the current directory.
23344 @anchor{show auto-load local-gdbinit}
23345 @kindex show auto-load local-gdbinit
23346 @item show auto-load local-gdbinit
23347 Show whether auto-loading of canned sequences of commands from init file in the
23348 current directory is enabled or disabled.
23350 @anchor{info auto-load local-gdbinit}
23351 @kindex info auto-load local-gdbinit
23352 @item info auto-load local-gdbinit
23353 Print whether canned sequences of commands from init file in the
23354 current directory have been auto-loaded.
23357 @node libthread_db.so.1 file
23358 @subsection Automatically loading thread debugging library
23359 @cindex auto-loading libthread_db.so.1
23361 This feature is currently present only on @sc{gnu}/Linux native hosts.
23363 @value{GDBN} reads in some cases thread debugging library from places specific
23364 to the inferior (@pxref{set libthread-db-search-path}).
23366 The special @samp{libthread-db-search-path} entry @samp{$sdir} is processed
23367 without checking this @samp{set auto-load libthread-db} switch as system
23368 libraries have to be trusted in general. In all other cases of
23369 @samp{libthread-db-search-path} entries @value{GDBN} checks first if @samp{set
23370 auto-load libthread-db} is enabled before trying to open such thread debugging
23373 Note that loading of this debugging library also requires accordingly configured
23374 @code{auto-load safe-path} (@pxref{Auto-loading safe path}).
23377 @anchor{set auto-load libthread-db}
23378 @kindex set auto-load libthread-db
23379 @item set auto-load libthread-db [on|off]
23380 Enable or disable the auto-loading of inferior specific thread debugging library.
23382 @anchor{show auto-load libthread-db}
23383 @kindex show auto-load libthread-db
23384 @item show auto-load libthread-db
23385 Show whether auto-loading of inferior specific thread debugging library is
23386 enabled or disabled.
23388 @anchor{info auto-load libthread-db}
23389 @kindex info auto-load libthread-db
23390 @item info auto-load libthread-db
23391 Print the list of all loaded inferior specific thread debugging libraries and
23392 for each such library print list of inferior @var{pid}s using it.
23395 @node Auto-loading safe path
23396 @subsection Security restriction for auto-loading
23397 @cindex auto-loading safe-path
23399 As the files of inferior can come from untrusted source (such as submitted by
23400 an application user) @value{GDBN} does not always load any files automatically.
23401 @value{GDBN} provides the @samp{set auto-load safe-path} setting to list
23402 directories trusted for loading files not explicitly requested by user.
23403 Each directory can also be a shell wildcard pattern.
23405 If the path is not set properly you will see a warning and the file will not
23410 Reading symbols from /home/user/gdb/gdb...done.
23411 warning: File "/home/user/gdb/gdb-gdb.gdb" auto-loading has been
23412 declined by your `auto-load safe-path' set
23413 to "$debugdir:$datadir/auto-load".
23414 warning: File "/home/user/gdb/gdb-gdb.py" auto-loading has been
23415 declined by your `auto-load safe-path' set
23416 to "$debugdir:$datadir/auto-load".
23420 To instruct @value{GDBN} to go ahead and use the init files anyway,
23421 invoke @value{GDBN} like this:
23424 $ gdb -q -iex "set auto-load safe-path /home/user/gdb" ./gdb
23427 The list of trusted directories is controlled by the following commands:
23430 @anchor{set auto-load safe-path}
23431 @kindex set auto-load safe-path
23432 @item set auto-load safe-path @r{[}@var{directories}@r{]}
23433 Set the list of directories (and their subdirectories) trusted for automatic
23434 loading and execution of scripts. You can also enter a specific trusted file.
23435 Each directory can also be a shell wildcard pattern; wildcards do not match
23436 directory separator - see @code{FNM_PATHNAME} for system function @code{fnmatch}
23437 (@pxref{Wildcard Matching, fnmatch, , libc, GNU C Library Reference Manual}).
23438 If you omit @var{directories}, @samp{auto-load safe-path} will be reset to
23439 its default value as specified during @value{GDBN} compilation.
23441 The list of directories uses path separator (@samp{:} on GNU and Unix
23442 systems, @samp{;} on MS-Windows and MS-DOS) to separate directories, similarly
23443 to the @env{PATH} environment variable.
23445 @anchor{show auto-load safe-path}
23446 @kindex show auto-load safe-path
23447 @item show auto-load safe-path
23448 Show the list of directories trusted for automatic loading and execution of
23451 @anchor{add-auto-load-safe-path}
23452 @kindex add-auto-load-safe-path
23453 @item add-auto-load-safe-path
23454 Add an entry (or list of entries) to the list of directories trusted for
23455 automatic loading and execution of scripts. Multiple entries may be delimited
23456 by the host platform path separator in use.
23459 This variable defaults to what @code{--with-auto-load-dir} has been configured
23460 to (@pxref{with-auto-load-dir}). @file{$debugdir} and @file{$datadir}
23461 substitution applies the same as for @ref{set auto-load scripts-directory}.
23462 The default @code{set auto-load safe-path} value can be also overriden by
23463 @value{GDBN} configuration option @option{--with-auto-load-safe-path}.
23465 Setting this variable to @file{/} disables this security protection,
23466 corresponding @value{GDBN} configuration option is
23467 @option{--without-auto-load-safe-path}.
23468 This variable is supposed to be set to the system directories writable by the
23469 system superuser only. Users can add their source directories in init files in
23470 their home directories (@pxref{Home Directory Init File}). See also deprecated
23471 init file in the current directory
23472 (@pxref{Init File in the Current Directory during Startup}).
23474 To force @value{GDBN} to load the files it declined to load in the previous
23475 example, you could use one of the following ways:
23478 @item @file{~/.gdbinit}: @samp{add-auto-load-safe-path ~/src/gdb}
23479 Specify this trusted directory (or a file) as additional component of the list.
23480 You have to specify also any existing directories displayed by
23481 by @samp{show auto-load safe-path} (such as @samp{/usr:/bin} in this example).
23483 @item @kbd{gdb -iex "set auto-load safe-path /usr:/bin:~/src/gdb" @dots{}}
23484 Specify this directory as in the previous case but just for a single
23485 @value{GDBN} session.
23487 @item @kbd{gdb -iex "set auto-load safe-path /" @dots{}}
23488 Disable auto-loading safety for a single @value{GDBN} session.
23489 This assumes all the files you debug during this @value{GDBN} session will come
23490 from trusted sources.
23492 @item @kbd{./configure --without-auto-load-safe-path}
23493 During compilation of @value{GDBN} you may disable any auto-loading safety.
23494 This assumes all the files you will ever debug with this @value{GDBN} come from
23498 On the other hand you can also explicitly forbid automatic files loading which
23499 also suppresses any such warning messages:
23502 @item @kbd{gdb -iex "set auto-load no" @dots{}}
23503 You can use @value{GDBN} command-line option for a single @value{GDBN} session.
23505 @item @file{~/.gdbinit}: @samp{set auto-load no}
23506 Disable auto-loading globally for the user
23507 (@pxref{Home Directory Init File}). While it is improbable, you could also
23508 use system init file instead (@pxref{System-wide configuration}).
23511 This setting applies to the file names as entered by user. If no entry matches
23512 @value{GDBN} tries as a last resort to also resolve all the file names into
23513 their canonical form (typically resolving symbolic links) and compare the
23514 entries again. @value{GDBN} already canonicalizes most of the filenames on its
23515 own before starting the comparison so a canonical form of directories is
23516 recommended to be entered.
23518 @node Auto-loading verbose mode
23519 @subsection Displaying files tried for auto-load
23520 @cindex auto-loading verbose mode
23522 For better visibility of all the file locations where you can place scripts to
23523 be auto-loaded with inferior --- or to protect yourself against accidental
23524 execution of untrusted scripts --- @value{GDBN} provides a feature for printing
23525 all the files attempted to be loaded. Both existing and non-existing files may
23528 For example the list of directories from which it is safe to auto-load files
23529 (@pxref{Auto-loading safe path}) applies also to canonicalized filenames which
23530 may not be too obvious while setting it up.
23533 (gdb) set debug auto-load on
23534 (gdb) file ~/src/t/true
23535 auto-load: Loading canned sequences of commands script "/tmp/true-gdb.gdb"
23536 for objfile "/tmp/true".
23537 auto-load: Updating directories of "/usr:/opt".
23538 auto-load: Using directory "/usr".
23539 auto-load: Using directory "/opt".
23540 warning: File "/tmp/true-gdb.gdb" auto-loading has been declined
23541 by your `auto-load safe-path' set to "/usr:/opt".
23545 @anchor{set debug auto-load}
23546 @kindex set debug auto-load
23547 @item set debug auto-load [on|off]
23548 Set whether to print the filenames attempted to be auto-loaded.
23550 @anchor{show debug auto-load}
23551 @kindex show debug auto-load
23552 @item show debug auto-load
23553 Show whether printing of the filenames attempted to be auto-loaded is turned
23557 @node Messages/Warnings
23558 @section Optional Warnings and Messages
23560 @cindex verbose operation
23561 @cindex optional warnings
23562 By default, @value{GDBN} is silent about its inner workings. If you are
23563 running on a slow machine, you may want to use the @code{set verbose}
23564 command. This makes @value{GDBN} tell you when it does a lengthy
23565 internal operation, so you will not think it has crashed.
23567 Currently, the messages controlled by @code{set verbose} are those
23568 which announce that the symbol table for a source file is being read;
23569 see @code{symbol-file} in @ref{Files, ,Commands to Specify Files}.
23572 @kindex set verbose
23573 @item set verbose on
23574 Enables @value{GDBN} output of certain informational messages.
23576 @item set verbose off
23577 Disables @value{GDBN} output of certain informational messages.
23579 @kindex show verbose
23581 Displays whether @code{set verbose} is on or off.
23584 By default, if @value{GDBN} encounters bugs in the symbol table of an
23585 object file, it is silent; but if you are debugging a compiler, you may
23586 find this information useful (@pxref{Symbol Errors, ,Errors Reading
23591 @kindex set complaints
23592 @item set complaints @var{limit}
23593 Permits @value{GDBN} to output @var{limit} complaints about each type of
23594 unusual symbols before becoming silent about the problem. Set
23595 @var{limit} to zero to suppress all complaints; set it to a large number
23596 to prevent complaints from being suppressed.
23598 @kindex show complaints
23599 @item show complaints
23600 Displays how many symbol complaints @value{GDBN} is permitted to produce.
23604 @anchor{confirmation requests}
23605 By default, @value{GDBN} is cautious, and asks what sometimes seems to be a
23606 lot of stupid questions to confirm certain commands. For example, if
23607 you try to run a program which is already running:
23611 The program being debugged has been started already.
23612 Start it from the beginning? (y or n)
23615 If you are willing to unflinchingly face the consequences of your own
23616 commands, you can disable this ``feature'':
23620 @kindex set confirm
23622 @cindex confirmation
23623 @cindex stupid questions
23624 @item set confirm off
23625 Disables confirmation requests. Note that running @value{GDBN} with
23626 the @option{--batch} option (@pxref{Mode Options, -batch}) also
23627 automatically disables confirmation requests.
23629 @item set confirm on
23630 Enables confirmation requests (the default).
23632 @kindex show confirm
23634 Displays state of confirmation requests.
23638 @cindex command tracing
23639 If you need to debug user-defined commands or sourced files you may find it
23640 useful to enable @dfn{command tracing}. In this mode each command will be
23641 printed as it is executed, prefixed with one or more @samp{+} symbols, the
23642 quantity denoting the call depth of each command.
23645 @kindex set trace-commands
23646 @cindex command scripts, debugging
23647 @item set trace-commands on
23648 Enable command tracing.
23649 @item set trace-commands off
23650 Disable command tracing.
23651 @item show trace-commands
23652 Display the current state of command tracing.
23655 @node Debugging Output
23656 @section Optional Messages about Internal Happenings
23657 @cindex optional debugging messages
23659 @value{GDBN} has commands that enable optional debugging messages from
23660 various @value{GDBN} subsystems; normally these commands are of
23661 interest to @value{GDBN} maintainers, or when reporting a bug. This
23662 section documents those commands.
23665 @kindex set exec-done-display
23666 @item set exec-done-display
23667 Turns on or off the notification of asynchronous commands'
23668 completion. When on, @value{GDBN} will print a message when an
23669 asynchronous command finishes its execution. The default is off.
23670 @kindex show exec-done-display
23671 @item show exec-done-display
23672 Displays the current setting of asynchronous command completion
23675 @cindex ARM AArch64
23676 @item set debug aarch64
23677 Turns on or off display of debugging messages related to ARM AArch64.
23678 The default is off.
23680 @item show debug aarch64
23681 Displays the current state of displaying debugging messages related to
23683 @cindex gdbarch debugging info
23684 @cindex architecture debugging info
23685 @item set debug arch
23686 Turns on or off display of gdbarch debugging info. The default is off
23687 @item show debug arch
23688 Displays the current state of displaying gdbarch debugging info.
23689 @item set debug aix-solib
23690 @cindex AIX shared library debugging
23691 Control display of debugging messages from the AIX shared library
23692 support module. The default is off.
23693 @item show debug aix-thread
23694 Show the current state of displaying AIX shared library debugging messages.
23695 @item set debug aix-thread
23696 @cindex AIX threads
23697 Display debugging messages about inner workings of the AIX thread
23699 @item show debug aix-thread
23700 Show the current state of AIX thread debugging info display.
23701 @item set debug check-physname
23703 Check the results of the ``physname'' computation. When reading DWARF
23704 debugging information for C@t{++}, @value{GDBN} attempts to compute
23705 each entity's name. @value{GDBN} can do this computation in two
23706 different ways, depending on exactly what information is present.
23707 When enabled, this setting causes @value{GDBN} to compute the names
23708 both ways and display any discrepancies.
23709 @item show debug check-physname
23710 Show the current state of ``physname'' checking.
23711 @item set debug coff-pe-read
23712 @cindex COFF/PE exported symbols
23713 Control display of debugging messages related to reading of COFF/PE
23714 exported symbols. The default is off.
23715 @item show debug coff-pe-read
23716 Displays the current state of displaying debugging messages related to
23717 reading of COFF/PE exported symbols.
23718 @item set debug dwarf-die
23720 Dump DWARF DIEs after they are read in.
23721 The value is the number of nesting levels to print.
23722 A value of zero turns off the display.
23723 @item show debug dwarf-die
23724 Show the current state of DWARF DIE debugging.
23725 @item set debug dwarf-line
23726 @cindex DWARF Line Tables
23727 Turns on or off display of debugging messages related to reading
23728 DWARF line tables. The default is 0 (off).
23729 A value of 1 provides basic information.
23730 A value greater than 1 provides more verbose information.
23731 @item show debug dwarf-line
23732 Show the current state of DWARF line table debugging.
23733 @item set debug dwarf-read
23734 @cindex DWARF Reading
23735 Turns on or off display of debugging messages related to reading
23736 DWARF debug info. The default is 0 (off).
23737 A value of 1 provides basic information.
23738 A value greater than 1 provides more verbose information.
23739 @item show debug dwarf-read
23740 Show the current state of DWARF reader debugging.
23741 @item set debug displaced
23742 @cindex displaced stepping debugging info
23743 Turns on or off display of @value{GDBN} debugging info for the
23744 displaced stepping support. The default is off.
23745 @item show debug displaced
23746 Displays the current state of displaying @value{GDBN} debugging info
23747 related to displaced stepping.
23748 @item set debug event
23749 @cindex event debugging info
23750 Turns on or off display of @value{GDBN} event debugging info. The
23752 @item show debug event
23753 Displays the current state of displaying @value{GDBN} event debugging
23755 @item set debug expression
23756 @cindex expression debugging info
23757 Turns on or off display of debugging info about @value{GDBN}
23758 expression parsing. The default is off.
23759 @item show debug expression
23760 Displays the current state of displaying debugging info about
23761 @value{GDBN} expression parsing.
23762 @item set debug fbsd-lwp
23763 @cindex FreeBSD LWP debug messages
23764 Turns on or off debugging messages from the FreeBSD LWP debug support.
23765 @item show debug fbsd-lwp
23766 Show the current state of FreeBSD LWP debugging messages.
23767 @item set debug frame
23768 @cindex frame debugging info
23769 Turns on or off display of @value{GDBN} frame debugging info. The
23771 @item show debug frame
23772 Displays the current state of displaying @value{GDBN} frame debugging
23774 @item set debug gnu-nat
23775 @cindex @sc{gnu}/Hurd debug messages
23776 Turn on or off debugging messages from the @sc{gnu}/Hurd debug support.
23777 @item show debug gnu-nat
23778 Show the current state of @sc{gnu}/Hurd debugging messages.
23779 @item set debug infrun
23780 @cindex inferior debugging info
23781 Turns on or off display of @value{GDBN} debugging info for running the inferior.
23782 The default is off. @file{infrun.c} contains GDB's runtime state machine used
23783 for implementing operations such as single-stepping the inferior.
23784 @item show debug infrun
23785 Displays the current state of @value{GDBN} inferior debugging.
23786 @item set debug jit
23787 @cindex just-in-time compilation, debugging messages
23788 Turn on or off debugging messages from JIT debug support.
23789 @item show debug jit
23790 Displays the current state of @value{GDBN} JIT debugging.
23791 @item set debug lin-lwp
23792 @cindex @sc{gnu}/Linux LWP debug messages
23793 @cindex Linux lightweight processes
23794 Turn on or off debugging messages from the Linux LWP debug support.
23795 @item show debug lin-lwp
23796 Show the current state of Linux LWP debugging messages.
23797 @item set debug linux-namespaces
23798 @cindex @sc{gnu}/Linux namespaces debug messages
23799 Turn on or off debugging messages from the Linux namespaces debug support.
23800 @item show debug linux-namespaces
23801 Show the current state of Linux namespaces debugging messages.
23802 @item set debug mach-o
23803 @cindex Mach-O symbols processing
23804 Control display of debugging messages related to Mach-O symbols
23805 processing. The default is off.
23806 @item show debug mach-o
23807 Displays the current state of displaying debugging messages related to
23808 reading of COFF/PE exported symbols.
23809 @item set debug notification
23810 @cindex remote async notification debugging info
23811 Turn on or off debugging messages about remote async notification.
23812 The default is off.
23813 @item show debug notification
23814 Displays the current state of remote async notification debugging messages.
23815 @item set debug observer
23816 @cindex observer debugging info
23817 Turns on or off display of @value{GDBN} observer debugging. This
23818 includes info such as the notification of observable events.
23819 @item show debug observer
23820 Displays the current state of observer debugging.
23821 @item set debug overload
23822 @cindex C@t{++} overload debugging info
23823 Turns on or off display of @value{GDBN} C@t{++} overload debugging
23824 info. This includes info such as ranking of functions, etc. The default
23826 @item show debug overload
23827 Displays the current state of displaying @value{GDBN} C@t{++} overload
23829 @cindex expression parser, debugging info
23830 @cindex debug expression parser
23831 @item set debug parser
23832 Turns on or off the display of expression parser debugging output.
23833 Internally, this sets the @code{yydebug} variable in the expression
23834 parser. @xref{Tracing, , Tracing Your Parser, bison, Bison}, for
23835 details. The default is off.
23836 @item show debug parser
23837 Show the current state of expression parser debugging.
23838 @cindex packets, reporting on stdout
23839 @cindex serial connections, debugging
23840 @cindex debug remote protocol
23841 @cindex remote protocol debugging
23842 @cindex display remote packets
23843 @item set debug remote
23844 Turns on or off display of reports on all packets sent back and forth across
23845 the serial line to the remote machine. The info is printed on the
23846 @value{GDBN} standard output stream. The default is off.
23847 @item show debug remote
23848 Displays the state of display of remote packets.
23849 @item set debug serial
23850 Turns on or off display of @value{GDBN} serial debugging info. The
23852 @item show debug serial
23853 Displays the current state of displaying @value{GDBN} serial debugging
23855 @item set debug solib-frv
23856 @cindex FR-V shared-library debugging
23857 Turn on or off debugging messages for FR-V shared-library code.
23858 @item show debug solib-frv
23859 Display the current state of FR-V shared-library code debugging
23861 @item set debug symbol-lookup
23862 @cindex symbol lookup
23863 Turns on or off display of debugging messages related to symbol lookup.
23864 The default is 0 (off).
23865 A value of 1 provides basic information.
23866 A value greater than 1 provides more verbose information.
23867 @item show debug symbol-lookup
23868 Show the current state of symbol lookup debugging messages.
23869 @item set debug symfile
23870 @cindex symbol file functions
23871 Turns on or off display of debugging messages related to symbol file functions.
23872 The default is off. @xref{Files}.
23873 @item show debug symfile
23874 Show the current state of symbol file debugging messages.
23875 @item set debug symtab-create
23876 @cindex symbol table creation
23877 Turns on or off display of debugging messages related to symbol table creation.
23878 The default is 0 (off).
23879 A value of 1 provides basic information.
23880 A value greater than 1 provides more verbose information.
23881 @item show debug symtab-create
23882 Show the current state of symbol table creation debugging.
23883 @item set debug target
23884 @cindex target debugging info
23885 Turns on or off display of @value{GDBN} target debugging info. This info
23886 includes what is going on at the target level of GDB, as it happens. The
23887 default is 0. Set it to 1 to track events, and to 2 to also track the
23888 value of large memory transfers.
23889 @item show debug target
23890 Displays the current state of displaying @value{GDBN} target debugging
23892 @item set debug timestamp
23893 @cindex timestampping debugging info
23894 Turns on or off display of timestamps with @value{GDBN} debugging info.
23895 When enabled, seconds and microseconds are displayed before each debugging
23897 @item show debug timestamp
23898 Displays the current state of displaying timestamps with @value{GDBN}
23900 @item set debug varobj
23901 @cindex variable object debugging info
23902 Turns on or off display of @value{GDBN} variable object debugging
23903 info. The default is off.
23904 @item show debug varobj
23905 Displays the current state of displaying @value{GDBN} variable object
23907 @item set debug xml
23908 @cindex XML parser debugging
23909 Turn on or off debugging messages for built-in XML parsers.
23910 @item show debug xml
23911 Displays the current state of XML debugging messages.
23914 @node Other Misc Settings
23915 @section Other Miscellaneous Settings
23916 @cindex miscellaneous settings
23919 @kindex set interactive-mode
23920 @item set interactive-mode
23921 If @code{on}, forces @value{GDBN} to assume that GDB was started
23922 in a terminal. In practice, this means that @value{GDBN} should wait
23923 for the user to answer queries generated by commands entered at
23924 the command prompt. If @code{off}, forces @value{GDBN} to operate
23925 in the opposite mode, and it uses the default answers to all queries.
23926 If @code{auto} (the default), @value{GDBN} tries to determine whether
23927 its standard input is a terminal, and works in interactive-mode if it
23928 is, non-interactively otherwise.
23930 In the vast majority of cases, the debugger should be able to guess
23931 correctly which mode should be used. But this setting can be useful
23932 in certain specific cases, such as running a MinGW @value{GDBN}
23933 inside a cygwin window.
23935 @kindex show interactive-mode
23936 @item show interactive-mode
23937 Displays whether the debugger is operating in interactive mode or not.
23940 @node Extending GDB
23941 @chapter Extending @value{GDBN}
23942 @cindex extending GDB
23944 @value{GDBN} provides several mechanisms for extension.
23945 @value{GDBN} also provides the ability to automatically load
23946 extensions when it reads a file for debugging. This allows the
23947 user to automatically customize @value{GDBN} for the program
23951 * Sequences:: Canned Sequences of @value{GDBN} Commands
23952 * Python:: Extending @value{GDBN} using Python
23953 * Guile:: Extending @value{GDBN} using Guile
23954 * Auto-loading extensions:: Automatically loading extensions
23955 * Multiple Extension Languages:: Working with multiple extension languages
23956 * Aliases:: Creating new spellings of existing commands
23959 To facilitate the use of extension languages, @value{GDBN} is capable
23960 of evaluating the contents of a file. When doing so, @value{GDBN}
23961 can recognize which extension language is being used by looking at
23962 the filename extension. Files with an unrecognized filename extension
23963 are always treated as a @value{GDBN} Command Files.
23964 @xref{Command Files,, Command files}.
23966 You can control how @value{GDBN} evaluates these files with the following
23970 @kindex set script-extension
23971 @kindex show script-extension
23972 @item set script-extension off
23973 All scripts are always evaluated as @value{GDBN} Command Files.
23975 @item set script-extension soft
23976 The debugger determines the scripting language based on filename
23977 extension. If this scripting language is supported, @value{GDBN}
23978 evaluates the script using that language. Otherwise, it evaluates
23979 the file as a @value{GDBN} Command File.
23981 @item set script-extension strict
23982 The debugger determines the scripting language based on filename
23983 extension, and evaluates the script using that language. If the
23984 language is not supported, then the evaluation fails.
23986 @item show script-extension
23987 Display the current value of the @code{script-extension} option.
23992 @section Canned Sequences of Commands
23994 Aside from breakpoint commands (@pxref{Break Commands, ,Breakpoint
23995 Command Lists}), @value{GDBN} provides two ways to store sequences of
23996 commands for execution as a unit: user-defined commands and command
24000 * Define:: How to define your own commands
24001 * Hooks:: Hooks for user-defined commands
24002 * Command Files:: How to write scripts of commands to be stored in a file
24003 * Output:: Commands for controlled output
24004 * Auto-loading sequences:: Controlling auto-loaded command files
24008 @subsection User-defined Commands
24010 @cindex user-defined command
24011 @cindex arguments, to user-defined commands
24012 A @dfn{user-defined command} is a sequence of @value{GDBN} commands to
24013 which you assign a new name as a command. This is done with the
24014 @code{define} command. User commands may accept up to 10 arguments
24015 separated by whitespace. Arguments are accessed within the user command
24016 via @code{$arg0@dots{}$arg9}. A trivial example:
24020 print $arg0 + $arg1 + $arg2
24025 To execute the command use:
24032 This defines the command @code{adder}, which prints the sum of
24033 its three arguments. Note the arguments are text substitutions, so they may
24034 reference variables, use complex expressions, or even perform inferior
24037 @cindex argument count in user-defined commands
24038 @cindex how many arguments (user-defined commands)
24039 In addition, @code{$argc} may be used to find out how many arguments have
24040 been passed. This expands to a number in the range 0@dots{}10.
24045 print $arg0 + $arg1
24048 print $arg0 + $arg1 + $arg2
24056 @item define @var{commandname}
24057 Define a command named @var{commandname}. If there is already a command
24058 by that name, you are asked to confirm that you want to redefine it.
24059 The argument @var{commandname} may be a bare command name consisting of letters,
24060 numbers, dashes, and underscores. It may also start with any predefined
24061 prefix command. For example, @samp{define target my-target} creates
24062 a user-defined @samp{target my-target} command.
24064 The definition of the command is made up of other @value{GDBN} command lines,
24065 which are given following the @code{define} command. The end of these
24066 commands is marked by a line containing @code{end}.
24069 @kindex end@r{ (user-defined commands)}
24070 @item document @var{commandname}
24071 Document the user-defined command @var{commandname}, so that it can be
24072 accessed by @code{help}. The command @var{commandname} must already be
24073 defined. This command reads lines of documentation just as @code{define}
24074 reads the lines of the command definition, ending with @code{end}.
24075 After the @code{document} command is finished, @code{help} on command
24076 @var{commandname} displays the documentation you have written.
24078 You may use the @code{document} command again to change the
24079 documentation of a command. Redefining the command with @code{define}
24080 does not change the documentation.
24082 @kindex dont-repeat
24083 @cindex don't repeat command
24085 Used inside a user-defined command, this tells @value{GDBN} that this
24086 command should not be repeated when the user hits @key{RET}
24087 (@pxref{Command Syntax, repeat last command}).
24089 @kindex help user-defined
24090 @item help user-defined
24091 List all user-defined commands and all python commands defined in class
24092 COMAND_USER. The first line of the documentation or docstring is
24097 @itemx show user @var{commandname}
24098 Display the @value{GDBN} commands used to define @var{commandname} (but
24099 not its documentation). If no @var{commandname} is given, display the
24100 definitions for all user-defined commands.
24101 This does not work for user-defined python commands.
24103 @cindex infinite recursion in user-defined commands
24104 @kindex show max-user-call-depth
24105 @kindex set max-user-call-depth
24106 @item show max-user-call-depth
24107 @itemx set max-user-call-depth
24108 The value of @code{max-user-call-depth} controls how many recursion
24109 levels are allowed in user-defined commands before @value{GDBN} suspects an
24110 infinite recursion and aborts the command.
24111 This does not apply to user-defined python commands.
24114 In addition to the above commands, user-defined commands frequently
24115 use control flow commands, described in @ref{Command Files}.
24117 When user-defined commands are executed, the
24118 commands of the definition are not printed. An error in any command
24119 stops execution of the user-defined command.
24121 If used interactively, commands that would ask for confirmation proceed
24122 without asking when used inside a user-defined command. Many @value{GDBN}
24123 commands that normally print messages to say what they are doing omit the
24124 messages when used in a user-defined command.
24127 @subsection User-defined Command Hooks
24128 @cindex command hooks
24129 @cindex hooks, for commands
24130 @cindex hooks, pre-command
24133 You may define @dfn{hooks}, which are a special kind of user-defined
24134 command. Whenever you run the command @samp{foo}, if the user-defined
24135 command @samp{hook-foo} exists, it is executed (with no arguments)
24136 before that command.
24138 @cindex hooks, post-command
24140 A hook may also be defined which is run after the command you executed.
24141 Whenever you run the command @samp{foo}, if the user-defined command
24142 @samp{hookpost-foo} exists, it is executed (with no arguments) after
24143 that command. Post-execution hooks may exist simultaneously with
24144 pre-execution hooks, for the same command.
24146 It is valid for a hook to call the command which it hooks. If this
24147 occurs, the hook is not re-executed, thereby avoiding infinite recursion.
24149 @c It would be nice if hookpost could be passed a parameter indicating
24150 @c if the command it hooks executed properly or not. FIXME!
24152 @kindex stop@r{, a pseudo-command}
24153 In addition, a pseudo-command, @samp{stop} exists. Defining
24154 (@samp{hook-stop}) makes the associated commands execute every time
24155 execution stops in your program: before breakpoint commands are run,
24156 displays are printed, or the stack frame is printed.
24158 For example, to ignore @code{SIGALRM} signals while
24159 single-stepping, but treat them normally during normal execution,
24164 handle SIGALRM nopass
24168 handle SIGALRM pass
24171 define hook-continue
24172 handle SIGALRM pass
24176 As a further example, to hook at the beginning and end of the @code{echo}
24177 command, and to add extra text to the beginning and end of the message,
24185 define hookpost-echo
24189 (@value{GDBP}) echo Hello World
24190 <<<---Hello World--->>>
24195 You can define a hook for any single-word command in @value{GDBN}, but
24196 not for command aliases; you should define a hook for the basic command
24197 name, e.g.@: @code{backtrace} rather than @code{bt}.
24198 @c FIXME! So how does Joe User discover whether a command is an alias
24200 You can hook a multi-word command by adding @code{hook-} or
24201 @code{hookpost-} to the last word of the command, e.g.@:
24202 @samp{define target hook-remote} to add a hook to @samp{target remote}.
24204 If an error occurs during the execution of your hook, execution of
24205 @value{GDBN} commands stops and @value{GDBN} issues a prompt
24206 (before the command that you actually typed had a chance to run).
24208 If you try to define a hook which does not match any known command, you
24209 get a warning from the @code{define} command.
24211 @node Command Files
24212 @subsection Command Files
24214 @cindex command files
24215 @cindex scripting commands
24216 A command file for @value{GDBN} is a text file made of lines that are
24217 @value{GDBN} commands. Comments (lines starting with @kbd{#}) may
24218 also be included. An empty line in a command file does nothing; it
24219 does not mean to repeat the last command, as it would from the
24222 You can request the execution of a command file with the @code{source}
24223 command. Note that the @code{source} command is also used to evaluate
24224 scripts that are not Command Files. The exact behavior can be configured
24225 using the @code{script-extension} setting.
24226 @xref{Extending GDB,, Extending GDB}.
24230 @cindex execute commands from a file
24231 @item source [-s] [-v] @var{filename}
24232 Execute the command file @var{filename}.
24235 The lines in a command file are generally executed sequentially,
24236 unless the order of execution is changed by one of the
24237 @emph{flow-control commands} described below. The commands are not
24238 printed as they are executed. An error in any command terminates
24239 execution of the command file and control is returned to the console.
24241 @value{GDBN} first searches for @var{filename} in the current directory.
24242 If the file is not found there, and @var{filename} does not specify a
24243 directory, then @value{GDBN} also looks for the file on the source search path
24244 (specified with the @samp{directory} command);
24245 except that @file{$cdir} is not searched because the compilation directory
24246 is not relevant to scripts.
24248 If @code{-s} is specified, then @value{GDBN} searches for @var{filename}
24249 on the search path even if @var{filename} specifies a directory.
24250 The search is done by appending @var{filename} to each element of the
24251 search path. So, for example, if @var{filename} is @file{mylib/myscript}
24252 and the search path contains @file{/home/user} then @value{GDBN} will
24253 look for the script @file{/home/user/mylib/myscript}.
24254 The search is also done if @var{filename} is an absolute path.
24255 For example, if @var{filename} is @file{/tmp/myscript} and
24256 the search path contains @file{/home/user} then @value{GDBN} will
24257 look for the script @file{/home/user/tmp/myscript}.
24258 For DOS-like systems, if @var{filename} contains a drive specification,
24259 it is stripped before concatenation. For example, if @var{filename} is
24260 @file{d:myscript} and the search path contains @file{c:/tmp} then @value{GDBN}
24261 will look for the script @file{c:/tmp/myscript}.
24263 If @code{-v}, for verbose mode, is given then @value{GDBN} displays
24264 each command as it is executed. The option must be given before
24265 @var{filename}, and is interpreted as part of the filename anywhere else.
24267 Commands that would ask for confirmation if used interactively proceed
24268 without asking when used in a command file. Many @value{GDBN} commands that
24269 normally print messages to say what they are doing omit the messages
24270 when called from command files.
24272 @value{GDBN} also accepts command input from standard input. In this
24273 mode, normal output goes to standard output and error output goes to
24274 standard error. Errors in a command file supplied on standard input do
24275 not terminate execution of the command file---execution continues with
24279 gdb < cmds > log 2>&1
24282 (The syntax above will vary depending on the shell used.) This example
24283 will execute commands from the file @file{cmds}. All output and errors
24284 would be directed to @file{log}.
24286 Since commands stored on command files tend to be more general than
24287 commands typed interactively, they frequently need to deal with
24288 complicated situations, such as different or unexpected values of
24289 variables and symbols, changes in how the program being debugged is
24290 built, etc. @value{GDBN} provides a set of flow-control commands to
24291 deal with these complexities. Using these commands, you can write
24292 complex scripts that loop over data structures, execute commands
24293 conditionally, etc.
24300 This command allows to include in your script conditionally executed
24301 commands. The @code{if} command takes a single argument, which is an
24302 expression to evaluate. It is followed by a series of commands that
24303 are executed only if the expression is true (its value is nonzero).
24304 There can then optionally be an @code{else} line, followed by a series
24305 of commands that are only executed if the expression was false. The
24306 end of the list is marked by a line containing @code{end}.
24310 This command allows to write loops. Its syntax is similar to
24311 @code{if}: the command takes a single argument, which is an expression
24312 to evaluate, and must be followed by the commands to execute, one per
24313 line, terminated by an @code{end}. These commands are called the
24314 @dfn{body} of the loop. The commands in the body of @code{while} are
24315 executed repeatedly as long as the expression evaluates to true.
24319 This command exits the @code{while} loop in whose body it is included.
24320 Execution of the script continues after that @code{while}s @code{end}
24323 @kindex loop_continue
24324 @item loop_continue
24325 This command skips the execution of the rest of the body of commands
24326 in the @code{while} loop in whose body it is included. Execution
24327 branches to the beginning of the @code{while} loop, where it evaluates
24328 the controlling expression.
24330 @kindex end@r{ (if/else/while commands)}
24332 Terminate the block of commands that are the body of @code{if},
24333 @code{else}, or @code{while} flow-control commands.
24338 @subsection Commands for Controlled Output
24340 During the execution of a command file or a user-defined command, normal
24341 @value{GDBN} output is suppressed; the only output that appears is what is
24342 explicitly printed by the commands in the definition. This section
24343 describes three commands useful for generating exactly the output you
24348 @item echo @var{text}
24349 @c I do not consider backslash-space a standard C escape sequence
24350 @c because it is not in ANSI.
24351 Print @var{text}. Nonprinting characters can be included in
24352 @var{text} using C escape sequences, such as @samp{\n} to print a
24353 newline. @strong{No newline is printed unless you specify one.}
24354 In addition to the standard C escape sequences, a backslash followed
24355 by a space stands for a space. This is useful for displaying a
24356 string with spaces at the beginning or the end, since leading and
24357 trailing spaces are otherwise trimmed from all arguments.
24358 To print @samp{@w{ }and foo =@w{ }}, use the command
24359 @samp{echo \@w{ }and foo = \@w{ }}.
24361 A backslash at the end of @var{text} can be used, as in C, to continue
24362 the command onto subsequent lines. For example,
24365 echo This is some text\n\
24366 which is continued\n\
24367 onto several lines.\n
24370 produces the same output as
24373 echo This is some text\n
24374 echo which is continued\n
24375 echo onto several lines.\n
24379 @item output @var{expression}
24380 Print the value of @var{expression} and nothing but that value: no
24381 newlines, no @samp{$@var{nn} = }. The value is not entered in the
24382 value history either. @xref{Expressions, ,Expressions}, for more information
24385 @item output/@var{fmt} @var{expression}
24386 Print the value of @var{expression} in format @var{fmt}. You can use
24387 the same formats as for @code{print}. @xref{Output Formats,,Output
24388 Formats}, for more information.
24391 @item printf @var{template}, @var{expressions}@dots{}
24392 Print the values of one or more @var{expressions} under the control of
24393 the string @var{template}. To print several values, make
24394 @var{expressions} be a comma-separated list of individual expressions,
24395 which may be either numbers or pointers. Their values are printed as
24396 specified by @var{template}, exactly as a C program would do by
24397 executing the code below:
24400 printf (@var{template}, @var{expressions}@dots{});
24403 As in @code{C} @code{printf}, ordinary characters in @var{template}
24404 are printed verbatim, while @dfn{conversion specification} introduced
24405 by the @samp{%} character cause subsequent @var{expressions} to be
24406 evaluated, their values converted and formatted according to type and
24407 style information encoded in the conversion specifications, and then
24410 For example, you can print two values in hex like this:
24413 printf "foo, bar-foo = 0x%x, 0x%x\n", foo, bar-foo
24416 @code{printf} supports all the standard @code{C} conversion
24417 specifications, including the flags and modifiers between the @samp{%}
24418 character and the conversion letter, with the following exceptions:
24422 The argument-ordering modifiers, such as @samp{2$}, are not supported.
24425 The modifier @samp{*} is not supported for specifying precision or
24429 The @samp{'} flag (for separation of digits into groups according to
24430 @code{LC_NUMERIC'}) is not supported.
24433 The type modifiers @samp{hh}, @samp{j}, @samp{t}, and @samp{z} are not
24437 The conversion letter @samp{n} (as in @samp{%n}) is not supported.
24440 The conversion letters @samp{a} and @samp{A} are not supported.
24444 Note that the @samp{ll} type modifier is supported only if the
24445 underlying @code{C} implementation used to build @value{GDBN} supports
24446 the @code{long long int} type, and the @samp{L} type modifier is
24447 supported only if @code{long double} type is available.
24449 As in @code{C}, @code{printf} supports simple backslash-escape
24450 sequences, such as @code{\n}, @samp{\t}, @samp{\\}, @samp{\"},
24451 @samp{\a}, and @samp{\f}, that consist of backslash followed by a
24452 single character. Octal and hexadecimal escape sequences are not
24455 Additionally, @code{printf} supports conversion specifications for DFP
24456 (@dfn{Decimal Floating Point}) types using the following length modifiers
24457 together with a floating point specifier.
24462 @samp{H} for printing @code{Decimal32} types.
24465 @samp{D} for printing @code{Decimal64} types.
24468 @samp{DD} for printing @code{Decimal128} types.
24471 If the underlying @code{C} implementation used to build @value{GDBN} has
24472 support for the three length modifiers for DFP types, other modifiers
24473 such as width and precision will also be available for @value{GDBN} to use.
24475 In case there is no such @code{C} support, no additional modifiers will be
24476 available and the value will be printed in the standard way.
24478 Here's an example of printing DFP types using the above conversion letters:
24480 printf "D32: %Hf - D64: %Df - D128: %DDf\n",1.2345df,1.2E10dd,1.2E1dl
24484 @item eval @var{template}, @var{expressions}@dots{}
24485 Convert the values of one or more @var{expressions} under the control of
24486 the string @var{template} to a command line, and call it.
24490 @node Auto-loading sequences
24491 @subsection Controlling auto-loading native @value{GDBN} scripts
24492 @cindex native script auto-loading
24494 When a new object file is read (for example, due to the @code{file}
24495 command, or because the inferior has loaded a shared library),
24496 @value{GDBN} will look for the command file @file{@var{objfile}-gdb.gdb}.
24497 @xref{Auto-loading extensions}.
24499 Auto-loading can be enabled or disabled,
24500 and the list of auto-loaded scripts can be printed.
24503 @anchor{set auto-load gdb-scripts}
24504 @kindex set auto-load gdb-scripts
24505 @item set auto-load gdb-scripts [on|off]
24506 Enable or disable the auto-loading of canned sequences of commands scripts.
24508 @anchor{show auto-load gdb-scripts}
24509 @kindex show auto-load gdb-scripts
24510 @item show auto-load gdb-scripts
24511 Show whether auto-loading of canned sequences of commands scripts is enabled or
24514 @anchor{info auto-load gdb-scripts}
24515 @kindex info auto-load gdb-scripts
24516 @cindex print list of auto-loaded canned sequences of commands scripts
24517 @item info auto-load gdb-scripts [@var{regexp}]
24518 Print the list of all canned sequences of commands scripts that @value{GDBN}
24522 If @var{regexp} is supplied only canned sequences of commands scripts with
24523 matching names are printed.
24525 @c Python docs live in a separate file.
24526 @include python.texi
24528 @c Guile docs live in a separate file.
24529 @include guile.texi
24531 @node Auto-loading extensions
24532 @section Auto-loading extensions
24533 @cindex auto-loading extensions
24535 @value{GDBN} provides two mechanisms for automatically loading extensions
24536 when a new object file is read (for example, due to the @code{file}
24537 command, or because the inferior has loaded a shared library):
24538 @file{@var{objfile}-gdb.@var{ext}} and the @code{.debug_gdb_scripts}
24539 section of modern file formats like ELF.
24542 * objfile-gdb.ext file: objfile-gdbdotext file. The @file{@var{objfile}-gdb.@var{ext}} file
24543 * .debug_gdb_scripts section: dotdebug_gdb_scripts section. The @code{.debug_gdb_scripts} section
24544 * Which flavor to choose?::
24547 The auto-loading feature is useful for supplying application-specific
24548 debugging commands and features.
24550 Auto-loading can be enabled or disabled,
24551 and the list of auto-loaded scripts can be printed.
24552 See the @samp{auto-loading} section of each extension language
24553 for more information.
24554 For @value{GDBN} command files see @ref{Auto-loading sequences}.
24555 For Python files see @ref{Python Auto-loading}.
24557 Note that loading of this script file also requires accordingly configured
24558 @code{auto-load safe-path} (@pxref{Auto-loading safe path}).
24560 @node objfile-gdbdotext file
24561 @subsection The @file{@var{objfile}-gdb.@var{ext}} file
24562 @cindex @file{@var{objfile}-gdb.gdb}
24563 @cindex @file{@var{objfile}-gdb.py}
24564 @cindex @file{@var{objfile}-gdb.scm}
24566 When a new object file is read, @value{GDBN} looks for a file named
24567 @file{@var{objfile}-gdb.@var{ext}} (we call it @var{script-name} below),
24568 where @var{objfile} is the object file's name and
24569 where @var{ext} is the file extension for the extension language:
24572 @item @file{@var{objfile}-gdb.gdb}
24573 GDB's own command language
24574 @item @file{@var{objfile}-gdb.py}
24576 @item @file{@var{objfile}-gdb.scm}
24580 @var{script-name} is formed by ensuring that the file name of @var{objfile}
24581 is absolute, following all symlinks, and resolving @code{.} and @code{..}
24582 components, and appending the @file{-gdb.@var{ext}} suffix.
24583 If this file exists and is readable, @value{GDBN} will evaluate it as a
24584 script in the specified extension language.
24586 If this file does not exist, then @value{GDBN} will look for
24587 @var{script-name} file in all of the directories as specified below.
24589 Note that loading of these files requires an accordingly configured
24590 @code{auto-load safe-path} (@pxref{Auto-loading safe path}).
24592 For object files using @file{.exe} suffix @value{GDBN} tries to load first the
24593 scripts normally according to its @file{.exe} filename. But if no scripts are
24594 found @value{GDBN} also tries script filenames matching the object file without
24595 its @file{.exe} suffix. This @file{.exe} stripping is case insensitive and it
24596 is attempted on any platform. This makes the script filenames compatible
24597 between Unix and MS-Windows hosts.
24600 @anchor{set auto-load scripts-directory}
24601 @kindex set auto-load scripts-directory
24602 @item set auto-load scripts-directory @r{[}@var{directories}@r{]}
24603 Control @value{GDBN} auto-loaded scripts location. Multiple directory entries
24604 may be delimited by the host platform path separator in use
24605 (@samp{:} on Unix, @samp{;} on MS-Windows and MS-DOS).
24607 Each entry here needs to be covered also by the security setting
24608 @code{set auto-load safe-path} (@pxref{set auto-load safe-path}).
24610 @anchor{with-auto-load-dir}
24611 This variable defaults to @file{$debugdir:$datadir/auto-load}. The default
24612 @code{set auto-load safe-path} value can be also overriden by @value{GDBN}
24613 configuration option @option{--with-auto-load-dir}.
24615 Any reference to @file{$debugdir} will get replaced by
24616 @var{debug-file-directory} value (@pxref{Separate Debug Files}) and any
24617 reference to @file{$datadir} will get replaced by @var{data-directory} which is
24618 determined at @value{GDBN} startup (@pxref{Data Files}). @file{$debugdir} and
24619 @file{$datadir} must be placed as a directory component --- either alone or
24620 delimited by @file{/} or @file{\} directory separators, depending on the host
24623 The list of directories uses path separator (@samp{:} on GNU and Unix
24624 systems, @samp{;} on MS-Windows and MS-DOS) to separate directories, similarly
24625 to the @env{PATH} environment variable.
24627 @anchor{show auto-load scripts-directory}
24628 @kindex show auto-load scripts-directory
24629 @item show auto-load scripts-directory
24630 Show @value{GDBN} auto-loaded scripts location.
24632 @anchor{add-auto-load-scripts-directory}
24633 @kindex add-auto-load-scripts-directory
24634 @item add-auto-load-scripts-directory @r{[}@var{directories}@dots{}@r{]}
24635 Add an entry (or list of entries) to the list of auto-loaded scripts locations.
24636 Multiple entries may be delimited by the host platform path separator in use.
24639 @value{GDBN} does not track which files it has already auto-loaded this way.
24640 @value{GDBN} will load the associated script every time the corresponding
24641 @var{objfile} is opened.
24642 So your @file{-gdb.@var{ext}} file should be careful to avoid errors if it
24643 is evaluated more than once.
24645 @node dotdebug_gdb_scripts section
24646 @subsection The @code{.debug_gdb_scripts} section
24647 @cindex @code{.debug_gdb_scripts} section
24649 For systems using file formats like ELF and COFF,
24650 when @value{GDBN} loads a new object file
24651 it will look for a special section named @code{.debug_gdb_scripts}.
24652 If this section exists, its contents is a list of null-terminated entries
24653 specifying scripts to load. Each entry begins with a non-null prefix byte that
24654 specifies the kind of entry, typically the extension language and whether the
24655 script is in a file or inlined in @code{.debug_gdb_scripts}.
24657 The following entries are supported:
24660 @item SECTION_SCRIPT_ID_PYTHON_FILE = 1
24661 @item SECTION_SCRIPT_ID_SCHEME_FILE = 3
24662 @item SECTION_SCRIPT_ID_PYTHON_TEXT = 4
24663 @item SECTION_SCRIPT_ID_SCHEME_TEXT = 6
24666 @subsubsection Script File Entries
24668 If the entry specifies a file, @value{GDBN} will look for the file first
24669 in the current directory and then along the source search path
24670 (@pxref{Source Path, ,Specifying Source Directories}),
24671 except that @file{$cdir} is not searched, since the compilation
24672 directory is not relevant to scripts.
24674 File entries can be placed in section @code{.debug_gdb_scripts} with,
24675 for example, this GCC macro for Python scripts.
24678 /* Note: The "MS" section flags are to remove duplicates. */
24679 #define DEFINE_GDB_PY_SCRIPT(script_name) \
24681 .pushsection \".debug_gdb_scripts\", \"MS\",@@progbits,1\n\
24682 .byte 1 /* Python */\n\
24683 .asciz \"" script_name "\"\n\
24689 For Guile scripts, replace @code{.byte 1} with @code{.byte 3}.
24690 Then one can reference the macro in a header or source file like this:
24693 DEFINE_GDB_PY_SCRIPT ("my-app-scripts.py")
24696 The script name may include directories if desired.
24698 Note that loading of this script file also requires accordingly configured
24699 @code{auto-load safe-path} (@pxref{Auto-loading safe path}).
24701 If the macro invocation is put in a header, any application or library
24702 using this header will get a reference to the specified script,
24703 and with the use of @code{"MS"} attributes on the section, the linker
24704 will remove duplicates.
24706 @subsubsection Script Text Entries
24708 Script text entries allow to put the executable script in the entry
24709 itself instead of loading it from a file.
24710 The first line of the entry, everything after the prefix byte and up to
24711 the first newline (@code{0xa}) character, is the script name, and must not
24712 contain any kind of space character, e.g., spaces or tabs.
24713 The rest of the entry, up to the trailing null byte, is the script to
24714 execute in the specified language. The name needs to be unique among
24715 all script names, as @value{GDBN} executes each script only once based
24718 Here is an example from file @file{py-section-script.c} in the @value{GDBN}
24722 #include "symcat.h"
24723 #include "gdb/section-scripts.h"
24725 ".pushsection \".debug_gdb_scripts\", \"MS\",@@progbits,1\n"
24726 ".byte " XSTRING (SECTION_SCRIPT_ID_PYTHON_TEXT) "\n"
24727 ".ascii \"gdb.inlined-script\\n\"\n"
24728 ".ascii \"class test_cmd (gdb.Command):\\n\"\n"
24729 ".ascii \" def __init__ (self):\\n\"\n"
24730 ".ascii \" super (test_cmd, self).__init__ ("
24731 "\\\"test-cmd\\\", gdb.COMMAND_OBSCURE)\\n\"\n"
24732 ".ascii \" def invoke (self, arg, from_tty):\\n\"\n"
24733 ".ascii \" print (\\\"test-cmd output, arg = %s\\\" % arg)\\n\"\n"
24734 ".ascii \"test_cmd ()\\n\"\n"
24740 Loading of inlined scripts requires a properly configured
24741 @code{auto-load safe-path} (@pxref{Auto-loading safe path}).
24742 The path to specify in @code{auto-load safe-path} is the path of the file
24743 containing the @code{.debug_gdb_scripts} section.
24745 @node Which flavor to choose?
24746 @subsection Which flavor to choose?
24748 Given the multiple ways of auto-loading extensions, it might not always
24749 be clear which one to choose. This section provides some guidance.
24752 Benefits of the @file{-gdb.@var{ext}} way:
24756 Can be used with file formats that don't support multiple sections.
24759 Ease of finding scripts for public libraries.
24761 Scripts specified in the @code{.debug_gdb_scripts} section are searched for
24762 in the source search path.
24763 For publicly installed libraries, e.g., @file{libstdc++}, there typically
24764 isn't a source directory in which to find the script.
24767 Doesn't require source code additions.
24771 Benefits of the @code{.debug_gdb_scripts} way:
24775 Works with static linking.
24777 Scripts for libraries done the @file{-gdb.@var{ext}} way require an objfile to
24778 trigger their loading. When an application is statically linked the only
24779 objfile available is the executable, and it is cumbersome to attach all the
24780 scripts from all the input libraries to the executable's
24781 @file{-gdb.@var{ext}} script.
24784 Works with classes that are entirely inlined.
24786 Some classes can be entirely inlined, and thus there may not be an associated
24787 shared library to attach a @file{-gdb.@var{ext}} script to.
24790 Scripts needn't be copied out of the source tree.
24792 In some circumstances, apps can be built out of large collections of internal
24793 libraries, and the build infrastructure necessary to install the
24794 @file{-gdb.@var{ext}} scripts in a place where @value{GDBN} can find them is
24795 cumbersome. It may be easier to specify the scripts in the
24796 @code{.debug_gdb_scripts} section as relative paths, and add a path to the
24797 top of the source tree to the source search path.
24800 @node Multiple Extension Languages
24801 @section Multiple Extension Languages
24803 The Guile and Python extension languages do not share any state,
24804 and generally do not interfere with each other.
24805 There are some things to be aware of, however.
24807 @subsection Python comes first
24809 Python was @value{GDBN}'s first extension language, and to avoid breaking
24810 existing behaviour Python comes first. This is generally solved by the
24811 ``first one wins'' principle. @value{GDBN} maintains a list of enabled
24812 extension languages, and when it makes a call to an extension language,
24813 (say to pretty-print a value), it tries each in turn until an extension
24814 language indicates it has performed the request (e.g., has returned the
24815 pretty-printed form of a value).
24816 This extends to errors while performing such requests: If an error happens
24817 while, for example, trying to pretty-print an object then the error is
24818 reported and any following extension languages are not tried.
24821 @section Creating new spellings of existing commands
24822 @cindex aliases for commands
24824 It is often useful to define alternate spellings of existing commands.
24825 For example, if a new @value{GDBN} command defined in Python has
24826 a long name to type, it is handy to have an abbreviated version of it
24827 that involves less typing.
24829 @value{GDBN} itself uses aliases. For example @samp{s} is an alias
24830 of the @samp{step} command even though it is otherwise an ambiguous
24831 abbreviation of other commands like @samp{set} and @samp{show}.
24833 Aliases are also used to provide shortened or more common versions
24834 of multi-word commands. For example, @value{GDBN} provides the
24835 @samp{tty} alias of the @samp{set inferior-tty} command.
24837 You can define a new alias with the @samp{alias} command.
24842 @item alias [-a] [--] @var{ALIAS} = @var{COMMAND}
24846 @var{ALIAS} specifies the name of the new alias.
24847 Each word of @var{ALIAS} must consist of letters, numbers, dashes and
24850 @var{COMMAND} specifies the name of an existing command
24851 that is being aliased.
24853 The @samp{-a} option specifies that the new alias is an abbreviation
24854 of the command. Abbreviations are not shown in command
24855 lists displayed by the @samp{help} command.
24857 The @samp{--} option specifies the end of options,
24858 and is useful when @var{ALIAS} begins with a dash.
24860 Here is a simple example showing how to make an abbreviation
24861 of a command so that there is less to type.
24862 Suppose you were tired of typing @samp{disas}, the current
24863 shortest unambiguous abbreviation of the @samp{disassemble} command
24864 and you wanted an even shorter version named @samp{di}.
24865 The following will accomplish this.
24868 (gdb) alias -a di = disas
24871 Note that aliases are different from user-defined commands.
24872 With a user-defined command, you also need to write documentation
24873 for it with the @samp{document} command.
24874 An alias automatically picks up the documentation of the existing command.
24876 Here is an example where we make @samp{elms} an abbreviation of
24877 @samp{elements} in the @samp{set print elements} command.
24878 This is to show that you can make an abbreviation of any part
24882 (gdb) alias -a set print elms = set print elements
24883 (gdb) alias -a show print elms = show print elements
24884 (gdb) set p elms 20
24886 Limit on string chars or array elements to print is 200.
24889 Note that if you are defining an alias of a @samp{set} command,
24890 and you want to have an alias for the corresponding @samp{show}
24891 command, then you need to define the latter separately.
24893 Unambiguously abbreviated commands are allowed in @var{COMMAND} and
24894 @var{ALIAS}, just as they are normally.
24897 (gdb) alias -a set pr elms = set p ele
24900 Finally, here is an example showing the creation of a one word
24901 alias for a more complex command.
24902 This creates alias @samp{spe} of the command @samp{set print elements}.
24905 (gdb) alias spe = set print elements
24910 @chapter Command Interpreters
24911 @cindex command interpreters
24913 @value{GDBN} supports multiple command interpreters, and some command
24914 infrastructure to allow users or user interface writers to switch
24915 between interpreters or run commands in other interpreters.
24917 @value{GDBN} currently supports two command interpreters, the console
24918 interpreter (sometimes called the command-line interpreter or @sc{cli})
24919 and the machine interface interpreter (or @sc{gdb/mi}). This manual
24920 describes both of these interfaces in great detail.
24922 By default, @value{GDBN} will start with the console interpreter.
24923 However, the user may choose to start @value{GDBN} with another
24924 interpreter by specifying the @option{-i} or @option{--interpreter}
24925 startup options. Defined interpreters include:
24929 @cindex console interpreter
24930 The traditional console or command-line interpreter. This is the most often
24931 used interpreter with @value{GDBN}. With no interpreter specified at runtime,
24932 @value{GDBN} will use this interpreter.
24935 @cindex mi interpreter
24936 The newest @sc{gdb/mi} interface (currently @code{mi2}). Used primarily
24937 by programs wishing to use @value{GDBN} as a backend for a debugger GUI
24938 or an IDE. For more information, see @ref{GDB/MI, ,The @sc{gdb/mi}
24942 @cindex mi2 interpreter
24943 The current @sc{gdb/mi} interface.
24946 @cindex mi1 interpreter
24947 The @sc{gdb/mi} interface included in @value{GDBN} 5.1, 5.2, and 5.3.
24951 @cindex invoke another interpreter
24952 The interpreter being used by @value{GDBN} may not be dynamically
24953 switched at runtime. Although possible, this could lead to a very
24954 precarious situation. Consider an IDE using @sc{gdb/mi}. If a user
24955 enters the command "interpreter-set console" in a console view,
24956 @value{GDBN} would switch to using the console interpreter, rendering
24957 the IDE inoperable!
24959 @kindex interpreter-exec
24960 Although you may only choose a single interpreter at startup, you may execute
24961 commands in any interpreter from the current interpreter using the appropriate
24962 command. If you are running the console interpreter, simply use the
24963 @code{interpreter-exec} command:
24966 interpreter-exec mi "-data-list-register-names"
24969 @sc{gdb/mi} has a similar command, although it is only available in versions of
24970 @value{GDBN} which support @sc{gdb/mi} version 2 (or greater).
24973 @chapter @value{GDBN} Text User Interface
24975 @cindex Text User Interface
24978 * TUI Overview:: TUI overview
24979 * TUI Keys:: TUI key bindings
24980 * TUI Single Key Mode:: TUI single key mode
24981 * TUI Commands:: TUI-specific commands
24982 * TUI Configuration:: TUI configuration variables
24985 The @value{GDBN} Text User Interface (TUI) is a terminal
24986 interface which uses the @code{curses} library to show the source
24987 file, the assembly output, the program registers and @value{GDBN}
24988 commands in separate text windows. The TUI mode is supported only
24989 on platforms where a suitable version of the @code{curses} library
24992 The TUI mode is enabled by default when you invoke @value{GDBN} as
24993 @samp{@value{GDBP} -tui}.
24994 You can also switch in and out of TUI mode while @value{GDBN} runs by
24995 using various TUI commands and key bindings, such as @command{tui
24996 enable} or @kbd{C-x C-a}. @xref{TUI Commands, ,TUI Commands}, and
24997 @ref{TUI Keys, ,TUI Key Bindings}.
25000 @section TUI Overview
25002 In TUI mode, @value{GDBN} can display several text windows:
25006 This window is the @value{GDBN} command window with the @value{GDBN}
25007 prompt and the @value{GDBN} output. The @value{GDBN} input is still
25008 managed using readline.
25011 The source window shows the source file of the program. The current
25012 line and active breakpoints are displayed in this window.
25015 The assembly window shows the disassembly output of the program.
25018 This window shows the processor registers. Registers are highlighted
25019 when their values change.
25022 The source and assembly windows show the current program position
25023 by highlighting the current line and marking it with a @samp{>} marker.
25024 Breakpoints are indicated with two markers. The first marker
25025 indicates the breakpoint type:
25029 Breakpoint which was hit at least once.
25032 Breakpoint which was never hit.
25035 Hardware breakpoint which was hit at least once.
25038 Hardware breakpoint which was never hit.
25041 The second marker indicates whether the breakpoint is enabled or not:
25045 Breakpoint is enabled.
25048 Breakpoint is disabled.
25051 The source, assembly and register windows are updated when the current
25052 thread changes, when the frame changes, or when the program counter
25055 These windows are not all visible at the same time. The command
25056 window is always visible. The others can be arranged in several
25067 source and assembly,
25070 source and registers, or
25073 assembly and registers.
25076 A status line above the command window shows the following information:
25080 Indicates the current @value{GDBN} target.
25081 (@pxref{Targets, ,Specifying a Debugging Target}).
25084 Gives the current process or thread number.
25085 When no process is being debugged, this field is set to @code{No process}.
25088 Gives the current function name for the selected frame.
25089 The name is demangled if demangling is turned on (@pxref{Print Settings}).
25090 When there is no symbol corresponding to the current program counter,
25091 the string @code{??} is displayed.
25094 Indicates the current line number for the selected frame.
25095 When the current line number is not known, the string @code{??} is displayed.
25098 Indicates the current program counter address.
25102 @section TUI Key Bindings
25103 @cindex TUI key bindings
25105 The TUI installs several key bindings in the readline keymaps
25106 @ifset SYSTEM_READLINE
25107 (@pxref{Command Line Editing, , , rluserman, GNU Readline Library}).
25109 @ifclear SYSTEM_READLINE
25110 (@pxref{Command Line Editing}).
25112 The following key bindings are installed for both TUI mode and the
25113 @value{GDBN} standard mode.
25122 Enter or leave the TUI mode. When leaving the TUI mode,
25123 the curses window management stops and @value{GDBN} operates using
25124 its standard mode, writing on the terminal directly. When reentering
25125 the TUI mode, control is given back to the curses windows.
25126 The screen is then refreshed.
25130 Use a TUI layout with only one window. The layout will
25131 either be @samp{source} or @samp{assembly}. When the TUI mode
25132 is not active, it will switch to the TUI mode.
25134 Think of this key binding as the Emacs @kbd{C-x 1} binding.
25138 Use a TUI layout with at least two windows. When the current
25139 layout already has two windows, the next layout with two windows is used.
25140 When a new layout is chosen, one window will always be common to the
25141 previous layout and the new one.
25143 Think of it as the Emacs @kbd{C-x 2} binding.
25147 Change the active window. The TUI associates several key bindings
25148 (like scrolling and arrow keys) with the active window. This command
25149 gives the focus to the next TUI window.
25151 Think of it as the Emacs @kbd{C-x o} binding.
25155 Switch in and out of the TUI SingleKey mode that binds single
25156 keys to @value{GDBN} commands (@pxref{TUI Single Key Mode}).
25159 The following key bindings only work in the TUI mode:
25164 Scroll the active window one page up.
25168 Scroll the active window one page down.
25172 Scroll the active window one line up.
25176 Scroll the active window one line down.
25180 Scroll the active window one column left.
25184 Scroll the active window one column right.
25188 Refresh the screen.
25191 Because the arrow keys scroll the active window in the TUI mode, they
25192 are not available for their normal use by readline unless the command
25193 window has the focus. When another window is active, you must use
25194 other readline key bindings such as @kbd{C-p}, @kbd{C-n}, @kbd{C-b}
25195 and @kbd{C-f} to control the command window.
25197 @node TUI Single Key Mode
25198 @section TUI Single Key Mode
25199 @cindex TUI single key mode
25201 The TUI also provides a @dfn{SingleKey} mode, which binds several
25202 frequently used @value{GDBN} commands to single keys. Type @kbd{C-x s} to
25203 switch into this mode, where the following key bindings are used:
25206 @kindex c @r{(SingleKey TUI key)}
25210 @kindex d @r{(SingleKey TUI key)}
25214 @kindex f @r{(SingleKey TUI key)}
25218 @kindex n @r{(SingleKey TUI key)}
25222 @kindex q @r{(SingleKey TUI key)}
25224 exit the SingleKey mode.
25226 @kindex r @r{(SingleKey TUI key)}
25230 @kindex s @r{(SingleKey TUI key)}
25234 @kindex u @r{(SingleKey TUI key)}
25238 @kindex v @r{(SingleKey TUI key)}
25242 @kindex w @r{(SingleKey TUI key)}
25247 Other keys temporarily switch to the @value{GDBN} command prompt.
25248 The key that was pressed is inserted in the editing buffer so that
25249 it is possible to type most @value{GDBN} commands without interaction
25250 with the TUI SingleKey mode. Once the command is entered the TUI
25251 SingleKey mode is restored. The only way to permanently leave
25252 this mode is by typing @kbd{q} or @kbd{C-x s}.
25256 @section TUI-specific Commands
25257 @cindex TUI commands
25259 The TUI has specific commands to control the text windows.
25260 These commands are always available, even when @value{GDBN} is not in
25261 the TUI mode. When @value{GDBN} is in the standard mode, most
25262 of these commands will automatically switch to the TUI mode.
25264 Note that if @value{GDBN}'s @code{stdout} is not connected to a
25265 terminal, or @value{GDBN} has been started with the machine interface
25266 interpreter (@pxref{GDB/MI, ,The @sc{gdb/mi} Interface}), most of
25267 these commands will fail with an error, because it would not be
25268 possible or desirable to enable curses window management.
25273 Activate TUI mode. The last active TUI window layout will be used if
25274 TUI mode has prevsiouly been used in the current debugging session,
25275 otherwise a default layout is used.
25278 @kindex tui disable
25279 Disable TUI mode, returning to the console interpreter.
25283 List and give the size of all displayed windows.
25285 @item layout @var{name}
25287 Changes which TUI windows are displayed. In each layout the command
25288 window is always displayed, the @var{name} parameter controls which
25289 additional windows are displayed, and can be any of the following:
25293 Display the next layout.
25296 Display the previous layout.
25299 Display the source and command windows.
25302 Display the assembly and command windows.
25305 Display the source, assembly, and command windows.
25308 When in @code{src} layout display the register, source, and command
25309 windows. When in @code{asm} or @code{split} layout display the
25310 register, assembler, and command windows.
25313 @item focus @var{name}
25315 Changes which TUI window is currently active for scrolling. The
25316 @var{name} parameter can be any of the following:
25320 Make the next window active for scrolling.
25323 Make the previous window active for scrolling.
25326 Make the source window active for scrolling.
25329 Make the assembly window active for scrolling.
25332 Make the register window active for scrolling.
25335 Make the command window active for scrolling.
25340 Refresh the screen. This is similar to typing @kbd{C-L}.
25342 @item tui reg @var{group}
25344 Changes the register group displayed in the tui register window to
25345 @var{group}. If the register window is not currently displayed this
25346 command will cause the register window to be displayed. The list of
25347 register groups, as well as their order is target specific. The
25348 following groups are available on most targets:
25351 Repeatedly selecting this group will cause the display to cycle
25352 through all of the available register groups.
25355 Repeatedly selecting this group will cause the display to cycle
25356 through all of the available register groups in the reverse order to
25360 Display the general registers.
25362 Display the floating point registers.
25364 Display the system registers.
25366 Display the vector registers.
25368 Display all registers.
25373 Update the source window and the current execution point.
25375 @item winheight @var{name} +@var{count}
25376 @itemx winheight @var{name} -@var{count}
25378 Change the height of the window @var{name} by @var{count}
25379 lines. Positive counts increase the height, while negative counts
25380 decrease it. The @var{name} parameter can be one of @code{src} (the
25381 source window), @code{cmd} (the command window), @code{asm} (the
25382 disassembly window), or @code{regs} (the register display window).
25384 @item tabset @var{nchars}
25386 Set the width of tab stops to be @var{nchars} characters. This
25387 setting affects the display of TAB characters in the source and
25391 @node TUI Configuration
25392 @section TUI Configuration Variables
25393 @cindex TUI configuration variables
25395 Several configuration variables control the appearance of TUI windows.
25398 @item set tui border-kind @var{kind}
25399 @kindex set tui border-kind
25400 Select the border appearance for the source, assembly and register windows.
25401 The possible values are the following:
25404 Use a space character to draw the border.
25407 Use @sc{ascii} characters @samp{+}, @samp{-} and @samp{|} to draw the border.
25410 Use the Alternate Character Set to draw the border. The border is
25411 drawn using character line graphics if the terminal supports them.
25414 @item set tui border-mode @var{mode}
25415 @kindex set tui border-mode
25416 @itemx set tui active-border-mode @var{mode}
25417 @kindex set tui active-border-mode
25418 Select the display attributes for the borders of the inactive windows
25419 or the active window. The @var{mode} can be one of the following:
25422 Use normal attributes to display the border.
25428 Use reverse video mode.
25431 Use half bright mode.
25433 @item half-standout
25434 Use half bright and standout mode.
25437 Use extra bright or bold mode.
25439 @item bold-standout
25440 Use extra bright or bold and standout mode.
25445 @chapter Using @value{GDBN} under @sc{gnu} Emacs
25448 @cindex @sc{gnu} Emacs
25449 A special interface allows you to use @sc{gnu} Emacs to view (and
25450 edit) the source files for the program you are debugging with
25453 To use this interface, use the command @kbd{M-x gdb} in Emacs. Give the
25454 executable file you want to debug as an argument. This command starts
25455 @value{GDBN} as a subprocess of Emacs, with input and output through a newly
25456 created Emacs buffer.
25457 @c (Do not use the @code{-tui} option to run @value{GDBN} from Emacs.)
25459 Running @value{GDBN} under Emacs can be just like running @value{GDBN} normally except for two
25464 All ``terminal'' input and output goes through an Emacs buffer, called
25467 This applies both to @value{GDBN} commands and their output, and to the input
25468 and output done by the program you are debugging.
25470 This is useful because it means that you can copy the text of previous
25471 commands and input them again; you can even use parts of the output
25474 All the facilities of Emacs' Shell mode are available for interacting
25475 with your program. In particular, you can send signals the usual
25476 way---for example, @kbd{C-c C-c} for an interrupt, @kbd{C-c C-z} for a
25480 @value{GDBN} displays source code through Emacs.
25482 Each time @value{GDBN} displays a stack frame, Emacs automatically finds the
25483 source file for that frame and puts an arrow (@samp{=>}) at the
25484 left margin of the current line. Emacs uses a separate buffer for
25485 source display, and splits the screen to show both your @value{GDBN} session
25488 Explicit @value{GDBN} @code{list} or search commands still produce output as
25489 usual, but you probably have no reason to use them from Emacs.
25492 We call this @dfn{text command mode}. Emacs 22.1, and later, also uses
25493 a graphical mode, enabled by default, which provides further buffers
25494 that can control the execution and describe the state of your program.
25495 @xref{GDB Graphical Interface,,, Emacs, The @sc{gnu} Emacs Manual}.
25497 If you specify an absolute file name when prompted for the @kbd{M-x
25498 gdb} argument, then Emacs sets your current working directory to where
25499 your program resides. If you only specify the file name, then Emacs
25500 sets your current working directory to the directory associated
25501 with the previous buffer. In this case, @value{GDBN} may find your
25502 program by searching your environment's @code{PATH} variable, but on
25503 some operating systems it might not find the source. So, although the
25504 @value{GDBN} input and output session proceeds normally, the auxiliary
25505 buffer does not display the current source and line of execution.
25507 The initial working directory of @value{GDBN} is printed on the top
25508 line of the GUD buffer and this serves as a default for the commands
25509 that specify files for @value{GDBN} to operate on. @xref{Files,
25510 ,Commands to Specify Files}.
25512 By default, @kbd{M-x gdb} calls the program called @file{gdb}. If you
25513 need to call @value{GDBN} by a different name (for example, if you
25514 keep several configurations around, with different names) you can
25515 customize the Emacs variable @code{gud-gdb-command-name} to run the
25518 In the GUD buffer, you can use these special Emacs commands in
25519 addition to the standard Shell mode commands:
25523 Describe the features of Emacs' GUD Mode.
25526 Execute to another source line, like the @value{GDBN} @code{step} command; also
25527 update the display window to show the current file and location.
25530 Execute to next source line in this function, skipping all function
25531 calls, like the @value{GDBN} @code{next} command. Then update the display window
25532 to show the current file and location.
25535 Execute one instruction, like the @value{GDBN} @code{stepi} command; update
25536 display window accordingly.
25539 Execute until exit from the selected stack frame, like the @value{GDBN}
25540 @code{finish} command.
25543 Continue execution of your program, like the @value{GDBN} @code{continue}
25547 Go up the number of frames indicated by the numeric argument
25548 (@pxref{Arguments, , Numeric Arguments, Emacs, The @sc{gnu} Emacs Manual}),
25549 like the @value{GDBN} @code{up} command.
25552 Go down the number of frames indicated by the numeric argument, like the
25553 @value{GDBN} @code{down} command.
25556 In any source file, the Emacs command @kbd{C-x @key{SPC}} (@code{gud-break})
25557 tells @value{GDBN} to set a breakpoint on the source line point is on.
25559 In text command mode, if you type @kbd{M-x speedbar}, Emacs displays a
25560 separate frame which shows a backtrace when the GUD buffer is current.
25561 Move point to any frame in the stack and type @key{RET} to make it
25562 become the current frame and display the associated source in the
25563 source buffer. Alternatively, click @kbd{Mouse-2} to make the
25564 selected frame become the current one. In graphical mode, the
25565 speedbar displays watch expressions.
25567 If you accidentally delete the source-display buffer, an easy way to get
25568 it back is to type the command @code{f} in the @value{GDBN} buffer, to
25569 request a frame display; when you run under Emacs, this recreates
25570 the source buffer if necessary to show you the context of the current
25573 The source files displayed in Emacs are in ordinary Emacs buffers
25574 which are visiting the source files in the usual way. You can edit
25575 the files with these buffers if you wish; but keep in mind that @value{GDBN}
25576 communicates with Emacs in terms of line numbers. If you add or
25577 delete lines from the text, the line numbers that @value{GDBN} knows cease
25578 to correspond properly with the code.
25580 A more detailed description of Emacs' interaction with @value{GDBN} is
25581 given in the Emacs manual (@pxref{Debuggers,,, Emacs, The @sc{gnu}
25585 @chapter The @sc{gdb/mi} Interface
25587 @unnumberedsec Function and Purpose
25589 @cindex @sc{gdb/mi}, its purpose
25590 @sc{gdb/mi} is a line based machine oriented text interface to
25591 @value{GDBN} and is activated by specifying using the
25592 @option{--interpreter} command line option (@pxref{Mode Options}). It
25593 is specifically intended to support the development of systems which
25594 use the debugger as just one small component of a larger system.
25596 This chapter is a specification of the @sc{gdb/mi} interface. It is written
25597 in the form of a reference manual.
25599 Note that @sc{gdb/mi} is still under construction, so some of the
25600 features described below are incomplete and subject to change
25601 (@pxref{GDB/MI Development and Front Ends, , @sc{gdb/mi} Development and Front Ends}).
25603 @unnumberedsec Notation and Terminology
25605 @cindex notational conventions, for @sc{gdb/mi}
25606 This chapter uses the following notation:
25610 @code{|} separates two alternatives.
25613 @code{[ @var{something} ]} indicates that @var{something} is optional:
25614 it may or may not be given.
25617 @code{( @var{group} )*} means that @var{group} inside the parentheses
25618 may repeat zero or more times.
25621 @code{( @var{group} )+} means that @var{group} inside the parentheses
25622 may repeat one or more times.
25625 @code{"@var{string}"} means a literal @var{string}.
25629 @heading Dependencies
25633 * GDB/MI General Design::
25634 * GDB/MI Command Syntax::
25635 * GDB/MI Compatibility with CLI::
25636 * GDB/MI Development and Front Ends::
25637 * GDB/MI Output Records::
25638 * GDB/MI Simple Examples::
25639 * GDB/MI Command Description Format::
25640 * GDB/MI Breakpoint Commands::
25641 * GDB/MI Catchpoint Commands::
25642 * GDB/MI Program Context::
25643 * GDB/MI Thread Commands::
25644 * GDB/MI Ada Tasking Commands::
25645 * GDB/MI Program Execution::
25646 * GDB/MI Stack Manipulation::
25647 * GDB/MI Variable Objects::
25648 * GDB/MI Data Manipulation::
25649 * GDB/MI Tracepoint Commands::
25650 * GDB/MI Symbol Query::
25651 * GDB/MI File Commands::
25653 * GDB/MI Kod Commands::
25654 * GDB/MI Memory Overlay Commands::
25655 * GDB/MI Signal Handling Commands::
25657 * GDB/MI Target Manipulation::
25658 * GDB/MI File Transfer Commands::
25659 * GDB/MI Ada Exceptions Commands::
25660 * GDB/MI Support Commands::
25661 * GDB/MI Miscellaneous Commands::
25664 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
25665 @node GDB/MI General Design
25666 @section @sc{gdb/mi} General Design
25667 @cindex GDB/MI General Design
25669 Interaction of a @sc{GDB/MI} frontend with @value{GDBN} involves three
25670 parts---commands sent to @value{GDBN}, responses to those commands
25671 and notifications. Each command results in exactly one response,
25672 indicating either successful completion of the command, or an error.
25673 For the commands that do not resume the target, the response contains the
25674 requested information. For the commands that resume the target, the
25675 response only indicates whether the target was successfully resumed.
25676 Notifications is the mechanism for reporting changes in the state of the
25677 target, or in @value{GDBN} state, that cannot conveniently be associated with
25678 a command and reported as part of that command response.
25680 The important examples of notifications are:
25684 Exec notifications. These are used to report changes in
25685 target state---when a target is resumed, or stopped. It would not
25686 be feasible to include this information in response of resuming
25687 commands, because one resume commands can result in multiple events in
25688 different threads. Also, quite some time may pass before any event
25689 happens in the target, while a frontend needs to know whether the resuming
25690 command itself was successfully executed.
25693 Console output, and status notifications. Console output
25694 notifications are used to report output of CLI commands, as well as
25695 diagnostics for other commands. Status notifications are used to
25696 report the progress of a long-running operation. Naturally, including
25697 this information in command response would mean no output is produced
25698 until the command is finished, which is undesirable.
25701 General notifications. Commands may have various side effects on
25702 the @value{GDBN} or target state beyond their official purpose. For example,
25703 a command may change the selected thread. Although such changes can
25704 be included in command response, using notification allows for more
25705 orthogonal frontend design.
25709 There's no guarantee that whenever an MI command reports an error,
25710 @value{GDBN} or the target are in any specific state, and especially,
25711 the state is not reverted to the state before the MI command was
25712 processed. Therefore, whenever an MI command results in an error,
25713 we recommend that the frontend refreshes all the information shown in
25714 the user interface.
25718 * Context management::
25719 * Asynchronous and non-stop modes::
25723 @node Context management
25724 @subsection Context management
25726 @subsubsection Threads and Frames
25728 In most cases when @value{GDBN} accesses the target, this access is
25729 done in context of a specific thread and frame (@pxref{Frames}).
25730 Often, even when accessing global data, the target requires that a thread
25731 be specified. The CLI interface maintains the selected thread and frame,
25732 and supplies them to target on each command. This is convenient,
25733 because a command line user would not want to specify that information
25734 explicitly on each command, and because user interacts with
25735 @value{GDBN} via a single terminal, so no confusion is possible as
25736 to what thread and frame are the current ones.
25738 In the case of MI, the concept of selected thread and frame is less
25739 useful. First, a frontend can easily remember this information
25740 itself. Second, a graphical frontend can have more than one window,
25741 each one used for debugging a different thread, and the frontend might
25742 want to access additional threads for internal purposes. This
25743 increases the risk that by relying on implicitly selected thread, the
25744 frontend may be operating on a wrong one. Therefore, each MI command
25745 should explicitly specify which thread and frame to operate on. To
25746 make it possible, each MI command accepts the @samp{--thread} and
25747 @samp{--frame} options, the value to each is @value{GDBN} global
25748 identifier for thread and frame to operate on.
25750 Usually, each top-level window in a frontend allows the user to select
25751 a thread and a frame, and remembers the user selection for further
25752 operations. However, in some cases @value{GDBN} may suggest that the
25753 current thread be changed. For example, when stopping on a breakpoint
25754 it is reasonable to switch to the thread where breakpoint is hit. For
25755 another example, if the user issues the CLI @samp{thread} command via
25756 the frontend, it is desirable to change the frontend's selected thread to the
25757 one specified by user. @value{GDBN} communicates the suggestion to
25758 change current thread using the @samp{=thread-selected} notification.
25759 No such notification is available for the selected frame at the moment.
25761 Note that historically, MI shares the selected thread with CLI, so
25762 frontends used the @code{-thread-select} to execute commands in the
25763 right context. However, getting this to work right is cumbersome. The
25764 simplest way is for frontend to emit @code{-thread-select} command
25765 before every command. This doubles the number of commands that need
25766 to be sent. The alternative approach is to suppress @code{-thread-select}
25767 if the selected thread in @value{GDBN} is supposed to be identical to the
25768 thread the frontend wants to operate on. However, getting this
25769 optimization right can be tricky. In particular, if the frontend
25770 sends several commands to @value{GDBN}, and one of the commands changes the
25771 selected thread, then the behaviour of subsequent commands will
25772 change. So, a frontend should either wait for response from such
25773 problematic commands, or explicitly add @code{-thread-select} for
25774 all subsequent commands. No frontend is known to do this exactly
25775 right, so it is suggested to just always pass the @samp{--thread} and
25776 @samp{--frame} options.
25778 @subsubsection Language
25780 The execution of several commands depends on which language is selected.
25781 By default, the current language (@pxref{show language}) is used.
25782 But for commands known to be language-sensitive, it is recommended
25783 to use the @samp{--language} option. This option takes one argument,
25784 which is the name of the language to use while executing the command.
25788 -data-evaluate-expression --language c "sizeof (void*)"
25793 The valid language names are the same names accepted by the
25794 @samp{set language} command (@pxref{Manually}), excluding @samp{auto},
25795 @samp{local} or @samp{unknown}.
25797 @node Asynchronous and non-stop modes
25798 @subsection Asynchronous command execution and non-stop mode
25800 On some targets, @value{GDBN} is capable of processing MI commands
25801 even while the target is running. This is called @dfn{asynchronous
25802 command execution} (@pxref{Background Execution}). The frontend may
25803 specify a preferrence for asynchronous execution using the
25804 @code{-gdb-set mi-async 1} command, which should be emitted before
25805 either running the executable or attaching to the target. After the
25806 frontend has started the executable or attached to the target, it can
25807 find if asynchronous execution is enabled using the
25808 @code{-list-target-features} command.
25811 @item -gdb-set mi-async on
25812 @item -gdb-set mi-async off
25813 Set whether MI is in asynchronous mode.
25815 When @code{off}, which is the default, MI execution commands (e.g.,
25816 @code{-exec-continue}) are foreground commands, and @value{GDBN} waits
25817 for the program to stop before processing further commands.
25819 When @code{on}, MI execution commands are background execution
25820 commands (e.g., @code{-exec-continue} becomes the equivalent of the
25821 @code{c&} CLI command), and so @value{GDBN} is capable of processing
25822 MI commands even while the target is running.
25824 @item -gdb-show mi-async
25825 Show whether MI asynchronous mode is enabled.
25828 Note: In @value{GDBN} version 7.7 and earlier, this option was called
25829 @code{target-async} instead of @code{mi-async}, and it had the effect
25830 of both putting MI in asynchronous mode and making CLI background
25831 commands possible. CLI background commands are now always possible
25832 ``out of the box'' if the target supports them. The old spelling is
25833 kept as a deprecated alias for backwards compatibility.
25835 Even if @value{GDBN} can accept a command while target is running,
25836 many commands that access the target do not work when the target is
25837 running. Therefore, asynchronous command execution is most useful
25838 when combined with non-stop mode (@pxref{Non-Stop Mode}). Then,
25839 it is possible to examine the state of one thread, while other threads
25842 When a given thread is running, MI commands that try to access the
25843 target in the context of that thread may not work, or may work only on
25844 some targets. In particular, commands that try to operate on thread's
25845 stack will not work, on any target. Commands that read memory, or
25846 modify breakpoints, may work or not work, depending on the target. Note
25847 that even commands that operate on global state, such as @code{print},
25848 @code{set}, and breakpoint commands, still access the target in the
25849 context of a specific thread, so frontend should try to find a
25850 stopped thread and perform the operation on that thread (using the
25851 @samp{--thread} option).
25853 Which commands will work in the context of a running thread is
25854 highly target dependent. However, the two commands
25855 @code{-exec-interrupt}, to stop a thread, and @code{-thread-info},
25856 to find the state of a thread, will always work.
25858 @node Thread groups
25859 @subsection Thread groups
25860 @value{GDBN} may be used to debug several processes at the same time.
25861 On some platfroms, @value{GDBN} may support debugging of several
25862 hardware systems, each one having several cores with several different
25863 processes running on each core. This section describes the MI
25864 mechanism to support such debugging scenarios.
25866 The key observation is that regardless of the structure of the
25867 target, MI can have a global list of threads, because most commands that
25868 accept the @samp{--thread} option do not need to know what process that
25869 thread belongs to. Therefore, it is not necessary to introduce
25870 neither additional @samp{--process} option, nor an notion of the
25871 current process in the MI interface. The only strictly new feature
25872 that is required is the ability to find how the threads are grouped
25875 To allow the user to discover such grouping, and to support arbitrary
25876 hierarchy of machines/cores/processes, MI introduces the concept of a
25877 @dfn{thread group}. Thread group is a collection of threads and other
25878 thread groups. A thread group always has a string identifier, a type,
25879 and may have additional attributes specific to the type. A new
25880 command, @code{-list-thread-groups}, returns the list of top-level
25881 thread groups, which correspond to processes that @value{GDBN} is
25882 debugging at the moment. By passing an identifier of a thread group
25883 to the @code{-list-thread-groups} command, it is possible to obtain
25884 the members of specific thread group.
25886 To allow the user to easily discover processes, and other objects, he
25887 wishes to debug, a concept of @dfn{available thread group} is
25888 introduced. Available thread group is an thread group that
25889 @value{GDBN} is not debugging, but that can be attached to, using the
25890 @code{-target-attach} command. The list of available top-level thread
25891 groups can be obtained using @samp{-list-thread-groups --available}.
25892 In general, the content of a thread group may be only retrieved only
25893 after attaching to that thread group.
25895 Thread groups are related to inferiors (@pxref{Inferiors and
25896 Programs}). Each inferior corresponds to a thread group of a special
25897 type @samp{process}, and some additional operations are permitted on
25898 such thread groups.
25900 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
25901 @node GDB/MI Command Syntax
25902 @section @sc{gdb/mi} Command Syntax
25905 * GDB/MI Input Syntax::
25906 * GDB/MI Output Syntax::
25909 @node GDB/MI Input Syntax
25910 @subsection @sc{gdb/mi} Input Syntax
25912 @cindex input syntax for @sc{gdb/mi}
25913 @cindex @sc{gdb/mi}, input syntax
25915 @item @var{command} @expansion{}
25916 @code{@var{cli-command} | @var{mi-command}}
25918 @item @var{cli-command} @expansion{}
25919 @code{[ @var{token} ] @var{cli-command} @var{nl}}, where
25920 @var{cli-command} is any existing @value{GDBN} CLI command.
25922 @item @var{mi-command} @expansion{}
25923 @code{[ @var{token} ] "-" @var{operation} ( " " @var{option} )*
25924 @code{[} " --" @code{]} ( " " @var{parameter} )* @var{nl}}
25926 @item @var{token} @expansion{}
25927 "any sequence of digits"
25929 @item @var{option} @expansion{}
25930 @code{"-" @var{parameter} [ " " @var{parameter} ]}
25932 @item @var{parameter} @expansion{}
25933 @code{@var{non-blank-sequence} | @var{c-string}}
25935 @item @var{operation} @expansion{}
25936 @emph{any of the operations described in this chapter}
25938 @item @var{non-blank-sequence} @expansion{}
25939 @emph{anything, provided it doesn't contain special characters such as
25940 "-", @var{nl}, """ and of course " "}
25942 @item @var{c-string} @expansion{}
25943 @code{""" @var{seven-bit-iso-c-string-content} """}
25945 @item @var{nl} @expansion{}
25954 The CLI commands are still handled by the @sc{mi} interpreter; their
25955 output is described below.
25958 The @code{@var{token}}, when present, is passed back when the command
25962 Some @sc{mi} commands accept optional arguments as part of the parameter
25963 list. Each option is identified by a leading @samp{-} (dash) and may be
25964 followed by an optional argument parameter. Options occur first in the
25965 parameter list and can be delimited from normal parameters using
25966 @samp{--} (this is useful when some parameters begin with a dash).
25973 We want easy access to the existing CLI syntax (for debugging).
25976 We want it to be easy to spot a @sc{mi} operation.
25979 @node GDB/MI Output Syntax
25980 @subsection @sc{gdb/mi} Output Syntax
25982 @cindex output syntax of @sc{gdb/mi}
25983 @cindex @sc{gdb/mi}, output syntax
25984 The output from @sc{gdb/mi} consists of zero or more out-of-band records
25985 followed, optionally, by a single result record. This result record
25986 is for the most recent command. The sequence of output records is
25987 terminated by @samp{(gdb)}.
25989 If an input command was prefixed with a @code{@var{token}} then the
25990 corresponding output for that command will also be prefixed by that same
25994 @item @var{output} @expansion{}
25995 @code{( @var{out-of-band-record} )* [ @var{result-record} ] "(gdb)" @var{nl}}
25997 @item @var{result-record} @expansion{}
25998 @code{ [ @var{token} ] "^" @var{result-class} ( "," @var{result} )* @var{nl}}
26000 @item @var{out-of-band-record} @expansion{}
26001 @code{@var{async-record} | @var{stream-record}}
26003 @item @var{async-record} @expansion{}
26004 @code{@var{exec-async-output} | @var{status-async-output} | @var{notify-async-output}}
26006 @item @var{exec-async-output} @expansion{}
26007 @code{[ @var{token} ] "*" @var{async-output nl}}
26009 @item @var{status-async-output} @expansion{}
26010 @code{[ @var{token} ] "+" @var{async-output nl}}
26012 @item @var{notify-async-output} @expansion{}
26013 @code{[ @var{token} ] "=" @var{async-output nl}}
26015 @item @var{async-output} @expansion{}
26016 @code{@var{async-class} ( "," @var{result} )*}
26018 @item @var{result-class} @expansion{}
26019 @code{"done" | "running" | "connected" | "error" | "exit"}
26021 @item @var{async-class} @expansion{}
26022 @code{"stopped" | @var{others}} (where @var{others} will be added
26023 depending on the needs---this is still in development).
26025 @item @var{result} @expansion{}
26026 @code{ @var{variable} "=" @var{value}}
26028 @item @var{variable} @expansion{}
26029 @code{ @var{string} }
26031 @item @var{value} @expansion{}
26032 @code{ @var{const} | @var{tuple} | @var{list} }
26034 @item @var{const} @expansion{}
26035 @code{@var{c-string}}
26037 @item @var{tuple} @expansion{}
26038 @code{ "@{@}" | "@{" @var{result} ( "," @var{result} )* "@}" }
26040 @item @var{list} @expansion{}
26041 @code{ "[]" | "[" @var{value} ( "," @var{value} )* "]" | "["
26042 @var{result} ( "," @var{result} )* "]" }
26044 @item @var{stream-record} @expansion{}
26045 @code{@var{console-stream-output} | @var{target-stream-output} | @var{log-stream-output}}
26047 @item @var{console-stream-output} @expansion{}
26048 @code{"~" @var{c-string nl}}
26050 @item @var{target-stream-output} @expansion{}
26051 @code{"@@" @var{c-string nl}}
26053 @item @var{log-stream-output} @expansion{}
26054 @code{"&" @var{c-string nl}}
26056 @item @var{nl} @expansion{}
26059 @item @var{token} @expansion{}
26060 @emph{any sequence of digits}.
26068 All output sequences end in a single line containing a period.
26071 The @code{@var{token}} is from the corresponding request. Note that
26072 for all async output, while the token is allowed by the grammar and
26073 may be output by future versions of @value{GDBN} for select async
26074 output messages, it is generally omitted. Frontends should treat
26075 all async output as reporting general changes in the state of the
26076 target and there should be no need to associate async output to any
26080 @cindex status output in @sc{gdb/mi}
26081 @var{status-async-output} contains on-going status information about the
26082 progress of a slow operation. It can be discarded. All status output is
26083 prefixed by @samp{+}.
26086 @cindex async output in @sc{gdb/mi}
26087 @var{exec-async-output} contains asynchronous state change on the target
26088 (stopped, started, disappeared). All async output is prefixed by
26092 @cindex notify output in @sc{gdb/mi}
26093 @var{notify-async-output} contains supplementary information that the
26094 client should handle (e.g., a new breakpoint information). All notify
26095 output is prefixed by @samp{=}.
26098 @cindex console output in @sc{gdb/mi}
26099 @var{console-stream-output} is output that should be displayed as is in the
26100 console. It is the textual response to a CLI command. All the console
26101 output is prefixed by @samp{~}.
26104 @cindex target output in @sc{gdb/mi}
26105 @var{target-stream-output} is the output produced by the target program.
26106 All the target output is prefixed by @samp{@@}.
26109 @cindex log output in @sc{gdb/mi}
26110 @var{log-stream-output} is output text coming from @value{GDBN}'s internals, for
26111 instance messages that should be displayed as part of an error log. All
26112 the log output is prefixed by @samp{&}.
26115 @cindex list output in @sc{gdb/mi}
26116 New @sc{gdb/mi} commands should only output @var{lists} containing
26122 @xref{GDB/MI Stream Records, , @sc{gdb/mi} Stream Records}, for more
26123 details about the various output records.
26125 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
26126 @node GDB/MI Compatibility with CLI
26127 @section @sc{gdb/mi} Compatibility with CLI
26129 @cindex compatibility, @sc{gdb/mi} and CLI
26130 @cindex @sc{gdb/mi}, compatibility with CLI
26132 For the developers convenience CLI commands can be entered directly,
26133 but there may be some unexpected behaviour. For example, commands
26134 that query the user will behave as if the user replied yes, breakpoint
26135 command lists are not executed and some CLI commands, such as
26136 @code{if}, @code{when} and @code{define}, prompt for further input with
26137 @samp{>}, which is not valid MI output.
26139 This feature may be removed at some stage in the future and it is
26140 recommended that front ends use the @code{-interpreter-exec} command
26141 (@pxref{-interpreter-exec}).
26143 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
26144 @node GDB/MI Development and Front Ends
26145 @section @sc{gdb/mi} Development and Front Ends
26146 @cindex @sc{gdb/mi} development
26148 The application which takes the MI output and presents the state of the
26149 program being debugged to the user is called a @dfn{front end}.
26151 Although @sc{gdb/mi} is still incomplete, it is currently being used
26152 by a variety of front ends to @value{GDBN}. This makes it difficult
26153 to introduce new functionality without breaking existing usage. This
26154 section tries to minimize the problems by describing how the protocol
26157 Some changes in MI need not break a carefully designed front end, and
26158 for these the MI version will remain unchanged. The following is a
26159 list of changes that may occur within one level, so front ends should
26160 parse MI output in a way that can handle them:
26164 New MI commands may be added.
26167 New fields may be added to the output of any MI command.
26170 The range of values for fields with specified values, e.g.,
26171 @code{in_scope} (@pxref{-var-update}) may be extended.
26173 @c The format of field's content e.g type prefix, may change so parse it
26174 @c at your own risk. Yes, in general?
26176 @c The order of fields may change? Shouldn't really matter but it might
26177 @c resolve inconsistencies.
26180 If the changes are likely to break front ends, the MI version level
26181 will be increased by one. This will allow the front end to parse the
26182 output according to the MI version. Apart from mi0, new versions of
26183 @value{GDBN} will not support old versions of MI and it will be the
26184 responsibility of the front end to work with the new one.
26186 @c Starting with mi3, add a new command -mi-version that prints the MI
26189 The best way to avoid unexpected changes in MI that might break your front
26190 end is to make your project known to @value{GDBN} developers and
26191 follow development on @email{gdb@@sourceware.org} and
26192 @email{gdb-patches@@sourceware.org}.
26193 @cindex mailing lists
26195 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
26196 @node GDB/MI Output Records
26197 @section @sc{gdb/mi} Output Records
26200 * GDB/MI Result Records::
26201 * GDB/MI Stream Records::
26202 * GDB/MI Async Records::
26203 * GDB/MI Breakpoint Information::
26204 * GDB/MI Frame Information::
26205 * GDB/MI Thread Information::
26206 * GDB/MI Ada Exception Information::
26209 @node GDB/MI Result Records
26210 @subsection @sc{gdb/mi} Result Records
26212 @cindex result records in @sc{gdb/mi}
26213 @cindex @sc{gdb/mi}, result records
26214 In addition to a number of out-of-band notifications, the response to a
26215 @sc{gdb/mi} command includes one of the following result indications:
26219 @item "^done" [ "," @var{results} ]
26220 The synchronous operation was successful, @code{@var{results}} are the return
26225 This result record is equivalent to @samp{^done}. Historically, it
26226 was output instead of @samp{^done} if the command has resumed the
26227 target. This behaviour is maintained for backward compatibility, but
26228 all frontends should treat @samp{^done} and @samp{^running}
26229 identically and rely on the @samp{*running} output record to determine
26230 which threads are resumed.
26234 @value{GDBN} has connected to a remote target.
26236 @item "^error" "," "msg=" @var{c-string} [ "," "code=" @var{c-string} ]
26238 The operation failed. The @code{msg=@var{c-string}} variable contains
26239 the corresponding error message.
26241 If present, the @code{code=@var{c-string}} variable provides an error
26242 code on which consumers can rely on to detect the corresponding
26243 error condition. At present, only one error code is defined:
26246 @item "undefined-command"
26247 Indicates that the command causing the error does not exist.
26252 @value{GDBN} has terminated.
26256 @node GDB/MI Stream Records
26257 @subsection @sc{gdb/mi} Stream Records
26259 @cindex @sc{gdb/mi}, stream records
26260 @cindex stream records in @sc{gdb/mi}
26261 @value{GDBN} internally maintains a number of output streams: the console, the
26262 target, and the log. The output intended for each of these streams is
26263 funneled through the @sc{gdb/mi} interface using @dfn{stream records}.
26265 Each stream record begins with a unique @dfn{prefix character} which
26266 identifies its stream (@pxref{GDB/MI Output Syntax, , @sc{gdb/mi} Output
26267 Syntax}). In addition to the prefix, each stream record contains a
26268 @code{@var{string-output}}. This is either raw text (with an implicit new
26269 line) or a quoted C string (which does not contain an implicit newline).
26272 @item "~" @var{string-output}
26273 The console output stream contains text that should be displayed in the
26274 CLI console window. It contains the textual responses to CLI commands.
26276 @item "@@" @var{string-output}
26277 The target output stream contains any textual output from the running
26278 target. This is only present when GDB's event loop is truly
26279 asynchronous, which is currently only the case for remote targets.
26281 @item "&" @var{string-output}
26282 The log stream contains debugging messages being produced by @value{GDBN}'s
26286 @node GDB/MI Async Records
26287 @subsection @sc{gdb/mi} Async Records
26289 @cindex async records in @sc{gdb/mi}
26290 @cindex @sc{gdb/mi}, async records
26291 @dfn{Async} records are used to notify the @sc{gdb/mi} client of
26292 additional changes that have occurred. Those changes can either be a
26293 consequence of @sc{gdb/mi} commands (e.g., a breakpoint modified) or a result of
26294 target activity (e.g., target stopped).
26296 The following is the list of possible async records:
26300 @item *running,thread-id="@var{thread}"
26301 The target is now running. The @var{thread} field can be the global
26302 thread ID of the the thread that is now running, and it can be
26303 @samp{all} if all threads are running. The frontend should assume
26304 that no interaction with a running thread is possible after this
26305 notification is produced. The frontend should not assume that this
26306 notification is output only once for any command. @value{GDBN} may
26307 emit this notification several times, either for different threads,
26308 because it cannot resume all threads together, or even for a single
26309 thread, if the thread must be stepped though some code before letting
26312 @item *stopped,reason="@var{reason}",thread-id="@var{id}",stopped-threads="@var{stopped}",core="@var{core}"
26313 The target has stopped. The @var{reason} field can have one of the
26317 @item breakpoint-hit
26318 A breakpoint was reached.
26319 @item watchpoint-trigger
26320 A watchpoint was triggered.
26321 @item read-watchpoint-trigger
26322 A read watchpoint was triggered.
26323 @item access-watchpoint-trigger
26324 An access watchpoint was triggered.
26325 @item function-finished
26326 An -exec-finish or similar CLI command was accomplished.
26327 @item location-reached
26328 An -exec-until or similar CLI command was accomplished.
26329 @item watchpoint-scope
26330 A watchpoint has gone out of scope.
26331 @item end-stepping-range
26332 An -exec-next, -exec-next-instruction, -exec-step, -exec-step-instruction or
26333 similar CLI command was accomplished.
26334 @item exited-signalled
26335 The inferior exited because of a signal.
26337 The inferior exited.
26338 @item exited-normally
26339 The inferior exited normally.
26340 @item signal-received
26341 A signal was received by the inferior.
26343 The inferior has stopped due to a library being loaded or unloaded.
26344 This can happen when @code{stop-on-solib-events} (@pxref{Files}) is
26345 set or when a @code{catch load} or @code{catch unload} catchpoint is
26346 in use (@pxref{Set Catchpoints}).
26348 The inferior has forked. This is reported when @code{catch fork}
26349 (@pxref{Set Catchpoints}) has been used.
26351 The inferior has vforked. This is reported in when @code{catch vfork}
26352 (@pxref{Set Catchpoints}) has been used.
26353 @item syscall-entry
26354 The inferior entered a system call. This is reported when @code{catch
26355 syscall} (@pxref{Set Catchpoints}) has been used.
26356 @item syscall-return
26357 The inferior returned from a system call. This is reported when
26358 @code{catch syscall} (@pxref{Set Catchpoints}) has been used.
26360 The inferior called @code{exec}. This is reported when @code{catch exec}
26361 (@pxref{Set Catchpoints}) has been used.
26364 The @var{id} field identifies the global thread ID of the thread
26365 that directly caused the stop -- for example by hitting a breakpoint.
26366 Depending on whether all-stop
26367 mode is in effect (@pxref{All-Stop Mode}), @value{GDBN} may either
26368 stop all threads, or only the thread that directly triggered the stop.
26369 If all threads are stopped, the @var{stopped} field will have the
26370 value of @code{"all"}. Otherwise, the value of the @var{stopped}
26371 field will be a list of thread identifiers. Presently, this list will
26372 always include a single thread, but frontend should be prepared to see
26373 several threads in the list. The @var{core} field reports the
26374 processor core on which the stop event has happened. This field may be absent
26375 if such information is not available.
26377 @item =thread-group-added,id="@var{id}"
26378 @itemx =thread-group-removed,id="@var{id}"
26379 A thread group was either added or removed. The @var{id} field
26380 contains the @value{GDBN} identifier of the thread group. When a thread
26381 group is added, it generally might not be associated with a running
26382 process. When a thread group is removed, its id becomes invalid and
26383 cannot be used in any way.
26385 @item =thread-group-started,id="@var{id}",pid="@var{pid}"
26386 A thread group became associated with a running program,
26387 either because the program was just started or the thread group
26388 was attached to a program. The @var{id} field contains the
26389 @value{GDBN} identifier of the thread group. The @var{pid} field
26390 contains process identifier, specific to the operating system.
26392 @item =thread-group-exited,id="@var{id}"[,exit-code="@var{code}"]
26393 A thread group is no longer associated with a running program,
26394 either because the program has exited, or because it was detached
26395 from. The @var{id} field contains the @value{GDBN} identifier of the
26396 thread group. The @var{code} field is the exit code of the inferior; it exists
26397 only when the inferior exited with some code.
26399 @item =thread-created,id="@var{id}",group-id="@var{gid}"
26400 @itemx =thread-exited,id="@var{id}",group-id="@var{gid}"
26401 A thread either was created, or has exited. The @var{id} field
26402 contains the global @value{GDBN} identifier of the thread. The @var{gid}
26403 field identifies the thread group this thread belongs to.
26405 @item =thread-selected,id="@var{id}"
26406 Informs that the selected thread was changed as result of the last
26407 command. This notification is not emitted as result of @code{-thread-select}
26408 command but is emitted whenever an MI command that is not documented
26409 to change the selected thread actually changes it. In particular,
26410 invoking, directly or indirectly (via user-defined command), the CLI
26411 @code{thread} command, will generate this notification.
26413 We suggest that in response to this notification, front ends
26414 highlight the selected thread and cause subsequent commands to apply to
26417 @item =library-loaded,...
26418 Reports that a new library file was loaded by the program. This
26419 notification has 4 fields---@var{id}, @var{target-name},
26420 @var{host-name}, and @var{symbols-loaded}. The @var{id} field is an
26421 opaque identifier of the library. For remote debugging case,
26422 @var{target-name} and @var{host-name} fields give the name of the
26423 library file on the target, and on the host respectively. For native
26424 debugging, both those fields have the same value. The
26425 @var{symbols-loaded} field is emitted only for backward compatibility
26426 and should not be relied on to convey any useful information. The
26427 @var{thread-group} field, if present, specifies the id of the thread
26428 group in whose context the library was loaded. If the field is
26429 absent, it means the library was loaded in the context of all present
26432 @item =library-unloaded,...
26433 Reports that a library was unloaded by the program. This notification
26434 has 3 fields---@var{id}, @var{target-name} and @var{host-name} with
26435 the same meaning as for the @code{=library-loaded} notification.
26436 The @var{thread-group} field, if present, specifies the id of the
26437 thread group in whose context the library was unloaded. If the field is
26438 absent, it means the library was unloaded in the context of all present
26441 @item =traceframe-changed,num=@var{tfnum},tracepoint=@var{tpnum}
26442 @itemx =traceframe-changed,end
26443 Reports that the trace frame was changed and its new number is
26444 @var{tfnum}. The number of the tracepoint associated with this trace
26445 frame is @var{tpnum}.
26447 @item =tsv-created,name=@var{name},initial=@var{initial}
26448 Reports that the new trace state variable @var{name} is created with
26449 initial value @var{initial}.
26451 @item =tsv-deleted,name=@var{name}
26452 @itemx =tsv-deleted
26453 Reports that the trace state variable @var{name} is deleted or all
26454 trace state variables are deleted.
26456 @item =tsv-modified,name=@var{name},initial=@var{initial}[,current=@var{current}]
26457 Reports that the trace state variable @var{name} is modified with
26458 the initial value @var{initial}. The current value @var{current} of
26459 trace state variable is optional and is reported if the current
26460 value of trace state variable is known.
26462 @item =breakpoint-created,bkpt=@{...@}
26463 @itemx =breakpoint-modified,bkpt=@{...@}
26464 @itemx =breakpoint-deleted,id=@var{number}
26465 Reports that a breakpoint was created, modified, or deleted,
26466 respectively. Only user-visible breakpoints are reported to the MI
26469 The @var{bkpt} argument is of the same form as returned by the various
26470 breakpoint commands; @xref{GDB/MI Breakpoint Commands}. The
26471 @var{number} is the ordinal number of the breakpoint.
26473 Note that if a breakpoint is emitted in the result record of a
26474 command, then it will not also be emitted in an async record.
26476 @item =record-started,thread-group="@var{id}"
26477 @itemx =record-stopped,thread-group="@var{id}"
26478 Execution log recording was either started or stopped on an
26479 inferior. The @var{id} is the @value{GDBN} identifier of the thread
26480 group corresponding to the affected inferior.
26482 @item =cmd-param-changed,param=@var{param},value=@var{value}
26483 Reports that a parameter of the command @code{set @var{param}} is
26484 changed to @var{value}. In the multi-word @code{set} command,
26485 the @var{param} is the whole parameter list to @code{set} command.
26486 For example, In command @code{set check type on}, @var{param}
26487 is @code{check type} and @var{value} is @code{on}.
26489 @item =memory-changed,thread-group=@var{id},addr=@var{addr},len=@var{len}[,type="code"]
26490 Reports that bytes from @var{addr} to @var{data} + @var{len} were
26491 written in an inferior. The @var{id} is the identifier of the
26492 thread group corresponding to the affected inferior. The optional
26493 @code{type="code"} part is reported if the memory written to holds
26497 @node GDB/MI Breakpoint Information
26498 @subsection @sc{gdb/mi} Breakpoint Information
26500 When @value{GDBN} reports information about a breakpoint, a
26501 tracepoint, a watchpoint, or a catchpoint, it uses a tuple with the
26506 The breakpoint number. For a breakpoint that represents one location
26507 of a multi-location breakpoint, this will be a dotted pair, like
26511 The type of the breakpoint. For ordinary breakpoints this will be
26512 @samp{breakpoint}, but many values are possible.
26515 If the type of the breakpoint is @samp{catchpoint}, then this
26516 indicates the exact type of catchpoint.
26519 This is the breakpoint disposition---either @samp{del}, meaning that
26520 the breakpoint will be deleted at the next stop, or @samp{keep},
26521 meaning that the breakpoint will not be deleted.
26524 This indicates whether the breakpoint is enabled, in which case the
26525 value is @samp{y}, or disabled, in which case the value is @samp{n}.
26526 Note that this is not the same as the field @code{enable}.
26529 The address of the breakpoint. This may be a hexidecimal number,
26530 giving the address; or the string @samp{<PENDING>}, for a pending
26531 breakpoint; or the string @samp{<MULTIPLE>}, for a breakpoint with
26532 multiple locations. This field will not be present if no address can
26533 be determined. For example, a watchpoint does not have an address.
26536 If known, the function in which the breakpoint appears.
26537 If not known, this field is not present.
26540 The name of the source file which contains this function, if known.
26541 If not known, this field is not present.
26544 The full file name of the source file which contains this function, if
26545 known. If not known, this field is not present.
26548 The line number at which this breakpoint appears, if known.
26549 If not known, this field is not present.
26552 If the source file is not known, this field may be provided. If
26553 provided, this holds the address of the breakpoint, possibly followed
26557 If this breakpoint is pending, this field is present and holds the
26558 text used to set the breakpoint, as entered by the user.
26561 Where this breakpoint's condition is evaluated, either @samp{host} or
26565 If this is a thread-specific breakpoint, then this identifies the
26566 thread in which the breakpoint can trigger.
26569 If this breakpoint is restricted to a particular Ada task, then this
26570 field will hold the task identifier.
26573 If the breakpoint is conditional, this is the condition expression.
26576 The ignore count of the breakpoint.
26579 The enable count of the breakpoint.
26581 @item traceframe-usage
26584 @item static-tracepoint-marker-string-id
26585 For a static tracepoint, the name of the static tracepoint marker.
26588 For a masked watchpoint, this is the mask.
26591 A tracepoint's pass count.
26593 @item original-location
26594 The location of the breakpoint as originally specified by the user.
26595 This field is optional.
26598 The number of times the breakpoint has been hit.
26601 This field is only given for tracepoints. This is either @samp{y},
26602 meaning that the tracepoint is installed, or @samp{n}, meaning that it
26606 Some extra data, the exact contents of which are type-dependent.
26610 For example, here is what the output of @code{-break-insert}
26611 (@pxref{GDB/MI Breakpoint Commands}) might be:
26614 -> -break-insert main
26615 <- ^done,bkpt=@{number="1",type="breakpoint",disp="keep",
26616 enabled="y",addr="0x08048564",func="main",file="myprog.c",
26617 fullname="/home/nickrob/myprog.c",line="68",thread-groups=["i1"],
26622 @node GDB/MI Frame Information
26623 @subsection @sc{gdb/mi} Frame Information
26625 Response from many MI commands includes an information about stack
26626 frame. This information is a tuple that may have the following
26631 The level of the stack frame. The innermost frame has the level of
26632 zero. This field is always present.
26635 The name of the function corresponding to the frame. This field may
26636 be absent if @value{GDBN} is unable to determine the function name.
26639 The code address for the frame. This field is always present.
26642 The name of the source files that correspond to the frame's code
26643 address. This field may be absent.
26646 The source line corresponding to the frames' code address. This field
26650 The name of the binary file (either executable or shared library) the
26651 corresponds to the frame's code address. This field may be absent.
26655 @node GDB/MI Thread Information
26656 @subsection @sc{gdb/mi} Thread Information
26658 Whenever @value{GDBN} has to report an information about a thread, it
26659 uses a tuple with the following fields:
26663 The global numeric id assigned to the thread by @value{GDBN}. This field is
26667 Target-specific string identifying the thread. This field is always present.
26670 Additional information about the thread provided by the target.
26671 It is supposed to be human-readable and not interpreted by the
26672 frontend. This field is optional.
26675 Either @samp{stopped} or @samp{running}, depending on whether the
26676 thread is presently running. This field is always present.
26679 The value of this field is an integer number of the processor core the
26680 thread was last seen on. This field is optional.
26683 @node GDB/MI Ada Exception Information
26684 @subsection @sc{gdb/mi} Ada Exception Information
26686 Whenever a @code{*stopped} record is emitted because the program
26687 stopped after hitting an exception catchpoint (@pxref{Set Catchpoints}),
26688 @value{GDBN} provides the name of the exception that was raised via
26689 the @code{exception-name} field.
26691 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
26692 @node GDB/MI Simple Examples
26693 @section Simple Examples of @sc{gdb/mi} Interaction
26694 @cindex @sc{gdb/mi}, simple examples
26696 This subsection presents several simple examples of interaction using
26697 the @sc{gdb/mi} interface. In these examples, @samp{->} means that the
26698 following line is passed to @sc{gdb/mi} as input, while @samp{<-} means
26699 the output received from @sc{gdb/mi}.
26701 Note the line breaks shown in the examples are here only for
26702 readability, they don't appear in the real output.
26704 @subheading Setting a Breakpoint
26706 Setting a breakpoint generates synchronous output which contains detailed
26707 information of the breakpoint.
26710 -> -break-insert main
26711 <- ^done,bkpt=@{number="1",type="breakpoint",disp="keep",
26712 enabled="y",addr="0x08048564",func="main",file="myprog.c",
26713 fullname="/home/nickrob/myprog.c",line="68",thread-groups=["i1"],
26718 @subheading Program Execution
26720 Program execution generates asynchronous records and MI gives the
26721 reason that execution stopped.
26727 <- *stopped,reason="breakpoint-hit",disp="keep",bkptno="1",thread-id="0",
26728 frame=@{addr="0x08048564",func="main",
26729 args=[@{name="argc",value="1"@},@{name="argv",value="0xbfc4d4d4"@}],
26730 file="myprog.c",fullname="/home/nickrob/myprog.c",line="68"@}
26735 <- *stopped,reason="exited-normally"
26739 @subheading Quitting @value{GDBN}
26741 Quitting @value{GDBN} just prints the result class @samp{^exit}.
26749 Please note that @samp{^exit} is printed immediately, but it might
26750 take some time for @value{GDBN} to actually exit. During that time, @value{GDBN}
26751 performs necessary cleanups, including killing programs being debugged
26752 or disconnecting from debug hardware, so the frontend should wait till
26753 @value{GDBN} exits and should only forcibly kill @value{GDBN} if it
26754 fails to exit in reasonable time.
26756 @subheading A Bad Command
26758 Here's what happens if you pass a non-existent command:
26762 <- ^error,msg="Undefined MI command: rubbish"
26767 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
26768 @node GDB/MI Command Description Format
26769 @section @sc{gdb/mi} Command Description Format
26771 The remaining sections describe blocks of commands. Each block of
26772 commands is laid out in a fashion similar to this section.
26774 @subheading Motivation
26776 The motivation for this collection of commands.
26778 @subheading Introduction
26780 A brief introduction to this collection of commands as a whole.
26782 @subheading Commands
26784 For each command in the block, the following is described:
26786 @subsubheading Synopsis
26789 -command @var{args}@dots{}
26792 @subsubheading Result
26794 @subsubheading @value{GDBN} Command
26796 The corresponding @value{GDBN} CLI command(s), if any.
26798 @subsubheading Example
26800 Example(s) formatted for readability. Some of the described commands have
26801 not been implemented yet and these are labeled N.A.@: (not available).
26804 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
26805 @node GDB/MI Breakpoint Commands
26806 @section @sc{gdb/mi} Breakpoint Commands
26808 @cindex breakpoint commands for @sc{gdb/mi}
26809 @cindex @sc{gdb/mi}, breakpoint commands
26810 This section documents @sc{gdb/mi} commands for manipulating
26813 @subheading The @code{-break-after} Command
26814 @findex -break-after
26816 @subsubheading Synopsis
26819 -break-after @var{number} @var{count}
26822 The breakpoint number @var{number} is not in effect until it has been
26823 hit @var{count} times. To see how this is reflected in the output of
26824 the @samp{-break-list} command, see the description of the
26825 @samp{-break-list} command below.
26827 @subsubheading @value{GDBN} Command
26829 The corresponding @value{GDBN} command is @samp{ignore}.
26831 @subsubheading Example
26836 ^done,bkpt=@{number="1",type="breakpoint",disp="keep",
26837 enabled="y",addr="0x000100d0",func="main",file="hello.c",
26838 fullname="/home/foo/hello.c",line="5",thread-groups=["i1"],
26846 ^done,BreakpointTable=@{nr_rows="1",nr_cols="6",
26847 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
26848 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
26849 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
26850 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
26851 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
26852 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
26853 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
26854 addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c",
26855 line="5",thread-groups=["i1"],times="0",ignore="3"@}]@}
26860 @subheading The @code{-break-catch} Command
26861 @findex -break-catch
26864 @subheading The @code{-break-commands} Command
26865 @findex -break-commands
26867 @subsubheading Synopsis
26870 -break-commands @var{number} [ @var{command1} ... @var{commandN} ]
26873 Specifies the CLI commands that should be executed when breakpoint
26874 @var{number} is hit. The parameters @var{command1} to @var{commandN}
26875 are the commands. If no command is specified, any previously-set
26876 commands are cleared. @xref{Break Commands}. Typical use of this
26877 functionality is tracing a program, that is, printing of values of
26878 some variables whenever breakpoint is hit and then continuing.
26880 @subsubheading @value{GDBN} Command
26882 The corresponding @value{GDBN} command is @samp{commands}.
26884 @subsubheading Example
26889 ^done,bkpt=@{number="1",type="breakpoint",disp="keep",
26890 enabled="y",addr="0x000100d0",func="main",file="hello.c",
26891 fullname="/home/foo/hello.c",line="5",thread-groups=["i1"],
26894 -break-commands 1 "print v" "continue"
26899 @subheading The @code{-break-condition} Command
26900 @findex -break-condition
26902 @subsubheading Synopsis
26905 -break-condition @var{number} @var{expr}
26908 Breakpoint @var{number} will stop the program only if the condition in
26909 @var{expr} is true. The condition becomes part of the
26910 @samp{-break-list} output (see the description of the @samp{-break-list}
26913 @subsubheading @value{GDBN} Command
26915 The corresponding @value{GDBN} command is @samp{condition}.
26917 @subsubheading Example
26921 -break-condition 1 1
26925 ^done,BreakpointTable=@{nr_rows="1",nr_cols="6",
26926 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
26927 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
26928 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
26929 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
26930 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
26931 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
26932 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
26933 addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c",
26934 line="5",cond="1",thread-groups=["i1"],times="0",ignore="3"@}]@}
26938 @subheading The @code{-break-delete} Command
26939 @findex -break-delete
26941 @subsubheading Synopsis
26944 -break-delete ( @var{breakpoint} )+
26947 Delete the breakpoint(s) whose number(s) are specified in the argument
26948 list. This is obviously reflected in the breakpoint list.
26950 @subsubheading @value{GDBN} Command
26952 The corresponding @value{GDBN} command is @samp{delete}.
26954 @subsubheading Example
26962 ^done,BreakpointTable=@{nr_rows="0",nr_cols="6",
26963 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
26964 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
26965 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
26966 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
26967 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
26968 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
26973 @subheading The @code{-break-disable} Command
26974 @findex -break-disable
26976 @subsubheading Synopsis
26979 -break-disable ( @var{breakpoint} )+
26982 Disable the named @var{breakpoint}(s). The field @samp{enabled} in the
26983 break list is now set to @samp{n} for the named @var{breakpoint}(s).
26985 @subsubheading @value{GDBN} Command
26987 The corresponding @value{GDBN} command is @samp{disable}.
26989 @subsubheading Example
26997 ^done,BreakpointTable=@{nr_rows="1",nr_cols="6",
26998 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
26999 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
27000 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
27001 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
27002 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
27003 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
27004 body=[bkpt=@{number="2",type="breakpoint",disp="keep",enabled="n",
27005 addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c",
27006 line="5",thread-groups=["i1"],times="0"@}]@}
27010 @subheading The @code{-break-enable} Command
27011 @findex -break-enable
27013 @subsubheading Synopsis
27016 -break-enable ( @var{breakpoint} )+
27019 Enable (previously disabled) @var{breakpoint}(s).
27021 @subsubheading @value{GDBN} Command
27023 The corresponding @value{GDBN} command is @samp{enable}.
27025 @subsubheading Example
27033 ^done,BreakpointTable=@{nr_rows="1",nr_cols="6",
27034 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
27035 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
27036 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
27037 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
27038 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
27039 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
27040 body=[bkpt=@{number="2",type="breakpoint",disp="keep",enabled="y",
27041 addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c",
27042 line="5",thread-groups=["i1"],times="0"@}]@}
27046 @subheading The @code{-break-info} Command
27047 @findex -break-info
27049 @subsubheading Synopsis
27052 -break-info @var{breakpoint}
27056 Get information about a single breakpoint.
27058 The result is a table of breakpoints. @xref{GDB/MI Breakpoint
27059 Information}, for details on the format of each breakpoint in the
27062 @subsubheading @value{GDBN} Command
27064 The corresponding @value{GDBN} command is @samp{info break @var{breakpoint}}.
27066 @subsubheading Example
27069 @subheading The @code{-break-insert} Command
27070 @findex -break-insert
27071 @anchor{-break-insert}
27073 @subsubheading Synopsis
27076 -break-insert [ -t ] [ -h ] [ -f ] [ -d ] [ -a ]
27077 [ -c @var{condition} ] [ -i @var{ignore-count} ]
27078 [ -p @var{thread-id} ] [ @var{location} ]
27082 If specified, @var{location}, can be one of:
27085 @item linespec location
27086 A linespec location. @xref{Linespec Locations}.
27088 @item explicit location
27089 An explicit location. @sc{gdb/mi} explicit locations are
27090 analogous to the CLI's explicit locations using the option names
27091 listed below. @xref{Explicit Locations}.
27094 @item --source @var{filename}
27095 The source file name of the location. This option requires the use
27096 of either @samp{--function} or @samp{--line}.
27098 @item --function @var{function}
27099 The name of a function or method.
27101 @item --label @var{label}
27102 The name of a label.
27104 @item --line @var{lineoffset}
27105 An absolute or relative line offset from the start of the location.
27108 @item address location
27109 An address location, *@var{address}. @xref{Address Locations}.
27113 The possible optional parameters of this command are:
27117 Insert a temporary breakpoint.
27119 Insert a hardware breakpoint.
27121 If @var{location} cannot be parsed (for example if it
27122 refers to unknown files or functions), create a pending
27123 breakpoint. Without this flag, @value{GDBN} will report
27124 an error, and won't create a breakpoint, if @var{location}
27127 Create a disabled breakpoint.
27129 Create a tracepoint. @xref{Tracepoints}. When this parameter
27130 is used together with @samp{-h}, a fast tracepoint is created.
27131 @item -c @var{condition}
27132 Make the breakpoint conditional on @var{condition}.
27133 @item -i @var{ignore-count}
27134 Initialize the @var{ignore-count}.
27135 @item -p @var{thread-id}
27136 Restrict the breakpoint to the thread with the specified global
27140 @subsubheading Result
27142 @xref{GDB/MI Breakpoint Information}, for details on the format of the
27143 resulting breakpoint.
27145 Note: this format is open to change.
27146 @c An out-of-band breakpoint instead of part of the result?
27148 @subsubheading @value{GDBN} Command
27150 The corresponding @value{GDBN} commands are @samp{break}, @samp{tbreak},
27151 @samp{hbreak}, and @samp{thbreak}. @c and @samp{rbreak}.
27153 @subsubheading Example
27158 ^done,bkpt=@{number="1",addr="0x0001072c",file="recursive2.c",
27159 fullname="/home/foo/recursive2.c,line="4",thread-groups=["i1"],
27162 -break-insert -t foo
27163 ^done,bkpt=@{number="2",addr="0x00010774",file="recursive2.c",
27164 fullname="/home/foo/recursive2.c,line="11",thread-groups=["i1"],
27168 ^done,BreakpointTable=@{nr_rows="2",nr_cols="6",
27169 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
27170 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
27171 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
27172 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
27173 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
27174 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
27175 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
27176 addr="0x0001072c", func="main",file="recursive2.c",
27177 fullname="/home/foo/recursive2.c,"line="4",thread-groups=["i1"],
27179 bkpt=@{number="2",type="breakpoint",disp="del",enabled="y",
27180 addr="0x00010774",func="foo",file="recursive2.c",
27181 fullname="/home/foo/recursive2.c",line="11",thread-groups=["i1"],
27184 @c -break-insert -r foo.*
27185 @c ~int foo(int, int);
27186 @c ^done,bkpt=@{number="3",addr="0x00010774",file="recursive2.c,
27187 @c "fullname="/home/foo/recursive2.c",line="11",thread-groups=["i1"],
27192 @subheading The @code{-dprintf-insert} Command
27193 @findex -dprintf-insert
27195 @subsubheading Synopsis
27198 -dprintf-insert [ -t ] [ -f ] [ -d ]
27199 [ -c @var{condition} ] [ -i @var{ignore-count} ]
27200 [ -p @var{thread-id} ] [ @var{location} ] [ @var{format} ]
27205 If supplied, @var{location} may be specified the same way as for
27206 the @code{-break-insert} command. @xref{-break-insert}.
27208 The possible optional parameters of this command are:
27212 Insert a temporary breakpoint.
27214 If @var{location} cannot be parsed (for example, if it
27215 refers to unknown files or functions), create a pending
27216 breakpoint. Without this flag, @value{GDBN} will report
27217 an error, and won't create a breakpoint, if @var{location}
27220 Create a disabled breakpoint.
27221 @item -c @var{condition}
27222 Make the breakpoint conditional on @var{condition}.
27223 @item -i @var{ignore-count}
27224 Set the ignore count of the breakpoint (@pxref{Conditions, ignore count})
27225 to @var{ignore-count}.
27226 @item -p @var{thread-id}
27227 Restrict the breakpoint to the thread with the specified global
27231 @subsubheading Result
27233 @xref{GDB/MI Breakpoint Information}, for details on the format of the
27234 resulting breakpoint.
27236 @c An out-of-band breakpoint instead of part of the result?
27238 @subsubheading @value{GDBN} Command
27240 The corresponding @value{GDBN} command is @samp{dprintf}.
27242 @subsubheading Example
27246 4-dprintf-insert foo "At foo entry\n"
27247 4^done,bkpt=@{number="1",type="dprintf",disp="keep",enabled="y",
27248 addr="0x000000000040061b",func="foo",file="mi-dprintf.c",
27249 fullname="mi-dprintf.c",line="25",thread-groups=["i1"],
27250 times="0",script=@{"printf \"At foo entry\\n\"","continue"@},
27251 original-location="foo"@}
27253 5-dprintf-insert 26 "arg=%d, g=%d\n" arg g
27254 5^done,bkpt=@{number="2",type="dprintf",disp="keep",enabled="y",
27255 addr="0x000000000040062a",func="foo",file="mi-dprintf.c",
27256 fullname="mi-dprintf.c",line="26",thread-groups=["i1"],
27257 times="0",script=@{"printf \"arg=%d, g=%d\\n\", arg, g","continue"@},
27258 original-location="mi-dprintf.c:26"@}
27262 @subheading The @code{-break-list} Command
27263 @findex -break-list
27265 @subsubheading Synopsis
27271 Displays the list of inserted breakpoints, showing the following fields:
27275 number of the breakpoint
27277 type of the breakpoint: @samp{breakpoint} or @samp{watchpoint}
27279 should the breakpoint be deleted or disabled when it is hit: @samp{keep}
27282 is the breakpoint enabled or no: @samp{y} or @samp{n}
27284 memory location at which the breakpoint is set
27286 logical location of the breakpoint, expressed by function name, file
27288 @item Thread-groups
27289 list of thread groups to which this breakpoint applies
27291 number of times the breakpoint has been hit
27294 If there are no breakpoints or watchpoints, the @code{BreakpointTable}
27295 @code{body} field is an empty list.
27297 @subsubheading @value{GDBN} Command
27299 The corresponding @value{GDBN} command is @samp{info break}.
27301 @subsubheading Example
27306 ^done,BreakpointTable=@{nr_rows="2",nr_cols="6",
27307 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
27308 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
27309 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
27310 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
27311 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
27312 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
27313 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
27314 addr="0x000100d0",func="main",file="hello.c",line="5",thread-groups=["i1"],
27316 bkpt=@{number="2",type="breakpoint",disp="keep",enabled="y",
27317 addr="0x00010114",func="foo",file="hello.c",fullname="/home/foo/hello.c",
27318 line="13",thread-groups=["i1"],times="0"@}]@}
27322 Here's an example of the result when there are no breakpoints:
27327 ^done,BreakpointTable=@{nr_rows="0",nr_cols="6",
27328 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
27329 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
27330 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
27331 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
27332 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
27333 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
27338 @subheading The @code{-break-passcount} Command
27339 @findex -break-passcount
27341 @subsubheading Synopsis
27344 -break-passcount @var{tracepoint-number} @var{passcount}
27347 Set the passcount for tracepoint @var{tracepoint-number} to
27348 @var{passcount}. If the breakpoint referred to by @var{tracepoint-number}
27349 is not a tracepoint, error is emitted. This corresponds to CLI
27350 command @samp{passcount}.
27352 @subheading The @code{-break-watch} Command
27353 @findex -break-watch
27355 @subsubheading Synopsis
27358 -break-watch [ -a | -r ]
27361 Create a watchpoint. With the @samp{-a} option it will create an
27362 @dfn{access} watchpoint, i.e., a watchpoint that triggers either on a
27363 read from or on a write to the memory location. With the @samp{-r}
27364 option, the watchpoint created is a @dfn{read} watchpoint, i.e., it will
27365 trigger only when the memory location is accessed for reading. Without
27366 either of the options, the watchpoint created is a regular watchpoint,
27367 i.e., it will trigger when the memory location is accessed for writing.
27368 @xref{Set Watchpoints, , Setting Watchpoints}.
27370 Note that @samp{-break-list} will report a single list of watchpoints and
27371 breakpoints inserted.
27373 @subsubheading @value{GDBN} Command
27375 The corresponding @value{GDBN} commands are @samp{watch}, @samp{awatch}, and
27378 @subsubheading Example
27380 Setting a watchpoint on a variable in the @code{main} function:
27385 ^done,wpt=@{number="2",exp="x"@}
27390 *stopped,reason="watchpoint-trigger",wpt=@{number="2",exp="x"@},
27391 value=@{old="-268439212",new="55"@},
27392 frame=@{func="main",args=[],file="recursive2.c",
27393 fullname="/home/foo/bar/recursive2.c",line="5"@}
27397 Setting a watchpoint on a variable local to a function. @value{GDBN} will stop
27398 the program execution twice: first for the variable changing value, then
27399 for the watchpoint going out of scope.
27404 ^done,wpt=@{number="5",exp="C"@}
27409 *stopped,reason="watchpoint-trigger",
27410 wpt=@{number="5",exp="C"@},value=@{old="-276895068",new="3"@},
27411 frame=@{func="callee4",args=[],
27412 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
27413 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="13"@}
27418 *stopped,reason="watchpoint-scope",wpnum="5",
27419 frame=@{func="callee3",args=[@{name="strarg",
27420 value="0x11940 \"A string argument.\""@}],
27421 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
27422 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="18"@}
27426 Listing breakpoints and watchpoints, at different points in the program
27427 execution. Note that once the watchpoint goes out of scope, it is
27433 ^done,wpt=@{number="2",exp="C"@}
27436 ^done,BreakpointTable=@{nr_rows="2",nr_cols="6",
27437 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
27438 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
27439 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
27440 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
27441 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
27442 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
27443 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
27444 addr="0x00010734",func="callee4",
27445 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
27446 fullname="/home/foo/devo/gdb/testsuite/gdb.mi/basics.c"line="8",thread-groups=["i1"],
27448 bkpt=@{number="2",type="watchpoint",disp="keep",
27449 enabled="y",addr="",what="C",thread-groups=["i1"],times="0"@}]@}
27454 *stopped,reason="watchpoint-trigger",wpt=@{number="2",exp="C"@},
27455 value=@{old="-276895068",new="3"@},
27456 frame=@{func="callee4",args=[],
27457 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
27458 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="13"@}
27461 ^done,BreakpointTable=@{nr_rows="2",nr_cols="6",
27462 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
27463 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
27464 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
27465 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
27466 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
27467 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
27468 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
27469 addr="0x00010734",func="callee4",
27470 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
27471 fullname="/home/foo/devo/gdb/testsuite/gdb.mi/basics.c",line="8",thread-groups=["i1"],
27473 bkpt=@{number="2",type="watchpoint",disp="keep",
27474 enabled="y",addr="",what="C",thread-groups=["i1"],times="-5"@}]@}
27478 ^done,reason="watchpoint-scope",wpnum="2",
27479 frame=@{func="callee3",args=[@{name="strarg",
27480 value="0x11940 \"A string argument.\""@}],
27481 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
27482 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="18"@}
27485 ^done,BreakpointTable=@{nr_rows="1",nr_cols="6",
27486 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
27487 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
27488 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
27489 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
27490 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
27491 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
27492 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
27493 addr="0x00010734",func="callee4",
27494 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
27495 fullname="/home/foo/devo/gdb/testsuite/gdb.mi/basics.c",line="8",
27496 thread-groups=["i1"],times="1"@}]@}
27501 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
27502 @node GDB/MI Catchpoint Commands
27503 @section @sc{gdb/mi} Catchpoint Commands
27505 This section documents @sc{gdb/mi} commands for manipulating
27509 * Shared Library GDB/MI Catchpoint Commands::
27510 * Ada Exception GDB/MI Catchpoint Commands::
27513 @node Shared Library GDB/MI Catchpoint Commands
27514 @subsection Shared Library @sc{gdb/mi} Catchpoints
27516 @subheading The @code{-catch-load} Command
27517 @findex -catch-load
27519 @subsubheading Synopsis
27522 -catch-load [ -t ] [ -d ] @var{regexp}
27525 Add a catchpoint for library load events. If the @samp{-t} option is used,
27526 the catchpoint is a temporary one (@pxref{Set Breaks, ,Setting
27527 Breakpoints}). If the @samp{-d} option is used, the catchpoint is created
27528 in a disabled state. The @samp{regexp} argument is a regular
27529 expression used to match the name of the loaded library.
27532 @subsubheading @value{GDBN} Command
27534 The corresponding @value{GDBN} command is @samp{catch load}.
27536 @subsubheading Example
27539 -catch-load -t foo.so
27540 ^done,bkpt=@{number="1",type="catchpoint",disp="del",enabled="y",
27541 what="load of library matching foo.so",catch-type="load",times="0"@}
27546 @subheading The @code{-catch-unload} Command
27547 @findex -catch-unload
27549 @subsubheading Synopsis
27552 -catch-unload [ -t ] [ -d ] @var{regexp}
27555 Add a catchpoint for library unload events. If the @samp{-t} option is
27556 used, the catchpoint is a temporary one (@pxref{Set Breaks, ,Setting
27557 Breakpoints}). If the @samp{-d} option is used, the catchpoint is
27558 created in a disabled state. The @samp{regexp} argument is a regular
27559 expression used to match the name of the unloaded library.
27561 @subsubheading @value{GDBN} Command
27563 The corresponding @value{GDBN} command is @samp{catch unload}.
27565 @subsubheading Example
27568 -catch-unload -d bar.so
27569 ^done,bkpt=@{number="2",type="catchpoint",disp="keep",enabled="n",
27570 what="load of library matching bar.so",catch-type="unload",times="0"@}
27574 @node Ada Exception GDB/MI Catchpoint Commands
27575 @subsection Ada Exception @sc{gdb/mi} Catchpoints
27577 The following @sc{gdb/mi} commands can be used to create catchpoints
27578 that stop the execution when Ada exceptions are being raised.
27580 @subheading The @code{-catch-assert} Command
27581 @findex -catch-assert
27583 @subsubheading Synopsis
27586 -catch-assert [ -c @var{condition}] [ -d ] [ -t ]
27589 Add a catchpoint for failed Ada assertions.
27591 The possible optional parameters for this command are:
27594 @item -c @var{condition}
27595 Make the catchpoint conditional on @var{condition}.
27597 Create a disabled catchpoint.
27599 Create a temporary catchpoint.
27602 @subsubheading @value{GDBN} Command
27604 The corresponding @value{GDBN} command is @samp{catch assert}.
27606 @subsubheading Example
27610 ^done,bkptno="5",bkpt=@{number="5",type="breakpoint",disp="keep",
27611 enabled="y",addr="0x0000000000404888",what="failed Ada assertions",
27612 thread-groups=["i1"],times="0",
27613 original-location="__gnat_debug_raise_assert_failure"@}
27617 @subheading The @code{-catch-exception} Command
27618 @findex -catch-exception
27620 @subsubheading Synopsis
27623 -catch-exception [ -c @var{condition}] [ -d ] [ -e @var{exception-name} ]
27627 Add a catchpoint stopping when Ada exceptions are raised.
27628 By default, the command stops the program when any Ada exception
27629 gets raised. But it is also possible, by using some of the
27630 optional parameters described below, to create more selective
27633 The possible optional parameters for this command are:
27636 @item -c @var{condition}
27637 Make the catchpoint conditional on @var{condition}.
27639 Create a disabled catchpoint.
27640 @item -e @var{exception-name}
27641 Only stop when @var{exception-name} is raised. This option cannot
27642 be used combined with @samp{-u}.
27644 Create a temporary catchpoint.
27646 Stop only when an unhandled exception gets raised. This option
27647 cannot be used combined with @samp{-e}.
27650 @subsubheading @value{GDBN} Command
27652 The corresponding @value{GDBN} commands are @samp{catch exception}
27653 and @samp{catch exception unhandled}.
27655 @subsubheading Example
27658 -catch-exception -e Program_Error
27659 ^done,bkptno="4",bkpt=@{number="4",type="breakpoint",disp="keep",
27660 enabled="y",addr="0x0000000000404874",
27661 what="`Program_Error' Ada exception", thread-groups=["i1"],
27662 times="0",original-location="__gnat_debug_raise_exception"@}
27666 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
27667 @node GDB/MI Program Context
27668 @section @sc{gdb/mi} Program Context
27670 @subheading The @code{-exec-arguments} Command
27671 @findex -exec-arguments
27674 @subsubheading Synopsis
27677 -exec-arguments @var{args}
27680 Set the inferior program arguments, to be used in the next
27683 @subsubheading @value{GDBN} Command
27685 The corresponding @value{GDBN} command is @samp{set args}.
27687 @subsubheading Example
27691 -exec-arguments -v word
27698 @subheading The @code{-exec-show-arguments} Command
27699 @findex -exec-show-arguments
27701 @subsubheading Synopsis
27704 -exec-show-arguments
27707 Print the arguments of the program.
27709 @subsubheading @value{GDBN} Command
27711 The corresponding @value{GDBN} command is @samp{show args}.
27713 @subsubheading Example
27718 @subheading The @code{-environment-cd} Command
27719 @findex -environment-cd
27721 @subsubheading Synopsis
27724 -environment-cd @var{pathdir}
27727 Set @value{GDBN}'s working directory.
27729 @subsubheading @value{GDBN} Command
27731 The corresponding @value{GDBN} command is @samp{cd}.
27733 @subsubheading Example
27737 -environment-cd /kwikemart/marge/ezannoni/flathead-dev/devo/gdb
27743 @subheading The @code{-environment-directory} Command
27744 @findex -environment-directory
27746 @subsubheading Synopsis
27749 -environment-directory [ -r ] [ @var{pathdir} ]+
27752 Add directories @var{pathdir} to beginning of search path for source files.
27753 If the @samp{-r} option is used, the search path is reset to the default
27754 search path. If directories @var{pathdir} are supplied in addition to the
27755 @samp{-r} option, the search path is first reset and then addition
27757 Multiple directories may be specified, separated by blanks. Specifying
27758 multiple directories in a single command
27759 results in the directories added to the beginning of the
27760 search path in the same order they were presented in the command.
27761 If blanks are needed as
27762 part of a directory name, double-quotes should be used around
27763 the name. In the command output, the path will show up separated
27764 by the system directory-separator character. The directory-separator
27765 character must not be used
27766 in any directory name.
27767 If no directories are specified, the current search path is displayed.
27769 @subsubheading @value{GDBN} Command
27771 The corresponding @value{GDBN} command is @samp{dir}.
27773 @subsubheading Example
27777 -environment-directory /kwikemart/marge/ezannoni/flathead-dev/devo/gdb
27778 ^done,source-path="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb:$cdir:$cwd"
27780 -environment-directory ""
27781 ^done,source-path="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb:$cdir:$cwd"
27783 -environment-directory -r /home/jjohnstn/src/gdb /usr/src
27784 ^done,source-path="/home/jjohnstn/src/gdb:/usr/src:$cdir:$cwd"
27786 -environment-directory -r
27787 ^done,source-path="$cdir:$cwd"
27792 @subheading The @code{-environment-path} Command
27793 @findex -environment-path
27795 @subsubheading Synopsis
27798 -environment-path [ -r ] [ @var{pathdir} ]+
27801 Add directories @var{pathdir} to beginning of search path for object files.
27802 If the @samp{-r} option is used, the search path is reset to the original
27803 search path that existed at gdb start-up. If directories @var{pathdir} are
27804 supplied in addition to the
27805 @samp{-r} option, the search path is first reset and then addition
27807 Multiple directories may be specified, separated by blanks. Specifying
27808 multiple directories in a single command
27809 results in the directories added to the beginning of the
27810 search path in the same order they were presented in the command.
27811 If blanks are needed as
27812 part of a directory name, double-quotes should be used around
27813 the name. In the command output, the path will show up separated
27814 by the system directory-separator character. The directory-separator
27815 character must not be used
27816 in any directory name.
27817 If no directories are specified, the current path is displayed.
27820 @subsubheading @value{GDBN} Command
27822 The corresponding @value{GDBN} command is @samp{path}.
27824 @subsubheading Example
27829 ^done,path="/usr/bin"
27831 -environment-path /kwikemart/marge/ezannoni/flathead-dev/ppc-eabi/gdb /bin
27832 ^done,path="/kwikemart/marge/ezannoni/flathead-dev/ppc-eabi/gdb:/bin:/usr/bin"
27834 -environment-path -r /usr/local/bin
27835 ^done,path="/usr/local/bin:/usr/bin"
27840 @subheading The @code{-environment-pwd} Command
27841 @findex -environment-pwd
27843 @subsubheading Synopsis
27849 Show the current working directory.
27851 @subsubheading @value{GDBN} Command
27853 The corresponding @value{GDBN} command is @samp{pwd}.
27855 @subsubheading Example
27860 ^done,cwd="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb"
27864 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
27865 @node GDB/MI Thread Commands
27866 @section @sc{gdb/mi} Thread Commands
27869 @subheading The @code{-thread-info} Command
27870 @findex -thread-info
27872 @subsubheading Synopsis
27875 -thread-info [ @var{thread-id} ]
27878 Reports information about either a specific thread, if the
27879 @var{thread-id} parameter is present, or about all threads.
27880 @var{thread-id} is the thread's global thread ID. When printing
27881 information about all threads, also reports the global ID of the
27884 @subsubheading @value{GDBN} Command
27886 The @samp{info thread} command prints the same information
27889 @subsubheading Result
27891 The result is a list of threads. The following attributes are
27892 defined for a given thread:
27896 This field exists only for the current thread. It has the value @samp{*}.
27899 The global identifier that @value{GDBN} uses to refer to the thread.
27902 The identifier that the target uses to refer to the thread.
27905 Extra information about the thread, in a target-specific format. This
27909 The name of the thread. If the user specified a name using the
27910 @code{thread name} command, then this name is given. Otherwise, if
27911 @value{GDBN} can extract the thread name from the target, then that
27912 name is given. If @value{GDBN} cannot find the thread name, then this
27916 The stack frame currently executing in the thread.
27919 The thread's state. The @samp{state} field may have the following
27924 The thread is stopped. Frame information is available for stopped
27928 The thread is running. There's no frame information for running
27934 If @value{GDBN} can find the CPU core on which this thread is running,
27935 then this field is the core identifier. This field is optional.
27939 @subsubheading Example
27944 @{id="2",target-id="Thread 0xb7e14b90 (LWP 21257)",
27945 frame=@{level="0",addr="0xffffe410",func="__kernel_vsyscall",
27946 args=[]@},state="running"@},
27947 @{id="1",target-id="Thread 0xb7e156b0 (LWP 21254)",
27948 frame=@{level="0",addr="0x0804891f",func="foo",
27949 args=[@{name="i",value="10"@}],
27950 file="/tmp/a.c",fullname="/tmp/a.c",line="158"@},
27951 state="running"@}],
27952 current-thread-id="1"
27956 @subheading The @code{-thread-list-ids} Command
27957 @findex -thread-list-ids
27959 @subsubheading Synopsis
27965 Produces a list of the currently known global @value{GDBN} thread ids.
27966 At the end of the list it also prints the total number of such
27969 This command is retained for historical reasons, the
27970 @code{-thread-info} command should be used instead.
27972 @subsubheading @value{GDBN} Command
27974 Part of @samp{info threads} supplies the same information.
27976 @subsubheading Example
27981 ^done,thread-ids=@{thread-id="3",thread-id="2",thread-id="1"@},
27982 current-thread-id="1",number-of-threads="3"
27987 @subheading The @code{-thread-select} Command
27988 @findex -thread-select
27990 @subsubheading Synopsis
27993 -thread-select @var{thread-id}
27996 Make thread with global thread number @var{thread-id} the current
27997 thread. It prints the number of the new current thread, and the
27998 topmost frame for that thread.
28000 This command is deprecated in favor of explicitly using the
28001 @samp{--thread} option to each command.
28003 @subsubheading @value{GDBN} Command
28005 The corresponding @value{GDBN} command is @samp{thread}.
28007 @subsubheading Example
28014 *stopped,reason="end-stepping-range",thread-id="2",line="187",
28015 file="../../../devo/gdb/testsuite/gdb.threads/linux-dp.c"
28019 thread-ids=@{thread-id="3",thread-id="2",thread-id="1"@},
28020 number-of-threads="3"
28023 ^done,new-thread-id="3",
28024 frame=@{level="0",func="vprintf",
28025 args=[@{name="format",value="0x8048e9c \"%*s%c %d %c\\n\""@},
28026 @{name="arg",value="0x2"@}],file="vprintf.c",line="31"@}
28030 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
28031 @node GDB/MI Ada Tasking Commands
28032 @section @sc{gdb/mi} Ada Tasking Commands
28034 @subheading The @code{-ada-task-info} Command
28035 @findex -ada-task-info
28037 @subsubheading Synopsis
28040 -ada-task-info [ @var{task-id} ]
28043 Reports information about either a specific Ada task, if the
28044 @var{task-id} parameter is present, or about all Ada tasks.
28046 @subsubheading @value{GDBN} Command
28048 The @samp{info tasks} command prints the same information
28049 about all Ada tasks (@pxref{Ada Tasks}).
28051 @subsubheading Result
28053 The result is a table of Ada tasks. The following columns are
28054 defined for each Ada task:
28058 This field exists only for the current thread. It has the value @samp{*}.
28061 The identifier that @value{GDBN} uses to refer to the Ada task.
28064 The identifier that the target uses to refer to the Ada task.
28067 The global thread identifier of the thread corresponding to the Ada
28070 This field should always exist, as Ada tasks are always implemented
28071 on top of a thread. But if @value{GDBN} cannot find this corresponding
28072 thread for any reason, the field is omitted.
28075 This field exists only when the task was created by another task.
28076 In this case, it provides the ID of the parent task.
28079 The base priority of the task.
28082 The current state of the task. For a detailed description of the
28083 possible states, see @ref{Ada Tasks}.
28086 The name of the task.
28090 @subsubheading Example
28094 ^done,tasks=@{nr_rows="3",nr_cols="8",
28095 hdr=[@{width="1",alignment="-1",col_name="current",colhdr=""@},
28096 @{width="3",alignment="1",col_name="id",colhdr="ID"@},
28097 @{width="9",alignment="1",col_name="task-id",colhdr="TID"@},
28098 @{width="4",alignment="1",col_name="thread-id",colhdr=""@},
28099 @{width="4",alignment="1",col_name="parent-id",colhdr="P-ID"@},
28100 @{width="3",alignment="1",col_name="priority",colhdr="Pri"@},
28101 @{width="22",alignment="-1",col_name="state",colhdr="State"@},
28102 @{width="1",alignment="2",col_name="name",colhdr="Name"@}],
28103 body=[@{current="*",id="1",task-id=" 644010",thread-id="1",priority="48",
28104 state="Child Termination Wait",name="main_task"@}]@}
28108 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
28109 @node GDB/MI Program Execution
28110 @section @sc{gdb/mi} Program Execution
28112 These are the asynchronous commands which generate the out-of-band
28113 record @samp{*stopped}. Currently @value{GDBN} only really executes
28114 asynchronously with remote targets and this interaction is mimicked in
28117 @subheading The @code{-exec-continue} Command
28118 @findex -exec-continue
28120 @subsubheading Synopsis
28123 -exec-continue [--reverse] [--all|--thread-group N]
28126 Resumes the execution of the inferior program, which will continue
28127 to execute until it reaches a debugger stop event. If the
28128 @samp{--reverse} option is specified, execution resumes in reverse until
28129 it reaches a stop event. Stop events may include
28132 breakpoints or watchpoints
28134 signals or exceptions
28136 the end of the process (or its beginning under @samp{--reverse})
28138 the end or beginning of a replay log if one is being used.
28140 In all-stop mode (@pxref{All-Stop
28141 Mode}), may resume only one thread, or all threads, depending on the
28142 value of the @samp{scheduler-locking} variable. If @samp{--all} is
28143 specified, all threads (in all inferiors) will be resumed. The @samp{--all} option is
28144 ignored in all-stop mode. If the @samp{--thread-group} options is
28145 specified, then all threads in that thread group are resumed.
28147 @subsubheading @value{GDBN} Command
28149 The corresponding @value{GDBN} corresponding is @samp{continue}.
28151 @subsubheading Example
28158 *stopped,reason="breakpoint-hit",disp="keep",bkptno="2",frame=@{
28159 func="foo",args=[],file="hello.c",fullname="/home/foo/bar/hello.c",
28165 @subheading The @code{-exec-finish} Command
28166 @findex -exec-finish
28168 @subsubheading Synopsis
28171 -exec-finish [--reverse]
28174 Resumes the execution of the inferior program until the current
28175 function is exited. Displays the results returned by the function.
28176 If the @samp{--reverse} option is specified, resumes the reverse
28177 execution of the inferior program until the point where current
28178 function was called.
28180 @subsubheading @value{GDBN} Command
28182 The corresponding @value{GDBN} command is @samp{finish}.
28184 @subsubheading Example
28186 Function returning @code{void}.
28193 *stopped,reason="function-finished",frame=@{func="main",args=[],
28194 file="hello.c",fullname="/home/foo/bar/hello.c",line="7"@}
28198 Function returning other than @code{void}. The name of the internal
28199 @value{GDBN} variable storing the result is printed, together with the
28206 *stopped,reason="function-finished",frame=@{addr="0x000107b0",func="foo",
28207 args=[@{name="a",value="1"],@{name="b",value="9"@}@},
28208 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
28209 gdb-result-var="$1",return-value="0"
28214 @subheading The @code{-exec-interrupt} Command
28215 @findex -exec-interrupt
28217 @subsubheading Synopsis
28220 -exec-interrupt [--all|--thread-group N]
28223 Interrupts the background execution of the target. Note how the token
28224 associated with the stop message is the one for the execution command
28225 that has been interrupted. The token for the interrupt itself only
28226 appears in the @samp{^done} output. If the user is trying to
28227 interrupt a non-running program, an error message will be printed.
28229 Note that when asynchronous execution is enabled, this command is
28230 asynchronous just like other execution commands. That is, first the
28231 @samp{^done} response will be printed, and the target stop will be
28232 reported after that using the @samp{*stopped} notification.
28234 In non-stop mode, only the context thread is interrupted by default.
28235 All threads (in all inferiors) will be interrupted if the
28236 @samp{--all} option is specified. If the @samp{--thread-group}
28237 option is specified, all threads in that group will be interrupted.
28239 @subsubheading @value{GDBN} Command
28241 The corresponding @value{GDBN} command is @samp{interrupt}.
28243 @subsubheading Example
28254 111*stopped,signal-name="SIGINT",signal-meaning="Interrupt",
28255 frame=@{addr="0x00010140",func="foo",args=[],file="try.c",
28256 fullname="/home/foo/bar/try.c",line="13"@}
28261 ^error,msg="mi_cmd_exec_interrupt: Inferior not executing."
28265 @subheading The @code{-exec-jump} Command
28268 @subsubheading Synopsis
28271 -exec-jump @var{location}
28274 Resumes execution of the inferior program at the location specified by
28275 parameter. @xref{Specify Location}, for a description of the
28276 different forms of @var{location}.
28278 @subsubheading @value{GDBN} Command
28280 The corresponding @value{GDBN} command is @samp{jump}.
28282 @subsubheading Example
28285 -exec-jump foo.c:10
28286 *running,thread-id="all"
28291 @subheading The @code{-exec-next} Command
28294 @subsubheading Synopsis
28297 -exec-next [--reverse]
28300 Resumes execution of the inferior program, stopping when the beginning
28301 of the next source line is reached.
28303 If the @samp{--reverse} option is specified, resumes reverse execution
28304 of the inferior program, stopping at the beginning of the previous
28305 source line. If you issue this command on the first line of a
28306 function, it will take you back to the caller of that function, to the
28307 source line where the function was called.
28310 @subsubheading @value{GDBN} Command
28312 The corresponding @value{GDBN} command is @samp{next}.
28314 @subsubheading Example
28320 *stopped,reason="end-stepping-range",line="8",file="hello.c"
28325 @subheading The @code{-exec-next-instruction} Command
28326 @findex -exec-next-instruction
28328 @subsubheading Synopsis
28331 -exec-next-instruction [--reverse]
28334 Executes one machine instruction. If the instruction is a function
28335 call, continues until the function returns. If the program stops at an
28336 instruction in the middle of a source line, the address will be
28339 If the @samp{--reverse} option is specified, resumes reverse execution
28340 of the inferior program, stopping at the previous instruction. If the
28341 previously executed instruction was a return from another function,
28342 it will continue to execute in reverse until the call to that function
28343 (from the current stack frame) is reached.
28345 @subsubheading @value{GDBN} Command
28347 The corresponding @value{GDBN} command is @samp{nexti}.
28349 @subsubheading Example
28353 -exec-next-instruction
28357 *stopped,reason="end-stepping-range",
28358 addr="0x000100d4",line="5",file="hello.c"
28363 @subheading The @code{-exec-return} Command
28364 @findex -exec-return
28366 @subsubheading Synopsis
28372 Makes current function return immediately. Doesn't execute the inferior.
28373 Displays the new current frame.
28375 @subsubheading @value{GDBN} Command
28377 The corresponding @value{GDBN} command is @samp{return}.
28379 @subsubheading Example
28383 200-break-insert callee4
28384 200^done,bkpt=@{number="1",addr="0x00010734",
28385 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="8"@}
28390 000*stopped,reason="breakpoint-hit",disp="keep",bkptno="1",
28391 frame=@{func="callee4",args=[],
28392 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
28393 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="8"@}
28399 111^done,frame=@{level="0",func="callee3",
28400 args=[@{name="strarg",
28401 value="0x11940 \"A string argument.\""@}],
28402 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
28403 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="18"@}
28408 @subheading The @code{-exec-run} Command
28411 @subsubheading Synopsis
28414 -exec-run [ --all | --thread-group N ] [ --start ]
28417 Starts execution of the inferior from the beginning. The inferior
28418 executes until either a breakpoint is encountered or the program
28419 exits. In the latter case the output will include an exit code, if
28420 the program has exited exceptionally.
28422 When neither the @samp{--all} nor the @samp{--thread-group} option
28423 is specified, the current inferior is started. If the
28424 @samp{--thread-group} option is specified, it should refer to a thread
28425 group of type @samp{process}, and that thread group will be started.
28426 If the @samp{--all} option is specified, then all inferiors will be started.
28428 Using the @samp{--start} option instructs the debugger to stop
28429 the execution at the start of the inferior's main subprogram,
28430 following the same behavior as the @code{start} command
28431 (@pxref{Starting}).
28433 @subsubheading @value{GDBN} Command
28435 The corresponding @value{GDBN} command is @samp{run}.
28437 @subsubheading Examples
28442 ^done,bkpt=@{number="1",addr="0x0001072c",file="recursive2.c",line="4"@}
28447 *stopped,reason="breakpoint-hit",disp="keep",bkptno="1",
28448 frame=@{func="main",args=[],file="recursive2.c",
28449 fullname="/home/foo/bar/recursive2.c",line="4"@}
28454 Program exited normally:
28462 *stopped,reason="exited-normally"
28467 Program exited exceptionally:
28475 *stopped,reason="exited",exit-code="01"
28479 Another way the program can terminate is if it receives a signal such as
28480 @code{SIGINT}. In this case, @sc{gdb/mi} displays this:
28484 *stopped,reason="exited-signalled",signal-name="SIGINT",
28485 signal-meaning="Interrupt"
28489 @c @subheading -exec-signal
28492 @subheading The @code{-exec-step} Command
28495 @subsubheading Synopsis
28498 -exec-step [--reverse]
28501 Resumes execution of the inferior program, stopping when the beginning
28502 of the next source line is reached, if the next source line is not a
28503 function call. If it is, stop at the first instruction of the called
28504 function. If the @samp{--reverse} option is specified, resumes reverse
28505 execution of the inferior program, stopping at the beginning of the
28506 previously executed source line.
28508 @subsubheading @value{GDBN} Command
28510 The corresponding @value{GDBN} command is @samp{step}.
28512 @subsubheading Example
28514 Stepping into a function:
28520 *stopped,reason="end-stepping-range",
28521 frame=@{func="foo",args=[@{name="a",value="10"@},
28522 @{name="b",value="0"@}],file="recursive2.c",
28523 fullname="/home/foo/bar/recursive2.c",line="11"@}
28533 *stopped,reason="end-stepping-range",line="14",file="recursive2.c"
28538 @subheading The @code{-exec-step-instruction} Command
28539 @findex -exec-step-instruction
28541 @subsubheading Synopsis
28544 -exec-step-instruction [--reverse]
28547 Resumes the inferior which executes one machine instruction. If the
28548 @samp{--reverse} option is specified, resumes reverse execution of the
28549 inferior program, stopping at the previously executed instruction.
28550 The output, once @value{GDBN} has stopped, will vary depending on
28551 whether we have stopped in the middle of a source line or not. In the
28552 former case, the address at which the program stopped will be printed
28555 @subsubheading @value{GDBN} Command
28557 The corresponding @value{GDBN} command is @samp{stepi}.
28559 @subsubheading Example
28563 -exec-step-instruction
28567 *stopped,reason="end-stepping-range",
28568 frame=@{func="foo",args=[],file="try.c",
28569 fullname="/home/foo/bar/try.c",line="10"@}
28571 -exec-step-instruction
28575 *stopped,reason="end-stepping-range",
28576 frame=@{addr="0x000100f4",func="foo",args=[],file="try.c",
28577 fullname="/home/foo/bar/try.c",line="10"@}
28582 @subheading The @code{-exec-until} Command
28583 @findex -exec-until
28585 @subsubheading Synopsis
28588 -exec-until [ @var{location} ]
28591 Executes the inferior until the @var{location} specified in the
28592 argument is reached. If there is no argument, the inferior executes
28593 until a source line greater than the current one is reached. The
28594 reason for stopping in this case will be @samp{location-reached}.
28596 @subsubheading @value{GDBN} Command
28598 The corresponding @value{GDBN} command is @samp{until}.
28600 @subsubheading Example
28604 -exec-until recursive2.c:6
28608 *stopped,reason="location-reached",frame=@{func="main",args=[],
28609 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="6"@}
28614 @subheading -file-clear
28615 Is this going away????
28618 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
28619 @node GDB/MI Stack Manipulation
28620 @section @sc{gdb/mi} Stack Manipulation Commands
28622 @subheading The @code{-enable-frame-filters} Command
28623 @findex -enable-frame-filters
28626 -enable-frame-filters
28629 @value{GDBN} allows Python-based frame filters to affect the output of
28630 the MI commands relating to stack traces. As there is no way to
28631 implement this in a fully backward-compatible way, a front end must
28632 request that this functionality be enabled.
28634 Once enabled, this feature cannot be disabled.
28636 Note that if Python support has not been compiled into @value{GDBN},
28637 this command will still succeed (and do nothing).
28639 @subheading The @code{-stack-info-frame} Command
28640 @findex -stack-info-frame
28642 @subsubheading Synopsis
28648 Get info on the selected frame.
28650 @subsubheading @value{GDBN} Command
28652 The corresponding @value{GDBN} command is @samp{info frame} or @samp{frame}
28653 (without arguments).
28655 @subsubheading Example
28660 ^done,frame=@{level="1",addr="0x0001076c",func="callee3",
28661 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
28662 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="17"@}
28666 @subheading The @code{-stack-info-depth} Command
28667 @findex -stack-info-depth
28669 @subsubheading Synopsis
28672 -stack-info-depth [ @var{max-depth} ]
28675 Return the depth of the stack. If the integer argument @var{max-depth}
28676 is specified, do not count beyond @var{max-depth} frames.
28678 @subsubheading @value{GDBN} Command
28680 There's no equivalent @value{GDBN} command.
28682 @subsubheading Example
28684 For a stack with frame levels 0 through 11:
28691 -stack-info-depth 4
28694 -stack-info-depth 12
28697 -stack-info-depth 11
28700 -stack-info-depth 13
28705 @anchor{-stack-list-arguments}
28706 @subheading The @code{-stack-list-arguments} Command
28707 @findex -stack-list-arguments
28709 @subsubheading Synopsis
28712 -stack-list-arguments [ --no-frame-filters ] [ --skip-unavailable ] @var{print-values}
28713 [ @var{low-frame} @var{high-frame} ]
28716 Display a list of the arguments for the frames between @var{low-frame}
28717 and @var{high-frame} (inclusive). If @var{low-frame} and
28718 @var{high-frame} are not provided, list the arguments for the whole
28719 call stack. If the two arguments are equal, show the single frame
28720 at the corresponding level. It is an error if @var{low-frame} is
28721 larger than the actual number of frames. On the other hand,
28722 @var{high-frame} may be larger than the actual number of frames, in
28723 which case only existing frames will be returned.
28725 If @var{print-values} is 0 or @code{--no-values}, print only the names of
28726 the variables; if it is 1 or @code{--all-values}, print also their
28727 values; and if it is 2 or @code{--simple-values}, print the name,
28728 type and value for simple data types, and the name and type for arrays,
28729 structures and unions. If the option @code{--no-frame-filters} is
28730 supplied, then Python frame filters will not be executed.
28732 If the @code{--skip-unavailable} option is specified, arguments that
28733 are not available are not listed. Partially available arguments
28734 are still displayed, however.
28736 Use of this command to obtain arguments in a single frame is
28737 deprecated in favor of the @samp{-stack-list-variables} command.
28739 @subsubheading @value{GDBN} Command
28741 @value{GDBN} does not have an equivalent command. @code{gdbtk} has a
28742 @samp{gdb_get_args} command which partially overlaps with the
28743 functionality of @samp{-stack-list-arguments}.
28745 @subsubheading Example
28752 frame=@{level="0",addr="0x00010734",func="callee4",
28753 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
28754 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="8"@},
28755 frame=@{level="1",addr="0x0001076c",func="callee3",
28756 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
28757 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="17"@},
28758 frame=@{level="2",addr="0x0001078c",func="callee2",
28759 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
28760 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="22"@},
28761 frame=@{level="3",addr="0x000107b4",func="callee1",
28762 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
28763 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="27"@},
28764 frame=@{level="4",addr="0x000107e0",func="main",
28765 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
28766 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="32"@}]
28768 -stack-list-arguments 0
28771 frame=@{level="0",args=[]@},
28772 frame=@{level="1",args=[name="strarg"]@},
28773 frame=@{level="2",args=[name="intarg",name="strarg"]@},
28774 frame=@{level="3",args=[name="intarg",name="strarg",name="fltarg"]@},
28775 frame=@{level="4",args=[]@}]
28777 -stack-list-arguments 1
28780 frame=@{level="0",args=[]@},
28782 args=[@{name="strarg",value="0x11940 \"A string argument.\""@}]@},
28783 frame=@{level="2",args=[
28784 @{name="intarg",value="2"@},
28785 @{name="strarg",value="0x11940 \"A string argument.\""@}]@},
28786 @{frame=@{level="3",args=[
28787 @{name="intarg",value="2"@},
28788 @{name="strarg",value="0x11940 \"A string argument.\""@},
28789 @{name="fltarg",value="3.5"@}]@},
28790 frame=@{level="4",args=[]@}]
28792 -stack-list-arguments 0 2 2
28793 ^done,stack-args=[frame=@{level="2",args=[name="intarg",name="strarg"]@}]
28795 -stack-list-arguments 1 2 2
28796 ^done,stack-args=[frame=@{level="2",
28797 args=[@{name="intarg",value="2"@},
28798 @{name="strarg",value="0x11940 \"A string argument.\""@}]@}]
28802 @c @subheading -stack-list-exception-handlers
28805 @anchor{-stack-list-frames}
28806 @subheading The @code{-stack-list-frames} Command
28807 @findex -stack-list-frames
28809 @subsubheading Synopsis
28812 -stack-list-frames [ --no-frame-filters @var{low-frame} @var{high-frame} ]
28815 List the frames currently on the stack. For each frame it displays the
28820 The frame number, 0 being the topmost frame, i.e., the innermost function.
28822 The @code{$pc} value for that frame.
28826 File name of the source file where the function lives.
28827 @item @var{fullname}
28828 The full file name of the source file where the function lives.
28830 Line number corresponding to the @code{$pc}.
28832 The shared library where this function is defined. This is only given
28833 if the frame's function is not known.
28836 If invoked without arguments, this command prints a backtrace for the
28837 whole stack. If given two integer arguments, it shows the frames whose
28838 levels are between the two arguments (inclusive). If the two arguments
28839 are equal, it shows the single frame at the corresponding level. It is
28840 an error if @var{low-frame} is larger than the actual number of
28841 frames. On the other hand, @var{high-frame} may be larger than the
28842 actual number of frames, in which case only existing frames will be
28843 returned. If the option @code{--no-frame-filters} is supplied, then
28844 Python frame filters will not be executed.
28846 @subsubheading @value{GDBN} Command
28848 The corresponding @value{GDBN} commands are @samp{backtrace} and @samp{where}.
28850 @subsubheading Example
28852 Full stack backtrace:
28858 [frame=@{level="0",addr="0x0001076c",func="foo",
28859 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="11"@},
28860 frame=@{level="1",addr="0x000107a4",func="foo",
28861 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
28862 frame=@{level="2",addr="0x000107a4",func="foo",
28863 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
28864 frame=@{level="3",addr="0x000107a4",func="foo",
28865 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
28866 frame=@{level="4",addr="0x000107a4",func="foo",
28867 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
28868 frame=@{level="5",addr="0x000107a4",func="foo",
28869 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
28870 frame=@{level="6",addr="0x000107a4",func="foo",
28871 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
28872 frame=@{level="7",addr="0x000107a4",func="foo",
28873 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
28874 frame=@{level="8",addr="0x000107a4",func="foo",
28875 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
28876 frame=@{level="9",addr="0x000107a4",func="foo",
28877 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
28878 frame=@{level="10",addr="0x000107a4",func="foo",
28879 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
28880 frame=@{level="11",addr="0x00010738",func="main",
28881 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="4"@}]
28885 Show frames between @var{low_frame} and @var{high_frame}:
28889 -stack-list-frames 3 5
28891 [frame=@{level="3",addr="0x000107a4",func="foo",
28892 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
28893 frame=@{level="4",addr="0x000107a4",func="foo",
28894 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
28895 frame=@{level="5",addr="0x000107a4",func="foo",
28896 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}]
28900 Show a single frame:
28904 -stack-list-frames 3 3
28906 [frame=@{level="3",addr="0x000107a4",func="foo",
28907 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}]
28912 @subheading The @code{-stack-list-locals} Command
28913 @findex -stack-list-locals
28914 @anchor{-stack-list-locals}
28916 @subsubheading Synopsis
28919 -stack-list-locals [ --no-frame-filters ] [ --skip-unavailable ] @var{print-values}
28922 Display the local variable names for the selected frame. If
28923 @var{print-values} is 0 or @code{--no-values}, print only the names of
28924 the variables; if it is 1 or @code{--all-values}, print also their
28925 values; and if it is 2 or @code{--simple-values}, print the name,
28926 type and value for simple data types, and the name and type for arrays,
28927 structures and unions. In this last case, a frontend can immediately
28928 display the value of simple data types and create variable objects for
28929 other data types when the user wishes to explore their values in
28930 more detail. If the option @code{--no-frame-filters} is supplied, then
28931 Python frame filters will not be executed.
28933 If the @code{--skip-unavailable} option is specified, local variables
28934 that are not available are not listed. Partially available local
28935 variables are still displayed, however.
28937 This command is deprecated in favor of the
28938 @samp{-stack-list-variables} command.
28940 @subsubheading @value{GDBN} Command
28942 @samp{info locals} in @value{GDBN}, @samp{gdb_get_locals} in @code{gdbtk}.
28944 @subsubheading Example
28948 -stack-list-locals 0
28949 ^done,locals=[name="A",name="B",name="C"]
28951 -stack-list-locals --all-values
28952 ^done,locals=[@{name="A",value="1"@},@{name="B",value="2"@},
28953 @{name="C",value="@{1, 2, 3@}"@}]
28954 -stack-list-locals --simple-values
28955 ^done,locals=[@{name="A",type="int",value="1"@},
28956 @{name="B",type="int",value="2"@},@{name="C",type="int [3]"@}]
28960 @anchor{-stack-list-variables}
28961 @subheading The @code{-stack-list-variables} Command
28962 @findex -stack-list-variables
28964 @subsubheading Synopsis
28967 -stack-list-variables [ --no-frame-filters ] [ --skip-unavailable ] @var{print-values}
28970 Display the names of local variables and function arguments for the selected frame. If
28971 @var{print-values} is 0 or @code{--no-values}, print only the names of
28972 the variables; if it is 1 or @code{--all-values}, print also their
28973 values; and if it is 2 or @code{--simple-values}, print the name,
28974 type and value for simple data types, and the name and type for arrays,
28975 structures and unions. If the option @code{--no-frame-filters} is
28976 supplied, then Python frame filters will not be executed.
28978 If the @code{--skip-unavailable} option is specified, local variables
28979 and arguments that are not available are not listed. Partially
28980 available arguments and local variables are still displayed, however.
28982 @subsubheading Example
28986 -stack-list-variables --thread 1 --frame 0 --all-values
28987 ^done,variables=[@{name="x",value="11"@},@{name="s",value="@{a = 1, b = 2@}"@}]
28992 @subheading The @code{-stack-select-frame} Command
28993 @findex -stack-select-frame
28995 @subsubheading Synopsis
28998 -stack-select-frame @var{framenum}
29001 Change the selected frame. Select a different frame @var{framenum} on
29004 This command in deprecated in favor of passing the @samp{--frame}
29005 option to every command.
29007 @subsubheading @value{GDBN} Command
29009 The corresponding @value{GDBN} commands are @samp{frame}, @samp{up},
29010 @samp{down}, @samp{select-frame}, @samp{up-silent}, and @samp{down-silent}.
29012 @subsubheading Example
29016 -stack-select-frame 2
29021 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
29022 @node GDB/MI Variable Objects
29023 @section @sc{gdb/mi} Variable Objects
29027 @subheading Motivation for Variable Objects in @sc{gdb/mi}
29029 For the implementation of a variable debugger window (locals, watched
29030 expressions, etc.), we are proposing the adaptation of the existing code
29031 used by @code{Insight}.
29033 The two main reasons for that are:
29037 It has been proven in practice (it is already on its second generation).
29040 It will shorten development time (needless to say how important it is
29044 The original interface was designed to be used by Tcl code, so it was
29045 slightly changed so it could be used through @sc{gdb/mi}. This section
29046 describes the @sc{gdb/mi} operations that will be available and gives some
29047 hints about their use.
29049 @emph{Note}: In addition to the set of operations described here, we
29050 expect the @sc{gui} implementation of a variable window to require, at
29051 least, the following operations:
29054 @item @code{-gdb-show} @code{output-radix}
29055 @item @code{-stack-list-arguments}
29056 @item @code{-stack-list-locals}
29057 @item @code{-stack-select-frame}
29062 @subheading Introduction to Variable Objects
29064 @cindex variable objects in @sc{gdb/mi}
29066 Variable objects are "object-oriented" MI interface for examining and
29067 changing values of expressions. Unlike some other MI interfaces that
29068 work with expressions, variable objects are specifically designed for
29069 simple and efficient presentation in the frontend. A variable object
29070 is identified by string name. When a variable object is created, the
29071 frontend specifies the expression for that variable object. The
29072 expression can be a simple variable, or it can be an arbitrary complex
29073 expression, and can even involve CPU registers. After creating a
29074 variable object, the frontend can invoke other variable object
29075 operations---for example to obtain or change the value of a variable
29076 object, or to change display format.
29078 Variable objects have hierarchical tree structure. Any variable object
29079 that corresponds to a composite type, such as structure in C, has
29080 a number of child variable objects, for example corresponding to each
29081 element of a structure. A child variable object can itself have
29082 children, recursively. Recursion ends when we reach
29083 leaf variable objects, which always have built-in types. Child variable
29084 objects are created only by explicit request, so if a frontend
29085 is not interested in the children of a particular variable object, no
29086 child will be created.
29088 For a leaf variable object it is possible to obtain its value as a
29089 string, or set the value from a string. String value can be also
29090 obtained for a non-leaf variable object, but it's generally a string
29091 that only indicates the type of the object, and does not list its
29092 contents. Assignment to a non-leaf variable object is not allowed.
29094 A frontend does not need to read the values of all variable objects each time
29095 the program stops. Instead, MI provides an update command that lists all
29096 variable objects whose values has changed since the last update
29097 operation. This considerably reduces the amount of data that must
29098 be transferred to the frontend. As noted above, children variable
29099 objects are created on demand, and only leaf variable objects have a
29100 real value. As result, gdb will read target memory only for leaf
29101 variables that frontend has created.
29103 The automatic update is not always desirable. For example, a frontend
29104 might want to keep a value of some expression for future reference,
29105 and never update it. For another example, fetching memory is
29106 relatively slow for embedded targets, so a frontend might want
29107 to disable automatic update for the variables that are either not
29108 visible on the screen, or ``closed''. This is possible using so
29109 called ``frozen variable objects''. Such variable objects are never
29110 implicitly updated.
29112 Variable objects can be either @dfn{fixed} or @dfn{floating}. For the
29113 fixed variable object, the expression is parsed when the variable
29114 object is created, including associating identifiers to specific
29115 variables. The meaning of expression never changes. For a floating
29116 variable object the values of variables whose names appear in the
29117 expressions are re-evaluated every time in the context of the current
29118 frame. Consider this example:
29123 struct work_state state;
29130 If a fixed variable object for the @code{state} variable is created in
29131 this function, and we enter the recursive call, the variable
29132 object will report the value of @code{state} in the top-level
29133 @code{do_work} invocation. On the other hand, a floating variable
29134 object will report the value of @code{state} in the current frame.
29136 If an expression specified when creating a fixed variable object
29137 refers to a local variable, the variable object becomes bound to the
29138 thread and frame in which the variable object is created. When such
29139 variable object is updated, @value{GDBN} makes sure that the
29140 thread/frame combination the variable object is bound to still exists,
29141 and re-evaluates the variable object in context of that thread/frame.
29143 The following is the complete set of @sc{gdb/mi} operations defined to
29144 access this functionality:
29146 @multitable @columnfractions .4 .6
29147 @item @strong{Operation}
29148 @tab @strong{Description}
29150 @item @code{-enable-pretty-printing}
29151 @tab enable Python-based pretty-printing
29152 @item @code{-var-create}
29153 @tab create a variable object
29154 @item @code{-var-delete}
29155 @tab delete the variable object and/or its children
29156 @item @code{-var-set-format}
29157 @tab set the display format of this variable
29158 @item @code{-var-show-format}
29159 @tab show the display format of this variable
29160 @item @code{-var-info-num-children}
29161 @tab tells how many children this object has
29162 @item @code{-var-list-children}
29163 @tab return a list of the object's children
29164 @item @code{-var-info-type}
29165 @tab show the type of this variable object
29166 @item @code{-var-info-expression}
29167 @tab print parent-relative expression that this variable object represents
29168 @item @code{-var-info-path-expression}
29169 @tab print full expression that this variable object represents
29170 @item @code{-var-show-attributes}
29171 @tab is this variable editable? does it exist here?
29172 @item @code{-var-evaluate-expression}
29173 @tab get the value of this variable
29174 @item @code{-var-assign}
29175 @tab set the value of this variable
29176 @item @code{-var-update}
29177 @tab update the variable and its children
29178 @item @code{-var-set-frozen}
29179 @tab set frozeness attribute
29180 @item @code{-var-set-update-range}
29181 @tab set range of children to display on update
29184 In the next subsection we describe each operation in detail and suggest
29185 how it can be used.
29187 @subheading Description And Use of Operations on Variable Objects
29189 @subheading The @code{-enable-pretty-printing} Command
29190 @findex -enable-pretty-printing
29193 -enable-pretty-printing
29196 @value{GDBN} allows Python-based visualizers to affect the output of the
29197 MI variable object commands. However, because there was no way to
29198 implement this in a fully backward-compatible way, a front end must
29199 request that this functionality be enabled.
29201 Once enabled, this feature cannot be disabled.
29203 Note that if Python support has not been compiled into @value{GDBN},
29204 this command will still succeed (and do nothing).
29206 This feature is currently (as of @value{GDBN} 7.0) experimental, and
29207 may work differently in future versions of @value{GDBN}.
29209 @subheading The @code{-var-create} Command
29210 @findex -var-create
29212 @subsubheading Synopsis
29215 -var-create @{@var{name} | "-"@}
29216 @{@var{frame-addr} | "*" | "@@"@} @var{expression}
29219 This operation creates a variable object, which allows the monitoring of
29220 a variable, the result of an expression, a memory cell or a CPU
29223 The @var{name} parameter is the string by which the object can be
29224 referenced. It must be unique. If @samp{-} is specified, the varobj
29225 system will generate a string ``varNNNNNN'' automatically. It will be
29226 unique provided that one does not specify @var{name} of that format.
29227 The command fails if a duplicate name is found.
29229 The frame under which the expression should be evaluated can be
29230 specified by @var{frame-addr}. A @samp{*} indicates that the current
29231 frame should be used. A @samp{@@} indicates that a floating variable
29232 object must be created.
29234 @var{expression} is any expression valid on the current language set (must not
29235 begin with a @samp{*}), or one of the following:
29239 @samp{*@var{addr}}, where @var{addr} is the address of a memory cell
29242 @samp{*@var{addr}-@var{addr}} --- a memory address range (TBD)
29245 @samp{$@var{regname}} --- a CPU register name
29248 @cindex dynamic varobj
29249 A varobj's contents may be provided by a Python-based pretty-printer. In this
29250 case the varobj is known as a @dfn{dynamic varobj}. Dynamic varobjs
29251 have slightly different semantics in some cases. If the
29252 @code{-enable-pretty-printing} command is not sent, then @value{GDBN}
29253 will never create a dynamic varobj. This ensures backward
29254 compatibility for existing clients.
29256 @subsubheading Result
29258 This operation returns attributes of the newly-created varobj. These
29263 The name of the varobj.
29266 The number of children of the varobj. This number is not necessarily
29267 reliable for a dynamic varobj. Instead, you must examine the
29268 @samp{has_more} attribute.
29271 The varobj's scalar value. For a varobj whose type is some sort of
29272 aggregate (e.g., a @code{struct}), or for a dynamic varobj, this value
29273 will not be interesting.
29276 The varobj's type. This is a string representation of the type, as
29277 would be printed by the @value{GDBN} CLI. If @samp{print object}
29278 (@pxref{Print Settings, set print object}) is set to @code{on}, the
29279 @emph{actual} (derived) type of the object is shown rather than the
29280 @emph{declared} one.
29283 If a variable object is bound to a specific thread, then this is the
29284 thread's global identifier.
29287 For a dynamic varobj, this indicates whether there appear to be any
29288 children available. For a non-dynamic varobj, this will be 0.
29291 This attribute will be present and have the value @samp{1} if the
29292 varobj is a dynamic varobj. If the varobj is not a dynamic varobj,
29293 then this attribute will not be present.
29296 A dynamic varobj can supply a display hint to the front end. The
29297 value comes directly from the Python pretty-printer object's
29298 @code{display_hint} method. @xref{Pretty Printing API}.
29301 Typical output will look like this:
29304 name="@var{name}",numchild="@var{N}",type="@var{type}",thread-id="@var{M}",
29305 has_more="@var{has_more}"
29309 @subheading The @code{-var-delete} Command
29310 @findex -var-delete
29312 @subsubheading Synopsis
29315 -var-delete [ -c ] @var{name}
29318 Deletes a previously created variable object and all of its children.
29319 With the @samp{-c} option, just deletes the children.
29321 Returns an error if the object @var{name} is not found.
29324 @subheading The @code{-var-set-format} Command
29325 @findex -var-set-format
29327 @subsubheading Synopsis
29330 -var-set-format @var{name} @var{format-spec}
29333 Sets the output format for the value of the object @var{name} to be
29336 @anchor{-var-set-format}
29337 The syntax for the @var{format-spec} is as follows:
29340 @var{format-spec} @expansion{}
29341 @{binary | decimal | hexadecimal | octal | natural | zero-hexadecimal@}
29344 The natural format is the default format choosen automatically
29345 based on the variable type (like decimal for an @code{int}, hex
29346 for pointers, etc.).
29348 The zero-hexadecimal format has a representation similar to hexadecimal
29349 but with padding zeroes to the left of the value. For example, a 32-bit
29350 hexadecimal value of 0x1234 would be represented as 0x00001234 in the
29351 zero-hexadecimal format.
29353 For a variable with children, the format is set only on the
29354 variable itself, and the children are not affected.
29356 @subheading The @code{-var-show-format} Command
29357 @findex -var-show-format
29359 @subsubheading Synopsis
29362 -var-show-format @var{name}
29365 Returns the format used to display the value of the object @var{name}.
29368 @var{format} @expansion{}
29373 @subheading The @code{-var-info-num-children} Command
29374 @findex -var-info-num-children
29376 @subsubheading Synopsis
29379 -var-info-num-children @var{name}
29382 Returns the number of children of a variable object @var{name}:
29388 Note that this number is not completely reliable for a dynamic varobj.
29389 It will return the current number of children, but more children may
29393 @subheading The @code{-var-list-children} Command
29394 @findex -var-list-children
29396 @subsubheading Synopsis
29399 -var-list-children [@var{print-values}] @var{name} [@var{from} @var{to}]
29401 @anchor{-var-list-children}
29403 Return a list of the children of the specified variable object and
29404 create variable objects for them, if they do not already exist. With
29405 a single argument or if @var{print-values} has a value of 0 or
29406 @code{--no-values}, print only the names of the variables; if
29407 @var{print-values} is 1 or @code{--all-values}, also print their
29408 values; and if it is 2 or @code{--simple-values} print the name and
29409 value for simple data types and just the name for arrays, structures
29412 @var{from} and @var{to}, if specified, indicate the range of children
29413 to report. If @var{from} or @var{to} is less than zero, the range is
29414 reset and all children will be reported. Otherwise, children starting
29415 at @var{from} (zero-based) and up to and excluding @var{to} will be
29418 If a child range is requested, it will only affect the current call to
29419 @code{-var-list-children}, but not future calls to @code{-var-update}.
29420 For this, you must instead use @code{-var-set-update-range}. The
29421 intent of this approach is to enable a front end to implement any
29422 update approach it likes; for example, scrolling a view may cause the
29423 front end to request more children with @code{-var-list-children}, and
29424 then the front end could call @code{-var-set-update-range} with a
29425 different range to ensure that future updates are restricted to just
29428 For each child the following results are returned:
29433 Name of the variable object created for this child.
29436 The expression to be shown to the user by the front end to designate this child.
29437 For example this may be the name of a structure member.
29439 For a dynamic varobj, this value cannot be used to form an
29440 expression. There is no way to do this at all with a dynamic varobj.
29442 For C/C@t{++} structures there are several pseudo children returned to
29443 designate access qualifiers. For these pseudo children @var{exp} is
29444 @samp{public}, @samp{private}, or @samp{protected}. In this case the
29445 type and value are not present.
29447 A dynamic varobj will not report the access qualifying
29448 pseudo-children, regardless of the language. This information is not
29449 available at all with a dynamic varobj.
29452 Number of children this child has. For a dynamic varobj, this will be
29456 The type of the child. If @samp{print object}
29457 (@pxref{Print Settings, set print object}) is set to @code{on}, the
29458 @emph{actual} (derived) type of the object is shown rather than the
29459 @emph{declared} one.
29462 If values were requested, this is the value.
29465 If this variable object is associated with a thread, this is the
29466 thread's global thread id. Otherwise this result is not present.
29469 If the variable object is frozen, this variable will be present with a value of 1.
29472 A dynamic varobj can supply a display hint to the front end. The
29473 value comes directly from the Python pretty-printer object's
29474 @code{display_hint} method. @xref{Pretty Printing API}.
29477 This attribute will be present and have the value @samp{1} if the
29478 varobj is a dynamic varobj. If the varobj is not a dynamic varobj,
29479 then this attribute will not be present.
29483 The result may have its own attributes:
29487 A dynamic varobj can supply a display hint to the front end. The
29488 value comes directly from the Python pretty-printer object's
29489 @code{display_hint} method. @xref{Pretty Printing API}.
29492 This is an integer attribute which is nonzero if there are children
29493 remaining after the end of the selected range.
29496 @subsubheading Example
29500 -var-list-children n
29501 ^done,numchild=@var{n},children=[child=@{name=@var{name},exp=@var{exp},
29502 numchild=@var{n},type=@var{type}@},@r{(repeats N times)}]
29504 -var-list-children --all-values n
29505 ^done,numchild=@var{n},children=[child=@{name=@var{name},exp=@var{exp},
29506 numchild=@var{n},value=@var{value},type=@var{type}@},@r{(repeats N times)}]
29510 @subheading The @code{-var-info-type} Command
29511 @findex -var-info-type
29513 @subsubheading Synopsis
29516 -var-info-type @var{name}
29519 Returns the type of the specified variable @var{name}. The type is
29520 returned as a string in the same format as it is output by the
29524 type=@var{typename}
29528 @subheading The @code{-var-info-expression} Command
29529 @findex -var-info-expression
29531 @subsubheading Synopsis
29534 -var-info-expression @var{name}
29537 Returns a string that is suitable for presenting this
29538 variable object in user interface. The string is generally
29539 not valid expression in the current language, and cannot be evaluated.
29541 For example, if @code{a} is an array, and variable object
29542 @code{A} was created for @code{a}, then we'll get this output:
29545 (gdb) -var-info-expression A.1
29546 ^done,lang="C",exp="1"
29550 Here, the value of @code{lang} is the language name, which can be
29551 found in @ref{Supported Languages}.
29553 Note that the output of the @code{-var-list-children} command also
29554 includes those expressions, so the @code{-var-info-expression} command
29557 @subheading The @code{-var-info-path-expression} Command
29558 @findex -var-info-path-expression
29560 @subsubheading Synopsis
29563 -var-info-path-expression @var{name}
29566 Returns an expression that can be evaluated in the current
29567 context and will yield the same value that a variable object has.
29568 Compare this with the @code{-var-info-expression} command, which
29569 result can be used only for UI presentation. Typical use of
29570 the @code{-var-info-path-expression} command is creating a
29571 watchpoint from a variable object.
29573 This command is currently not valid for children of a dynamic varobj,
29574 and will give an error when invoked on one.
29576 For example, suppose @code{C} is a C@t{++} class, derived from class
29577 @code{Base}, and that the @code{Base} class has a member called
29578 @code{m_size}. Assume a variable @code{c} is has the type of
29579 @code{C} and a variable object @code{C} was created for variable
29580 @code{c}. Then, we'll get this output:
29582 (gdb) -var-info-path-expression C.Base.public.m_size
29583 ^done,path_expr=((Base)c).m_size)
29586 @subheading The @code{-var-show-attributes} Command
29587 @findex -var-show-attributes
29589 @subsubheading Synopsis
29592 -var-show-attributes @var{name}
29595 List attributes of the specified variable object @var{name}:
29598 status=@var{attr} [ ( ,@var{attr} )* ]
29602 where @var{attr} is @code{@{ @{ editable | noneditable @} | TBD @}}.
29604 @subheading The @code{-var-evaluate-expression} Command
29605 @findex -var-evaluate-expression
29607 @subsubheading Synopsis
29610 -var-evaluate-expression [-f @var{format-spec}] @var{name}
29613 Evaluates the expression that is represented by the specified variable
29614 object and returns its value as a string. The format of the string
29615 can be specified with the @samp{-f} option. The possible values of
29616 this option are the same as for @code{-var-set-format}
29617 (@pxref{-var-set-format}). If the @samp{-f} option is not specified,
29618 the current display format will be used. The current display format
29619 can be changed using the @code{-var-set-format} command.
29625 Note that one must invoke @code{-var-list-children} for a variable
29626 before the value of a child variable can be evaluated.
29628 @subheading The @code{-var-assign} Command
29629 @findex -var-assign
29631 @subsubheading Synopsis
29634 -var-assign @var{name} @var{expression}
29637 Assigns the value of @var{expression} to the variable object specified
29638 by @var{name}. The object must be @samp{editable}. If the variable's
29639 value is altered by the assign, the variable will show up in any
29640 subsequent @code{-var-update} list.
29642 @subsubheading Example
29650 ^done,changelist=[@{name="var1",in_scope="true",type_changed="false"@}]
29654 @subheading The @code{-var-update} Command
29655 @findex -var-update
29657 @subsubheading Synopsis
29660 -var-update [@var{print-values}] @{@var{name} | "*"@}
29663 Reevaluate the expressions corresponding to the variable object
29664 @var{name} and all its direct and indirect children, and return the
29665 list of variable objects whose values have changed; @var{name} must
29666 be a root variable object. Here, ``changed'' means that the result of
29667 @code{-var-evaluate-expression} before and after the
29668 @code{-var-update} is different. If @samp{*} is used as the variable
29669 object names, all existing variable objects are updated, except
29670 for frozen ones (@pxref{-var-set-frozen}). The option
29671 @var{print-values} determines whether both names and values, or just
29672 names are printed. The possible values of this option are the same
29673 as for @code{-var-list-children} (@pxref{-var-list-children}). It is
29674 recommended to use the @samp{--all-values} option, to reduce the
29675 number of MI commands needed on each program stop.
29677 With the @samp{*} parameter, if a variable object is bound to a
29678 currently running thread, it will not be updated, without any
29681 If @code{-var-set-update-range} was previously used on a varobj, then
29682 only the selected range of children will be reported.
29684 @code{-var-update} reports all the changed varobjs in a tuple named
29687 Each item in the change list is itself a tuple holding:
29691 The name of the varobj.
29694 If values were requested for this update, then this field will be
29695 present and will hold the value of the varobj.
29698 @anchor{-var-update}
29699 This field is a string which may take one of three values:
29703 The variable object's current value is valid.
29706 The variable object does not currently hold a valid value but it may
29707 hold one in the future if its associated expression comes back into
29711 The variable object no longer holds a valid value.
29712 This can occur when the executable file being debugged has changed,
29713 either through recompilation or by using the @value{GDBN} @code{file}
29714 command. The front end should normally choose to delete these variable
29718 In the future new values may be added to this list so the front should
29719 be prepared for this possibility. @xref{GDB/MI Development and Front Ends, ,@sc{GDB/MI} Development and Front Ends}.
29722 This is only present if the varobj is still valid. If the type
29723 changed, then this will be the string @samp{true}; otherwise it will
29726 When a varobj's type changes, its children are also likely to have
29727 become incorrect. Therefore, the varobj's children are automatically
29728 deleted when this attribute is @samp{true}. Also, the varobj's update
29729 range, when set using the @code{-var-set-update-range} command, is
29733 If the varobj's type changed, then this field will be present and will
29736 @item new_num_children
29737 For a dynamic varobj, if the number of children changed, or if the
29738 type changed, this will be the new number of children.
29740 The @samp{numchild} field in other varobj responses is generally not
29741 valid for a dynamic varobj -- it will show the number of children that
29742 @value{GDBN} knows about, but because dynamic varobjs lazily
29743 instantiate their children, this will not reflect the number of
29744 children which may be available.
29746 The @samp{new_num_children} attribute only reports changes to the
29747 number of children known by @value{GDBN}. This is the only way to
29748 detect whether an update has removed children (which necessarily can
29749 only happen at the end of the update range).
29752 The display hint, if any.
29755 This is an integer value, which will be 1 if there are more children
29756 available outside the varobj's update range.
29759 This attribute will be present and have the value @samp{1} if the
29760 varobj is a dynamic varobj. If the varobj is not a dynamic varobj,
29761 then this attribute will not be present.
29764 If new children were added to a dynamic varobj within the selected
29765 update range (as set by @code{-var-set-update-range}), then they will
29766 be listed in this attribute.
29769 @subsubheading Example
29776 -var-update --all-values var1
29777 ^done,changelist=[@{name="var1",value="3",in_scope="true",
29778 type_changed="false"@}]
29782 @subheading The @code{-var-set-frozen} Command
29783 @findex -var-set-frozen
29784 @anchor{-var-set-frozen}
29786 @subsubheading Synopsis
29789 -var-set-frozen @var{name} @var{flag}
29792 Set the frozenness flag on the variable object @var{name}. The
29793 @var{flag} parameter should be either @samp{1} to make the variable
29794 frozen or @samp{0} to make it unfrozen. If a variable object is
29795 frozen, then neither itself, nor any of its children, are
29796 implicitly updated by @code{-var-update} of
29797 a parent variable or by @code{-var-update *}. Only
29798 @code{-var-update} of the variable itself will update its value and
29799 values of its children. After a variable object is unfrozen, it is
29800 implicitly updated by all subsequent @code{-var-update} operations.
29801 Unfreezing a variable does not update it, only subsequent
29802 @code{-var-update} does.
29804 @subsubheading Example
29808 -var-set-frozen V 1
29813 @subheading The @code{-var-set-update-range} command
29814 @findex -var-set-update-range
29815 @anchor{-var-set-update-range}
29817 @subsubheading Synopsis
29820 -var-set-update-range @var{name} @var{from} @var{to}
29823 Set the range of children to be returned by future invocations of
29824 @code{-var-update}.
29826 @var{from} and @var{to} indicate the range of children to report. If
29827 @var{from} or @var{to} is less than zero, the range is reset and all
29828 children will be reported. Otherwise, children starting at @var{from}
29829 (zero-based) and up to and excluding @var{to} will be reported.
29831 @subsubheading Example
29835 -var-set-update-range V 1 2
29839 @subheading The @code{-var-set-visualizer} command
29840 @findex -var-set-visualizer
29841 @anchor{-var-set-visualizer}
29843 @subsubheading Synopsis
29846 -var-set-visualizer @var{name} @var{visualizer}
29849 Set a visualizer for the variable object @var{name}.
29851 @var{visualizer} is the visualizer to use. The special value
29852 @samp{None} means to disable any visualizer in use.
29854 If not @samp{None}, @var{visualizer} must be a Python expression.
29855 This expression must evaluate to a callable object which accepts a
29856 single argument. @value{GDBN} will call this object with the value of
29857 the varobj @var{name} as an argument (this is done so that the same
29858 Python pretty-printing code can be used for both the CLI and MI).
29859 When called, this object must return an object which conforms to the
29860 pretty-printing interface (@pxref{Pretty Printing API}).
29862 The pre-defined function @code{gdb.default_visualizer} may be used to
29863 select a visualizer by following the built-in process
29864 (@pxref{Selecting Pretty-Printers}). This is done automatically when
29865 a varobj is created, and so ordinarily is not needed.
29867 This feature is only available if Python support is enabled. The MI
29868 command @code{-list-features} (@pxref{GDB/MI Support Commands})
29869 can be used to check this.
29871 @subsubheading Example
29873 Resetting the visualizer:
29877 -var-set-visualizer V None
29881 Reselecting the default (type-based) visualizer:
29885 -var-set-visualizer V gdb.default_visualizer
29889 Suppose @code{SomeClass} is a visualizer class. A lambda expression
29890 can be used to instantiate this class for a varobj:
29894 -var-set-visualizer V "lambda val: SomeClass()"
29898 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
29899 @node GDB/MI Data Manipulation
29900 @section @sc{gdb/mi} Data Manipulation
29902 @cindex data manipulation, in @sc{gdb/mi}
29903 @cindex @sc{gdb/mi}, data manipulation
29904 This section describes the @sc{gdb/mi} commands that manipulate data:
29905 examine memory and registers, evaluate expressions, etc.
29907 For details about what an addressable memory unit is,
29908 @pxref{addressable memory unit}.
29910 @c REMOVED FROM THE INTERFACE.
29911 @c @subheading -data-assign
29912 @c Change the value of a program variable. Plenty of side effects.
29913 @c @subsubheading GDB Command
29915 @c @subsubheading Example
29918 @subheading The @code{-data-disassemble} Command
29919 @findex -data-disassemble
29921 @subsubheading Synopsis
29925 [ -s @var{start-addr} -e @var{end-addr} ]
29926 | [ -f @var{filename} -l @var{linenum} [ -n @var{lines} ] ]
29934 @item @var{start-addr}
29935 is the beginning address (or @code{$pc})
29936 @item @var{end-addr}
29938 @item @var{filename}
29939 is the name of the file to disassemble
29940 @item @var{linenum}
29941 is the line number to disassemble around
29943 is the number of disassembly lines to be produced. If it is -1,
29944 the whole function will be disassembled, in case no @var{end-addr} is
29945 specified. If @var{end-addr} is specified as a non-zero value, and
29946 @var{lines} is lower than the number of disassembly lines between
29947 @var{start-addr} and @var{end-addr}, only @var{lines} lines are
29948 displayed; if @var{lines} is higher than the number of lines between
29949 @var{start-addr} and @var{end-addr}, only the lines up to @var{end-addr}
29954 @item 0 disassembly only
29955 @item 1 mixed source and disassembly (deprecated)
29956 @item 2 disassembly with raw opcodes
29957 @item 3 mixed source and disassembly with raw opcodes (deprecated)
29958 @item 4 mixed source and disassembly
29959 @item 5 mixed source and disassembly with raw opcodes
29962 Modes 1 and 3 are deprecated. The output is ``source centric''
29963 which hasn't proved useful in practice.
29964 @xref{Machine Code}, for a discussion of the difference between
29965 @code{/m} and @code{/s} output of the @code{disassemble} command.
29968 @subsubheading Result
29970 The result of the @code{-data-disassemble} command will be a list named
29971 @samp{asm_insns}, the contents of this list depend on the @var{mode}
29972 used with the @code{-data-disassemble} command.
29974 For modes 0 and 2 the @samp{asm_insns} list contains tuples with the
29979 The address at which this instruction was disassembled.
29982 The name of the function this instruction is within.
29985 The decimal offset in bytes from the start of @samp{func-name}.
29988 The text disassembly for this @samp{address}.
29991 This field is only present for modes 2, 3 and 5. This contains the raw opcode
29992 bytes for the @samp{inst} field.
29996 For modes 1, 3, 4 and 5 the @samp{asm_insns} list contains tuples named
29997 @samp{src_and_asm_line}, each of which has the following fields:
30001 The line number within @samp{file}.
30004 The file name from the compilation unit. This might be an absolute
30005 file name or a relative file name depending on the compile command
30009 Absolute file name of @samp{file}. It is converted to a canonical form
30010 using the source file search path
30011 (@pxref{Source Path, ,Specifying Source Directories})
30012 and after resolving all the symbolic links.
30014 If the source file is not found this field will contain the path as
30015 present in the debug information.
30017 @item line_asm_insn
30018 This is a list of tuples containing the disassembly for @samp{line} in
30019 @samp{file}. The fields of each tuple are the same as for
30020 @code{-data-disassemble} in @var{mode} 0 and 2, so @samp{address},
30021 @samp{func-name}, @samp{offset}, @samp{inst}, and optionally
30026 Note that whatever included in the @samp{inst} field, is not
30027 manipulated directly by @sc{gdb/mi}, i.e., it is not possible to
30030 @subsubheading @value{GDBN} Command
30032 The corresponding @value{GDBN} command is @samp{disassemble}.
30034 @subsubheading Example
30036 Disassemble from the current value of @code{$pc} to @code{$pc + 20}:
30040 -data-disassemble -s $pc -e "$pc + 20" -- 0
30043 @{address="0x000107c0",func-name="main",offset="4",
30044 inst="mov 2, %o0"@},
30045 @{address="0x000107c4",func-name="main",offset="8",
30046 inst="sethi %hi(0x11800), %o2"@},
30047 @{address="0x000107c8",func-name="main",offset="12",
30048 inst="or %o2, 0x140, %o1\t! 0x11940 <_lib_version+8>"@},
30049 @{address="0x000107cc",func-name="main",offset="16",
30050 inst="sethi %hi(0x11800), %o2"@},
30051 @{address="0x000107d0",func-name="main",offset="20",
30052 inst="or %o2, 0x168, %o4\t! 0x11968 <_lib_version+48>"@}]
30056 Disassemble the whole @code{main} function. Line 32 is part of
30060 -data-disassemble -f basics.c -l 32 -- 0
30062 @{address="0x000107bc",func-name="main",offset="0",
30063 inst="save %sp, -112, %sp"@},
30064 @{address="0x000107c0",func-name="main",offset="4",
30065 inst="mov 2, %o0"@},
30066 @{address="0x000107c4",func-name="main",offset="8",
30067 inst="sethi %hi(0x11800), %o2"@},
30069 @{address="0x0001081c",func-name="main",offset="96",inst="ret "@},
30070 @{address="0x00010820",func-name="main",offset="100",inst="restore "@}]
30074 Disassemble 3 instructions from the start of @code{main}:
30078 -data-disassemble -f basics.c -l 32 -n 3 -- 0
30080 @{address="0x000107bc",func-name="main",offset="0",
30081 inst="save %sp, -112, %sp"@},
30082 @{address="0x000107c0",func-name="main",offset="4",
30083 inst="mov 2, %o0"@},
30084 @{address="0x000107c4",func-name="main",offset="8",
30085 inst="sethi %hi(0x11800), %o2"@}]
30089 Disassemble 3 instructions from the start of @code{main} in mixed mode:
30093 -data-disassemble -f basics.c -l 32 -n 3 -- 1
30095 src_and_asm_line=@{line="31",
30096 file="../../../src/gdb/testsuite/gdb.mi/basics.c",
30097 fullname="/absolute/path/to/src/gdb/testsuite/gdb.mi/basics.c",
30098 line_asm_insn=[@{address="0x000107bc",
30099 func-name="main",offset="0",inst="save %sp, -112, %sp"@}]@},
30100 src_and_asm_line=@{line="32",
30101 file="../../../src/gdb/testsuite/gdb.mi/basics.c",
30102 fullname="/absolute/path/to/src/gdb/testsuite/gdb.mi/basics.c",
30103 line_asm_insn=[@{address="0x000107c0",
30104 func-name="main",offset="4",inst="mov 2, %o0"@},
30105 @{address="0x000107c4",func-name="main",offset="8",
30106 inst="sethi %hi(0x11800), %o2"@}]@}]
30111 @subheading The @code{-data-evaluate-expression} Command
30112 @findex -data-evaluate-expression
30114 @subsubheading Synopsis
30117 -data-evaluate-expression @var{expr}
30120 Evaluate @var{expr} as an expression. The expression could contain an
30121 inferior function call. The function call will execute synchronously.
30122 If the expression contains spaces, it must be enclosed in double quotes.
30124 @subsubheading @value{GDBN} Command
30126 The corresponding @value{GDBN} commands are @samp{print}, @samp{output}, and
30127 @samp{call}. In @code{gdbtk} only, there's a corresponding
30128 @samp{gdb_eval} command.
30130 @subsubheading Example
30132 In the following example, the numbers that precede the commands are the
30133 @dfn{tokens} described in @ref{GDB/MI Command Syntax, ,@sc{gdb/mi}
30134 Command Syntax}. Notice how @sc{gdb/mi} returns the same tokens in its
30138 211-data-evaluate-expression A
30141 311-data-evaluate-expression &A
30142 311^done,value="0xefffeb7c"
30144 411-data-evaluate-expression A+3
30147 511-data-evaluate-expression "A + 3"
30153 @subheading The @code{-data-list-changed-registers} Command
30154 @findex -data-list-changed-registers
30156 @subsubheading Synopsis
30159 -data-list-changed-registers
30162 Display a list of the registers that have changed.
30164 @subsubheading @value{GDBN} Command
30166 @value{GDBN} doesn't have a direct analog for this command; @code{gdbtk}
30167 has the corresponding command @samp{gdb_changed_register_list}.
30169 @subsubheading Example
30171 On a PPC MBX board:
30179 *stopped,reason="breakpoint-hit",disp="keep",bkptno="1",frame=@{
30180 func="main",args=[],file="try.c",fullname="/home/foo/bar/try.c",
30183 -data-list-changed-registers
30184 ^done,changed-registers=["0","1","2","4","5","6","7","8","9",
30185 "10","11","13","14","15","16","17","18","19","20","21","22","23",
30186 "24","25","26","27","28","30","31","64","65","66","67","69"]
30191 @subheading The @code{-data-list-register-names} Command
30192 @findex -data-list-register-names
30194 @subsubheading Synopsis
30197 -data-list-register-names [ ( @var{regno} )+ ]
30200 Show a list of register names for the current target. If no arguments
30201 are given, it shows a list of the names of all the registers. If
30202 integer numbers are given as arguments, it will print a list of the
30203 names of the registers corresponding to the arguments. To ensure
30204 consistency between a register name and its number, the output list may
30205 include empty register names.
30207 @subsubheading @value{GDBN} Command
30209 @value{GDBN} does not have a command which corresponds to
30210 @samp{-data-list-register-names}. In @code{gdbtk} there is a
30211 corresponding command @samp{gdb_regnames}.
30213 @subsubheading Example
30215 For the PPC MBX board:
30218 -data-list-register-names
30219 ^done,register-names=["r0","r1","r2","r3","r4","r5","r6","r7",
30220 "r8","r9","r10","r11","r12","r13","r14","r15","r16","r17","r18",
30221 "r19","r20","r21","r22","r23","r24","r25","r26","r27","r28","r29",
30222 "r30","r31","f0","f1","f2","f3","f4","f5","f6","f7","f8","f9",
30223 "f10","f11","f12","f13","f14","f15","f16","f17","f18","f19","f20",
30224 "f21","f22","f23","f24","f25","f26","f27","f28","f29","f30","f31",
30225 "", "pc","ps","cr","lr","ctr","xer"]
30227 -data-list-register-names 1 2 3
30228 ^done,register-names=["r1","r2","r3"]
30232 @subheading The @code{-data-list-register-values} Command
30233 @findex -data-list-register-values
30235 @subsubheading Synopsis
30238 -data-list-register-values
30239 [ @code{--skip-unavailable} ] @var{fmt} [ ( @var{regno} )*]
30242 Display the registers' contents. The format according to which the
30243 registers' contents are to be returned is given by @var{fmt}, followed
30244 by an optional list of numbers specifying the registers to display. A
30245 missing list of numbers indicates that the contents of all the
30246 registers must be returned. The @code{--skip-unavailable} option
30247 indicates that only the available registers are to be returned.
30249 Allowed formats for @var{fmt} are:
30266 @subsubheading @value{GDBN} Command
30268 The corresponding @value{GDBN} commands are @samp{info reg}, @samp{info
30269 all-reg}, and (in @code{gdbtk}) @samp{gdb_fetch_registers}.
30271 @subsubheading Example
30273 For a PPC MBX board (note: line breaks are for readability only, they
30274 don't appear in the actual output):
30278 -data-list-register-values r 64 65
30279 ^done,register-values=[@{number="64",value="0xfe00a300"@},
30280 @{number="65",value="0x00029002"@}]
30282 -data-list-register-values x
30283 ^done,register-values=[@{number="0",value="0xfe0043c8"@},
30284 @{number="1",value="0x3fff88"@},@{number="2",value="0xfffffffe"@},
30285 @{number="3",value="0x0"@},@{number="4",value="0xa"@},
30286 @{number="5",value="0x3fff68"@},@{number="6",value="0x3fff58"@},
30287 @{number="7",value="0xfe011e98"@},@{number="8",value="0x2"@},
30288 @{number="9",value="0xfa202820"@},@{number="10",value="0xfa202808"@},
30289 @{number="11",value="0x1"@},@{number="12",value="0x0"@},
30290 @{number="13",value="0x4544"@},@{number="14",value="0xffdfffff"@},
30291 @{number="15",value="0xffffffff"@},@{number="16",value="0xfffffeff"@},
30292 @{number="17",value="0xefffffed"@},@{number="18",value="0xfffffffe"@},
30293 @{number="19",value="0xffffffff"@},@{number="20",value="0xffffffff"@},
30294 @{number="21",value="0xffffffff"@},@{number="22",value="0xfffffff7"@},
30295 @{number="23",value="0xffffffff"@},@{number="24",value="0xffffffff"@},
30296 @{number="25",value="0xffffffff"@},@{number="26",value="0xfffffffb"@},
30297 @{number="27",value="0xffffffff"@},@{number="28",value="0xf7bfffff"@},
30298 @{number="29",value="0x0"@},@{number="30",value="0xfe010000"@},
30299 @{number="31",value="0x0"@},@{number="32",value="0x0"@},
30300 @{number="33",value="0x0"@},@{number="34",value="0x0"@},
30301 @{number="35",value="0x0"@},@{number="36",value="0x0"@},
30302 @{number="37",value="0x0"@},@{number="38",value="0x0"@},
30303 @{number="39",value="0x0"@},@{number="40",value="0x0"@},
30304 @{number="41",value="0x0"@},@{number="42",value="0x0"@},
30305 @{number="43",value="0x0"@},@{number="44",value="0x0"@},
30306 @{number="45",value="0x0"@},@{number="46",value="0x0"@},
30307 @{number="47",value="0x0"@},@{number="48",value="0x0"@},
30308 @{number="49",value="0x0"@},@{number="50",value="0x0"@},
30309 @{number="51",value="0x0"@},@{number="52",value="0x0"@},
30310 @{number="53",value="0x0"@},@{number="54",value="0x0"@},
30311 @{number="55",value="0x0"@},@{number="56",value="0x0"@},
30312 @{number="57",value="0x0"@},@{number="58",value="0x0"@},
30313 @{number="59",value="0x0"@},@{number="60",value="0x0"@},
30314 @{number="61",value="0x0"@},@{number="62",value="0x0"@},
30315 @{number="63",value="0x0"@},@{number="64",value="0xfe00a300"@},
30316 @{number="65",value="0x29002"@},@{number="66",value="0x202f04b5"@},
30317 @{number="67",value="0xfe0043b0"@},@{number="68",value="0xfe00b3e4"@},
30318 @{number="69",value="0x20002b03"@}]
30323 @subheading The @code{-data-read-memory} Command
30324 @findex -data-read-memory
30326 This command is deprecated, use @code{-data-read-memory-bytes} instead.
30328 @subsubheading Synopsis
30331 -data-read-memory [ -o @var{byte-offset} ]
30332 @var{address} @var{word-format} @var{word-size}
30333 @var{nr-rows} @var{nr-cols} [ @var{aschar} ]
30340 @item @var{address}
30341 An expression specifying the address of the first memory word to be
30342 read. Complex expressions containing embedded white space should be
30343 quoted using the C convention.
30345 @item @var{word-format}
30346 The format to be used to print the memory words. The notation is the
30347 same as for @value{GDBN}'s @code{print} command (@pxref{Output Formats,
30350 @item @var{word-size}
30351 The size of each memory word in bytes.
30353 @item @var{nr-rows}
30354 The number of rows in the output table.
30356 @item @var{nr-cols}
30357 The number of columns in the output table.
30360 If present, indicates that each row should include an @sc{ascii} dump. The
30361 value of @var{aschar} is used as a padding character when a byte is not a
30362 member of the printable @sc{ascii} character set (printable @sc{ascii}
30363 characters are those whose code is between 32 and 126, inclusively).
30365 @item @var{byte-offset}
30366 An offset to add to the @var{address} before fetching memory.
30369 This command displays memory contents as a table of @var{nr-rows} by
30370 @var{nr-cols} words, each word being @var{word-size} bytes. In total,
30371 @code{@var{nr-rows} * @var{nr-cols} * @var{word-size}} bytes are read
30372 (returned as @samp{total-bytes}). Should less than the requested number
30373 of bytes be returned by the target, the missing words are identified
30374 using @samp{N/A}. The number of bytes read from the target is returned
30375 in @samp{nr-bytes} and the starting address used to read memory in
30378 The address of the next/previous row or page is available in
30379 @samp{next-row} and @samp{prev-row}, @samp{next-page} and
30382 @subsubheading @value{GDBN} Command
30384 The corresponding @value{GDBN} command is @samp{x}. @code{gdbtk} has
30385 @samp{gdb_get_mem} memory read command.
30387 @subsubheading Example
30389 Read six bytes of memory starting at @code{bytes+6} but then offset by
30390 @code{-6} bytes. Format as three rows of two columns. One byte per
30391 word. Display each word in hex.
30395 9-data-read-memory -o -6 -- bytes+6 x 1 3 2
30396 9^done,addr="0x00001390",nr-bytes="6",total-bytes="6",
30397 next-row="0x00001396",prev-row="0x0000138e",next-page="0x00001396",
30398 prev-page="0x0000138a",memory=[
30399 @{addr="0x00001390",data=["0x00","0x01"]@},
30400 @{addr="0x00001392",data=["0x02","0x03"]@},
30401 @{addr="0x00001394",data=["0x04","0x05"]@}]
30405 Read two bytes of memory starting at address @code{shorts + 64} and
30406 display as a single word formatted in decimal.
30410 5-data-read-memory shorts+64 d 2 1 1
30411 5^done,addr="0x00001510",nr-bytes="2",total-bytes="2",
30412 next-row="0x00001512",prev-row="0x0000150e",
30413 next-page="0x00001512",prev-page="0x0000150e",memory=[
30414 @{addr="0x00001510",data=["128"]@}]
30418 Read thirty two bytes of memory starting at @code{bytes+16} and format
30419 as eight rows of four columns. Include a string encoding with @samp{x}
30420 used as the non-printable character.
30424 4-data-read-memory bytes+16 x 1 8 4 x
30425 4^done,addr="0x000013a0",nr-bytes="32",total-bytes="32",
30426 next-row="0x000013c0",prev-row="0x0000139c",
30427 next-page="0x000013c0",prev-page="0x00001380",memory=[
30428 @{addr="0x000013a0",data=["0x10","0x11","0x12","0x13"],ascii="xxxx"@},
30429 @{addr="0x000013a4",data=["0x14","0x15","0x16","0x17"],ascii="xxxx"@},
30430 @{addr="0x000013a8",data=["0x18","0x19","0x1a","0x1b"],ascii="xxxx"@},
30431 @{addr="0x000013ac",data=["0x1c","0x1d","0x1e","0x1f"],ascii="xxxx"@},
30432 @{addr="0x000013b0",data=["0x20","0x21","0x22","0x23"],ascii=" !\"#"@},
30433 @{addr="0x000013b4",data=["0x24","0x25","0x26","0x27"],ascii="$%&'"@},
30434 @{addr="0x000013b8",data=["0x28","0x29","0x2a","0x2b"],ascii="()*+"@},
30435 @{addr="0x000013bc",data=["0x2c","0x2d","0x2e","0x2f"],ascii=",-./"@}]
30439 @subheading The @code{-data-read-memory-bytes} Command
30440 @findex -data-read-memory-bytes
30442 @subsubheading Synopsis
30445 -data-read-memory-bytes [ -o @var{offset} ]
30446 @var{address} @var{count}
30453 @item @var{address}
30454 An expression specifying the address of the first addressable memory unit
30455 to be read. Complex expressions containing embedded white space should be
30456 quoted using the C convention.
30459 The number of addressable memory units to read. This should be an integer
30463 The offset relative to @var{address} at which to start reading. This
30464 should be an integer literal. This option is provided so that a frontend
30465 is not required to first evaluate address and then perform address
30466 arithmetics itself.
30470 This command attempts to read all accessible memory regions in the
30471 specified range. First, all regions marked as unreadable in the memory
30472 map (if one is defined) will be skipped. @xref{Memory Region
30473 Attributes}. Second, @value{GDBN} will attempt to read the remaining
30474 regions. For each one, if reading full region results in an errors,
30475 @value{GDBN} will try to read a subset of the region.
30477 In general, every single memory unit in the region may be readable or not,
30478 and the only way to read every readable unit is to try a read at
30479 every address, which is not practical. Therefore, @value{GDBN} will
30480 attempt to read all accessible memory units at either beginning or the end
30481 of the region, using a binary division scheme. This heuristic works
30482 well for reading accross a memory map boundary. Note that if a region
30483 has a readable range that is neither at the beginning or the end,
30484 @value{GDBN} will not read it.
30486 The result record (@pxref{GDB/MI Result Records}) that is output of
30487 the command includes a field named @samp{memory} whose content is a
30488 list of tuples. Each tuple represent a successfully read memory block
30489 and has the following fields:
30493 The start address of the memory block, as hexadecimal literal.
30496 The end address of the memory block, as hexadecimal literal.
30499 The offset of the memory block, as hexadecimal literal, relative to
30500 the start address passed to @code{-data-read-memory-bytes}.
30503 The contents of the memory block, in hex.
30509 @subsubheading @value{GDBN} Command
30511 The corresponding @value{GDBN} command is @samp{x}.
30513 @subsubheading Example
30517 -data-read-memory-bytes &a 10
30518 ^done,memory=[@{begin="0xbffff154",offset="0x00000000",
30520 contents="01000000020000000300"@}]
30525 @subheading The @code{-data-write-memory-bytes} Command
30526 @findex -data-write-memory-bytes
30528 @subsubheading Synopsis
30531 -data-write-memory-bytes @var{address} @var{contents}
30532 -data-write-memory-bytes @var{address} @var{contents} @r{[}@var{count}@r{]}
30539 @item @var{address}
30540 An expression specifying the address of the first addressable memory unit
30541 to be written. Complex expressions containing embedded white space should
30542 be quoted using the C convention.
30544 @item @var{contents}
30545 The hex-encoded data to write. It is an error if @var{contents} does
30546 not represent an integral number of addressable memory units.
30549 Optional argument indicating the number of addressable memory units to be
30550 written. If @var{count} is greater than @var{contents}' length,
30551 @value{GDBN} will repeatedly write @var{contents} until it fills
30552 @var{count} memory units.
30556 @subsubheading @value{GDBN} Command
30558 There's no corresponding @value{GDBN} command.
30560 @subsubheading Example
30564 -data-write-memory-bytes &a "aabbccdd"
30571 -data-write-memory-bytes &a "aabbccdd" 16e
30576 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
30577 @node GDB/MI Tracepoint Commands
30578 @section @sc{gdb/mi} Tracepoint Commands
30580 The commands defined in this section implement MI support for
30581 tracepoints. For detailed introduction, see @ref{Tracepoints}.
30583 @subheading The @code{-trace-find} Command
30584 @findex -trace-find
30586 @subsubheading Synopsis
30589 -trace-find @var{mode} [@var{parameters}@dots{}]
30592 Find a trace frame using criteria defined by @var{mode} and
30593 @var{parameters}. The following table lists permissible
30594 modes and their parameters. For details of operation, see @ref{tfind}.
30599 No parameters are required. Stops examining trace frames.
30602 An integer is required as parameter. Selects tracepoint frame with
30605 @item tracepoint-number
30606 An integer is required as parameter. Finds next
30607 trace frame that corresponds to tracepoint with the specified number.
30610 An address is required as parameter. Finds
30611 next trace frame that corresponds to any tracepoint at the specified
30614 @item pc-inside-range
30615 Two addresses are required as parameters. Finds next trace
30616 frame that corresponds to a tracepoint at an address inside the
30617 specified range. Both bounds are considered to be inside the range.
30619 @item pc-outside-range
30620 Two addresses are required as parameters. Finds
30621 next trace frame that corresponds to a tracepoint at an address outside
30622 the specified range. Both bounds are considered to be inside the range.
30625 Line specification is required as parameter. @xref{Specify Location}.
30626 Finds next trace frame that corresponds to a tracepoint at
30627 the specified location.
30631 If @samp{none} was passed as @var{mode}, the response does not
30632 have fields. Otherwise, the response may have the following fields:
30636 This field has either @samp{0} or @samp{1} as the value, depending
30637 on whether a matching tracepoint was found.
30640 The index of the found traceframe. This field is present iff
30641 the @samp{found} field has value of @samp{1}.
30644 The index of the found tracepoint. This field is present iff
30645 the @samp{found} field has value of @samp{1}.
30648 The information about the frame corresponding to the found trace
30649 frame. This field is present only if a trace frame was found.
30650 @xref{GDB/MI Frame Information}, for description of this field.
30654 @subsubheading @value{GDBN} Command
30656 The corresponding @value{GDBN} command is @samp{tfind}.
30658 @subheading -trace-define-variable
30659 @findex -trace-define-variable
30661 @subsubheading Synopsis
30664 -trace-define-variable @var{name} [ @var{value} ]
30667 Create trace variable @var{name} if it does not exist. If
30668 @var{value} is specified, sets the initial value of the specified
30669 trace variable to that value. Note that the @var{name} should start
30670 with the @samp{$} character.
30672 @subsubheading @value{GDBN} Command
30674 The corresponding @value{GDBN} command is @samp{tvariable}.
30676 @subheading The @code{-trace-frame-collected} Command
30677 @findex -trace-frame-collected
30679 @subsubheading Synopsis
30682 -trace-frame-collected
30683 [--var-print-values @var{var_pval}]
30684 [--comp-print-values @var{comp_pval}]
30685 [--registers-format @var{regformat}]
30686 [--memory-contents]
30689 This command returns the set of collected objects, register names,
30690 trace state variable names, memory ranges and computed expressions
30691 that have been collected at a particular trace frame. The optional
30692 parameters to the command affect the output format in different ways.
30693 See the output description table below for more details.
30695 The reported names can be used in the normal manner to create
30696 varobjs and inspect the objects themselves. The items returned by
30697 this command are categorized so that it is clear which is a variable,
30698 which is a register, which is a trace state variable, which is a
30699 memory range and which is a computed expression.
30701 For instance, if the actions were
30703 collect myVar, myArray[myIndex], myObj.field, myPtr->field, myCount + 2
30704 collect *(int*)0xaf02bef0@@40
30708 the object collected in its entirety would be @code{myVar}. The
30709 object @code{myArray} would be partially collected, because only the
30710 element at index @code{myIndex} would be collected. The remaining
30711 objects would be computed expressions.
30713 An example output would be:
30717 -trace-frame-collected
30719 explicit-variables=[@{name="myVar",value="1"@}],
30720 computed-expressions=[@{name="myArray[myIndex]",value="0"@},
30721 @{name="myObj.field",value="0"@},
30722 @{name="myPtr->field",value="1"@},
30723 @{name="myCount + 2",value="3"@},
30724 @{name="$tvar1 + 1",value="43970027"@}],
30725 registers=[@{number="0",value="0x7fe2c6e79ec8"@},
30726 @{number="1",value="0x0"@},
30727 @{number="2",value="0x4"@},
30729 @{number="125",value="0x0"@}],
30730 tvars=[@{name="$tvar1",current="43970026"@}],
30731 memory=[@{address="0x0000000000602264",length="4"@},
30732 @{address="0x0000000000615bc0",length="4"@}]
30739 @item explicit-variables
30740 The set of objects that have been collected in their entirety (as
30741 opposed to collecting just a few elements of an array or a few struct
30742 members). For each object, its name and value are printed.
30743 The @code{--var-print-values} option affects how or whether the value
30744 field is output. If @var{var_pval} is 0, then print only the names;
30745 if it is 1, print also their values; and if it is 2, print the name,
30746 type and value for simple data types, and the name and type for
30747 arrays, structures and unions.
30749 @item computed-expressions
30750 The set of computed expressions that have been collected at the
30751 current trace frame. The @code{--comp-print-values} option affects
30752 this set like the @code{--var-print-values} option affects the
30753 @code{explicit-variables} set. See above.
30756 The registers that have been collected at the current trace frame.
30757 For each register collected, the name and current value are returned.
30758 The value is formatted according to the @code{--registers-format}
30759 option. See the @command{-data-list-register-values} command for a
30760 list of the allowed formats. The default is @samp{x}.
30763 The trace state variables that have been collected at the current
30764 trace frame. For each trace state variable collected, the name and
30765 current value are returned.
30768 The set of memory ranges that have been collected at the current trace
30769 frame. Its content is a list of tuples. Each tuple represents a
30770 collected memory range and has the following fields:
30774 The start address of the memory range, as hexadecimal literal.
30777 The length of the memory range, as decimal literal.
30780 The contents of the memory block, in hex. This field is only present
30781 if the @code{--memory-contents} option is specified.
30787 @subsubheading @value{GDBN} Command
30789 There is no corresponding @value{GDBN} command.
30791 @subsubheading Example
30793 @subheading -trace-list-variables
30794 @findex -trace-list-variables
30796 @subsubheading Synopsis
30799 -trace-list-variables
30802 Return a table of all defined trace variables. Each element of the
30803 table has the following fields:
30807 The name of the trace variable. This field is always present.
30810 The initial value. This is a 64-bit signed integer. This
30811 field is always present.
30814 The value the trace variable has at the moment. This is a 64-bit
30815 signed integer. This field is absent iff current value is
30816 not defined, for example if the trace was never run, or is
30821 @subsubheading @value{GDBN} Command
30823 The corresponding @value{GDBN} command is @samp{tvariables}.
30825 @subsubheading Example
30829 -trace-list-variables
30830 ^done,trace-variables=@{nr_rows="1",nr_cols="3",
30831 hdr=[@{width="15",alignment="-1",col_name="name",colhdr="Name"@},
30832 @{width="11",alignment="-1",col_name="initial",colhdr="Initial"@},
30833 @{width="11",alignment="-1",col_name="current",colhdr="Current"@}],
30834 body=[variable=@{name="$trace_timestamp",initial="0"@}
30835 variable=@{name="$foo",initial="10",current="15"@}]@}
30839 @subheading -trace-save
30840 @findex -trace-save
30842 @subsubheading Synopsis
30845 -trace-save [-r ] @var{filename}
30848 Saves the collected trace data to @var{filename}. Without the
30849 @samp{-r} option, the data is downloaded from the target and saved
30850 in a local file. With the @samp{-r} option the target is asked
30851 to perform the save.
30853 @subsubheading @value{GDBN} Command
30855 The corresponding @value{GDBN} command is @samp{tsave}.
30858 @subheading -trace-start
30859 @findex -trace-start
30861 @subsubheading Synopsis
30867 Starts a tracing experiments. The result of this command does not
30870 @subsubheading @value{GDBN} Command
30872 The corresponding @value{GDBN} command is @samp{tstart}.
30874 @subheading -trace-status
30875 @findex -trace-status
30877 @subsubheading Synopsis
30883 Obtains the status of a tracing experiment. The result may include
30884 the following fields:
30889 May have a value of either @samp{0}, when no tracing operations are
30890 supported, @samp{1}, when all tracing operations are supported, or
30891 @samp{file} when examining trace file. In the latter case, examining
30892 of trace frame is possible but new tracing experiement cannot be
30893 started. This field is always present.
30896 May have a value of either @samp{0} or @samp{1} depending on whether
30897 tracing experiement is in progress on target. This field is present
30898 if @samp{supported} field is not @samp{0}.
30901 Report the reason why the tracing was stopped last time. This field
30902 may be absent iff tracing was never stopped on target yet. The
30903 value of @samp{request} means the tracing was stopped as result of
30904 the @code{-trace-stop} command. The value of @samp{overflow} means
30905 the tracing buffer is full. The value of @samp{disconnection} means
30906 tracing was automatically stopped when @value{GDBN} has disconnected.
30907 The value of @samp{passcount} means tracing was stopped when a
30908 tracepoint was passed a maximal number of times for that tracepoint.
30909 This field is present if @samp{supported} field is not @samp{0}.
30911 @item stopping-tracepoint
30912 The number of tracepoint whose passcount as exceeded. This field is
30913 present iff the @samp{stop-reason} field has the value of
30917 @itemx frames-created
30918 The @samp{frames} field is a count of the total number of trace frames
30919 in the trace buffer, while @samp{frames-created} is the total created
30920 during the run, including ones that were discarded, such as when a
30921 circular trace buffer filled up. Both fields are optional.
30925 These fields tell the current size of the tracing buffer and the
30926 remaining space. These fields are optional.
30929 The value of the circular trace buffer flag. @code{1} means that the
30930 trace buffer is circular and old trace frames will be discarded if
30931 necessary to make room, @code{0} means that the trace buffer is linear
30935 The value of the disconnected tracing flag. @code{1} means that
30936 tracing will continue after @value{GDBN} disconnects, @code{0} means
30937 that the trace run will stop.
30940 The filename of the trace file being examined. This field is
30941 optional, and only present when examining a trace file.
30945 @subsubheading @value{GDBN} Command
30947 The corresponding @value{GDBN} command is @samp{tstatus}.
30949 @subheading -trace-stop
30950 @findex -trace-stop
30952 @subsubheading Synopsis
30958 Stops a tracing experiment. The result of this command has the same
30959 fields as @code{-trace-status}, except that the @samp{supported} and
30960 @samp{running} fields are not output.
30962 @subsubheading @value{GDBN} Command
30964 The corresponding @value{GDBN} command is @samp{tstop}.
30967 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
30968 @node GDB/MI Symbol Query
30969 @section @sc{gdb/mi} Symbol Query Commands
30973 @subheading The @code{-symbol-info-address} Command
30974 @findex -symbol-info-address
30976 @subsubheading Synopsis
30979 -symbol-info-address @var{symbol}
30982 Describe where @var{symbol} is stored.
30984 @subsubheading @value{GDBN} Command
30986 The corresponding @value{GDBN} command is @samp{info address}.
30988 @subsubheading Example
30992 @subheading The @code{-symbol-info-file} Command
30993 @findex -symbol-info-file
30995 @subsubheading Synopsis
31001 Show the file for the symbol.
31003 @subsubheading @value{GDBN} Command
31005 There's no equivalent @value{GDBN} command. @code{gdbtk} has
31006 @samp{gdb_find_file}.
31008 @subsubheading Example
31012 @subheading The @code{-symbol-info-function} Command
31013 @findex -symbol-info-function
31015 @subsubheading Synopsis
31018 -symbol-info-function
31021 Show which function the symbol lives in.
31023 @subsubheading @value{GDBN} Command
31025 @samp{gdb_get_function} in @code{gdbtk}.
31027 @subsubheading Example
31031 @subheading The @code{-symbol-info-line} Command
31032 @findex -symbol-info-line
31034 @subsubheading Synopsis
31040 Show the core addresses of the code for a source line.
31042 @subsubheading @value{GDBN} Command
31044 The corresponding @value{GDBN} command is @samp{info line}.
31045 @code{gdbtk} has the @samp{gdb_get_line} and @samp{gdb_get_file} commands.
31047 @subsubheading Example
31051 @subheading The @code{-symbol-info-symbol} Command
31052 @findex -symbol-info-symbol
31054 @subsubheading Synopsis
31057 -symbol-info-symbol @var{addr}
31060 Describe what symbol is at location @var{addr}.
31062 @subsubheading @value{GDBN} Command
31064 The corresponding @value{GDBN} command is @samp{info symbol}.
31066 @subsubheading Example
31070 @subheading The @code{-symbol-list-functions} Command
31071 @findex -symbol-list-functions
31073 @subsubheading Synopsis
31076 -symbol-list-functions
31079 List the functions in the executable.
31081 @subsubheading @value{GDBN} Command
31083 @samp{info functions} in @value{GDBN}, @samp{gdb_listfunc} and
31084 @samp{gdb_search} in @code{gdbtk}.
31086 @subsubheading Example
31091 @subheading The @code{-symbol-list-lines} Command
31092 @findex -symbol-list-lines
31094 @subsubheading Synopsis
31097 -symbol-list-lines @var{filename}
31100 Print the list of lines that contain code and their associated program
31101 addresses for the given source filename. The entries are sorted in
31102 ascending PC order.
31104 @subsubheading @value{GDBN} Command
31106 There is no corresponding @value{GDBN} command.
31108 @subsubheading Example
31111 -symbol-list-lines basics.c
31112 ^done,lines=[@{pc="0x08048554",line="7"@},@{pc="0x0804855a",line="8"@}]
31118 @subheading The @code{-symbol-list-types} Command
31119 @findex -symbol-list-types
31121 @subsubheading Synopsis
31127 List all the type names.
31129 @subsubheading @value{GDBN} Command
31131 The corresponding commands are @samp{info types} in @value{GDBN},
31132 @samp{gdb_search} in @code{gdbtk}.
31134 @subsubheading Example
31138 @subheading The @code{-symbol-list-variables} Command
31139 @findex -symbol-list-variables
31141 @subsubheading Synopsis
31144 -symbol-list-variables
31147 List all the global and static variable names.
31149 @subsubheading @value{GDBN} Command
31151 @samp{info variables} in @value{GDBN}, @samp{gdb_search} in @code{gdbtk}.
31153 @subsubheading Example
31157 @subheading The @code{-symbol-locate} Command
31158 @findex -symbol-locate
31160 @subsubheading Synopsis
31166 @subsubheading @value{GDBN} Command
31168 @samp{gdb_loc} in @code{gdbtk}.
31170 @subsubheading Example
31174 @subheading The @code{-symbol-type} Command
31175 @findex -symbol-type
31177 @subsubheading Synopsis
31180 -symbol-type @var{variable}
31183 Show type of @var{variable}.
31185 @subsubheading @value{GDBN} Command
31187 The corresponding @value{GDBN} command is @samp{ptype}, @code{gdbtk} has
31188 @samp{gdb_obj_variable}.
31190 @subsubheading Example
31195 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
31196 @node GDB/MI File Commands
31197 @section @sc{gdb/mi} File Commands
31199 This section describes the GDB/MI commands to specify executable file names
31200 and to read in and obtain symbol table information.
31202 @subheading The @code{-file-exec-and-symbols} Command
31203 @findex -file-exec-and-symbols
31205 @subsubheading Synopsis
31208 -file-exec-and-symbols @var{file}
31211 Specify the executable file to be debugged. This file is the one from
31212 which the symbol table is also read. If no file is specified, the
31213 command clears the executable and symbol information. If breakpoints
31214 are set when using this command with no arguments, @value{GDBN} will produce
31215 error messages. Otherwise, no output is produced, except a completion
31218 @subsubheading @value{GDBN} Command
31220 The corresponding @value{GDBN} command is @samp{file}.
31222 @subsubheading Example
31226 -file-exec-and-symbols /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx
31232 @subheading The @code{-file-exec-file} Command
31233 @findex -file-exec-file
31235 @subsubheading Synopsis
31238 -file-exec-file @var{file}
31241 Specify the executable file to be debugged. Unlike
31242 @samp{-file-exec-and-symbols}, the symbol table is @emph{not} read
31243 from this file. If used without argument, @value{GDBN} clears the information
31244 about the executable file. No output is produced, except a completion
31247 @subsubheading @value{GDBN} Command
31249 The corresponding @value{GDBN} command is @samp{exec-file}.
31251 @subsubheading Example
31255 -file-exec-file /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx
31262 @subheading The @code{-file-list-exec-sections} Command
31263 @findex -file-list-exec-sections
31265 @subsubheading Synopsis
31268 -file-list-exec-sections
31271 List the sections of the current executable file.
31273 @subsubheading @value{GDBN} Command
31275 The @value{GDBN} command @samp{info file} shows, among the rest, the same
31276 information as this command. @code{gdbtk} has a corresponding command
31277 @samp{gdb_load_info}.
31279 @subsubheading Example
31284 @subheading The @code{-file-list-exec-source-file} Command
31285 @findex -file-list-exec-source-file
31287 @subsubheading Synopsis
31290 -file-list-exec-source-file
31293 List the line number, the current source file, and the absolute path
31294 to the current source file for the current executable. The macro
31295 information field has a value of @samp{1} or @samp{0} depending on
31296 whether or not the file includes preprocessor macro information.
31298 @subsubheading @value{GDBN} Command
31300 The @value{GDBN} equivalent is @samp{info source}
31302 @subsubheading Example
31306 123-file-list-exec-source-file
31307 123^done,line="1",file="foo.c",fullname="/home/bar/foo.c,macro-info="1"
31312 @subheading The @code{-file-list-exec-source-files} Command
31313 @findex -file-list-exec-source-files
31315 @subsubheading Synopsis
31318 -file-list-exec-source-files
31321 List the source files for the current executable.
31323 It will always output both the filename and fullname (absolute file
31324 name) of a source file.
31326 @subsubheading @value{GDBN} Command
31328 The @value{GDBN} equivalent is @samp{info sources}.
31329 @code{gdbtk} has an analogous command @samp{gdb_listfiles}.
31331 @subsubheading Example
31334 -file-list-exec-source-files
31336 @{file=foo.c,fullname=/home/foo.c@},
31337 @{file=/home/bar.c,fullname=/home/bar.c@},
31338 @{file=gdb_could_not_find_fullpath.c@}]
31343 @subheading The @code{-file-list-shared-libraries} Command
31344 @findex -file-list-shared-libraries
31346 @subsubheading Synopsis
31349 -file-list-shared-libraries
31352 List the shared libraries in the program.
31354 @subsubheading @value{GDBN} Command
31356 The corresponding @value{GDBN} command is @samp{info shared}.
31358 @subsubheading Example
31362 @subheading The @code{-file-list-symbol-files} Command
31363 @findex -file-list-symbol-files
31365 @subsubheading Synopsis
31368 -file-list-symbol-files
31373 @subsubheading @value{GDBN} Command
31375 The corresponding @value{GDBN} command is @samp{info file} (part of it).
31377 @subsubheading Example
31382 @subheading The @code{-file-symbol-file} Command
31383 @findex -file-symbol-file
31385 @subsubheading Synopsis
31388 -file-symbol-file @var{file}
31391 Read symbol table info from the specified @var{file} argument. When
31392 used without arguments, clears @value{GDBN}'s symbol table info. No output is
31393 produced, except for a completion notification.
31395 @subsubheading @value{GDBN} Command
31397 The corresponding @value{GDBN} command is @samp{symbol-file}.
31399 @subsubheading Example
31403 -file-symbol-file /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx
31409 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
31410 @node GDB/MI Memory Overlay Commands
31411 @section @sc{gdb/mi} Memory Overlay Commands
31413 The memory overlay commands are not implemented.
31415 @c @subheading -overlay-auto
31417 @c @subheading -overlay-list-mapping-state
31419 @c @subheading -overlay-list-overlays
31421 @c @subheading -overlay-map
31423 @c @subheading -overlay-off
31425 @c @subheading -overlay-on
31427 @c @subheading -overlay-unmap
31429 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
31430 @node GDB/MI Signal Handling Commands
31431 @section @sc{gdb/mi} Signal Handling Commands
31433 Signal handling commands are not implemented.
31435 @c @subheading -signal-handle
31437 @c @subheading -signal-list-handle-actions
31439 @c @subheading -signal-list-signal-types
31443 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
31444 @node GDB/MI Target Manipulation
31445 @section @sc{gdb/mi} Target Manipulation Commands
31448 @subheading The @code{-target-attach} Command
31449 @findex -target-attach
31451 @subsubheading Synopsis
31454 -target-attach @var{pid} | @var{gid} | @var{file}
31457 Attach to a process @var{pid} or a file @var{file} outside of
31458 @value{GDBN}, or a thread group @var{gid}. If attaching to a thread
31459 group, the id previously returned by
31460 @samp{-list-thread-groups --available} must be used.
31462 @subsubheading @value{GDBN} Command
31464 The corresponding @value{GDBN} command is @samp{attach}.
31466 @subsubheading Example
31470 =thread-created,id="1"
31471 *stopped,thread-id="1",frame=@{addr="0xb7f7e410",func="bar",args=[]@}
31477 @subheading The @code{-target-compare-sections} Command
31478 @findex -target-compare-sections
31480 @subsubheading Synopsis
31483 -target-compare-sections [ @var{section} ]
31486 Compare data of section @var{section} on target to the exec file.
31487 Without the argument, all sections are compared.
31489 @subsubheading @value{GDBN} Command
31491 The @value{GDBN} equivalent is @samp{compare-sections}.
31493 @subsubheading Example
31498 @subheading The @code{-target-detach} Command
31499 @findex -target-detach
31501 @subsubheading Synopsis
31504 -target-detach [ @var{pid} | @var{gid} ]
31507 Detach from the remote target which normally resumes its execution.
31508 If either @var{pid} or @var{gid} is specified, detaches from either
31509 the specified process, or specified thread group. There's no output.
31511 @subsubheading @value{GDBN} Command
31513 The corresponding @value{GDBN} command is @samp{detach}.
31515 @subsubheading Example
31525 @subheading The @code{-target-disconnect} Command
31526 @findex -target-disconnect
31528 @subsubheading Synopsis
31534 Disconnect from the remote target. There's no output and the target is
31535 generally not resumed.
31537 @subsubheading @value{GDBN} Command
31539 The corresponding @value{GDBN} command is @samp{disconnect}.
31541 @subsubheading Example
31551 @subheading The @code{-target-download} Command
31552 @findex -target-download
31554 @subsubheading Synopsis
31560 Loads the executable onto the remote target.
31561 It prints out an update message every half second, which includes the fields:
31565 The name of the section.
31567 The size of what has been sent so far for that section.
31569 The size of the section.
31571 The total size of what was sent so far (the current and the previous sections).
31573 The size of the overall executable to download.
31577 Each message is sent as status record (@pxref{GDB/MI Output Syntax, ,
31578 @sc{gdb/mi} Output Syntax}).
31580 In addition, it prints the name and size of the sections, as they are
31581 downloaded. These messages include the following fields:
31585 The name of the section.
31587 The size of the section.
31589 The size of the overall executable to download.
31593 At the end, a summary is printed.
31595 @subsubheading @value{GDBN} Command
31597 The corresponding @value{GDBN} command is @samp{load}.
31599 @subsubheading Example
31601 Note: each status message appears on a single line. Here the messages
31602 have been broken down so that they can fit onto a page.
31607 +download,@{section=".text",section-size="6668",total-size="9880"@}
31608 +download,@{section=".text",section-sent="512",section-size="6668",
31609 total-sent="512",total-size="9880"@}
31610 +download,@{section=".text",section-sent="1024",section-size="6668",
31611 total-sent="1024",total-size="9880"@}
31612 +download,@{section=".text",section-sent="1536",section-size="6668",
31613 total-sent="1536",total-size="9880"@}
31614 +download,@{section=".text",section-sent="2048",section-size="6668",
31615 total-sent="2048",total-size="9880"@}
31616 +download,@{section=".text",section-sent="2560",section-size="6668",
31617 total-sent="2560",total-size="9880"@}
31618 +download,@{section=".text",section-sent="3072",section-size="6668",
31619 total-sent="3072",total-size="9880"@}
31620 +download,@{section=".text",section-sent="3584",section-size="6668",
31621 total-sent="3584",total-size="9880"@}
31622 +download,@{section=".text",section-sent="4096",section-size="6668",
31623 total-sent="4096",total-size="9880"@}
31624 +download,@{section=".text",section-sent="4608",section-size="6668",
31625 total-sent="4608",total-size="9880"@}
31626 +download,@{section=".text",section-sent="5120",section-size="6668",
31627 total-sent="5120",total-size="9880"@}
31628 +download,@{section=".text",section-sent="5632",section-size="6668",
31629 total-sent="5632",total-size="9880"@}
31630 +download,@{section=".text",section-sent="6144",section-size="6668",
31631 total-sent="6144",total-size="9880"@}
31632 +download,@{section=".text",section-sent="6656",section-size="6668",
31633 total-sent="6656",total-size="9880"@}
31634 +download,@{section=".init",section-size="28",total-size="9880"@}
31635 +download,@{section=".fini",section-size="28",total-size="9880"@}
31636 +download,@{section=".data",section-size="3156",total-size="9880"@}
31637 +download,@{section=".data",section-sent="512",section-size="3156",
31638 total-sent="7236",total-size="9880"@}
31639 +download,@{section=".data",section-sent="1024",section-size="3156",
31640 total-sent="7748",total-size="9880"@}
31641 +download,@{section=".data",section-sent="1536",section-size="3156",
31642 total-sent="8260",total-size="9880"@}
31643 +download,@{section=".data",section-sent="2048",section-size="3156",
31644 total-sent="8772",total-size="9880"@}
31645 +download,@{section=".data",section-sent="2560",section-size="3156",
31646 total-sent="9284",total-size="9880"@}
31647 +download,@{section=".data",section-sent="3072",section-size="3156",
31648 total-sent="9796",total-size="9880"@}
31649 ^done,address="0x10004",load-size="9880",transfer-rate="6586",
31656 @subheading The @code{-target-exec-status} Command
31657 @findex -target-exec-status
31659 @subsubheading Synopsis
31662 -target-exec-status
31665 Provide information on the state of the target (whether it is running or
31666 not, for instance).
31668 @subsubheading @value{GDBN} Command
31670 There's no equivalent @value{GDBN} command.
31672 @subsubheading Example
31676 @subheading The @code{-target-list-available-targets} Command
31677 @findex -target-list-available-targets
31679 @subsubheading Synopsis
31682 -target-list-available-targets
31685 List the possible targets to connect to.
31687 @subsubheading @value{GDBN} Command
31689 The corresponding @value{GDBN} command is @samp{help target}.
31691 @subsubheading Example
31695 @subheading The @code{-target-list-current-targets} Command
31696 @findex -target-list-current-targets
31698 @subsubheading Synopsis
31701 -target-list-current-targets
31704 Describe the current target.
31706 @subsubheading @value{GDBN} Command
31708 The corresponding information is printed by @samp{info file} (among
31711 @subsubheading Example
31715 @subheading The @code{-target-list-parameters} Command
31716 @findex -target-list-parameters
31718 @subsubheading Synopsis
31721 -target-list-parameters
31727 @subsubheading @value{GDBN} Command
31731 @subsubheading Example
31735 @subheading The @code{-target-select} Command
31736 @findex -target-select
31738 @subsubheading Synopsis
31741 -target-select @var{type} @var{parameters @dots{}}
31744 Connect @value{GDBN} to the remote target. This command takes two args:
31748 The type of target, for instance @samp{remote}, etc.
31749 @item @var{parameters}
31750 Device names, host names and the like. @xref{Target Commands, ,
31751 Commands for Managing Targets}, for more details.
31754 The output is a connection notification, followed by the address at
31755 which the target program is, in the following form:
31758 ^connected,addr="@var{address}",func="@var{function name}",
31759 args=[@var{arg list}]
31762 @subsubheading @value{GDBN} Command
31764 The corresponding @value{GDBN} command is @samp{target}.
31766 @subsubheading Example
31770 -target-select remote /dev/ttya
31771 ^connected,addr="0xfe00a300",func="??",args=[]
31775 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
31776 @node GDB/MI File Transfer Commands
31777 @section @sc{gdb/mi} File Transfer Commands
31780 @subheading The @code{-target-file-put} Command
31781 @findex -target-file-put
31783 @subsubheading Synopsis
31786 -target-file-put @var{hostfile} @var{targetfile}
31789 Copy file @var{hostfile} from the host system (the machine running
31790 @value{GDBN}) to @var{targetfile} on the target system.
31792 @subsubheading @value{GDBN} Command
31794 The corresponding @value{GDBN} command is @samp{remote put}.
31796 @subsubheading Example
31800 -target-file-put localfile remotefile
31806 @subheading The @code{-target-file-get} Command
31807 @findex -target-file-get
31809 @subsubheading Synopsis
31812 -target-file-get @var{targetfile} @var{hostfile}
31815 Copy file @var{targetfile} from the target system to @var{hostfile}
31816 on the host system.
31818 @subsubheading @value{GDBN} Command
31820 The corresponding @value{GDBN} command is @samp{remote get}.
31822 @subsubheading Example
31826 -target-file-get remotefile localfile
31832 @subheading The @code{-target-file-delete} Command
31833 @findex -target-file-delete
31835 @subsubheading Synopsis
31838 -target-file-delete @var{targetfile}
31841 Delete @var{targetfile} from the target system.
31843 @subsubheading @value{GDBN} Command
31845 The corresponding @value{GDBN} command is @samp{remote delete}.
31847 @subsubheading Example
31851 -target-file-delete remotefile
31857 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
31858 @node GDB/MI Ada Exceptions Commands
31859 @section Ada Exceptions @sc{gdb/mi} Commands
31861 @subheading The @code{-info-ada-exceptions} Command
31862 @findex -info-ada-exceptions
31864 @subsubheading Synopsis
31867 -info-ada-exceptions [ @var{regexp}]
31870 List all Ada exceptions defined within the program being debugged.
31871 With a regular expression @var{regexp}, only those exceptions whose
31872 names match @var{regexp} are listed.
31874 @subsubheading @value{GDBN} Command
31876 The corresponding @value{GDBN} command is @samp{info exceptions}.
31878 @subsubheading Result
31880 The result is a table of Ada exceptions. The following columns are
31881 defined for each exception:
31885 The name of the exception.
31888 The address of the exception.
31892 @subsubheading Example
31895 -info-ada-exceptions aint
31896 ^done,ada-exceptions=@{nr_rows="2",nr_cols="2",
31897 hdr=[@{width="1",alignment="-1",col_name="name",colhdr="Name"@},
31898 @{width="1",alignment="-1",col_name="address",colhdr="Address"@}],
31899 body=[@{name="constraint_error",address="0x0000000000613da0"@},
31900 @{name="const.aint_global_e",address="0x0000000000613b00"@}]@}
31903 @subheading Catching Ada Exceptions
31905 The commands describing how to ask @value{GDBN} to stop when a program
31906 raises an exception are described at @ref{Ada Exception GDB/MI
31907 Catchpoint Commands}.
31910 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
31911 @node GDB/MI Support Commands
31912 @section @sc{gdb/mi} Support Commands
31914 Since new commands and features get regularly added to @sc{gdb/mi},
31915 some commands are available to help front-ends query the debugger
31916 about support for these capabilities. Similarly, it is also possible
31917 to query @value{GDBN} about target support of certain features.
31919 @subheading The @code{-info-gdb-mi-command} Command
31920 @cindex @code{-info-gdb-mi-command}
31921 @findex -info-gdb-mi-command
31923 @subsubheading Synopsis
31926 -info-gdb-mi-command @var{cmd_name}
31929 Query support for the @sc{gdb/mi} command named @var{cmd_name}.
31931 Note that the dash (@code{-}) starting all @sc{gdb/mi} commands
31932 is technically not part of the command name (@pxref{GDB/MI Input
31933 Syntax}), and thus should be omitted in @var{cmd_name}. However,
31934 for ease of use, this command also accepts the form with the leading
31937 @subsubheading @value{GDBN} Command
31939 There is no corresponding @value{GDBN} command.
31941 @subsubheading Result
31943 The result is a tuple. There is currently only one field:
31947 This field is equal to @code{"true"} if the @sc{gdb/mi} command exists,
31948 @code{"false"} otherwise.
31952 @subsubheading Example
31954 Here is an example where the @sc{gdb/mi} command does not exist:
31957 -info-gdb-mi-command unsupported-command
31958 ^done,command=@{exists="false"@}
31962 And here is an example where the @sc{gdb/mi} command is known
31966 -info-gdb-mi-command symbol-list-lines
31967 ^done,command=@{exists="true"@}
31970 @subheading The @code{-list-features} Command
31971 @findex -list-features
31972 @cindex supported @sc{gdb/mi} features, list
31974 Returns a list of particular features of the MI protocol that
31975 this version of gdb implements. A feature can be a command,
31976 or a new field in an output of some command, or even an
31977 important bugfix. While a frontend can sometimes detect presence
31978 of a feature at runtime, it is easier to perform detection at debugger
31981 The command returns a list of strings, with each string naming an
31982 available feature. Each returned string is just a name, it does not
31983 have any internal structure. The list of possible feature names
31989 (gdb) -list-features
31990 ^done,result=["feature1","feature2"]
31993 The current list of features is:
31996 @item frozen-varobjs
31997 Indicates support for the @code{-var-set-frozen} command, as well
31998 as possible presense of the @code{frozen} field in the output
31999 of @code{-varobj-create}.
32000 @item pending-breakpoints
32001 Indicates support for the @option{-f} option to the @code{-break-insert}
32004 Indicates Python scripting support, Python-based
32005 pretty-printing commands, and possible presence of the
32006 @samp{display_hint} field in the output of @code{-var-list-children}
32008 Indicates support for the @code{-thread-info} command.
32009 @item data-read-memory-bytes
32010 Indicates support for the @code{-data-read-memory-bytes} and the
32011 @code{-data-write-memory-bytes} commands.
32012 @item breakpoint-notifications
32013 Indicates that changes to breakpoints and breakpoints created via the
32014 CLI will be announced via async records.
32015 @item ada-task-info
32016 Indicates support for the @code{-ada-task-info} command.
32017 @item language-option
32018 Indicates that all @sc{gdb/mi} commands accept the @option{--language}
32019 option (@pxref{Context management}).
32020 @item info-gdb-mi-command
32021 Indicates support for the @code{-info-gdb-mi-command} command.
32022 @item undefined-command-error-code
32023 Indicates support for the "undefined-command" error code in error result
32024 records, produced when trying to execute an undefined @sc{gdb/mi} command
32025 (@pxref{GDB/MI Result Records}).
32026 @item exec-run-start-option
32027 Indicates that the @code{-exec-run} command supports the @option{--start}
32028 option (@pxref{GDB/MI Program Execution}).
32031 @subheading The @code{-list-target-features} Command
32032 @findex -list-target-features
32034 Returns a list of particular features that are supported by the
32035 target. Those features affect the permitted MI commands, but
32036 unlike the features reported by the @code{-list-features} command, the
32037 features depend on which target GDB is using at the moment. Whenever
32038 a target can change, due to commands such as @code{-target-select},
32039 @code{-target-attach} or @code{-exec-run}, the list of target features
32040 may change, and the frontend should obtain it again.
32044 (gdb) -list-target-features
32045 ^done,result=["async"]
32048 The current list of features is:
32052 Indicates that the target is capable of asynchronous command
32053 execution, which means that @value{GDBN} will accept further commands
32054 while the target is running.
32057 Indicates that the target is capable of reverse execution.
32058 @xref{Reverse Execution}, for more information.
32062 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
32063 @node GDB/MI Miscellaneous Commands
32064 @section Miscellaneous @sc{gdb/mi} Commands
32066 @c @subheading -gdb-complete
32068 @subheading The @code{-gdb-exit} Command
32071 @subsubheading Synopsis
32077 Exit @value{GDBN} immediately.
32079 @subsubheading @value{GDBN} Command
32081 Approximately corresponds to @samp{quit}.
32083 @subsubheading Example
32093 @subheading The @code{-exec-abort} Command
32094 @findex -exec-abort
32096 @subsubheading Synopsis
32102 Kill the inferior running program.
32104 @subsubheading @value{GDBN} Command
32106 The corresponding @value{GDBN} command is @samp{kill}.
32108 @subsubheading Example
32113 @subheading The @code{-gdb-set} Command
32116 @subsubheading Synopsis
32122 Set an internal @value{GDBN} variable.
32123 @c IS THIS A DOLLAR VARIABLE? OR SOMETHING LIKE ANNOTATE ?????
32125 @subsubheading @value{GDBN} Command
32127 The corresponding @value{GDBN} command is @samp{set}.
32129 @subsubheading Example
32139 @subheading The @code{-gdb-show} Command
32142 @subsubheading Synopsis
32148 Show the current value of a @value{GDBN} variable.
32150 @subsubheading @value{GDBN} Command
32152 The corresponding @value{GDBN} command is @samp{show}.
32154 @subsubheading Example
32163 @c @subheading -gdb-source
32166 @subheading The @code{-gdb-version} Command
32167 @findex -gdb-version
32169 @subsubheading Synopsis
32175 Show version information for @value{GDBN}. Used mostly in testing.
32177 @subsubheading @value{GDBN} Command
32179 The @value{GDBN} equivalent is @samp{show version}. @value{GDBN} by
32180 default shows this information when you start an interactive session.
32182 @subsubheading Example
32184 @c This example modifies the actual output from GDB to avoid overfull
32190 ~Copyright 2000 Free Software Foundation, Inc.
32191 ~GDB is free software, covered by the GNU General Public License, and
32192 ~you are welcome to change it and/or distribute copies of it under
32193 ~ certain conditions.
32194 ~Type "show copying" to see the conditions.
32195 ~There is absolutely no warranty for GDB. Type "show warranty" for
32197 ~This GDB was configured as
32198 "--host=sparc-sun-solaris2.5.1 --target=ppc-eabi".
32203 @subheading The @code{-list-thread-groups} Command
32204 @findex -list-thread-groups
32206 @subheading Synopsis
32209 -list-thread-groups [ --available ] [ --recurse 1 ] [ @var{group} ... ]
32212 Lists thread groups (@pxref{Thread groups}). When a single thread
32213 group is passed as the argument, lists the children of that group.
32214 When several thread group are passed, lists information about those
32215 thread groups. Without any parameters, lists information about all
32216 top-level thread groups.
32218 Normally, thread groups that are being debugged are reported.
32219 With the @samp{--available} option, @value{GDBN} reports thread groups
32220 available on the target.
32222 The output of this command may have either a @samp{threads} result or
32223 a @samp{groups} result. The @samp{thread} result has a list of tuples
32224 as value, with each tuple describing a thread (@pxref{GDB/MI Thread
32225 Information}). The @samp{groups} result has a list of tuples as value,
32226 each tuple describing a thread group. If top-level groups are
32227 requested (that is, no parameter is passed), or when several groups
32228 are passed, the output always has a @samp{groups} result. The format
32229 of the @samp{group} result is described below.
32231 To reduce the number of roundtrips it's possible to list thread groups
32232 together with their children, by passing the @samp{--recurse} option
32233 and the recursion depth. Presently, only recursion depth of 1 is
32234 permitted. If this option is present, then every reported thread group
32235 will also include its children, either as @samp{group} or
32236 @samp{threads} field.
32238 In general, any combination of option and parameters is permitted, with
32239 the following caveats:
32243 When a single thread group is passed, the output will typically
32244 be the @samp{threads} result. Because threads may not contain
32245 anything, the @samp{recurse} option will be ignored.
32248 When the @samp{--available} option is passed, limited information may
32249 be available. In particular, the list of threads of a process might
32250 be inaccessible. Further, specifying specific thread groups might
32251 not give any performance advantage over listing all thread groups.
32252 The frontend should assume that @samp{-list-thread-groups --available}
32253 is always an expensive operation and cache the results.
32257 The @samp{groups} result is a list of tuples, where each tuple may
32258 have the following fields:
32262 Identifier of the thread group. This field is always present.
32263 The identifier is an opaque string; frontends should not try to
32264 convert it to an integer, even though it might look like one.
32267 The type of the thread group. At present, only @samp{process} is a
32271 The target-specific process identifier. This field is only present
32272 for thread groups of type @samp{process} and only if the process exists.
32275 The exit code of this group's last exited thread, formatted in octal.
32276 This field is only present for thread groups of type @samp{process} and
32277 only if the process is not running.
32280 The number of children this thread group has. This field may be
32281 absent for an available thread group.
32284 This field has a list of tuples as value, each tuple describing a
32285 thread. It may be present if the @samp{--recurse} option is
32286 specified, and it's actually possible to obtain the threads.
32289 This field is a list of integers, each identifying a core that one
32290 thread of the group is running on. This field may be absent if
32291 such information is not available.
32294 The name of the executable file that corresponds to this thread group.
32295 The field is only present for thread groups of type @samp{process},
32296 and only if there is a corresponding executable file.
32300 @subheading Example
32304 -list-thread-groups
32305 ^done,groups=[@{id="17",type="process",pid="yyy",num_children="2"@}]
32306 -list-thread-groups 17
32307 ^done,threads=[@{id="2",target-id="Thread 0xb7e14b90 (LWP 21257)",
32308 frame=@{level="0",addr="0xffffe410",func="__kernel_vsyscall",args=[]@},state="running"@},
32309 @{id="1",target-id="Thread 0xb7e156b0 (LWP 21254)",
32310 frame=@{level="0",addr="0x0804891f",func="foo",args=[@{name="i",value="10"@}],
32311 file="/tmp/a.c",fullname="/tmp/a.c",line="158"@},state="running"@}]]
32312 -list-thread-groups --available
32313 ^done,groups=[@{id="17",type="process",pid="yyy",num_children="2",cores=[1,2]@}]
32314 -list-thread-groups --available --recurse 1
32315 ^done,groups=[@{id="17", types="process",pid="yyy",num_children="2",cores=[1,2],
32316 threads=[@{id="1",target-id="Thread 0xb7e14b90",cores=[1]@},
32317 @{id="2",target-id="Thread 0xb7e14b90",cores=[2]@}]@},..]
32318 -list-thread-groups --available --recurse 1 17 18
32319 ^done,groups=[@{id="17", types="process",pid="yyy",num_children="2",cores=[1,2],
32320 threads=[@{id="1",target-id="Thread 0xb7e14b90",cores=[1]@},
32321 @{id="2",target-id="Thread 0xb7e14b90",cores=[2]@}]@},...]
32324 @subheading The @code{-info-os} Command
32327 @subsubheading Synopsis
32330 -info-os [ @var{type} ]
32333 If no argument is supplied, the command returns a table of available
32334 operating-system-specific information types. If one of these types is
32335 supplied as an argument @var{type}, then the command returns a table
32336 of data of that type.
32338 The types of information available depend on the target operating
32341 @subsubheading @value{GDBN} Command
32343 The corresponding @value{GDBN} command is @samp{info os}.
32345 @subsubheading Example
32347 When run on a @sc{gnu}/Linux system, the output will look something
32353 ^done,OSDataTable=@{nr_rows="10",nr_cols="3",
32354 hdr=[@{width="10",alignment="-1",col_name="col0",colhdr="Type"@},
32355 @{width="10",alignment="-1",col_name="col1",colhdr="Description"@},
32356 @{width="10",alignment="-1",col_name="col2",colhdr="Title"@}],
32357 body=[item=@{col0="cpus",col1="Listing of all cpus/cores on the system",
32359 item=@{col0="files",col1="Listing of all file descriptors",
32360 col2="File descriptors"@},
32361 item=@{col0="modules",col1="Listing of all loaded kernel modules",
32362 col2="Kernel modules"@},
32363 item=@{col0="msg",col1="Listing of all message queues",
32364 col2="Message queues"@},
32365 item=@{col0="processes",col1="Listing of all processes",
32366 col2="Processes"@},
32367 item=@{col0="procgroups",col1="Listing of all process groups",
32368 col2="Process groups"@},
32369 item=@{col0="semaphores",col1="Listing of all semaphores",
32370 col2="Semaphores"@},
32371 item=@{col0="shm",col1="Listing of all shared-memory regions",
32372 col2="Shared-memory regions"@},
32373 item=@{col0="sockets",col1="Listing of all internet-domain sockets",
32375 item=@{col0="threads",col1="Listing of all threads",
32379 ^done,OSDataTable=@{nr_rows="190",nr_cols="4",
32380 hdr=[@{width="10",alignment="-1",col_name="col0",colhdr="pid"@},
32381 @{width="10",alignment="-1",col_name="col1",colhdr="user"@},
32382 @{width="10",alignment="-1",col_name="col2",colhdr="command"@},
32383 @{width="10",alignment="-1",col_name="col3",colhdr="cores"@}],
32384 body=[item=@{col0="1",col1="root",col2="/sbin/init",col3="0"@},
32385 item=@{col0="2",col1="root",col2="[kthreadd]",col3="1"@},
32386 item=@{col0="3",col1="root",col2="[ksoftirqd/0]",col3="0"@},
32388 item=@{col0="26446",col1="stan",col2="bash",col3="0"@},
32389 item=@{col0="28152",col1="stan",col2="bash",col3="1"@}]@}
32393 (Note that the MI output here includes a @code{"Title"} column that
32394 does not appear in command-line @code{info os}; this column is useful
32395 for MI clients that want to enumerate the types of data, such as in a
32396 popup menu, but is needless clutter on the command line, and
32397 @code{info os} omits it.)
32399 @subheading The @code{-add-inferior} Command
32400 @findex -add-inferior
32402 @subheading Synopsis
32408 Creates a new inferior (@pxref{Inferiors and Programs}). The created
32409 inferior is not associated with any executable. Such association may
32410 be established with the @samp{-file-exec-and-symbols} command
32411 (@pxref{GDB/MI File Commands}). The command response has a single
32412 field, @samp{inferior}, whose value is the identifier of the
32413 thread group corresponding to the new inferior.
32415 @subheading Example
32420 ^done,inferior="i3"
32423 @subheading The @code{-interpreter-exec} Command
32424 @findex -interpreter-exec
32426 @subheading Synopsis
32429 -interpreter-exec @var{interpreter} @var{command}
32431 @anchor{-interpreter-exec}
32433 Execute the specified @var{command} in the given @var{interpreter}.
32435 @subheading @value{GDBN} Command
32437 The corresponding @value{GDBN} command is @samp{interpreter-exec}.
32439 @subheading Example
32443 -interpreter-exec console "break main"
32444 &"During symbol reading, couldn't parse type; debugger out of date?.\n"
32445 &"During symbol reading, bad structure-type format.\n"
32446 ~"Breakpoint 1 at 0x8074fc6: file ../../src/gdb/main.c, line 743.\n"
32451 @subheading The @code{-inferior-tty-set} Command
32452 @findex -inferior-tty-set
32454 @subheading Synopsis
32457 -inferior-tty-set /dev/pts/1
32460 Set terminal for future runs of the program being debugged.
32462 @subheading @value{GDBN} Command
32464 The corresponding @value{GDBN} command is @samp{set inferior-tty} /dev/pts/1.
32466 @subheading Example
32470 -inferior-tty-set /dev/pts/1
32475 @subheading The @code{-inferior-tty-show} Command
32476 @findex -inferior-tty-show
32478 @subheading Synopsis
32484 Show terminal for future runs of program being debugged.
32486 @subheading @value{GDBN} Command
32488 The corresponding @value{GDBN} command is @samp{show inferior-tty}.
32490 @subheading Example
32494 -inferior-tty-set /dev/pts/1
32498 ^done,inferior_tty_terminal="/dev/pts/1"
32502 @subheading The @code{-enable-timings} Command
32503 @findex -enable-timings
32505 @subheading Synopsis
32508 -enable-timings [yes | no]
32511 Toggle the printing of the wallclock, user and system times for an MI
32512 command as a field in its output. This command is to help frontend
32513 developers optimize the performance of their code. No argument is
32514 equivalent to @samp{yes}.
32516 @subheading @value{GDBN} Command
32520 @subheading Example
32528 ^done,bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
32529 addr="0x080484ed",func="main",file="myprog.c",
32530 fullname="/home/nickrob/myprog.c",line="73",thread-groups=["i1"],
32532 time=@{wallclock="0.05185",user="0.00800",system="0.00000"@}
32540 *stopped,reason="breakpoint-hit",disp="keep",bkptno="1",thread-id="0",
32541 frame=@{addr="0x080484ed",func="main",args=[@{name="argc",value="1"@},
32542 @{name="argv",value="0xbfb60364"@}],file="myprog.c",
32543 fullname="/home/nickrob/myprog.c",line="73"@}
32548 @chapter @value{GDBN} Annotations
32550 This chapter describes annotations in @value{GDBN}. Annotations were
32551 designed to interface @value{GDBN} to graphical user interfaces or other
32552 similar programs which want to interact with @value{GDBN} at a
32553 relatively high level.
32555 The annotation mechanism has largely been superseded by @sc{gdb/mi}
32559 This is Edition @value{EDITION}, @value{DATE}.
32563 * Annotations Overview:: What annotations are; the general syntax.
32564 * Server Prefix:: Issuing a command without affecting user state.
32565 * Prompting:: Annotations marking @value{GDBN}'s need for input.
32566 * Errors:: Annotations for error messages.
32567 * Invalidation:: Some annotations describe things now invalid.
32568 * Annotations for Running::
32569 Whether the program is running, how it stopped, etc.
32570 * Source Annotations:: Annotations describing source code.
32573 @node Annotations Overview
32574 @section What is an Annotation?
32575 @cindex annotations
32577 Annotations start with a newline character, two @samp{control-z}
32578 characters, and the name of the annotation. If there is no additional
32579 information associated with this annotation, the name of the annotation
32580 is followed immediately by a newline. If there is additional
32581 information, the name of the annotation is followed by a space, the
32582 additional information, and a newline. The additional information
32583 cannot contain newline characters.
32585 Any output not beginning with a newline and two @samp{control-z}
32586 characters denotes literal output from @value{GDBN}. Currently there is
32587 no need for @value{GDBN} to output a newline followed by two
32588 @samp{control-z} characters, but if there was such a need, the
32589 annotations could be extended with an @samp{escape} annotation which
32590 means those three characters as output.
32592 The annotation @var{level}, which is specified using the
32593 @option{--annotate} command line option (@pxref{Mode Options}), controls
32594 how much information @value{GDBN} prints together with its prompt,
32595 values of expressions, source lines, and other types of output. Level 0
32596 is for no annotations, level 1 is for use when @value{GDBN} is run as a
32597 subprocess of @sc{gnu} Emacs, level 3 is the maximum annotation suitable
32598 for programs that control @value{GDBN}, and level 2 annotations have
32599 been made obsolete (@pxref{Limitations, , Limitations of the Annotation
32600 Interface, annotate, GDB's Obsolete Annotations}).
32603 @kindex set annotate
32604 @item set annotate @var{level}
32605 The @value{GDBN} command @code{set annotate} sets the level of
32606 annotations to the specified @var{level}.
32608 @item show annotate
32609 @kindex show annotate
32610 Show the current annotation level.
32613 This chapter describes level 3 annotations.
32615 A simple example of starting up @value{GDBN} with annotations is:
32618 $ @kbd{gdb --annotate=3}
32620 Copyright 2003 Free Software Foundation, Inc.
32621 GDB is free software, covered by the GNU General Public License,
32622 and you are welcome to change it and/or distribute copies of it
32623 under certain conditions.
32624 Type "show copying" to see the conditions.
32625 There is absolutely no warranty for GDB. Type "show warranty"
32627 This GDB was configured as "i386-pc-linux-gnu"
32638 Here @samp{quit} is input to @value{GDBN}; the rest is output from
32639 @value{GDBN}. The three lines beginning @samp{^Z^Z} (where @samp{^Z}
32640 denotes a @samp{control-z} character) are annotations; the rest is
32641 output from @value{GDBN}.
32643 @node Server Prefix
32644 @section The Server Prefix
32645 @cindex server prefix
32647 If you prefix a command with @samp{server } then it will not affect
32648 the command history, nor will it affect @value{GDBN}'s notion of which
32649 command to repeat if @key{RET} is pressed on a line by itself. This
32650 means that commands can be run behind a user's back by a front-end in
32651 a transparent manner.
32653 The @code{server } prefix does not affect the recording of values into
32654 the value history; to print a value without recording it into the
32655 value history, use the @code{output} command instead of the
32656 @code{print} command.
32658 Using this prefix also disables confirmation requests
32659 (@pxref{confirmation requests}).
32662 @section Annotation for @value{GDBN} Input
32664 @cindex annotations for prompts
32665 When @value{GDBN} prompts for input, it annotates this fact so it is possible
32666 to know when to send output, when the output from a given command is
32669 Different kinds of input each have a different @dfn{input type}. Each
32670 input type has three annotations: a @code{pre-} annotation, which
32671 denotes the beginning of any prompt which is being output, a plain
32672 annotation, which denotes the end of the prompt, and then a @code{post-}
32673 annotation which denotes the end of any echo which may (or may not) be
32674 associated with the input. For example, the @code{prompt} input type
32675 features the following annotations:
32683 The input types are
32686 @findex pre-prompt annotation
32687 @findex prompt annotation
32688 @findex post-prompt annotation
32690 When @value{GDBN} is prompting for a command (the main @value{GDBN} prompt).
32692 @findex pre-commands annotation
32693 @findex commands annotation
32694 @findex post-commands annotation
32696 When @value{GDBN} prompts for a set of commands, like in the @code{commands}
32697 command. The annotations are repeated for each command which is input.
32699 @findex pre-overload-choice annotation
32700 @findex overload-choice annotation
32701 @findex post-overload-choice annotation
32702 @item overload-choice
32703 When @value{GDBN} wants the user to select between various overloaded functions.
32705 @findex pre-query annotation
32706 @findex query annotation
32707 @findex post-query annotation
32709 When @value{GDBN} wants the user to confirm a potentially dangerous operation.
32711 @findex pre-prompt-for-continue annotation
32712 @findex prompt-for-continue annotation
32713 @findex post-prompt-for-continue annotation
32714 @item prompt-for-continue
32715 When @value{GDBN} is asking the user to press return to continue. Note: Don't
32716 expect this to work well; instead use @code{set height 0} to disable
32717 prompting. This is because the counting of lines is buggy in the
32718 presence of annotations.
32723 @cindex annotations for errors, warnings and interrupts
32725 @findex quit annotation
32730 This annotation occurs right before @value{GDBN} responds to an interrupt.
32732 @findex error annotation
32737 This annotation occurs right before @value{GDBN} responds to an error.
32739 Quit and error annotations indicate that any annotations which @value{GDBN} was
32740 in the middle of may end abruptly. For example, if a
32741 @code{value-history-begin} annotation is followed by a @code{error}, one
32742 cannot expect to receive the matching @code{value-history-end}. One
32743 cannot expect not to receive it either, however; an error annotation
32744 does not necessarily mean that @value{GDBN} is immediately returning all the way
32747 @findex error-begin annotation
32748 A quit or error annotation may be preceded by
32754 Any output between that and the quit or error annotation is the error
32757 Warning messages are not yet annotated.
32758 @c If we want to change that, need to fix warning(), type_error(),
32759 @c range_error(), and possibly other places.
32762 @section Invalidation Notices
32764 @cindex annotations for invalidation messages
32765 The following annotations say that certain pieces of state may have
32769 @findex frames-invalid annotation
32770 @item ^Z^Zframes-invalid
32772 The frames (for example, output from the @code{backtrace} command) may
32775 @findex breakpoints-invalid annotation
32776 @item ^Z^Zbreakpoints-invalid
32778 The breakpoints may have changed. For example, the user just added or
32779 deleted a breakpoint.
32782 @node Annotations for Running
32783 @section Running the Program
32784 @cindex annotations for running programs
32786 @findex starting annotation
32787 @findex stopping annotation
32788 When the program starts executing due to a @value{GDBN} command such as
32789 @code{step} or @code{continue},
32795 is output. When the program stops,
32801 is output. Before the @code{stopped} annotation, a variety of
32802 annotations describe how the program stopped.
32805 @findex exited annotation
32806 @item ^Z^Zexited @var{exit-status}
32807 The program exited, and @var{exit-status} is the exit status (zero for
32808 successful exit, otherwise nonzero).
32810 @findex signalled annotation
32811 @findex signal-name annotation
32812 @findex signal-name-end annotation
32813 @findex signal-string annotation
32814 @findex signal-string-end annotation
32815 @item ^Z^Zsignalled
32816 The program exited with a signal. After the @code{^Z^Zsignalled}, the
32817 annotation continues:
32823 ^Z^Zsignal-name-end
32827 ^Z^Zsignal-string-end
32832 where @var{name} is the name of the signal, such as @code{SIGILL} or
32833 @code{SIGSEGV}, and @var{string} is the explanation of the signal, such
32834 as @code{Illegal Instruction} or @code{Segmentation fault}. The arguments
32835 @var{intro-text}, @var{middle-text}, and @var{end-text} are for the
32836 user's benefit and have no particular format.
32838 @findex signal annotation
32840 The syntax of this annotation is just like @code{signalled}, but @value{GDBN} is
32841 just saying that the program received the signal, not that it was
32842 terminated with it.
32844 @findex breakpoint annotation
32845 @item ^Z^Zbreakpoint @var{number}
32846 The program hit breakpoint number @var{number}.
32848 @findex watchpoint annotation
32849 @item ^Z^Zwatchpoint @var{number}
32850 The program hit watchpoint number @var{number}.
32853 @node Source Annotations
32854 @section Displaying Source
32855 @cindex annotations for source display
32857 @findex source annotation
32858 The following annotation is used instead of displaying source code:
32861 ^Z^Zsource @var{filename}:@var{line}:@var{character}:@var{middle}:@var{addr}
32864 where @var{filename} is an absolute file name indicating which source
32865 file, @var{line} is the line number within that file (where 1 is the
32866 first line in the file), @var{character} is the character position
32867 within the file (where 0 is the first character in the file) (for most
32868 debug formats this will necessarily point to the beginning of a line),
32869 @var{middle} is @samp{middle} if @var{addr} is in the middle of the
32870 line, or @samp{beg} if @var{addr} is at the beginning of the line, and
32871 @var{addr} is the address in the target program associated with the
32872 source which is being displayed. The @var{addr} is in the form @samp{0x}
32873 followed by one or more lowercase hex digits (note that this does not
32874 depend on the language).
32876 @node JIT Interface
32877 @chapter JIT Compilation Interface
32878 @cindex just-in-time compilation
32879 @cindex JIT compilation interface
32881 This chapter documents @value{GDBN}'s @dfn{just-in-time} (JIT) compilation
32882 interface. A JIT compiler is a program or library that generates native
32883 executable code at runtime and executes it, usually in order to achieve good
32884 performance while maintaining platform independence.
32886 Programs that use JIT compilation are normally difficult to debug because
32887 portions of their code are generated at runtime, instead of being loaded from
32888 object files, which is where @value{GDBN} normally finds the program's symbols
32889 and debug information. In order to debug programs that use JIT compilation,
32890 @value{GDBN} has an interface that allows the program to register in-memory
32891 symbol files with @value{GDBN} at runtime.
32893 If you are using @value{GDBN} to debug a program that uses this interface, then
32894 it should work transparently so long as you have not stripped the binary. If
32895 you are developing a JIT compiler, then the interface is documented in the rest
32896 of this chapter. At this time, the only known client of this interface is the
32899 Broadly speaking, the JIT interface mirrors the dynamic loader interface. The
32900 JIT compiler communicates with @value{GDBN} by writing data into a global
32901 variable and calling a fuction at a well-known symbol. When @value{GDBN}
32902 attaches, it reads a linked list of symbol files from the global variable to
32903 find existing code, and puts a breakpoint in the function so that it can find
32904 out about additional code.
32907 * Declarations:: Relevant C struct declarations
32908 * Registering Code:: Steps to register code
32909 * Unregistering Code:: Steps to unregister code
32910 * Custom Debug Info:: Emit debug information in a custom format
32914 @section JIT Declarations
32916 These are the relevant struct declarations that a C program should include to
32917 implement the interface:
32927 struct jit_code_entry
32929 struct jit_code_entry *next_entry;
32930 struct jit_code_entry *prev_entry;
32931 const char *symfile_addr;
32932 uint64_t symfile_size;
32935 struct jit_descriptor
32938 /* This type should be jit_actions_t, but we use uint32_t
32939 to be explicit about the bitwidth. */
32940 uint32_t action_flag;
32941 struct jit_code_entry *relevant_entry;
32942 struct jit_code_entry *first_entry;
32945 /* GDB puts a breakpoint in this function. */
32946 void __attribute__((noinline)) __jit_debug_register_code() @{ @};
32948 /* Make sure to specify the version statically, because the
32949 debugger may check the version before we can set it. */
32950 struct jit_descriptor __jit_debug_descriptor = @{ 1, 0, 0, 0 @};
32953 If the JIT is multi-threaded, then it is important that the JIT synchronize any
32954 modifications to this global data properly, which can easily be done by putting
32955 a global mutex around modifications to these structures.
32957 @node Registering Code
32958 @section Registering Code
32960 To register code with @value{GDBN}, the JIT should follow this protocol:
32964 Generate an object file in memory with symbols and other desired debug
32965 information. The file must include the virtual addresses of the sections.
32968 Create a code entry for the file, which gives the start and size of the symbol
32972 Add it to the linked list in the JIT descriptor.
32975 Point the relevant_entry field of the descriptor at the entry.
32978 Set @code{action_flag} to @code{JIT_REGISTER} and call
32979 @code{__jit_debug_register_code}.
32982 When @value{GDBN} is attached and the breakpoint fires, @value{GDBN} uses the
32983 @code{relevant_entry} pointer so it doesn't have to walk the list looking for
32984 new code. However, the linked list must still be maintained in order to allow
32985 @value{GDBN} to attach to a running process and still find the symbol files.
32987 @node Unregistering Code
32988 @section Unregistering Code
32990 If code is freed, then the JIT should use the following protocol:
32994 Remove the code entry corresponding to the code from the linked list.
32997 Point the @code{relevant_entry} field of the descriptor at the code entry.
33000 Set @code{action_flag} to @code{JIT_UNREGISTER} and call
33001 @code{__jit_debug_register_code}.
33004 If the JIT frees or recompiles code without unregistering it, then @value{GDBN}
33005 and the JIT will leak the memory used for the associated symbol files.
33007 @node Custom Debug Info
33008 @section Custom Debug Info
33009 @cindex custom JIT debug info
33010 @cindex JIT debug info reader
33012 Generating debug information in platform-native file formats (like ELF
33013 or COFF) may be an overkill for JIT compilers; especially if all the
33014 debug info is used for is displaying a meaningful backtrace. The
33015 issue can be resolved by having the JIT writers decide on a debug info
33016 format and also provide a reader that parses the debug info generated
33017 by the JIT compiler. This section gives a brief overview on writing
33018 such a parser. More specific details can be found in the source file
33019 @file{gdb/jit-reader.in}, which is also installed as a header at
33020 @file{@var{includedir}/gdb/jit-reader.h} for easy inclusion.
33022 The reader is implemented as a shared object (so this functionality is
33023 not available on platforms which don't allow loading shared objects at
33024 runtime). Two @value{GDBN} commands, @code{jit-reader-load} and
33025 @code{jit-reader-unload} are provided, to be used to load and unload
33026 the readers from a preconfigured directory. Once loaded, the shared
33027 object is used the parse the debug information emitted by the JIT
33031 * Using JIT Debug Info Readers:: How to use supplied readers correctly
33032 * Writing JIT Debug Info Readers:: Creating a debug-info reader
33035 @node Using JIT Debug Info Readers
33036 @subsection Using JIT Debug Info Readers
33037 @kindex jit-reader-load
33038 @kindex jit-reader-unload
33040 Readers can be loaded and unloaded using the @code{jit-reader-load}
33041 and @code{jit-reader-unload} commands.
33044 @item jit-reader-load @var{reader}
33045 Load the JIT reader named @var{reader}, which is a shared
33046 object specified as either an absolute or a relative file name. In
33047 the latter case, @value{GDBN} will try to load the reader from a
33048 pre-configured directory, usually @file{@var{libdir}/gdb/} on a UNIX
33049 system (here @var{libdir} is the system library directory, often
33050 @file{/usr/local/lib}).
33052 Only one reader can be active at a time; trying to load a second
33053 reader when one is already loaded will result in @value{GDBN}
33054 reporting an error. A new JIT reader can be loaded by first unloading
33055 the current one using @code{jit-reader-unload} and then invoking
33056 @code{jit-reader-load}.
33058 @item jit-reader-unload
33059 Unload the currently loaded JIT reader.
33063 @node Writing JIT Debug Info Readers
33064 @subsection Writing JIT Debug Info Readers
33065 @cindex writing JIT debug info readers
33067 As mentioned, a reader is essentially a shared object conforming to a
33068 certain ABI. This ABI is described in @file{jit-reader.h}.
33070 @file{jit-reader.h} defines the structures, macros and functions
33071 required to write a reader. It is installed (along with
33072 @value{GDBN}), in @file{@var{includedir}/gdb} where @var{includedir} is
33073 the system include directory.
33075 Readers need to be released under a GPL compatible license. A reader
33076 can be declared as released under such a license by placing the macro
33077 @code{GDB_DECLARE_GPL_COMPATIBLE_READER} in a source file.
33079 The entry point for readers is the symbol @code{gdb_init_reader},
33080 which is expected to be a function with the prototype
33082 @findex gdb_init_reader
33084 extern struct gdb_reader_funcs *gdb_init_reader (void);
33087 @cindex @code{struct gdb_reader_funcs}
33089 @code{struct gdb_reader_funcs} contains a set of pointers to callback
33090 functions. These functions are executed to read the debug info
33091 generated by the JIT compiler (@code{read}), to unwind stack frames
33092 (@code{unwind}) and to create canonical frame IDs
33093 (@code{get_Frame_id}). It also has a callback that is called when the
33094 reader is being unloaded (@code{destroy}). The struct looks like this
33097 struct gdb_reader_funcs
33099 /* Must be set to GDB_READER_INTERFACE_VERSION. */
33100 int reader_version;
33102 /* For use by the reader. */
33105 gdb_read_debug_info *read;
33106 gdb_unwind_frame *unwind;
33107 gdb_get_frame_id *get_frame_id;
33108 gdb_destroy_reader *destroy;
33112 @cindex @code{struct gdb_symbol_callbacks}
33113 @cindex @code{struct gdb_unwind_callbacks}
33115 The callbacks are provided with another set of callbacks by
33116 @value{GDBN} to do their job. For @code{read}, these callbacks are
33117 passed in a @code{struct gdb_symbol_callbacks} and for @code{unwind}
33118 and @code{get_frame_id}, in a @code{struct gdb_unwind_callbacks}.
33119 @code{struct gdb_symbol_callbacks} has callbacks to create new object
33120 files and new symbol tables inside those object files. @code{struct
33121 gdb_unwind_callbacks} has callbacks to read registers off the current
33122 frame and to write out the values of the registers in the previous
33123 frame. Both have a callback (@code{target_read}) to read bytes off the
33124 target's address space.
33126 @node In-Process Agent
33127 @chapter In-Process Agent
33128 @cindex debugging agent
33129 The traditional debugging model is conceptually low-speed, but works fine,
33130 because most bugs can be reproduced in debugging-mode execution. However,
33131 as multi-core or many-core processors are becoming mainstream, and
33132 multi-threaded programs become more and more popular, there should be more
33133 and more bugs that only manifest themselves at normal-mode execution, for
33134 example, thread races, because debugger's interference with the program's
33135 timing may conceal the bugs. On the other hand, in some applications,
33136 it is not feasible for the debugger to interrupt the program's execution
33137 long enough for the developer to learn anything helpful about its behavior.
33138 If the program's correctness depends on its real-time behavior, delays
33139 introduced by a debugger might cause the program to fail, even when the
33140 code itself is correct. It is useful to be able to observe the program's
33141 behavior without interrupting it.
33143 Therefore, traditional debugging model is too intrusive to reproduce
33144 some bugs. In order to reduce the interference with the program, we can
33145 reduce the number of operations performed by debugger. The
33146 @dfn{In-Process Agent}, a shared library, is running within the same
33147 process with inferior, and is able to perform some debugging operations
33148 itself. As a result, debugger is only involved when necessary, and
33149 performance of debugging can be improved accordingly. Note that
33150 interference with program can be reduced but can't be removed completely,
33151 because the in-process agent will still stop or slow down the program.
33153 The in-process agent can interpret and execute Agent Expressions
33154 (@pxref{Agent Expressions}) during performing debugging operations. The
33155 agent expressions can be used for different purposes, such as collecting
33156 data in tracepoints, and condition evaluation in breakpoints.
33158 @anchor{Control Agent}
33159 You can control whether the in-process agent is used as an aid for
33160 debugging with the following commands:
33163 @kindex set agent on
33165 Causes the in-process agent to perform some operations on behalf of the
33166 debugger. Just which operations requested by the user will be done
33167 by the in-process agent depends on the its capabilities. For example,
33168 if you request to evaluate breakpoint conditions in the in-process agent,
33169 and the in-process agent has such capability as well, then breakpoint
33170 conditions will be evaluated in the in-process agent.
33172 @kindex set agent off
33173 @item set agent off
33174 Disables execution of debugging operations by the in-process agent. All
33175 of the operations will be performed by @value{GDBN}.
33179 Display the current setting of execution of debugging operations by
33180 the in-process agent.
33184 * In-Process Agent Protocol::
33187 @node In-Process Agent Protocol
33188 @section In-Process Agent Protocol
33189 @cindex in-process agent protocol
33191 The in-process agent is able to communicate with both @value{GDBN} and
33192 GDBserver (@pxref{In-Process Agent}). This section documents the protocol
33193 used for communications between @value{GDBN} or GDBserver and the IPA.
33194 In general, @value{GDBN} or GDBserver sends commands
33195 (@pxref{IPA Protocol Commands}) and data to in-process agent, and then
33196 in-process agent replies back with the return result of the command, or
33197 some other information. The data sent to in-process agent is composed
33198 of primitive data types, such as 4-byte or 8-byte type, and composite
33199 types, which are called objects (@pxref{IPA Protocol Objects}).
33202 * IPA Protocol Objects::
33203 * IPA Protocol Commands::
33206 @node IPA Protocol Objects
33207 @subsection IPA Protocol Objects
33208 @cindex ipa protocol objects
33210 The commands sent to and results received from agent may contain some
33211 complex data types called @dfn{objects}.
33213 The in-process agent is running on the same machine with @value{GDBN}
33214 or GDBserver, so it doesn't have to handle as much differences between
33215 two ends as remote protocol (@pxref{Remote Protocol}) tries to handle.
33216 However, there are still some differences of two ends in two processes:
33220 word size. On some 64-bit machines, @value{GDBN} or GDBserver can be
33221 compiled as a 64-bit executable, while in-process agent is a 32-bit one.
33223 ABI. Some machines may have multiple types of ABI, @value{GDBN} or
33224 GDBserver is compiled with one, and in-process agent is compiled with
33228 Here are the IPA Protocol Objects:
33232 agent expression object. It represents an agent expression
33233 (@pxref{Agent Expressions}).
33234 @anchor{agent expression object}
33236 tracepoint action object. It represents a tracepoint action
33237 (@pxref{Tracepoint Actions,,Tracepoint Action Lists}) to collect registers,
33238 memory, static trace data and to evaluate expression.
33239 @anchor{tracepoint action object}
33241 tracepoint object. It represents a tracepoint (@pxref{Tracepoints}).
33242 @anchor{tracepoint object}
33246 The following table describes important attributes of each IPA protocol
33249 @multitable @columnfractions .30 .20 .50
33250 @headitem Name @tab Size @tab Description
33251 @item @emph{agent expression object} @tab @tab
33252 @item length @tab 4 @tab length of bytes code
33253 @item byte code @tab @var{length} @tab contents of byte code
33254 @item @emph{tracepoint action for collecting memory} @tab @tab
33255 @item 'M' @tab 1 @tab type of tracepoint action
33256 @item addr @tab 8 @tab if @var{basereg} is @samp{-1}, @var{addr} is the
33257 address of the lowest byte to collect, otherwise @var{addr} is the offset
33258 of @var{basereg} for memory collecting.
33259 @item len @tab 8 @tab length of memory for collecting
33260 @item basereg @tab 4 @tab the register number containing the starting
33261 memory address for collecting.
33262 @item @emph{tracepoint action for collecting registers} @tab @tab
33263 @item 'R' @tab 1 @tab type of tracepoint action
33264 @item @emph{tracepoint action for collecting static trace data} @tab @tab
33265 @item 'L' @tab 1 @tab type of tracepoint action
33266 @item @emph{tracepoint action for expression evaluation} @tab @tab
33267 @item 'X' @tab 1 @tab type of tracepoint action
33268 @item agent expression @tab length of @tab @ref{agent expression object}
33269 @item @emph{tracepoint object} @tab @tab
33270 @item number @tab 4 @tab number of tracepoint
33271 @item address @tab 8 @tab address of tracepoint inserted on
33272 @item type @tab 4 @tab type of tracepoint
33273 @item enabled @tab 1 @tab enable or disable of tracepoint
33274 @item step_count @tab 8 @tab step
33275 @item pass_count @tab 8 @tab pass
33276 @item numactions @tab 4 @tab number of tracepoint actions
33277 @item hit count @tab 8 @tab hit count
33278 @item trace frame usage @tab 8 @tab trace frame usage
33279 @item compiled_cond @tab 8 @tab compiled condition
33280 @item orig_size @tab 8 @tab orig size
33281 @item condition @tab 4 if condition is NULL otherwise length of
33282 @ref{agent expression object}
33283 @tab zero if condition is NULL, otherwise is
33284 @ref{agent expression object}
33285 @item actions @tab variable
33286 @tab numactions number of @ref{tracepoint action object}
33289 @node IPA Protocol Commands
33290 @subsection IPA Protocol Commands
33291 @cindex ipa protocol commands
33293 The spaces in each command are delimiters to ease reading this commands
33294 specification. They don't exist in real commands.
33298 @item FastTrace:@var{tracepoint_object} @var{gdb_jump_pad_head}
33299 Installs a new fast tracepoint described by @var{tracepoint_object}
33300 (@pxref{tracepoint object}). The @var{gdb_jump_pad_head}, 8-byte long, is the
33301 head of @dfn{jumppad}, which is used to jump to data collection routine
33306 @item OK @var{target_address} @var{gdb_jump_pad_head} @var{fjump_size} @var{fjump}
33307 @var{target_address} is address of tracepoint in the inferior.
33308 The @var{gdb_jump_pad_head} is updated head of jumppad. Both of
33309 @var{target_address} and @var{gdb_jump_pad_head} are 8-byte long.
33310 The @var{fjump} contains a sequence of instructions jump to jumppad entry.
33311 The @var{fjump_size}, 4-byte long, is the size of @var{fjump}.
33318 Closes the in-process agent. This command is sent when @value{GDBN} or GDBserver
33319 is about to kill inferiors.
33327 @item probe_marker_at:@var{address}
33328 Asks in-process agent to probe the marker at @var{address}.
33335 @item unprobe_marker_at:@var{address}
33336 Asks in-process agent to unprobe the marker at @var{address}.
33340 @chapter Reporting Bugs in @value{GDBN}
33341 @cindex bugs in @value{GDBN}
33342 @cindex reporting bugs in @value{GDBN}
33344 Your bug reports play an essential role in making @value{GDBN} reliable.
33346 Reporting a bug may help you by bringing a solution to your problem, or it
33347 may not. But in any case the principal function of a bug report is to help
33348 the entire community by making the next version of @value{GDBN} work better. Bug
33349 reports are your contribution to the maintenance of @value{GDBN}.
33351 In order for a bug report to serve its purpose, you must include the
33352 information that enables us to fix the bug.
33355 * Bug Criteria:: Have you found a bug?
33356 * Bug Reporting:: How to report bugs
33360 @section Have You Found a Bug?
33361 @cindex bug criteria
33363 If you are not sure whether you have found a bug, here are some guidelines:
33366 @cindex fatal signal
33367 @cindex debugger crash
33368 @cindex crash of debugger
33370 If the debugger gets a fatal signal, for any input whatever, that is a
33371 @value{GDBN} bug. Reliable debuggers never crash.
33373 @cindex error on valid input
33375 If @value{GDBN} produces an error message for valid input, that is a
33376 bug. (Note that if you're cross debugging, the problem may also be
33377 somewhere in the connection to the target.)
33379 @cindex invalid input
33381 If @value{GDBN} does not produce an error message for invalid input,
33382 that is a bug. However, you should note that your idea of
33383 ``invalid input'' might be our idea of ``an extension'' or ``support
33384 for traditional practice''.
33387 If you are an experienced user of debugging tools, your suggestions
33388 for improvement of @value{GDBN} are welcome in any case.
33391 @node Bug Reporting
33392 @section How to Report Bugs
33393 @cindex bug reports
33394 @cindex @value{GDBN} bugs, reporting
33396 A number of companies and individuals offer support for @sc{gnu} products.
33397 If you obtained @value{GDBN} from a support organization, we recommend you
33398 contact that organization first.
33400 You can find contact information for many support companies and
33401 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
33403 @c should add a web page ref...
33406 @ifset BUGURL_DEFAULT
33407 In any event, we also recommend that you submit bug reports for
33408 @value{GDBN}. The preferred method is to submit them directly using
33409 @uref{http://www.gnu.org/software/gdb/bugs/, @value{GDBN}'s Bugs web
33410 page}. Alternatively, the @email{bug-gdb@@gnu.org, e-mail gateway} can
33413 @strong{Do not send bug reports to @samp{info-gdb}, or to
33414 @samp{help-gdb}, or to any newsgroups.} Most users of @value{GDBN} do
33415 not want to receive bug reports. Those that do have arranged to receive
33418 The mailing list @samp{bug-gdb} has a newsgroup @samp{gnu.gdb.bug} which
33419 serves as a repeater. The mailing list and the newsgroup carry exactly
33420 the same messages. Often people think of posting bug reports to the
33421 newsgroup instead of mailing them. This appears to work, but it has one
33422 problem which can be crucial: a newsgroup posting often lacks a mail
33423 path back to the sender. Thus, if we need to ask for more information,
33424 we may be unable to reach you. For this reason, it is better to send
33425 bug reports to the mailing list.
33427 @ifclear BUGURL_DEFAULT
33428 In any event, we also recommend that you submit bug reports for
33429 @value{GDBN} to @value{BUGURL}.
33433 The fundamental principle of reporting bugs usefully is this:
33434 @strong{report all the facts}. If you are not sure whether to state a
33435 fact or leave it out, state it!
33437 Often people omit facts because they think they know what causes the
33438 problem and assume that some details do not matter. Thus, you might
33439 assume that the name of the variable you use in an example does not matter.
33440 Well, probably it does not, but one cannot be sure. Perhaps the bug is a
33441 stray memory reference which happens to fetch from the location where that
33442 name is stored in memory; perhaps, if the name were different, the contents
33443 of that location would fool the debugger into doing the right thing despite
33444 the bug. Play it safe and give a specific, complete example. That is the
33445 easiest thing for you to do, and the most helpful.
33447 Keep in mind that the purpose of a bug report is to enable us to fix the
33448 bug. It may be that the bug has been reported previously, but neither
33449 you nor we can know that unless your bug report is complete and
33452 Sometimes people give a few sketchy facts and ask, ``Does this ring a
33453 bell?'' Those bug reports are useless, and we urge everyone to
33454 @emph{refuse to respond to them} except to chide the sender to report
33457 To enable us to fix the bug, you should include all these things:
33461 The version of @value{GDBN}. @value{GDBN} announces it if you start
33462 with no arguments; you can also print it at any time using @code{show
33465 Without this, we will not know whether there is any point in looking for
33466 the bug in the current version of @value{GDBN}.
33469 The type of machine you are using, and the operating system name and
33473 The details of the @value{GDBN} build-time configuration.
33474 @value{GDBN} shows these details if you invoke it with the
33475 @option{--configuration} command-line option, or if you type
33476 @code{show configuration} at @value{GDBN}'s prompt.
33479 What compiler (and its version) was used to compile @value{GDBN}---e.g.@:
33480 ``@value{GCC}--2.8.1''.
33483 What compiler (and its version) was used to compile the program you are
33484 debugging---e.g.@: ``@value{GCC}--2.8.1'', or ``HP92453-01 A.10.32.03 HP
33485 C Compiler''. For @value{NGCC}, you can say @kbd{@value{GCC} --version}
33486 to get this information; for other compilers, see the documentation for
33490 The command arguments you gave the compiler to compile your example and
33491 observe the bug. For example, did you use @samp{-O}? To guarantee
33492 you will not omit something important, list them all. A copy of the
33493 Makefile (or the output from make) is sufficient.
33495 If we were to try to guess the arguments, we would probably guess wrong
33496 and then we might not encounter the bug.
33499 A complete input script, and all necessary source files, that will
33503 A description of what behavior you observe that you believe is
33504 incorrect. For example, ``It gets a fatal signal.''
33506 Of course, if the bug is that @value{GDBN} gets a fatal signal, then we
33507 will certainly notice it. But if the bug is incorrect output, we might
33508 not notice unless it is glaringly wrong. You might as well not give us
33509 a chance to make a mistake.
33511 Even if the problem you experience is a fatal signal, you should still
33512 say so explicitly. Suppose something strange is going on, such as, your
33513 copy of @value{GDBN} is out of synch, or you have encountered a bug in
33514 the C library on your system. (This has happened!) Your copy might
33515 crash and ours would not. If you told us to expect a crash, then when
33516 ours fails to crash, we would know that the bug was not happening for
33517 us. If you had not told us to expect a crash, then we would not be able
33518 to draw any conclusion from our observations.
33521 @cindex recording a session script
33522 To collect all this information, you can use a session recording program
33523 such as @command{script}, which is available on many Unix systems.
33524 Just run your @value{GDBN} session inside @command{script} and then
33525 include the @file{typescript} file with your bug report.
33527 Another way to record a @value{GDBN} session is to run @value{GDBN}
33528 inside Emacs and then save the entire buffer to a file.
33531 If you wish to suggest changes to the @value{GDBN} source, send us context
33532 diffs. If you even discuss something in the @value{GDBN} source, refer to
33533 it by context, not by line number.
33535 The line numbers in our development sources will not match those in your
33536 sources. Your line numbers would convey no useful information to us.
33540 Here are some things that are not necessary:
33544 A description of the envelope of the bug.
33546 Often people who encounter a bug spend a lot of time investigating
33547 which changes to the input file will make the bug go away and which
33548 changes will not affect it.
33550 This is often time consuming and not very useful, because the way we
33551 will find the bug is by running a single example under the debugger
33552 with breakpoints, not by pure deduction from a series of examples.
33553 We recommend that you save your time for something else.
33555 Of course, if you can find a simpler example to report @emph{instead}
33556 of the original one, that is a convenience for us. Errors in the
33557 output will be easier to spot, running under the debugger will take
33558 less time, and so on.
33560 However, simplification is not vital; if you do not want to do this,
33561 report the bug anyway and send us the entire test case you used.
33564 A patch for the bug.
33566 A patch for the bug does help us if it is a good one. But do not omit
33567 the necessary information, such as the test case, on the assumption that
33568 a patch is all we need. We might see problems with your patch and decide
33569 to fix the problem another way, or we might not understand it at all.
33571 Sometimes with a program as complicated as @value{GDBN} it is very hard to
33572 construct an example that will make the program follow a certain path
33573 through the code. If you do not send us the example, we will not be able
33574 to construct one, so we will not be able to verify that the bug is fixed.
33576 And if we cannot understand what bug you are trying to fix, or why your
33577 patch should be an improvement, we will not install it. A test case will
33578 help us to understand.
33581 A guess about what the bug is or what it depends on.
33583 Such guesses are usually wrong. Even we cannot guess right about such
33584 things without first using the debugger to find the facts.
33587 @c The readline documentation is distributed with the readline code
33588 @c and consists of the two following files:
33591 @c Use -I with makeinfo to point to the appropriate directory,
33592 @c environment var TEXINPUTS with TeX.
33593 @ifclear SYSTEM_READLINE
33594 @include rluser.texi
33595 @include hsuser.texi
33599 @appendix In Memoriam
33601 The @value{GDBN} project mourns the loss of the following long-time
33606 Fred was a long-standing contributor to @value{GDBN} (1991-2006), and
33607 to Free Software in general. Outside of @value{GDBN}, he was known in
33608 the Amiga world for his series of Fish Disks, and the GeekGadget project.
33610 @item Michael Snyder
33611 Michael was one of the Global Maintainers of the @value{GDBN} project,
33612 with contributions recorded as early as 1996, until 2011. In addition
33613 to his day to day participation, he was a large driving force behind
33614 adding Reverse Debugging to @value{GDBN}.
33617 Beyond their technical contributions to the project, they were also
33618 enjoyable members of the Free Software Community. We will miss them.
33620 @node Formatting Documentation
33621 @appendix Formatting Documentation
33623 @cindex @value{GDBN} reference card
33624 @cindex reference card
33625 The @value{GDBN} 4 release includes an already-formatted reference card, ready
33626 for printing with PostScript or Ghostscript, in the @file{gdb}
33627 subdirectory of the main source directory@footnote{In
33628 @file{gdb-@value{GDBVN}/gdb/refcard.ps} of the version @value{GDBVN}
33629 release.}. If you can use PostScript or Ghostscript with your printer,
33630 you can print the reference card immediately with @file{refcard.ps}.
33632 The release also includes the source for the reference card. You
33633 can format it, using @TeX{}, by typing:
33639 The @value{GDBN} reference card is designed to print in @dfn{landscape}
33640 mode on US ``letter'' size paper;
33641 that is, on a sheet 11 inches wide by 8.5 inches
33642 high. You will need to specify this form of printing as an option to
33643 your @sc{dvi} output program.
33645 @cindex documentation
33647 All the documentation for @value{GDBN} comes as part of the machine-readable
33648 distribution. The documentation is written in Texinfo format, which is
33649 a documentation system that uses a single source file to produce both
33650 on-line information and a printed manual. You can use one of the Info
33651 formatting commands to create the on-line version of the documentation
33652 and @TeX{} (or @code{texi2roff}) to typeset the printed version.
33654 @value{GDBN} includes an already formatted copy of the on-line Info
33655 version of this manual in the @file{gdb} subdirectory. The main Info
33656 file is @file{gdb-@value{GDBVN}/gdb/gdb.info}, and it refers to
33657 subordinate files matching @samp{gdb.info*} in the same directory. If
33658 necessary, you can print out these files, or read them with any editor;
33659 but they are easier to read using the @code{info} subsystem in @sc{gnu}
33660 Emacs or the standalone @code{info} program, available as part of the
33661 @sc{gnu} Texinfo distribution.
33663 If you want to format these Info files yourself, you need one of the
33664 Info formatting programs, such as @code{texinfo-format-buffer} or
33667 If you have @code{makeinfo} installed, and are in the top level
33668 @value{GDBN} source directory (@file{gdb-@value{GDBVN}}, in the case of
33669 version @value{GDBVN}), you can make the Info file by typing:
33676 If you want to typeset and print copies of this manual, you need @TeX{},
33677 a program to print its @sc{dvi} output files, and @file{texinfo.tex}, the
33678 Texinfo definitions file.
33680 @TeX{} is a typesetting program; it does not print files directly, but
33681 produces output files called @sc{dvi} files. To print a typeset
33682 document, you need a program to print @sc{dvi} files. If your system
33683 has @TeX{} installed, chances are it has such a program. The precise
33684 command to use depends on your system; @kbd{lpr -d} is common; another
33685 (for PostScript devices) is @kbd{dvips}. The @sc{dvi} print command may
33686 require a file name without any extension or a @samp{.dvi} extension.
33688 @TeX{} also requires a macro definitions file called
33689 @file{texinfo.tex}. This file tells @TeX{} how to typeset a document
33690 written in Texinfo format. On its own, @TeX{} cannot either read or
33691 typeset a Texinfo file. @file{texinfo.tex} is distributed with GDB
33692 and is located in the @file{gdb-@var{version-number}/texinfo}
33695 If you have @TeX{} and a @sc{dvi} printer program installed, you can
33696 typeset and print this manual. First switch to the @file{gdb}
33697 subdirectory of the main source directory (for example, to
33698 @file{gdb-@value{GDBVN}/gdb}) and type:
33704 Then give @file{gdb.dvi} to your @sc{dvi} printing program.
33706 @node Installing GDB
33707 @appendix Installing @value{GDBN}
33708 @cindex installation
33711 * Requirements:: Requirements for building @value{GDBN}
33712 * Running Configure:: Invoking the @value{GDBN} @file{configure} script
33713 * Separate Objdir:: Compiling @value{GDBN} in another directory
33714 * Config Names:: Specifying names for hosts and targets
33715 * Configure Options:: Summary of options for configure
33716 * System-wide configuration:: Having a system-wide init file
33720 @section Requirements for Building @value{GDBN}
33721 @cindex building @value{GDBN}, requirements for
33723 Building @value{GDBN} requires various tools and packages to be available.
33724 Other packages will be used only if they are found.
33726 @heading Tools/Packages Necessary for Building @value{GDBN}
33728 @item ISO C90 compiler
33729 @value{GDBN} is written in ISO C90. It should be buildable with any
33730 working C90 compiler, e.g.@: GCC.
33734 @heading Tools/Packages Optional for Building @value{GDBN}
33738 @value{GDBN} can use the Expat XML parsing library. This library may be
33739 included with your operating system distribution; if it is not, you
33740 can get the latest version from @url{http://expat.sourceforge.net}.
33741 The @file{configure} script will search for this library in several
33742 standard locations; if it is installed in an unusual path, you can
33743 use the @option{--with-libexpat-prefix} option to specify its location.
33749 Remote protocol memory maps (@pxref{Memory Map Format})
33751 Target descriptions (@pxref{Target Descriptions})
33753 Remote shared library lists (@xref{Library List Format},
33754 or alternatively @pxref{Library List Format for SVR4 Targets})
33756 MS-Windows shared libraries (@pxref{Shared Libraries})
33758 Traceframe info (@pxref{Traceframe Info Format})
33760 Branch trace (@pxref{Branch Trace Format},
33761 @pxref{Branch Trace Configuration Format})
33765 @cindex compressed debug sections
33766 @value{GDBN} will use the @samp{zlib} library, if available, to read
33767 compressed debug sections. Some linkers, such as GNU gold, are capable
33768 of producing binaries with compressed debug sections. If @value{GDBN}
33769 is compiled with @samp{zlib}, it will be able to read the debug
33770 information in such binaries.
33772 The @samp{zlib} library is likely included with your operating system
33773 distribution; if it is not, you can get the latest version from
33774 @url{http://zlib.net}.
33777 @value{GDBN}'s features related to character sets (@pxref{Character
33778 Sets}) require a functioning @code{iconv} implementation. If you are
33779 on a GNU system, then this is provided by the GNU C Library. Some
33780 other systems also provide a working @code{iconv}.
33782 If @value{GDBN} is using the @code{iconv} program which is installed
33783 in a non-standard place, you will need to tell @value{GDBN} where to find it.
33784 This is done with @option{--with-iconv-bin} which specifies the
33785 directory that contains the @code{iconv} program.
33787 On systems without @code{iconv}, you can install GNU Libiconv. If you
33788 have previously installed Libiconv, you can use the
33789 @option{--with-libiconv-prefix} option to configure.
33791 @value{GDBN}'s top-level @file{configure} and @file{Makefile} will
33792 arrange to build Libiconv if a directory named @file{libiconv} appears
33793 in the top-most source directory. If Libiconv is built this way, and
33794 if the operating system does not provide a suitable @code{iconv}
33795 implementation, then the just-built library will automatically be used
33796 by @value{GDBN}. One easy way to set this up is to download GNU
33797 Libiconv, unpack it, and then rename the directory holding the
33798 Libiconv source code to @samp{libiconv}.
33801 @node Running Configure
33802 @section Invoking the @value{GDBN} @file{configure} Script
33803 @cindex configuring @value{GDBN}
33804 @value{GDBN} comes with a @file{configure} script that automates the process
33805 of preparing @value{GDBN} for installation; you can then use @code{make} to
33806 build the @code{gdb} program.
33808 @c irrelevant in info file; it's as current as the code it lives with.
33809 @footnote{If you have a more recent version of @value{GDBN} than @value{GDBVN},
33810 look at the @file{README} file in the sources; we may have improved the
33811 installation procedures since publishing this manual.}
33814 The @value{GDBN} distribution includes all the source code you need for
33815 @value{GDBN} in a single directory, whose name is usually composed by
33816 appending the version number to @samp{gdb}.
33818 For example, the @value{GDBN} version @value{GDBVN} distribution is in the
33819 @file{gdb-@value{GDBVN}} directory. That directory contains:
33822 @item gdb-@value{GDBVN}/configure @r{(and supporting files)}
33823 script for configuring @value{GDBN} and all its supporting libraries
33825 @item gdb-@value{GDBVN}/gdb
33826 the source specific to @value{GDBN} itself
33828 @item gdb-@value{GDBVN}/bfd
33829 source for the Binary File Descriptor library
33831 @item gdb-@value{GDBVN}/include
33832 @sc{gnu} include files
33834 @item gdb-@value{GDBVN}/libiberty
33835 source for the @samp{-liberty} free software library
33837 @item gdb-@value{GDBVN}/opcodes
33838 source for the library of opcode tables and disassemblers
33840 @item gdb-@value{GDBVN}/readline
33841 source for the @sc{gnu} command-line interface
33843 @item gdb-@value{GDBVN}/glob
33844 source for the @sc{gnu} filename pattern-matching subroutine
33846 @item gdb-@value{GDBVN}/mmalloc
33847 source for the @sc{gnu} memory-mapped malloc package
33850 The simplest way to configure and build @value{GDBN} is to run @file{configure}
33851 from the @file{gdb-@var{version-number}} source directory, which in
33852 this example is the @file{gdb-@value{GDBVN}} directory.
33854 First switch to the @file{gdb-@var{version-number}} source directory
33855 if you are not already in it; then run @file{configure}. Pass the
33856 identifier for the platform on which @value{GDBN} will run as an
33862 cd gdb-@value{GDBVN}
33863 ./configure @var{host}
33868 where @var{host} is an identifier such as @samp{sun4} or
33869 @samp{decstation}, that identifies the platform where @value{GDBN} will run.
33870 (You can often leave off @var{host}; @file{configure} tries to guess the
33871 correct value by examining your system.)
33873 Running @samp{configure @var{host}} and then running @code{make} builds the
33874 @file{bfd}, @file{readline}, @file{mmalloc}, and @file{libiberty}
33875 libraries, then @code{gdb} itself. The configured source files, and the
33876 binaries, are left in the corresponding source directories.
33879 @file{configure} is a Bourne-shell (@code{/bin/sh}) script; if your
33880 system does not recognize this automatically when you run a different
33881 shell, you may need to run @code{sh} on it explicitly:
33884 sh configure @var{host}
33887 If you run @file{configure} from a directory that contains source
33888 directories for multiple libraries or programs, such as the
33889 @file{gdb-@value{GDBVN}} source directory for version @value{GDBVN},
33891 creates configuration files for every directory level underneath (unless
33892 you tell it not to, with the @samp{--norecursion} option).
33894 You should run the @file{configure} script from the top directory in the
33895 source tree, the @file{gdb-@var{version-number}} directory. If you run
33896 @file{configure} from one of the subdirectories, you will configure only
33897 that subdirectory. That is usually not what you want. In particular,
33898 if you run the first @file{configure} from the @file{gdb} subdirectory
33899 of the @file{gdb-@var{version-number}} directory, you will omit the
33900 configuration of @file{bfd}, @file{readline}, and other sibling
33901 directories of the @file{gdb} subdirectory. This leads to build errors
33902 about missing include files such as @file{bfd/bfd.h}.
33904 You can install @code{@value{GDBP}} anywhere; it has no hardwired paths.
33905 However, you should make sure that the shell on your path (named by
33906 the @samp{SHELL} environment variable) is publicly readable. Remember
33907 that @value{GDBN} uses the shell to start your program---some systems refuse to
33908 let @value{GDBN} debug child processes whose programs are not readable.
33910 @node Separate Objdir
33911 @section Compiling @value{GDBN} in Another Directory
33913 If you want to run @value{GDBN} versions for several host or target machines,
33914 you need a different @code{gdb} compiled for each combination of
33915 host and target. @file{configure} is designed to make this easy by
33916 allowing you to generate each configuration in a separate subdirectory,
33917 rather than in the source directory. If your @code{make} program
33918 handles the @samp{VPATH} feature (@sc{gnu} @code{make} does), running
33919 @code{make} in each of these directories builds the @code{gdb}
33920 program specified there.
33922 To build @code{gdb} in a separate directory, run @file{configure}
33923 with the @samp{--srcdir} option to specify where to find the source.
33924 (You also need to specify a path to find @file{configure}
33925 itself from your working directory. If the path to @file{configure}
33926 would be the same as the argument to @samp{--srcdir}, you can leave out
33927 the @samp{--srcdir} option; it is assumed.)
33929 For example, with version @value{GDBVN}, you can build @value{GDBN} in a
33930 separate directory for a Sun 4 like this:
33934 cd gdb-@value{GDBVN}
33937 ../gdb-@value{GDBVN}/configure sun4
33942 When @file{configure} builds a configuration using a remote source
33943 directory, it creates a tree for the binaries with the same structure
33944 (and using the same names) as the tree under the source directory. In
33945 the example, you'd find the Sun 4 library @file{libiberty.a} in the
33946 directory @file{gdb-sun4/libiberty}, and @value{GDBN} itself in
33947 @file{gdb-sun4/gdb}.
33949 Make sure that your path to the @file{configure} script has just one
33950 instance of @file{gdb} in it. If your path to @file{configure} looks
33951 like @file{../gdb-@value{GDBVN}/gdb/configure}, you are configuring only
33952 one subdirectory of @value{GDBN}, not the whole package. This leads to
33953 build errors about missing include files such as @file{bfd/bfd.h}.
33955 One popular reason to build several @value{GDBN} configurations in separate
33956 directories is to configure @value{GDBN} for cross-compiling (where
33957 @value{GDBN} runs on one machine---the @dfn{host}---while debugging
33958 programs that run on another machine---the @dfn{target}).
33959 You specify a cross-debugging target by
33960 giving the @samp{--target=@var{target}} option to @file{configure}.
33962 When you run @code{make} to build a program or library, you must run
33963 it in a configured directory---whatever directory you were in when you
33964 called @file{configure} (or one of its subdirectories).
33966 The @code{Makefile} that @file{configure} generates in each source
33967 directory also runs recursively. If you type @code{make} in a source
33968 directory such as @file{gdb-@value{GDBVN}} (or in a separate configured
33969 directory configured with @samp{--srcdir=@var{dirname}/gdb-@value{GDBVN}}), you
33970 will build all the required libraries, and then build GDB.
33972 When you have multiple hosts or targets configured in separate
33973 directories, you can run @code{make} on them in parallel (for example,
33974 if they are NFS-mounted on each of the hosts); they will not interfere
33978 @section Specifying Names for Hosts and Targets
33980 The specifications used for hosts and targets in the @file{configure}
33981 script are based on a three-part naming scheme, but some short predefined
33982 aliases are also supported. The full naming scheme encodes three pieces
33983 of information in the following pattern:
33986 @var{architecture}-@var{vendor}-@var{os}
33989 For example, you can use the alias @code{sun4} as a @var{host} argument,
33990 or as the value for @var{target} in a @code{--target=@var{target}}
33991 option. The equivalent full name is @samp{sparc-sun-sunos4}.
33993 The @file{configure} script accompanying @value{GDBN} does not provide
33994 any query facility to list all supported host and target names or
33995 aliases. @file{configure} calls the Bourne shell script
33996 @code{config.sub} to map abbreviations to full names; you can read the
33997 script, if you wish, or you can use it to test your guesses on
33998 abbreviations---for example:
34001 % sh config.sub i386-linux
34003 % sh config.sub alpha-linux
34004 alpha-unknown-linux-gnu
34005 % sh config.sub hp9k700
34007 % sh config.sub sun4
34008 sparc-sun-sunos4.1.1
34009 % sh config.sub sun3
34010 m68k-sun-sunos4.1.1
34011 % sh config.sub i986v
34012 Invalid configuration `i986v': machine `i986v' not recognized
34016 @code{config.sub} is also distributed in the @value{GDBN} source
34017 directory (@file{gdb-@value{GDBVN}}, for version @value{GDBVN}).
34019 @node Configure Options
34020 @section @file{configure} Options
34022 Here is a summary of the @file{configure} options and arguments that
34023 are most often useful for building @value{GDBN}. @file{configure} also has
34024 several other options not listed here. @inforef{What Configure
34025 Does,,configure.info}, for a full explanation of @file{configure}.
34028 configure @r{[}--help@r{]}
34029 @r{[}--prefix=@var{dir}@r{]}
34030 @r{[}--exec-prefix=@var{dir}@r{]}
34031 @r{[}--srcdir=@var{dirname}@r{]}
34032 @r{[}--norecursion@r{]} @r{[}--rm@r{]}
34033 @r{[}--target=@var{target}@r{]}
34038 You may introduce options with a single @samp{-} rather than
34039 @samp{--} if you prefer; but you may abbreviate option names if you use
34044 Display a quick summary of how to invoke @file{configure}.
34046 @item --prefix=@var{dir}
34047 Configure the source to install programs and files under directory
34050 @item --exec-prefix=@var{dir}
34051 Configure the source to install programs under directory
34054 @c avoid splitting the warning from the explanation:
34056 @item --srcdir=@var{dirname}
34057 @strong{Warning: using this option requires @sc{gnu} @code{make}, or another
34058 @code{make} that implements the @code{VPATH} feature.}@*
34059 Use this option to make configurations in directories separate from the
34060 @value{GDBN} source directories. Among other things, you can use this to
34061 build (or maintain) several configurations simultaneously, in separate
34062 directories. @file{configure} writes configuration-specific files in
34063 the current directory, but arranges for them to use the source in the
34064 directory @var{dirname}. @file{configure} creates directories under
34065 the working directory in parallel to the source directories below
34068 @item --norecursion
34069 Configure only the directory level where @file{configure} is executed; do not
34070 propagate configuration to subdirectories.
34072 @item --target=@var{target}
34073 Configure @value{GDBN} for cross-debugging programs running on the specified
34074 @var{target}. Without this option, @value{GDBN} is configured to debug
34075 programs that run on the same machine (@var{host}) as @value{GDBN} itself.
34077 There is no convenient way to generate a list of all available targets.
34079 @item @var{host} @dots{}
34080 Configure @value{GDBN} to run on the specified @var{host}.
34082 There is no convenient way to generate a list of all available hosts.
34085 There are many other options available as well, but they are generally
34086 needed for special purposes only.
34088 @node System-wide configuration
34089 @section System-wide configuration and settings
34090 @cindex system-wide init file
34092 @value{GDBN} can be configured to have a system-wide init file;
34093 this file will be read and executed at startup (@pxref{Startup, , What
34094 @value{GDBN} does during startup}).
34096 Here is the corresponding configure option:
34099 @item --with-system-gdbinit=@var{file}
34100 Specify that the default location of the system-wide init file is
34104 If @value{GDBN} has been configured with the option @option{--prefix=$prefix},
34105 it may be subject to relocation. Two possible cases:
34109 If the default location of this init file contains @file{$prefix},
34110 it will be subject to relocation. Suppose that the configure options
34111 are @option{--prefix=$prefix --with-system-gdbinit=$prefix/etc/gdbinit};
34112 if @value{GDBN} is moved from @file{$prefix} to @file{$install}, the system
34113 init file is looked for as @file{$install/etc/gdbinit} instead of
34114 @file{$prefix/etc/gdbinit}.
34117 By contrast, if the default location does not contain the prefix,
34118 it will not be relocated. E.g.@: if @value{GDBN} has been configured with
34119 @option{--prefix=/usr/local --with-system-gdbinit=/usr/share/gdb/gdbinit},
34120 then @value{GDBN} will always look for @file{/usr/share/gdb/gdbinit},
34121 wherever @value{GDBN} is installed.
34124 If the configured location of the system-wide init file (as given by the
34125 @option{--with-system-gdbinit} option at configure time) is in the
34126 data-directory (as specified by @option{--with-gdb-datadir} at configure
34127 time) or in one of its subdirectories, then @value{GDBN} will look for the
34128 system-wide init file in the directory specified by the
34129 @option{--data-directory} command-line option.
34130 Note that the system-wide init file is only read once, during @value{GDBN}
34131 initialization. If the data-directory is changed after @value{GDBN} has
34132 started with the @code{set data-directory} command, the file will not be
34136 * System-wide Configuration Scripts:: Installed System-wide Configuration Scripts
34139 @node System-wide Configuration Scripts
34140 @subsection Installed System-wide Configuration Scripts
34141 @cindex system-wide configuration scripts
34143 The @file{system-gdbinit} directory, located inside the data-directory
34144 (as specified by @option{--with-gdb-datadir} at configure time) contains
34145 a number of scripts which can be used as system-wide init files. To
34146 automatically source those scripts at startup, @value{GDBN} should be
34147 configured with @option{--with-system-gdbinit}. Otherwise, any user
34148 should be able to source them by hand as needed.
34150 The following scripts are currently available:
34153 @item @file{elinos.py}
34155 @cindex ELinOS system-wide configuration script
34156 This script is useful when debugging a program on an ELinOS target.
34157 It takes advantage of the environment variables defined in a standard
34158 ELinOS environment in order to determine the location of the system
34159 shared libraries, and then sets the @samp{solib-absolute-prefix}
34160 and @samp{solib-search-path} variables appropriately.
34162 @item @file{wrs-linux.py}
34163 @pindex wrs-linux.py
34164 @cindex Wind River Linux system-wide configuration script
34165 This script is useful when debugging a program on a target running
34166 Wind River Linux. It expects the @env{ENV_PREFIX} to be set to
34167 the host-side sysroot used by the target system.
34171 @node Maintenance Commands
34172 @appendix Maintenance Commands
34173 @cindex maintenance commands
34174 @cindex internal commands
34176 In addition to commands intended for @value{GDBN} users, @value{GDBN}
34177 includes a number of commands intended for @value{GDBN} developers,
34178 that are not documented elsewhere in this manual. These commands are
34179 provided here for reference. (For commands that turn on debugging
34180 messages, see @ref{Debugging Output}.)
34183 @kindex maint agent
34184 @kindex maint agent-eval
34185 @item maint agent @r{[}-at @var{location}@r{,}@r{]} @var{expression}
34186 @itemx maint agent-eval @r{[}-at @var{location}@r{,}@r{]} @var{expression}
34187 Translate the given @var{expression} into remote agent bytecodes.
34188 This command is useful for debugging the Agent Expression mechanism
34189 (@pxref{Agent Expressions}). The @samp{agent} version produces an
34190 expression useful for data collection, such as by tracepoints, while
34191 @samp{maint agent-eval} produces an expression that evaluates directly
34192 to a result. For instance, a collection expression for @code{globa +
34193 globb} will include bytecodes to record four bytes of memory at each
34194 of the addresses of @code{globa} and @code{globb}, while discarding
34195 the result of the addition, while an evaluation expression will do the
34196 addition and return the sum.
34197 If @code{-at} is given, generate remote agent bytecode for @var{location}.
34198 If not, generate remote agent bytecode for current frame PC address.
34200 @kindex maint agent-printf
34201 @item maint agent-printf @var{format},@var{expr},...
34202 Translate the given format string and list of argument expressions
34203 into remote agent bytecodes and display them as a disassembled list.
34204 This command is useful for debugging the agent version of dynamic
34205 printf (@pxref{Dynamic Printf}).
34207 @kindex maint info breakpoints
34208 @item @anchor{maint info breakpoints}maint info breakpoints
34209 Using the same format as @samp{info breakpoints}, display both the
34210 breakpoints you've set explicitly, and those @value{GDBN} is using for
34211 internal purposes. Internal breakpoints are shown with negative
34212 breakpoint numbers. The type column identifies what kind of breakpoint
34217 Normal, explicitly set breakpoint.
34220 Normal, explicitly set watchpoint.
34223 Internal breakpoint, used to handle correctly stepping through
34224 @code{longjmp} calls.
34226 @item longjmp resume
34227 Internal breakpoint at the target of a @code{longjmp}.
34230 Temporary internal breakpoint used by the @value{GDBN} @code{until} command.
34233 Temporary internal breakpoint used by the @value{GDBN} @code{finish} command.
34236 Shared library events.
34240 @kindex maint info btrace
34241 @item maint info btrace
34242 Pint information about raw branch tracing data.
34244 @kindex maint btrace packet-history
34245 @item maint btrace packet-history
34246 Print the raw branch trace packets that are used to compute the
34247 execution history for the @samp{record btrace} command. Both the
34248 information and the format in which it is printed depend on the btrace
34253 For the BTS recording format, print a list of blocks of sequential
34254 code. For each block, the following information is printed:
34258 Newer blocks have higher numbers. The oldest block has number zero.
34259 @item Lowest @samp{PC}
34260 @item Highest @samp{PC}
34264 For the Intel Processor Trace recording format, print a list of
34265 Intel Processor Trace packets. For each packet, the following
34266 information is printed:
34269 @item Packet number
34270 Newer packets have higher numbers. The oldest packet has number zero.
34272 The packet's offset in the trace stream.
34273 @item Packet opcode and payload
34277 @kindex maint btrace clear-packet-history
34278 @item maint btrace clear-packet-history
34279 Discards the cached packet history printed by the @samp{maint btrace
34280 packet-history} command. The history will be computed again when
34283 @kindex maint btrace clear
34284 @item maint btrace clear
34285 Discard the branch trace data. The data will be fetched anew and the
34286 branch trace will be recomputed when needed.
34288 This implicitly truncates the branch trace to a single branch trace
34289 buffer. When updating branch trace incrementally, the branch trace
34290 available to @value{GDBN} may be bigger than a single branch trace
34293 @kindex maint set btrace pt skip-pad
34294 @item maint set btrace pt skip-pad
34295 @kindex maint show btrace pt skip-pad
34296 @item maint show btrace pt skip-pad
34297 Control whether @value{GDBN} will skip PAD packets when computing the
34300 @kindex set displaced-stepping
34301 @kindex show displaced-stepping
34302 @cindex displaced stepping support
34303 @cindex out-of-line single-stepping
34304 @item set displaced-stepping
34305 @itemx show displaced-stepping
34306 Control whether or not @value{GDBN} will do @dfn{displaced stepping}
34307 if the target supports it. Displaced stepping is a way to single-step
34308 over breakpoints without removing them from the inferior, by executing
34309 an out-of-line copy of the instruction that was originally at the
34310 breakpoint location. It is also known as out-of-line single-stepping.
34313 @item set displaced-stepping on
34314 If the target architecture supports it, @value{GDBN} will use
34315 displaced stepping to step over breakpoints.
34317 @item set displaced-stepping off
34318 @value{GDBN} will not use displaced stepping to step over breakpoints,
34319 even if such is supported by the target architecture.
34321 @cindex non-stop mode, and @samp{set displaced-stepping}
34322 @item set displaced-stepping auto
34323 This is the default mode. @value{GDBN} will use displaced stepping
34324 only if non-stop mode is active (@pxref{Non-Stop Mode}) and the target
34325 architecture supports displaced stepping.
34328 @kindex maint check-psymtabs
34329 @item maint check-psymtabs
34330 Check the consistency of currently expanded psymtabs versus symtabs.
34331 Use this to check, for example, whether a symbol is in one but not the other.
34333 @kindex maint check-symtabs
34334 @item maint check-symtabs
34335 Check the consistency of currently expanded symtabs.
34337 @kindex maint expand-symtabs
34338 @item maint expand-symtabs [@var{regexp}]
34339 Expand symbol tables.
34340 If @var{regexp} is specified, only expand symbol tables for file
34341 names matching @var{regexp}.
34343 @kindex maint set catch-demangler-crashes
34344 @kindex maint show catch-demangler-crashes
34345 @cindex demangler crashes
34346 @item maint set catch-demangler-crashes [on|off]
34347 @itemx maint show catch-demangler-crashes
34348 Control whether @value{GDBN} should attempt to catch crashes in the
34349 symbol name demangler. The default is to attempt to catch crashes.
34350 If enabled, the first time a crash is caught, a core file is created,
34351 the offending symbol is displayed and the user is presented with the
34352 option to terminate the current session.
34354 @kindex maint cplus first_component
34355 @item maint cplus first_component @var{name}
34356 Print the first C@t{++} class/namespace component of @var{name}.
34358 @kindex maint cplus namespace
34359 @item maint cplus namespace
34360 Print the list of possible C@t{++} namespaces.
34362 @kindex maint deprecate
34363 @kindex maint undeprecate
34364 @cindex deprecated commands
34365 @item maint deprecate @var{command} @r{[}@var{replacement}@r{]}
34366 @itemx maint undeprecate @var{command}
34367 Deprecate or undeprecate the named @var{command}. Deprecated commands
34368 cause @value{GDBN} to issue a warning when you use them. The optional
34369 argument @var{replacement} says which newer command should be used in
34370 favor of the deprecated one; if it is given, @value{GDBN} will mention
34371 the replacement as part of the warning.
34373 @kindex maint dump-me
34374 @item maint dump-me
34375 @cindex @code{SIGQUIT} signal, dump core of @value{GDBN}
34376 Cause a fatal signal in the debugger and force it to dump its core.
34377 This is supported only on systems which support aborting a program
34378 with the @code{SIGQUIT} signal.
34380 @kindex maint internal-error
34381 @kindex maint internal-warning
34382 @kindex maint demangler-warning
34383 @cindex demangler crashes
34384 @item maint internal-error @r{[}@var{message-text}@r{]}
34385 @itemx maint internal-warning @r{[}@var{message-text}@r{]}
34386 @itemx maint demangler-warning @r{[}@var{message-text}@r{]}
34388 Cause @value{GDBN} to call the internal function @code{internal_error},
34389 @code{internal_warning} or @code{demangler_warning} and hence behave
34390 as though an internal problem has been detected. In addition to
34391 reporting the internal problem, these functions give the user the
34392 opportunity to either quit @value{GDBN} or (for @code{internal_error}
34393 and @code{internal_warning}) create a core file of the current
34394 @value{GDBN} session.
34396 These commands take an optional parameter @var{message-text} that is
34397 used as the text of the error or warning message.
34399 Here's an example of using @code{internal-error}:
34402 (@value{GDBP}) @kbd{maint internal-error testing, 1, 2}
34403 @dots{}/maint.c:121: internal-error: testing, 1, 2
34404 A problem internal to GDB has been detected. Further
34405 debugging may prove unreliable.
34406 Quit this debugging session? (y or n) @kbd{n}
34407 Create a core file? (y or n) @kbd{n}
34411 @cindex @value{GDBN} internal error
34412 @cindex internal errors, control of @value{GDBN} behavior
34413 @cindex demangler crashes
34415 @kindex maint set internal-error
34416 @kindex maint show internal-error
34417 @kindex maint set internal-warning
34418 @kindex maint show internal-warning
34419 @kindex maint set demangler-warning
34420 @kindex maint show demangler-warning
34421 @item maint set internal-error @var{action} [ask|yes|no]
34422 @itemx maint show internal-error @var{action}
34423 @itemx maint set internal-warning @var{action} [ask|yes|no]
34424 @itemx maint show internal-warning @var{action}
34425 @itemx maint set demangler-warning @var{action} [ask|yes|no]
34426 @itemx maint show demangler-warning @var{action}
34427 When @value{GDBN} reports an internal problem (error or warning) it
34428 gives the user the opportunity to both quit @value{GDBN} and create a
34429 core file of the current @value{GDBN} session. These commands let you
34430 override the default behaviour for each particular @var{action},
34431 described in the table below.
34435 You can specify that @value{GDBN} should always (yes) or never (no)
34436 quit. The default is to ask the user what to do.
34439 You can specify that @value{GDBN} should always (yes) or never (no)
34440 create a core file. The default is to ask the user what to do. Note
34441 that there is no @code{corefile} option for @code{demangler-warning}:
34442 demangler warnings always create a core file and this cannot be
34446 @kindex maint packet
34447 @item maint packet @var{text}
34448 If @value{GDBN} is talking to an inferior via the serial protocol,
34449 then this command sends the string @var{text} to the inferior, and
34450 displays the response packet. @value{GDBN} supplies the initial
34451 @samp{$} character, the terminating @samp{#} character, and the
34454 @kindex maint print architecture
34455 @item maint print architecture @r{[}@var{file}@r{]}
34456 Print the entire architecture configuration. The optional argument
34457 @var{file} names the file where the output goes.
34459 @kindex maint print c-tdesc
34460 @item maint print c-tdesc
34461 Print the current target description (@pxref{Target Descriptions}) as
34462 a C source file. The created source file can be used in @value{GDBN}
34463 when an XML parser is not available to parse the description.
34465 @kindex maint print dummy-frames
34466 @item maint print dummy-frames
34467 Prints the contents of @value{GDBN}'s internal dummy-frame stack.
34470 (@value{GDBP}) @kbd{b add}
34472 (@value{GDBP}) @kbd{print add(2,3)}
34473 Breakpoint 2, add (a=2, b=3) at @dots{}
34475 The program being debugged stopped while in a function called from GDB.
34477 (@value{GDBP}) @kbd{maint print dummy-frames}
34478 0xa8206d8: id=@{stack=0xbfffe734,code=0xbfffe73f,!special@}, ptid=process 9353
34482 Takes an optional file parameter.
34484 @kindex maint print registers
34485 @kindex maint print raw-registers
34486 @kindex maint print cooked-registers
34487 @kindex maint print register-groups
34488 @kindex maint print remote-registers
34489 @item maint print registers @r{[}@var{file}@r{]}
34490 @itemx maint print raw-registers @r{[}@var{file}@r{]}
34491 @itemx maint print cooked-registers @r{[}@var{file}@r{]}
34492 @itemx maint print register-groups @r{[}@var{file}@r{]}
34493 @itemx maint print remote-registers @r{[}@var{file}@r{]}
34494 Print @value{GDBN}'s internal register data structures.
34496 The command @code{maint print raw-registers} includes the contents of
34497 the raw register cache; the command @code{maint print
34498 cooked-registers} includes the (cooked) value of all registers,
34499 including registers which aren't available on the target nor visible
34500 to user; the command @code{maint print register-groups} includes the
34501 groups that each register is a member of; and the command @code{maint
34502 print remote-registers} includes the remote target's register numbers
34503 and offsets in the `G' packets.
34505 These commands take an optional parameter, a file name to which to
34506 write the information.
34508 @kindex maint print reggroups
34509 @item maint print reggroups @r{[}@var{file}@r{]}
34510 Print @value{GDBN}'s internal register group data structures. The
34511 optional argument @var{file} tells to what file to write the
34514 The register groups info looks like this:
34517 (@value{GDBP}) @kbd{maint print reggroups}
34530 This command forces @value{GDBN} to flush its internal register cache.
34532 @kindex maint print objfiles
34533 @cindex info for known object files
34534 @item maint print objfiles @r{[}@var{regexp}@r{]}
34535 Print a dump of all known object files.
34536 If @var{regexp} is specified, only print object files whose names
34537 match @var{regexp}. For each object file, this command prints its name,
34538 address in memory, and all of its psymtabs and symtabs.
34540 @kindex maint print user-registers
34541 @cindex user registers
34542 @item maint print user-registers
34543 List all currently available @dfn{user registers}. User registers
34544 typically provide alternate names for actual hardware registers. They
34545 include the four ``standard'' registers @code{$fp}, @code{$pc},
34546 @code{$sp}, and @code{$ps}. @xref{standard registers}. User
34547 registers can be used in expressions in the same way as the canonical
34548 register names, but only the latter are listed by the @code{info
34549 registers} and @code{maint print registers} commands.
34551 @kindex maint print section-scripts
34552 @cindex info for known .debug_gdb_scripts-loaded scripts
34553 @item maint print section-scripts [@var{regexp}]
34554 Print a dump of scripts specified in the @code{.debug_gdb_section} section.
34555 If @var{regexp} is specified, only print scripts loaded by object files
34556 matching @var{regexp}.
34557 For each script, this command prints its name as specified in the objfile,
34558 and the full path if known.
34559 @xref{dotdebug_gdb_scripts section}.
34561 @kindex maint print statistics
34562 @cindex bcache statistics
34563 @item maint print statistics
34564 This command prints, for each object file in the program, various data
34565 about that object file followed by the byte cache (@dfn{bcache})
34566 statistics for the object file. The objfile data includes the number
34567 of minimal, partial, full, and stabs symbols, the number of types
34568 defined by the objfile, the number of as yet unexpanded psym tables,
34569 the number of line tables and string tables, and the amount of memory
34570 used by the various tables. The bcache statistics include the counts,
34571 sizes, and counts of duplicates of all and unique objects, max,
34572 average, and median entry size, total memory used and its overhead and
34573 savings, and various measures of the hash table size and chain
34576 @kindex maint print target-stack
34577 @cindex target stack description
34578 @item maint print target-stack
34579 A @dfn{target} is an interface between the debugger and a particular
34580 kind of file or process. Targets can be stacked in @dfn{strata},
34581 so that more than one target can potentially respond to a request.
34582 In particular, memory accesses will walk down the stack of targets
34583 until they find a target that is interested in handling that particular
34586 This command prints a short description of each layer that was pushed on
34587 the @dfn{target stack}, starting from the top layer down to the bottom one.
34589 @kindex maint print type
34590 @cindex type chain of a data type
34591 @item maint print type @var{expr}
34592 Print the type chain for a type specified by @var{expr}. The argument
34593 can be either a type name or a symbol. If it is a symbol, the type of
34594 that symbol is described. The type chain produced by this command is
34595 a recursive definition of the data type as stored in @value{GDBN}'s
34596 data structures, including its flags and contained types.
34598 @kindex maint set dwarf always-disassemble
34599 @kindex maint show dwarf always-disassemble
34600 @item maint set dwarf always-disassemble
34601 @item maint show dwarf always-disassemble
34602 Control the behavior of @code{info address} when using DWARF debugging
34605 The default is @code{off}, which means that @value{GDBN} should try to
34606 describe a variable's location in an easily readable format. When
34607 @code{on}, @value{GDBN} will instead display the DWARF location
34608 expression in an assembly-like format. Note that some locations are
34609 too complex for @value{GDBN} to describe simply; in this case you will
34610 always see the disassembly form.
34612 Here is an example of the resulting disassembly:
34615 (gdb) info addr argc
34616 Symbol "argc" is a complex DWARF expression:
34620 For more information on these expressions, see
34621 @uref{http://www.dwarfstd.org/, the DWARF standard}.
34623 @kindex maint set dwarf max-cache-age
34624 @kindex maint show dwarf max-cache-age
34625 @item maint set dwarf max-cache-age
34626 @itemx maint show dwarf max-cache-age
34627 Control the DWARF compilation unit cache.
34629 @cindex DWARF compilation units cache
34630 In object files with inter-compilation-unit references, such as those
34631 produced by the GCC option @samp{-feliminate-dwarf2-dups}, the DWARF
34632 reader needs to frequently refer to previously read compilation units.
34633 This setting controls how long a compilation unit will remain in the
34634 cache if it is not referenced. A higher limit means that cached
34635 compilation units will be stored in memory longer, and more total
34636 memory will be used. Setting it to zero disables caching, which will
34637 slow down @value{GDBN} startup, but reduce memory consumption.
34639 @kindex maint set profile
34640 @kindex maint show profile
34641 @cindex profiling GDB
34642 @item maint set profile
34643 @itemx maint show profile
34644 Control profiling of @value{GDBN}.
34646 Profiling will be disabled until you use the @samp{maint set profile}
34647 command to enable it. When you enable profiling, the system will begin
34648 collecting timing and execution count data; when you disable profiling or
34649 exit @value{GDBN}, the results will be written to a log file. Remember that
34650 if you use profiling, @value{GDBN} will overwrite the profiling log file
34651 (often called @file{gmon.out}). If you have a record of important profiling
34652 data in a @file{gmon.out} file, be sure to move it to a safe location.
34654 Configuring with @samp{--enable-profiling} arranges for @value{GDBN} to be
34655 compiled with the @samp{-pg} compiler option.
34657 @kindex maint set show-debug-regs
34658 @kindex maint show show-debug-regs
34659 @cindex hardware debug registers
34660 @item maint set show-debug-regs
34661 @itemx maint show show-debug-regs
34662 Control whether to show variables that mirror the hardware debug
34663 registers. Use @code{on} to enable, @code{off} to disable. If
34664 enabled, the debug registers values are shown when @value{GDBN} inserts or
34665 removes a hardware breakpoint or watchpoint, and when the inferior
34666 triggers a hardware-assisted breakpoint or watchpoint.
34668 @kindex maint set show-all-tib
34669 @kindex maint show show-all-tib
34670 @item maint set show-all-tib
34671 @itemx maint show show-all-tib
34672 Control whether to show all non zero areas within a 1k block starting
34673 at thread local base, when using the @samp{info w32 thread-information-block}
34676 @kindex maint set target-async
34677 @kindex maint show target-async
34678 @item maint set target-async
34679 @itemx maint show target-async
34680 This controls whether @value{GDBN} targets operate in synchronous or
34681 asynchronous mode (@pxref{Background Execution}). Normally the
34682 default is asynchronous, if it is available; but this can be changed
34683 to more easily debug problems occurring only in synchronous mode.
34685 @kindex maint set target-non-stop @var{mode} [on|off|auto]
34686 @kindex maint show target-non-stop
34687 @item maint set target-non-stop
34688 @itemx maint show target-non-stop
34690 This controls whether @value{GDBN} targets always operate in non-stop
34691 mode even if @code{set non-stop} is @code{off} (@pxref{Non-Stop
34692 Mode}). The default is @code{auto}, meaning non-stop mode is enabled
34693 if supported by the target.
34696 @item maint set target-non-stop auto
34697 This is the default mode. @value{GDBN} controls the target in
34698 non-stop mode if the target supports it.
34700 @item maint set target-non-stop on
34701 @value{GDBN} controls the target in non-stop mode even if the target
34702 does not indicate support.
34704 @item maint set target-non-stop off
34705 @value{GDBN} does not control the target in non-stop mode even if the
34706 target supports it.
34709 @kindex maint set per-command
34710 @kindex maint show per-command
34711 @item maint set per-command
34712 @itemx maint show per-command
34713 @cindex resources used by commands
34715 @value{GDBN} can display the resources used by each command.
34716 This is useful in debugging performance problems.
34719 @item maint set per-command space [on|off]
34720 @itemx maint show per-command space
34721 Enable or disable the printing of the memory used by GDB for each command.
34722 If enabled, @value{GDBN} will display how much memory each command
34723 took, following the command's own output.
34724 This can also be requested by invoking @value{GDBN} with the
34725 @option{--statistics} command-line switch (@pxref{Mode Options}).
34727 @item maint set per-command time [on|off]
34728 @itemx maint show per-command time
34729 Enable or disable the printing of the execution time of @value{GDBN}
34731 If enabled, @value{GDBN} will display how much time it
34732 took to execute each command, following the command's own output.
34733 Both CPU time and wallclock time are printed.
34734 Printing both is useful when trying to determine whether the cost is
34735 CPU or, e.g., disk/network latency.
34736 Note that the CPU time printed is for @value{GDBN} only, it does not include
34737 the execution time of the inferior because there's no mechanism currently
34738 to compute how much time was spent by @value{GDBN} and how much time was
34739 spent by the program been debugged.
34740 This can also be requested by invoking @value{GDBN} with the
34741 @option{--statistics} command-line switch (@pxref{Mode Options}).
34743 @item maint set per-command symtab [on|off]
34744 @itemx maint show per-command symtab
34745 Enable or disable the printing of basic symbol table statistics
34747 If enabled, @value{GDBN} will display the following information:
34751 number of symbol tables
34753 number of primary symbol tables
34755 number of blocks in the blockvector
34759 @kindex maint space
34760 @cindex memory used by commands
34761 @item maint space @var{value}
34762 An alias for @code{maint set per-command space}.
34763 A non-zero value enables it, zero disables it.
34766 @cindex time of command execution
34767 @item maint time @var{value}
34768 An alias for @code{maint set per-command time}.
34769 A non-zero value enables it, zero disables it.
34771 @kindex maint translate-address
34772 @item maint translate-address @r{[}@var{section}@r{]} @var{addr}
34773 Find the symbol stored at the location specified by the address
34774 @var{addr} and an optional section name @var{section}. If found,
34775 @value{GDBN} prints the name of the closest symbol and an offset from
34776 the symbol's location to the specified address. This is similar to
34777 the @code{info address} command (@pxref{Symbols}), except that this
34778 command also allows to find symbols in other sections.
34780 If section was not specified, the section in which the symbol was found
34781 is also printed. For dynamically linked executables, the name of
34782 executable or shared library containing the symbol is printed as well.
34786 The following command is useful for non-interactive invocations of
34787 @value{GDBN}, such as in the test suite.
34790 @item set watchdog @var{nsec}
34791 @kindex set watchdog
34792 @cindex watchdog timer
34793 @cindex timeout for commands
34794 Set the maximum number of seconds @value{GDBN} will wait for the
34795 target operation to finish. If this time expires, @value{GDBN}
34796 reports and error and the command is aborted.
34798 @item show watchdog
34799 Show the current setting of the target wait timeout.
34802 @node Remote Protocol
34803 @appendix @value{GDBN} Remote Serial Protocol
34808 * Stop Reply Packets::
34809 * General Query Packets::
34810 * Architecture-Specific Protocol Details::
34811 * Tracepoint Packets::
34812 * Host I/O Packets::
34814 * Notification Packets::
34815 * Remote Non-Stop::
34816 * Packet Acknowledgment::
34818 * File-I/O Remote Protocol Extension::
34819 * Library List Format::
34820 * Library List Format for SVR4 Targets::
34821 * Memory Map Format::
34822 * Thread List Format::
34823 * Traceframe Info Format::
34824 * Branch Trace Format::
34825 * Branch Trace Configuration Format::
34831 There may be occasions when you need to know something about the
34832 protocol---for example, if there is only one serial port to your target
34833 machine, you might want your program to do something special if it
34834 recognizes a packet meant for @value{GDBN}.
34836 In the examples below, @samp{->} and @samp{<-} are used to indicate
34837 transmitted and received data, respectively.
34839 @cindex protocol, @value{GDBN} remote serial
34840 @cindex serial protocol, @value{GDBN} remote
34841 @cindex remote serial protocol
34842 All @value{GDBN} commands and responses (other than acknowledgments
34843 and notifications, see @ref{Notification Packets}) are sent as a
34844 @var{packet}. A @var{packet} is introduced with the character
34845 @samp{$}, the actual @var{packet-data}, and the terminating character
34846 @samp{#} followed by a two-digit @var{checksum}:
34849 @code{$}@var{packet-data}@code{#}@var{checksum}
34853 @cindex checksum, for @value{GDBN} remote
34855 The two-digit @var{checksum} is computed as the modulo 256 sum of all
34856 characters between the leading @samp{$} and the trailing @samp{#} (an
34857 eight bit unsigned checksum).
34859 Implementors should note that prior to @value{GDBN} 5.0 the protocol
34860 specification also included an optional two-digit @var{sequence-id}:
34863 @code{$}@var{sequence-id}@code{:}@var{packet-data}@code{#}@var{checksum}
34866 @cindex sequence-id, for @value{GDBN} remote
34868 That @var{sequence-id} was appended to the acknowledgment. @value{GDBN}
34869 has never output @var{sequence-id}s. Stubs that handle packets added
34870 since @value{GDBN} 5.0 must not accept @var{sequence-id}.
34872 When either the host or the target machine receives a packet, the first
34873 response expected is an acknowledgment: either @samp{+} (to indicate
34874 the package was received correctly) or @samp{-} (to request
34878 -> @code{$}@var{packet-data}@code{#}@var{checksum}
34883 The @samp{+}/@samp{-} acknowledgments can be disabled
34884 once a connection is established.
34885 @xref{Packet Acknowledgment}, for details.
34887 The host (@value{GDBN}) sends @var{command}s, and the target (the
34888 debugging stub incorporated in your program) sends a @var{response}. In
34889 the case of step and continue @var{command}s, the response is only sent
34890 when the operation has completed, and the target has again stopped all
34891 threads in all attached processes. This is the default all-stop mode
34892 behavior, but the remote protocol also supports @value{GDBN}'s non-stop
34893 execution mode; see @ref{Remote Non-Stop}, for details.
34895 @var{packet-data} consists of a sequence of characters with the
34896 exception of @samp{#} and @samp{$} (see @samp{X} packet for additional
34899 @cindex remote protocol, field separator
34900 Fields within the packet should be separated using @samp{,} @samp{;} or
34901 @samp{:}. Except where otherwise noted all numbers are represented in
34902 @sc{hex} with leading zeros suppressed.
34904 Implementors should note that prior to @value{GDBN} 5.0, the character
34905 @samp{:} could not appear as the third character in a packet (as it
34906 would potentially conflict with the @var{sequence-id}).
34908 @cindex remote protocol, binary data
34909 @anchor{Binary Data}
34910 Binary data in most packets is encoded either as two hexadecimal
34911 digits per byte of binary data. This allowed the traditional remote
34912 protocol to work over connections which were only seven-bit clean.
34913 Some packets designed more recently assume an eight-bit clean
34914 connection, and use a more efficient encoding to send and receive
34917 The binary data representation uses @code{7d} (@sc{ascii} @samp{@}})
34918 as an escape character. Any escaped byte is transmitted as the escape
34919 character followed by the original character XORed with @code{0x20}.
34920 For example, the byte @code{0x7d} would be transmitted as the two
34921 bytes @code{0x7d 0x5d}. The bytes @code{0x23} (@sc{ascii} @samp{#}),
34922 @code{0x24} (@sc{ascii} @samp{$}), and @code{0x7d} (@sc{ascii}
34923 @samp{@}}) must always be escaped. Responses sent by the stub
34924 must also escape @code{0x2a} (@sc{ascii} @samp{*}), so that it
34925 is not interpreted as the start of a run-length encoded sequence
34928 Response @var{data} can be run-length encoded to save space.
34929 Run-length encoding replaces runs of identical characters with one
34930 instance of the repeated character, followed by a @samp{*} and a
34931 repeat count. The repeat count is itself sent encoded, to avoid
34932 binary characters in @var{data}: a value of @var{n} is sent as
34933 @code{@var{n}+29}. For a repeat count greater or equal to 3, this
34934 produces a printable @sc{ascii} character, e.g.@: a space (@sc{ascii}
34935 code 32) for a repeat count of 3. (This is because run-length
34936 encoding starts to win for counts 3 or more.) Thus, for example,
34937 @samp{0* } is a run-length encoding of ``0000'': the space character
34938 after @samp{*} means repeat the leading @code{0} @w{@code{32 - 29 =
34941 The printable characters @samp{#} and @samp{$} or with a numeric value
34942 greater than 126 must not be used. Runs of six repeats (@samp{#}) or
34943 seven repeats (@samp{$}) can be expanded using a repeat count of only
34944 five (@samp{"}). For example, @samp{00000000} can be encoded as
34947 The error response returned for some packets includes a two character
34948 error number. That number is not well defined.
34950 @cindex empty response, for unsupported packets
34951 For any @var{command} not supported by the stub, an empty response
34952 (@samp{$#00}) should be returned. That way it is possible to extend the
34953 protocol. A newer @value{GDBN} can tell if a packet is supported based
34956 At a minimum, a stub is required to support the @samp{g} and @samp{G}
34957 commands for register access, and the @samp{m} and @samp{M} commands
34958 for memory access. Stubs that only control single-threaded targets
34959 can implement run control with the @samp{c} (continue), and @samp{s}
34960 (step) commands. Stubs that support multi-threading targets should
34961 support the @samp{vCont} command. All other commands are optional.
34966 The following table provides a complete list of all currently defined
34967 @var{command}s and their corresponding response @var{data}.
34968 @xref{File-I/O Remote Protocol Extension}, for details about the File
34969 I/O extension of the remote protocol.
34971 Each packet's description has a template showing the packet's overall
34972 syntax, followed by an explanation of the packet's meaning. We
34973 include spaces in some of the templates for clarity; these are not
34974 part of the packet's syntax. No @value{GDBN} packet uses spaces to
34975 separate its components. For example, a template like @samp{foo
34976 @var{bar} @var{baz}} describes a packet beginning with the three ASCII
34977 bytes @samp{foo}, followed by a @var{bar}, followed directly by a
34978 @var{baz}. @value{GDBN} does not transmit a space character between the
34979 @samp{foo} and the @var{bar}, or between the @var{bar} and the
34982 @cindex @var{thread-id}, in remote protocol
34983 @anchor{thread-id syntax}
34984 Several packets and replies include a @var{thread-id} field to identify
34985 a thread. Normally these are positive numbers with a target-specific
34986 interpretation, formatted as big-endian hex strings. A @var{thread-id}
34987 can also be a literal @samp{-1} to indicate all threads, or @samp{0} to
34990 In addition, the remote protocol supports a multiprocess feature in
34991 which the @var{thread-id} syntax is extended to optionally include both
34992 process and thread ID fields, as @samp{p@var{pid}.@var{tid}}.
34993 The @var{pid} (process) and @var{tid} (thread) components each have the
34994 format described above: a positive number with target-specific
34995 interpretation formatted as a big-endian hex string, literal @samp{-1}
34996 to indicate all processes or threads (respectively), or @samp{0} to
34997 indicate an arbitrary process or thread. Specifying just a process, as
34998 @samp{p@var{pid}}, is equivalent to @samp{p@var{pid}.-1}. It is an
34999 error to specify all processes but a specific thread, such as
35000 @samp{p-1.@var{tid}}. Note that the @samp{p} prefix is @emph{not} used
35001 for those packets and replies explicitly documented to include a process
35002 ID, rather than a @var{thread-id}.
35004 The multiprocess @var{thread-id} syntax extensions are only used if both
35005 @value{GDBN} and the stub report support for the @samp{multiprocess}
35006 feature using @samp{qSupported}. @xref{multiprocess extensions}, for
35009 Note that all packet forms beginning with an upper- or lower-case
35010 letter, other than those described here, are reserved for future use.
35012 Here are the packet descriptions.
35017 @cindex @samp{!} packet
35018 @anchor{extended mode}
35019 Enable extended mode. In extended mode, the remote server is made
35020 persistent. The @samp{R} packet is used to restart the program being
35026 The remote target both supports and has enabled extended mode.
35030 @cindex @samp{?} packet
35032 Indicate the reason the target halted. The reply is the same as for
35033 step and continue. This packet has a special interpretation when the
35034 target is in non-stop mode; see @ref{Remote Non-Stop}.
35037 @xref{Stop Reply Packets}, for the reply specifications.
35039 @item A @var{arglen},@var{argnum},@var{arg},@dots{}
35040 @cindex @samp{A} packet
35041 Initialized @code{argv[]} array passed into program. @var{arglen}
35042 specifies the number of bytes in the hex encoded byte stream
35043 @var{arg}. See @code{gdbserver} for more details.
35048 The arguments were set.
35054 @cindex @samp{b} packet
35055 (Don't use this packet; its behavior is not well-defined.)
35056 Change the serial line speed to @var{baud}.
35058 JTC: @emph{When does the transport layer state change? When it's
35059 received, or after the ACK is transmitted. In either case, there are
35060 problems if the command or the acknowledgment packet is dropped.}
35062 Stan: @emph{If people really wanted to add something like this, and get
35063 it working for the first time, they ought to modify ser-unix.c to send
35064 some kind of out-of-band message to a specially-setup stub and have the
35065 switch happen "in between" packets, so that from remote protocol's point
35066 of view, nothing actually happened.}
35068 @item B @var{addr},@var{mode}
35069 @cindex @samp{B} packet
35070 Set (@var{mode} is @samp{S}) or clear (@var{mode} is @samp{C}) a
35071 breakpoint at @var{addr}.
35073 Don't use this packet. Use the @samp{Z} and @samp{z} packets instead
35074 (@pxref{insert breakpoint or watchpoint packet}).
35076 @cindex @samp{bc} packet
35079 Backward continue. Execute the target system in reverse. No parameter.
35080 @xref{Reverse Execution}, for more information.
35083 @xref{Stop Reply Packets}, for the reply specifications.
35085 @cindex @samp{bs} packet
35088 Backward single step. Execute one instruction in reverse. No parameter.
35089 @xref{Reverse Execution}, for more information.
35092 @xref{Stop Reply Packets}, for the reply specifications.
35094 @item c @r{[}@var{addr}@r{]}
35095 @cindex @samp{c} packet
35096 Continue at @var{addr}, which is the address to resume. If @var{addr}
35097 is omitted, resume at current address.
35099 This packet is deprecated for multi-threading support. @xref{vCont
35103 @xref{Stop Reply Packets}, for the reply specifications.
35105 @item C @var{sig}@r{[};@var{addr}@r{]}
35106 @cindex @samp{C} packet
35107 Continue with signal @var{sig} (hex signal number). If
35108 @samp{;@var{addr}} is omitted, resume at same address.
35110 This packet is deprecated for multi-threading support. @xref{vCont
35114 @xref{Stop Reply Packets}, for the reply specifications.
35117 @cindex @samp{d} packet
35120 Don't use this packet; instead, define a general set packet
35121 (@pxref{General Query Packets}).
35125 @cindex @samp{D} packet
35126 The first form of the packet is used to detach @value{GDBN} from the
35127 remote system. It is sent to the remote target
35128 before @value{GDBN} disconnects via the @code{detach} command.
35130 The second form, including a process ID, is used when multiprocess
35131 protocol extensions are enabled (@pxref{multiprocess extensions}), to
35132 detach only a specific process. The @var{pid} is specified as a
35133 big-endian hex string.
35143 @item F @var{RC},@var{EE},@var{CF};@var{XX}
35144 @cindex @samp{F} packet
35145 A reply from @value{GDBN} to an @samp{F} packet sent by the target.
35146 This is part of the File-I/O protocol extension. @xref{File-I/O
35147 Remote Protocol Extension}, for the specification.
35150 @anchor{read registers packet}
35151 @cindex @samp{g} packet
35152 Read general registers.
35156 @item @var{XX@dots{}}
35157 Each byte of register data is described by two hex digits. The bytes
35158 with the register are transmitted in target byte order. The size of
35159 each register and their position within the @samp{g} packet are
35160 determined by the @value{GDBN} internal gdbarch functions
35161 @code{DEPRECATED_REGISTER_RAW_SIZE} and @code{gdbarch_register_name}. The
35162 specification of several standard @samp{g} packets is specified below.
35164 When reading registers from a trace frame (@pxref{Analyze Collected
35165 Data,,Using the Collected Data}), the stub may also return a string of
35166 literal @samp{x}'s in place of the register data digits, to indicate
35167 that the corresponding register has not been collected, thus its value
35168 is unavailable. For example, for an architecture with 4 registers of
35169 4 bytes each, the following reply indicates to @value{GDBN} that
35170 registers 0 and 2 have not been collected, while registers 1 and 3
35171 have been collected, and both have zero value:
35175 <- @code{xxxxxxxx00000000xxxxxxxx00000000}
35182 @item G @var{XX@dots{}}
35183 @cindex @samp{G} packet
35184 Write general registers. @xref{read registers packet}, for a
35185 description of the @var{XX@dots{}} data.
35195 @item H @var{op} @var{thread-id}
35196 @cindex @samp{H} packet
35197 Set thread for subsequent operations (@samp{m}, @samp{M}, @samp{g},
35198 @samp{G}, et.al.). Depending on the operation to be performed, @var{op}
35199 should be @samp{c} for step and continue operations (note that this
35200 is deprecated, supporting the @samp{vCont} command is a better
35201 option), and @samp{g} for other operations. The thread designator
35202 @var{thread-id} has the format and interpretation described in
35203 @ref{thread-id syntax}.
35214 @c 'H': How restrictive (or permissive) is the thread model. If a
35215 @c thread is selected and stopped, are other threads allowed
35216 @c to continue to execute? As I mentioned above, I think the
35217 @c semantics of each command when a thread is selected must be
35218 @c described. For example:
35220 @c 'g': If the stub supports threads and a specific thread is
35221 @c selected, returns the register block from that thread;
35222 @c otherwise returns current registers.
35224 @c 'G' If the stub supports threads and a specific thread is
35225 @c selected, sets the registers of the register block of
35226 @c that thread; otherwise sets current registers.
35228 @item i @r{[}@var{addr}@r{[},@var{nnn}@r{]]}
35229 @anchor{cycle step packet}
35230 @cindex @samp{i} packet
35231 Step the remote target by a single clock cycle. If @samp{,@var{nnn}} is
35232 present, cycle step @var{nnn} cycles. If @var{addr} is present, cycle
35233 step starting at that address.
35236 @cindex @samp{I} packet
35237 Signal, then cycle step. @xref{step with signal packet}. @xref{cycle
35241 @cindex @samp{k} packet
35244 The exact effect of this packet is not specified.
35246 For a bare-metal target, it may power cycle or reset the target
35247 system. For that reason, the @samp{k} packet has no reply.
35249 For a single-process target, it may kill that process if possible.
35251 A multiple-process target may choose to kill just one process, or all
35252 that are under @value{GDBN}'s control. For more precise control, use
35253 the vKill packet (@pxref{vKill packet}).
35255 If the target system immediately closes the connection in response to
35256 @samp{k}, @value{GDBN} does not consider the lack of packet
35257 acknowledgment to be an error, and assumes the kill was successful.
35259 If connected using @kbd{target extended-remote}, and the target does
35260 not close the connection in response to a kill request, @value{GDBN}
35261 probes the target state as if a new connection was opened
35262 (@pxref{? packet}).
35264 @item m @var{addr},@var{length}
35265 @cindex @samp{m} packet
35266 Read @var{length} addressable memory units starting at address @var{addr}
35267 (@pxref{addressable memory unit}). Note that @var{addr} may not be aligned to
35268 any particular boundary.
35270 The stub need not use any particular size or alignment when gathering
35271 data from memory for the response; even if @var{addr} is word-aligned
35272 and @var{length} is a multiple of the word size, the stub is free to
35273 use byte accesses, or not. For this reason, this packet may not be
35274 suitable for accessing memory-mapped I/O devices.
35275 @cindex alignment of remote memory accesses
35276 @cindex size of remote memory accesses
35277 @cindex memory, alignment and size of remote accesses
35281 @item @var{XX@dots{}}
35282 Memory contents; each byte is transmitted as a two-digit hexadecimal number.
35283 The reply may contain fewer addressable memory units than requested if the
35284 server was able to read only part of the region of memory.
35289 @item M @var{addr},@var{length}:@var{XX@dots{}}
35290 @cindex @samp{M} packet
35291 Write @var{length} addressable memory units starting at address @var{addr}
35292 (@pxref{addressable memory unit}). The data is given by @var{XX@dots{}}; each
35293 byte is transmitted as a two-digit hexadecimal number.
35300 for an error (this includes the case where only part of the data was
35305 @cindex @samp{p} packet
35306 Read the value of register @var{n}; @var{n} is in hex.
35307 @xref{read registers packet}, for a description of how the returned
35308 register value is encoded.
35312 @item @var{XX@dots{}}
35313 the register's value
35317 Indicating an unrecognized @var{query}.
35320 @item P @var{n@dots{}}=@var{r@dots{}}
35321 @anchor{write register packet}
35322 @cindex @samp{P} packet
35323 Write register @var{n@dots{}} with value @var{r@dots{}}. The register
35324 number @var{n} is in hexadecimal, and @var{r@dots{}} contains two hex
35325 digits for each byte in the register (target byte order).
35335 @item q @var{name} @var{params}@dots{}
35336 @itemx Q @var{name} @var{params}@dots{}
35337 @cindex @samp{q} packet
35338 @cindex @samp{Q} packet
35339 General query (@samp{q}) and set (@samp{Q}). These packets are
35340 described fully in @ref{General Query Packets}.
35343 @cindex @samp{r} packet
35344 Reset the entire system.
35346 Don't use this packet; use the @samp{R} packet instead.
35349 @cindex @samp{R} packet
35350 Restart the program being debugged. The @var{XX}, while needed, is ignored.
35351 This packet is only available in extended mode (@pxref{extended mode}).
35353 The @samp{R} packet has no reply.
35355 @item s @r{[}@var{addr}@r{]}
35356 @cindex @samp{s} packet
35357 Single step, resuming at @var{addr}. If
35358 @var{addr} is omitted, resume at same address.
35360 This packet is deprecated for multi-threading support. @xref{vCont
35364 @xref{Stop Reply Packets}, for the reply specifications.
35366 @item S @var{sig}@r{[};@var{addr}@r{]}
35367 @anchor{step with signal packet}
35368 @cindex @samp{S} packet
35369 Step with signal. This is analogous to the @samp{C} packet, but
35370 requests a single-step, rather than a normal resumption of execution.
35372 This packet is deprecated for multi-threading support. @xref{vCont
35376 @xref{Stop Reply Packets}, for the reply specifications.
35378 @item t @var{addr}:@var{PP},@var{MM}
35379 @cindex @samp{t} packet
35380 Search backwards starting at address @var{addr} for a match with pattern
35381 @var{PP} and mask @var{MM}, both of which are are 4 byte long.
35382 There must be at least 3 digits in @var{addr}.
35384 @item T @var{thread-id}
35385 @cindex @samp{T} packet
35386 Find out if the thread @var{thread-id} is alive. @xref{thread-id syntax}.
35391 thread is still alive
35397 Packets starting with @samp{v} are identified by a multi-letter name,
35398 up to the first @samp{;} or @samp{?} (or the end of the packet).
35400 @item vAttach;@var{pid}
35401 @cindex @samp{vAttach} packet
35402 Attach to a new process with the specified process ID @var{pid}.
35403 The process ID is a
35404 hexadecimal integer identifying the process. In all-stop mode, all
35405 threads in the attached process are stopped; in non-stop mode, it may be
35406 attached without being stopped if that is supported by the target.
35408 @c In non-stop mode, on a successful vAttach, the stub should set the
35409 @c current thread to a thread of the newly-attached process. After
35410 @c attaching, GDB queries for the attached process's thread ID with qC.
35411 @c Also note that, from a user perspective, whether or not the
35412 @c target is stopped on attach in non-stop mode depends on whether you
35413 @c use the foreground or background version of the attach command, not
35414 @c on what vAttach does; GDB does the right thing with respect to either
35415 @c stopping or restarting threads.
35417 This packet is only available in extended mode (@pxref{extended mode}).
35423 @item @r{Any stop packet}
35424 for success in all-stop mode (@pxref{Stop Reply Packets})
35426 for success in non-stop mode (@pxref{Remote Non-Stop})
35429 @item vCont@r{[};@var{action}@r{[}:@var{thread-id}@r{]]}@dots{}
35430 @cindex @samp{vCont} packet
35431 @anchor{vCont packet}
35432 Resume the inferior, specifying different actions for each thread.
35433 If an action is specified with no @var{thread-id}, then it is applied to any
35434 threads that don't have a specific action specified; if no default action is
35435 specified then other threads should remain stopped in all-stop mode and
35436 in their current state in non-stop mode.
35437 Specifying multiple
35438 default actions is an error; specifying no actions is also an error.
35439 Thread IDs are specified using the syntax described in @ref{thread-id syntax}.
35441 Currently supported actions are:
35447 Continue with signal @var{sig}. The signal @var{sig} should be two hex digits.
35451 Step with signal @var{sig}. The signal @var{sig} should be two hex digits.
35454 @item r @var{start},@var{end}
35455 Step once, and then keep stepping as long as the thread stops at
35456 addresses between @var{start} (inclusive) and @var{end} (exclusive).
35457 The remote stub reports a stop reply when either the thread goes out
35458 of the range or is stopped due to an unrelated reason, such as hitting
35459 a breakpoint. @xref{range stepping}.
35461 If the range is empty (@var{start} == @var{end}), then the action
35462 becomes equivalent to the @samp{s} action. In other words,
35463 single-step once, and report the stop (even if the stepped instruction
35464 jumps to @var{start}).
35466 (A stop reply may be sent at any point even if the PC is still within
35467 the stepping range; for example, it is valid to implement this packet
35468 in a degenerate way as a single instruction step operation.)
35472 The optional argument @var{addr} normally associated with the
35473 @samp{c}, @samp{C}, @samp{s}, and @samp{S} packets is
35474 not supported in @samp{vCont}.
35476 The @samp{t} action is only relevant in non-stop mode
35477 (@pxref{Remote Non-Stop}) and may be ignored by the stub otherwise.
35478 A stop reply should be generated for any affected thread not already stopped.
35479 When a thread is stopped by means of a @samp{t} action,
35480 the corresponding stop reply should indicate that the thread has stopped with
35481 signal @samp{0}, regardless of whether the target uses some other signal
35482 as an implementation detail.
35484 The stub must support @samp{vCont} if it reports support for
35485 multiprocess extensions (@pxref{multiprocess extensions}). Note that in
35486 this case @samp{vCont} actions can be specified to apply to all threads
35487 in a process by using the @samp{p@var{pid}.-1} form of the
35491 @xref{Stop Reply Packets}, for the reply specifications.
35494 @cindex @samp{vCont?} packet
35495 Request a list of actions supported by the @samp{vCont} packet.
35499 @item vCont@r{[};@var{action}@dots{}@r{]}
35500 The @samp{vCont} packet is supported. Each @var{action} is a supported
35501 command in the @samp{vCont} packet.
35503 The @samp{vCont} packet is not supported.
35506 @anchor{vCtrlC packet}
35508 @cindex @samp{vCtrlC} packet
35509 Interrupt remote target as if a control-C was pressed on the remote
35510 terminal. This is the equivalent to reacting to the @code{^C}
35511 (@samp{\003}, the control-C character) character in all-stop mode
35512 while the target is running, except this works in non-stop mode.
35513 @xref{interrupting remote targets}, for more info on the all-stop
35524 @item vFile:@var{operation}:@var{parameter}@dots{}
35525 @cindex @samp{vFile} packet
35526 Perform a file operation on the target system. For details,
35527 see @ref{Host I/O Packets}.
35529 @item vFlashErase:@var{addr},@var{length}
35530 @cindex @samp{vFlashErase} packet
35531 Direct the stub to erase @var{length} bytes of flash starting at
35532 @var{addr}. The region may enclose any number of flash blocks, but
35533 its start and end must fall on block boundaries, as indicated by the
35534 flash block size appearing in the memory map (@pxref{Memory Map
35535 Format}). @value{GDBN} groups flash memory programming operations
35536 together, and sends a @samp{vFlashDone} request after each group; the
35537 stub is allowed to delay erase operation until the @samp{vFlashDone}
35538 packet is received.
35548 @item vFlashWrite:@var{addr}:@var{XX@dots{}}
35549 @cindex @samp{vFlashWrite} packet
35550 Direct the stub to write data to flash address @var{addr}. The data
35551 is passed in binary form using the same encoding as for the @samp{X}
35552 packet (@pxref{Binary Data}). The memory ranges specified by
35553 @samp{vFlashWrite} packets preceding a @samp{vFlashDone} packet must
35554 not overlap, and must appear in order of increasing addresses
35555 (although @samp{vFlashErase} packets for higher addresses may already
35556 have been received; the ordering is guaranteed only between
35557 @samp{vFlashWrite} packets). If a packet writes to an address that was
35558 neither erased by a preceding @samp{vFlashErase} packet nor by some other
35559 target-specific method, the results are unpredictable.
35567 for vFlashWrite addressing non-flash memory
35573 @cindex @samp{vFlashDone} packet
35574 Indicate to the stub that flash programming operation is finished.
35575 The stub is permitted to delay or batch the effects of a group of
35576 @samp{vFlashErase} and @samp{vFlashWrite} packets until a
35577 @samp{vFlashDone} packet is received. The contents of the affected
35578 regions of flash memory are unpredictable until the @samp{vFlashDone}
35579 request is completed.
35581 @item vKill;@var{pid}
35582 @cindex @samp{vKill} packet
35583 @anchor{vKill packet}
35584 Kill the process with the specified process ID @var{pid}, which is a
35585 hexadecimal integer identifying the process. This packet is used in
35586 preference to @samp{k} when multiprocess protocol extensions are
35587 supported; see @ref{multiprocess extensions}.
35597 @item vRun;@var{filename}@r{[};@var{argument}@r{]}@dots{}
35598 @cindex @samp{vRun} packet
35599 Run the program @var{filename}, passing it each @var{argument} on its
35600 command line. The file and arguments are hex-encoded strings. If
35601 @var{filename} is an empty string, the stub may use a default program
35602 (e.g.@: the last program run). The program is created in the stopped
35605 @c FIXME: What about non-stop mode?
35607 This packet is only available in extended mode (@pxref{extended mode}).
35613 @item @r{Any stop packet}
35614 for success (@pxref{Stop Reply Packets})
35618 @cindex @samp{vStopped} packet
35619 @xref{Notification Packets}.
35621 @item X @var{addr},@var{length}:@var{XX@dots{}}
35623 @cindex @samp{X} packet
35624 Write data to memory, where the data is transmitted in binary.
35625 Memory is specified by its address @var{addr} and number of addressable memory
35626 units @var{length} (@pxref{addressable memory unit});
35627 @samp{@var{XX}@dots{}} is binary data (@pxref{Binary Data}).
35637 @item z @var{type},@var{addr},@var{kind}
35638 @itemx Z @var{type},@var{addr},@var{kind}
35639 @anchor{insert breakpoint or watchpoint packet}
35640 @cindex @samp{z} packet
35641 @cindex @samp{Z} packets
35642 Insert (@samp{Z}) or remove (@samp{z}) a @var{type} breakpoint or
35643 watchpoint starting at address @var{address} of kind @var{kind}.
35645 Each breakpoint and watchpoint packet @var{type} is documented
35648 @emph{Implementation notes: A remote target shall return an empty string
35649 for an unrecognized breakpoint or watchpoint packet @var{type}. A
35650 remote target shall support either both or neither of a given
35651 @samp{Z@var{type}@dots{}} and @samp{z@var{type}@dots{}} packet pair. To
35652 avoid potential problems with duplicate packets, the operations should
35653 be implemented in an idempotent way.}
35655 @item z0,@var{addr},@var{kind}
35656 @itemx Z0,@var{addr},@var{kind}@r{[};@var{cond_list}@dots{}@r{]}@r{[};cmds:@var{persist},@var{cmd_list}@dots{}@r{]}
35657 @cindex @samp{z0} packet
35658 @cindex @samp{Z0} packet
35659 Insert (@samp{Z0}) or remove (@samp{z0}) a memory breakpoint at address
35660 @var{addr} of type @var{kind}.
35662 A memory breakpoint is implemented by replacing the instruction at
35663 @var{addr} with a software breakpoint or trap instruction. The
35664 @var{kind} is target-specific and typically indicates the size of
35665 the breakpoint in bytes that should be inserted. E.g., the @sc{arm}
35666 and @sc{mips} can insert either a 2 or 4 byte breakpoint. Some
35667 architectures have additional meanings for @var{kind};
35668 @var{cond_list} is an optional list of conditional expressions in bytecode
35669 form that should be evaluated on the target's side. These are the
35670 conditions that should be taken into consideration when deciding if
35671 the breakpoint trigger should be reported back to @var{GDBN}.
35673 See also the @samp{swbreak} stop reason (@pxref{swbreak stop reason})
35674 for how to best report a memory breakpoint event to @value{GDBN}.
35676 The @var{cond_list} parameter is comprised of a series of expressions,
35677 concatenated without separators. Each expression has the following form:
35681 @item X @var{len},@var{expr}
35682 @var{len} is the length of the bytecode expression and @var{expr} is the
35683 actual conditional expression in bytecode form.
35687 The optional @var{cmd_list} parameter introduces commands that may be
35688 run on the target, rather than being reported back to @value{GDBN}.
35689 The parameter starts with a numeric flag @var{persist}; if the flag is
35690 nonzero, then the breakpoint may remain active and the commands
35691 continue to be run even when @value{GDBN} disconnects from the target.
35692 Following this flag is a series of expressions concatenated with no
35693 separators. Each expression has the following form:
35697 @item X @var{len},@var{expr}
35698 @var{len} is the length of the bytecode expression and @var{expr} is the
35699 actual conditional expression in bytecode form.
35703 see @ref{Architecture-Specific Protocol Details}.
35705 @emph{Implementation note: It is possible for a target to copy or move
35706 code that contains memory breakpoints (e.g., when implementing
35707 overlays). The behavior of this packet, in the presence of such a
35708 target, is not defined.}
35720 @item z1,@var{addr},@var{kind}
35721 @itemx Z1,@var{addr},@var{kind}@r{[};@var{cond_list}@dots{}@r{]}
35722 @cindex @samp{z1} packet
35723 @cindex @samp{Z1} packet
35724 Insert (@samp{Z1}) or remove (@samp{z1}) a hardware breakpoint at
35725 address @var{addr}.
35727 A hardware breakpoint is implemented using a mechanism that is not
35728 dependant on being able to modify the target's memory. The @var{kind}
35729 and @var{cond_list} have the same meaning as in @samp{Z0} packets.
35731 @emph{Implementation note: A hardware breakpoint is not affected by code
35744 @item z2,@var{addr},@var{kind}
35745 @itemx Z2,@var{addr},@var{kind}
35746 @cindex @samp{z2} packet
35747 @cindex @samp{Z2} packet
35748 Insert (@samp{Z2}) or remove (@samp{z2}) a write watchpoint at @var{addr}.
35749 The number of bytes to watch is specified by @var{kind}.
35761 @item z3,@var{addr},@var{kind}
35762 @itemx Z3,@var{addr},@var{kind}
35763 @cindex @samp{z3} packet
35764 @cindex @samp{Z3} packet
35765 Insert (@samp{Z3}) or remove (@samp{z3}) a read watchpoint at @var{addr}.
35766 The number of bytes to watch is specified by @var{kind}.
35778 @item z4,@var{addr},@var{kind}
35779 @itemx Z4,@var{addr},@var{kind}
35780 @cindex @samp{z4} packet
35781 @cindex @samp{Z4} packet
35782 Insert (@samp{Z4}) or remove (@samp{z4}) an access watchpoint at @var{addr}.
35783 The number of bytes to watch is specified by @var{kind}.
35797 @node Stop Reply Packets
35798 @section Stop Reply Packets
35799 @cindex stop reply packets
35801 The @samp{C}, @samp{c}, @samp{S}, @samp{s}, @samp{vCont},
35802 @samp{vAttach}, @samp{vRun}, @samp{vStopped}, and @samp{?} packets can
35803 receive any of the below as a reply. Except for @samp{?}
35804 and @samp{vStopped}, that reply is only returned
35805 when the target halts. In the below the exact meaning of @dfn{signal
35806 number} is defined by the header @file{include/gdb/signals.h} in the
35807 @value{GDBN} source code.
35809 As in the description of request packets, we include spaces in the
35810 reply templates for clarity; these are not part of the reply packet's
35811 syntax. No @value{GDBN} stop reply packet uses spaces to separate its
35817 The program received signal number @var{AA} (a two-digit hexadecimal
35818 number). This is equivalent to a @samp{T} response with no
35819 @var{n}:@var{r} pairs.
35821 @item T @var{AA} @var{n1}:@var{r1};@var{n2}:@var{r2};@dots{}
35822 @cindex @samp{T} packet reply
35823 The program received signal number @var{AA} (a two-digit hexadecimal
35824 number). This is equivalent to an @samp{S} response, except that the
35825 @samp{@var{n}:@var{r}} pairs can carry values of important registers
35826 and other information directly in the stop reply packet, reducing
35827 round-trip latency. Single-step and breakpoint traps are reported
35828 this way. Each @samp{@var{n}:@var{r}} pair is interpreted as follows:
35832 If @var{n} is a hexadecimal number, it is a register number, and the
35833 corresponding @var{r} gives that register's value. The data @var{r} is a
35834 series of bytes in target byte order, with each byte given by a
35835 two-digit hex number.
35838 If @var{n} is @samp{thread}, then @var{r} is the @var{thread-id} of
35839 the stopped thread, as specified in @ref{thread-id syntax}.
35842 If @var{n} is @samp{core}, then @var{r} is the hexadecimal number of
35843 the core on which the stop event was detected.
35846 If @var{n} is a recognized @dfn{stop reason}, it describes a more
35847 specific event that stopped the target. The currently defined stop
35848 reasons are listed below. The @var{aa} should be @samp{05}, the trap
35849 signal. At most one stop reason should be present.
35852 Otherwise, @value{GDBN} should ignore this @samp{@var{n}:@var{r}} pair
35853 and go on to the next; this allows us to extend the protocol in the
35857 The currently defined stop reasons are:
35863 The packet indicates a watchpoint hit, and @var{r} is the data address, in
35866 @item syscall_entry
35867 @itemx syscall_return
35868 The packet indicates a syscall entry or return, and @var{r} is the
35869 syscall number, in hex.
35871 @cindex shared library events, remote reply
35873 The packet indicates that the loaded libraries have changed.
35874 @value{GDBN} should use @samp{qXfer:libraries:read} to fetch a new
35875 list of loaded libraries. The @var{r} part is ignored.
35877 @cindex replay log events, remote reply
35879 The packet indicates that the target cannot continue replaying
35880 logged execution events, because it has reached the end (or the
35881 beginning when executing backward) of the log. The value of @var{r}
35882 will be either @samp{begin} or @samp{end}. @xref{Reverse Execution},
35883 for more information.
35886 @anchor{swbreak stop reason}
35887 The packet indicates a memory breakpoint instruction was executed,
35888 irrespective of whether it was @value{GDBN} that planted the
35889 breakpoint or the breakpoint is hardcoded in the program. The @var{r}
35890 part must be left empty.
35892 On some architectures, such as x86, at the architecture level, when a
35893 breakpoint instruction executes the program counter points at the
35894 breakpoint address plus an offset. On such targets, the stub is
35895 responsible for adjusting the PC to point back at the breakpoint
35898 This packet should not be sent by default; older @value{GDBN} versions
35899 did not support it. @value{GDBN} requests it, by supplying an
35900 appropriate @samp{qSupported} feature (@pxref{qSupported}). The
35901 remote stub must also supply the appropriate @samp{qSupported} feature
35902 indicating support.
35904 This packet is required for correct non-stop mode operation.
35907 The packet indicates the target stopped for a hardware breakpoint.
35908 The @var{r} part must be left empty.
35910 The same remarks about @samp{qSupported} and non-stop mode above
35913 @cindex fork events, remote reply
35915 The packet indicates that @code{fork} was called, and @var{r}
35916 is the thread ID of the new child process. Refer to
35917 @ref{thread-id syntax} for the format of the @var{thread-id}
35918 field. This packet is only applicable to targets that support
35921 This packet should not be sent by default; older @value{GDBN} versions
35922 did not support it. @value{GDBN} requests it, by supplying an
35923 appropriate @samp{qSupported} feature (@pxref{qSupported}). The
35924 remote stub must also supply the appropriate @samp{qSupported} feature
35925 indicating support.
35927 @cindex vfork events, remote reply
35929 The packet indicates that @code{vfork} was called, and @var{r}
35930 is the thread ID of the new child process. Refer to
35931 @ref{thread-id syntax} for the format of the @var{thread-id}
35932 field. This packet is only applicable to targets that support
35935 This packet should not be sent by default; older @value{GDBN} versions
35936 did not support it. @value{GDBN} requests it, by supplying an
35937 appropriate @samp{qSupported} feature (@pxref{qSupported}). The
35938 remote stub must also supply the appropriate @samp{qSupported} feature
35939 indicating support.
35941 @cindex vforkdone events, remote reply
35943 The packet indicates that a child process created by a vfork
35944 has either called @code{exec} or terminated, so that the
35945 address spaces of the parent and child process are no longer
35946 shared. The @var{r} part is ignored. This packet is only
35947 applicable to targets that support vforkdone events.
35949 This packet should not be sent by default; older @value{GDBN} versions
35950 did not support it. @value{GDBN} requests it, by supplying an
35951 appropriate @samp{qSupported} feature (@pxref{qSupported}). The
35952 remote stub must also supply the appropriate @samp{qSupported} feature
35953 indicating support.
35955 @cindex exec events, remote reply
35957 The packet indicates that @code{execve} was called, and @var{r}
35958 is the absolute pathname of the file that was executed, in hex.
35959 This packet is only applicable to targets that support exec events.
35961 This packet should not be sent by default; older @value{GDBN} versions
35962 did not support it. @value{GDBN} requests it, by supplying an
35963 appropriate @samp{qSupported} feature (@pxref{qSupported}). The
35964 remote stub must also supply the appropriate @samp{qSupported} feature
35965 indicating support.
35967 @cindex thread create event, remote reply
35968 @anchor{thread create event}
35970 The packet indicates that the thread was just created. The new thread
35971 is stopped until @value{GDBN} sets it running with a resumption packet
35972 (@pxref{vCont packet}). This packet should not be sent by default;
35973 @value{GDBN} requests it with the @ref{QThreadEvents} packet. See
35974 also the @samp{w} (@ref{thread exit event}) remote reply below.
35979 @itemx W @var{AA} ; process:@var{pid}
35980 The process exited, and @var{AA} is the exit status. This is only
35981 applicable to certain targets.
35983 The second form of the response, including the process ID of the exited
35984 process, can be used only when @value{GDBN} has reported support for
35985 multiprocess protocol extensions; see @ref{multiprocess extensions}.
35986 The @var{pid} is formatted as a big-endian hex string.
35989 @itemx X @var{AA} ; process:@var{pid}
35990 The process terminated with signal @var{AA}.
35992 The second form of the response, including the process ID of the
35993 terminated process, can be used only when @value{GDBN} has reported
35994 support for multiprocess protocol extensions; see @ref{multiprocess
35995 extensions}. The @var{pid} is formatted as a big-endian hex string.
35997 @anchor{thread exit event}
35998 @cindex thread exit event, remote reply
35999 @item w @var{AA} ; @var{tid}
36001 The thread exited, and @var{AA} is the exit status. This response
36002 should not be sent by default; @value{GDBN} requests it with the
36003 @ref{QThreadEvents} packet. See also @ref{thread create event} above.
36006 There are no resumed threads left in the target. In other words, even
36007 though the process is alive, the last resumed thread has exited. For
36008 example, say the target process has two threads: thread 1 and thread
36009 2. The client leaves thread 1 stopped, and resumes thread 2, which
36010 subsequently exits. At this point, even though the process is still
36011 alive, and thus no @samp{W} stop reply is sent, no thread is actually
36012 executing either. The @samp{N} stop reply thus informs the client
36013 that it can stop waiting for stop replies. This packet should not be
36014 sent by default; older @value{GDBN} versions did not support it.
36015 @value{GDBN} requests it, by supplying an appropriate
36016 @samp{qSupported} feature (@pxref{qSupported}). The remote stub must
36017 also supply the appropriate @samp{qSupported} feature indicating
36020 @item O @var{XX}@dots{}
36021 @samp{@var{XX}@dots{}} is hex encoding of @sc{ascii} data, to be
36022 written as the program's console output. This can happen at any time
36023 while the program is running and the debugger should continue to wait
36024 for @samp{W}, @samp{T}, etc. This reply is not permitted in non-stop mode.
36026 @item F @var{call-id},@var{parameter}@dots{}
36027 @var{call-id} is the identifier which says which host system call should
36028 be called. This is just the name of the function. Translation into the
36029 correct system call is only applicable as it's defined in @value{GDBN}.
36030 @xref{File-I/O Remote Protocol Extension}, for a list of implemented
36033 @samp{@var{parameter}@dots{}} is a list of parameters as defined for
36034 this very system call.
36036 The target replies with this packet when it expects @value{GDBN} to
36037 call a host system call on behalf of the target. @value{GDBN} replies
36038 with an appropriate @samp{F} packet and keeps up waiting for the next
36039 reply packet from the target. The latest @samp{C}, @samp{c}, @samp{S}
36040 or @samp{s} action is expected to be continued. @xref{File-I/O Remote
36041 Protocol Extension}, for more details.
36045 @node General Query Packets
36046 @section General Query Packets
36047 @cindex remote query requests
36049 Packets starting with @samp{q} are @dfn{general query packets};
36050 packets starting with @samp{Q} are @dfn{general set packets}. General
36051 query and set packets are a semi-unified form for retrieving and
36052 sending information to and from the stub.
36054 The initial letter of a query or set packet is followed by a name
36055 indicating what sort of thing the packet applies to. For example,
36056 @value{GDBN} may use a @samp{qSymbol} packet to exchange symbol
36057 definitions with the stub. These packet names follow some
36062 The name must not contain commas, colons or semicolons.
36064 Most @value{GDBN} query and set packets have a leading upper case
36067 The names of custom vendor packets should use a company prefix, in
36068 lower case, followed by a period. For example, packets designed at
36069 the Acme Corporation might begin with @samp{qacme.foo} (for querying
36070 foos) or @samp{Qacme.bar} (for setting bars).
36073 The name of a query or set packet should be separated from any
36074 parameters by a @samp{:}; the parameters themselves should be
36075 separated by @samp{,} or @samp{;}. Stubs must be careful to match the
36076 full packet name, and check for a separator or the end of the packet,
36077 in case two packet names share a common prefix. New packets should not begin
36078 with @samp{qC}, @samp{qP}, or @samp{qL}@footnote{The @samp{qP} and @samp{qL}
36079 packets predate these conventions, and have arguments without any terminator
36080 for the packet name; we suspect they are in widespread use in places that
36081 are difficult to upgrade. The @samp{qC} packet has no arguments, but some
36082 existing stubs (e.g.@: RedBoot) are known to not check for the end of the
36085 Like the descriptions of the other packets, each description here
36086 has a template showing the packet's overall syntax, followed by an
36087 explanation of the packet's meaning. We include spaces in some of the
36088 templates for clarity; these are not part of the packet's syntax. No
36089 @value{GDBN} packet uses spaces to separate its components.
36091 Here are the currently defined query and set packets:
36097 Turn on or off the agent as a helper to perform some debugging operations
36098 delegated from @value{GDBN} (@pxref{Control Agent}).
36100 @item QAllow:@var{op}:@var{val}@dots{}
36101 @cindex @samp{QAllow} packet
36102 Specify which operations @value{GDBN} expects to request of the
36103 target, as a semicolon-separated list of operation name and value
36104 pairs. Possible values for @var{op} include @samp{WriteReg},
36105 @samp{WriteMem}, @samp{InsertBreak}, @samp{InsertTrace},
36106 @samp{InsertFastTrace}, and @samp{Stop}. @var{val} is either 0,
36107 indicating that @value{GDBN} will not request the operation, or 1,
36108 indicating that it may. (The target can then use this to set up its
36109 own internals optimally, for instance if the debugger never expects to
36110 insert breakpoints, it may not need to install its own trap handler.)
36113 @cindex current thread, remote request
36114 @cindex @samp{qC} packet
36115 Return the current thread ID.
36119 @item QC @var{thread-id}
36120 Where @var{thread-id} is a thread ID as documented in
36121 @ref{thread-id syntax}.
36122 @item @r{(anything else)}
36123 Any other reply implies the old thread ID.
36126 @item qCRC:@var{addr},@var{length}
36127 @cindex CRC of memory block, remote request
36128 @cindex @samp{qCRC} packet
36129 @anchor{qCRC packet}
36130 Compute the CRC checksum of a block of memory using CRC-32 defined in
36131 IEEE 802.3. The CRC is computed byte at a time, taking the most
36132 significant bit of each byte first. The initial pattern code
36133 @code{0xffffffff} is used to ensure leading zeros affect the CRC.
36135 @emph{Note:} This is the same CRC used in validating separate debug
36136 files (@pxref{Separate Debug Files, , Debugging Information in Separate
36137 Files}). However the algorithm is slightly different. When validating
36138 separate debug files, the CRC is computed taking the @emph{least}
36139 significant bit of each byte first, and the final result is inverted to
36140 detect trailing zeros.
36145 An error (such as memory fault)
36146 @item C @var{crc32}
36147 The specified memory region's checksum is @var{crc32}.
36150 @item QDisableRandomization:@var{value}
36151 @cindex disable address space randomization, remote request
36152 @cindex @samp{QDisableRandomization} packet
36153 Some target operating systems will randomize the virtual address space
36154 of the inferior process as a security feature, but provide a feature
36155 to disable such randomization, e.g.@: to allow for a more deterministic
36156 debugging experience. On such systems, this packet with a @var{value}
36157 of 1 directs the target to disable address space randomization for
36158 processes subsequently started via @samp{vRun} packets, while a packet
36159 with a @var{value} of 0 tells the target to enable address space
36162 This packet is only available in extended mode (@pxref{extended mode}).
36167 The request succeeded.
36170 An error occurred. The error number @var{nn} is given as hex digits.
36173 An empty reply indicates that @samp{QDisableRandomization} is not supported
36177 This packet is not probed by default; the remote stub must request it,
36178 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
36179 This should only be done on targets that actually support disabling
36180 address space randomization.
36183 @itemx qsThreadInfo
36184 @cindex list active threads, remote request
36185 @cindex @samp{qfThreadInfo} packet
36186 @cindex @samp{qsThreadInfo} packet
36187 Obtain a list of all active thread IDs from the target (OS). Since there
36188 may be too many active threads to fit into one reply packet, this query
36189 works iteratively: it may require more than one query/reply sequence to
36190 obtain the entire list of threads. The first query of the sequence will
36191 be the @samp{qfThreadInfo} query; subsequent queries in the
36192 sequence will be the @samp{qsThreadInfo} query.
36194 NOTE: This packet replaces the @samp{qL} query (see below).
36198 @item m @var{thread-id}
36200 @item m @var{thread-id},@var{thread-id}@dots{}
36201 a comma-separated list of thread IDs
36203 (lower case letter @samp{L}) denotes end of list.
36206 In response to each query, the target will reply with a list of one or
36207 more thread IDs, separated by commas.
36208 @value{GDBN} will respond to each reply with a request for more thread
36209 ids (using the @samp{qs} form of the query), until the target responds
36210 with @samp{l} (lower-case ell, for @dfn{last}).
36211 Refer to @ref{thread-id syntax}, for the format of the @var{thread-id}
36214 @emph{Note: @value{GDBN} will send the @code{qfThreadInfo} query during the
36215 initial connection with the remote target, and the very first thread ID
36216 mentioned in the reply will be stopped by @value{GDBN} in a subsequent
36217 message. Therefore, the stub should ensure that the first thread ID in
36218 the @code{qfThreadInfo} reply is suitable for being stopped by @value{GDBN}.}
36220 @item qGetTLSAddr:@var{thread-id},@var{offset},@var{lm}
36221 @cindex get thread-local storage address, remote request
36222 @cindex @samp{qGetTLSAddr} packet
36223 Fetch the address associated with thread local storage specified
36224 by @var{thread-id}, @var{offset}, and @var{lm}.
36226 @var{thread-id} is the thread ID associated with the
36227 thread for which to fetch the TLS address. @xref{thread-id syntax}.
36229 @var{offset} is the (big endian, hex encoded) offset associated with the
36230 thread local variable. (This offset is obtained from the debug
36231 information associated with the variable.)
36233 @var{lm} is the (big endian, hex encoded) OS/ABI-specific encoding of the
36234 load module associated with the thread local storage. For example,
36235 a @sc{gnu}/Linux system will pass the link map address of the shared
36236 object associated with the thread local storage under consideration.
36237 Other operating environments may choose to represent the load module
36238 differently, so the precise meaning of this parameter will vary.
36242 @item @var{XX}@dots{}
36243 Hex encoded (big endian) bytes representing the address of the thread
36244 local storage requested.
36247 An error occurred. The error number @var{nn} is given as hex digits.
36250 An empty reply indicates that @samp{qGetTLSAddr} is not supported by the stub.
36253 @item qGetTIBAddr:@var{thread-id}
36254 @cindex get thread information block address
36255 @cindex @samp{qGetTIBAddr} packet
36256 Fetch address of the Windows OS specific Thread Information Block.
36258 @var{thread-id} is the thread ID associated with the thread.
36262 @item @var{XX}@dots{}
36263 Hex encoded (big endian) bytes representing the linear address of the
36264 thread information block.
36267 An error occured. This means that either the thread was not found, or the
36268 address could not be retrieved.
36271 An empty reply indicates that @samp{qGetTIBAddr} is not supported by the stub.
36274 @item qL @var{startflag} @var{threadcount} @var{nextthread}
36275 Obtain thread information from RTOS. Where: @var{startflag} (one hex
36276 digit) is one to indicate the first query and zero to indicate a
36277 subsequent query; @var{threadcount} (two hex digits) is the maximum
36278 number of threads the response packet can contain; and @var{nextthread}
36279 (eight hex digits), for subsequent queries (@var{startflag} is zero), is
36280 returned in the response as @var{argthread}.
36282 Don't use this packet; use the @samp{qfThreadInfo} query instead (see above).
36286 @item qM @var{count} @var{done} @var{argthread} @var{thread}@dots{}
36287 Where: @var{count} (two hex digits) is the number of threads being
36288 returned; @var{done} (one hex digit) is zero to indicate more threads
36289 and one indicates no further threads; @var{argthreadid} (eight hex
36290 digits) is @var{nextthread} from the request packet; @var{thread}@dots{}
36291 is a sequence of thread IDs, @var{threadid} (eight hex
36292 digits), from the target. See @code{remote.c:parse_threadlist_response()}.
36296 @cindex section offsets, remote request
36297 @cindex @samp{qOffsets} packet
36298 Get section offsets that the target used when relocating the downloaded
36303 @item Text=@var{xxx};Data=@var{yyy}@r{[};Bss=@var{zzz}@r{]}
36304 Relocate the @code{Text} section by @var{xxx} from its original address.
36305 Relocate the @code{Data} section by @var{yyy} from its original address.
36306 If the object file format provides segment information (e.g.@: @sc{elf}
36307 @samp{PT_LOAD} program headers), @value{GDBN} will relocate entire
36308 segments by the supplied offsets.
36310 @emph{Note: while a @code{Bss} offset may be included in the response,
36311 @value{GDBN} ignores this and instead applies the @code{Data} offset
36312 to the @code{Bss} section.}
36314 @item TextSeg=@var{xxx}@r{[};DataSeg=@var{yyy}@r{]}
36315 Relocate the first segment of the object file, which conventionally
36316 contains program code, to a starting address of @var{xxx}. If
36317 @samp{DataSeg} is specified, relocate the second segment, which
36318 conventionally contains modifiable data, to a starting address of
36319 @var{yyy}. @value{GDBN} will report an error if the object file
36320 does not contain segment information, or does not contain at least
36321 as many segments as mentioned in the reply. Extra segments are
36322 kept at fixed offsets relative to the last relocated segment.
36325 @item qP @var{mode} @var{thread-id}
36326 @cindex thread information, remote request
36327 @cindex @samp{qP} packet
36328 Returns information on @var{thread-id}. Where: @var{mode} is a hex
36329 encoded 32 bit mode; @var{thread-id} is a thread ID
36330 (@pxref{thread-id syntax}).
36332 Don't use this packet; use the @samp{qThreadExtraInfo} query instead
36335 Reply: see @code{remote.c:remote_unpack_thread_info_response()}.
36339 @cindex non-stop mode, remote request
36340 @cindex @samp{QNonStop} packet
36342 Enter non-stop (@samp{QNonStop:1}) or all-stop (@samp{QNonStop:0}) mode.
36343 @xref{Remote Non-Stop}, for more information.
36348 The request succeeded.
36351 An error occurred. The error number @var{nn} is given as hex digits.
36354 An empty reply indicates that @samp{QNonStop} is not supported by
36358 This packet is not probed by default; the remote stub must request it,
36359 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
36360 Use of this packet is controlled by the @code{set non-stop} command;
36361 @pxref{Non-Stop Mode}.
36363 @item QCatchSyscalls:1 @r{[};@var{sysno}@r{]}@dots{}
36364 @itemx QCatchSyscalls:0
36365 @cindex catch syscalls from inferior, remote request
36366 @cindex @samp{QCatchSyscalls} packet
36367 @anchor{QCatchSyscalls}
36368 Enable (@samp{QCatchSyscalls:1}) or disable (@samp{QCatchSyscalls:0})
36369 catching syscalls from the inferior process.
36371 For @samp{QCatchSyscalls:1}, each listed syscall @var{sysno} (encoded
36372 in hex) should be reported to @value{GDBN}. If no syscall @var{sysno}
36373 is listed, every system call should be reported.
36375 Note that if a syscall not in the list is reported, @value{GDBN} will
36376 still filter the event according to its own list from all corresponding
36377 @code{catch syscall} commands. However, it is more efficient to only
36378 report the requested syscalls.
36380 Multiple @samp{QCatchSyscalls:1} packets do not combine; any earlier
36381 @samp{QCatchSyscalls:1} list is completely replaced by the new list.
36383 If the inferior process execs, the state of @samp{QCatchSyscalls} is
36384 kept for the new process too. On targets where exec may affect syscall
36385 numbers, for example with exec between 32 and 64-bit processes, the
36386 client should send a new packet with the new syscall list.
36391 The request succeeded.
36394 An error occurred. @var{nn} are hex digits.
36397 An empty reply indicates that @samp{QCatchSyscalls} is not supported by
36401 Use of this packet is controlled by the @code{set remote catch-syscalls}
36402 command (@pxref{Remote Configuration, set remote catch-syscalls}).
36403 This packet is not probed by default; the remote stub must request it,
36404 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
36406 @item QPassSignals: @var{signal} @r{[};@var{signal}@r{]}@dots{}
36407 @cindex pass signals to inferior, remote request
36408 @cindex @samp{QPassSignals} packet
36409 @anchor{QPassSignals}
36410 Each listed @var{signal} should be passed directly to the inferior process.
36411 Signals are numbered identically to continue packets and stop replies
36412 (@pxref{Stop Reply Packets}). Each @var{signal} list item should be
36413 strictly greater than the previous item. These signals do not need to stop
36414 the inferior, or be reported to @value{GDBN}. All other signals should be
36415 reported to @value{GDBN}. Multiple @samp{QPassSignals} packets do not
36416 combine; any earlier @samp{QPassSignals} list is completely replaced by the
36417 new list. This packet improves performance when using @samp{handle
36418 @var{signal} nostop noprint pass}.
36423 The request succeeded.
36426 An error occurred. The error number @var{nn} is given as hex digits.
36429 An empty reply indicates that @samp{QPassSignals} is not supported by
36433 Use of this packet is controlled by the @code{set remote pass-signals}
36434 command (@pxref{Remote Configuration, set remote pass-signals}).
36435 This packet is not probed by default; the remote stub must request it,
36436 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
36438 @item QProgramSignals: @var{signal} @r{[};@var{signal}@r{]}@dots{}
36439 @cindex signals the inferior may see, remote request
36440 @cindex @samp{QProgramSignals} packet
36441 @anchor{QProgramSignals}
36442 Each listed @var{signal} may be delivered to the inferior process.
36443 Others should be silently discarded.
36445 In some cases, the remote stub may need to decide whether to deliver a
36446 signal to the program or not without @value{GDBN} involvement. One
36447 example of that is while detaching --- the program's threads may have
36448 stopped for signals that haven't yet had a chance of being reported to
36449 @value{GDBN}, and so the remote stub can use the signal list specified
36450 by this packet to know whether to deliver or ignore those pending
36453 This does not influence whether to deliver a signal as requested by a
36454 resumption packet (@pxref{vCont packet}).
36456 Signals are numbered identically to continue packets and stop replies
36457 (@pxref{Stop Reply Packets}). Each @var{signal} list item should be
36458 strictly greater than the previous item. Multiple
36459 @samp{QProgramSignals} packets do not combine; any earlier
36460 @samp{QProgramSignals} list is completely replaced by the new list.
36465 The request succeeded.
36468 An error occurred. The error number @var{nn} is given as hex digits.
36471 An empty reply indicates that @samp{QProgramSignals} is not supported
36475 Use of this packet is controlled by the @code{set remote program-signals}
36476 command (@pxref{Remote Configuration, set remote program-signals}).
36477 This packet is not probed by default; the remote stub must request it,
36478 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
36480 @anchor{QThreadEvents}
36481 @item QThreadEvents:1
36482 @itemx QThreadEvents:0
36483 @cindex thread create/exit events, remote request
36484 @cindex @samp{QThreadEvents} packet
36486 Enable (@samp{QThreadEvents:1}) or disable (@samp{QThreadEvents:0})
36487 reporting of thread create and exit events. @xref{thread create
36488 event}, for the reply specifications. For example, this is used in
36489 non-stop mode when @value{GDBN} stops a set of threads and
36490 synchronously waits for the their corresponding stop replies. Without
36491 exit events, if one of the threads exits, @value{GDBN} would hang
36492 forever not knowing that it should no longer expect a stop for that
36493 same thread. @value{GDBN} does not enable this feature unless the
36494 stub reports that it supports it by including @samp{QThreadEvents+} in
36495 its @samp{qSupported} reply.
36500 The request succeeded.
36503 An error occurred. The error number @var{nn} is given as hex digits.
36506 An empty reply indicates that @samp{QThreadEvents} is not supported by
36510 Use of this packet is controlled by the @code{set remote thread-events}
36511 command (@pxref{Remote Configuration, set remote thread-events}).
36513 @item qRcmd,@var{command}
36514 @cindex execute remote command, remote request
36515 @cindex @samp{qRcmd} packet
36516 @var{command} (hex encoded) is passed to the local interpreter for
36517 execution. Invalid commands should be reported using the output
36518 string. Before the final result packet, the target may also respond
36519 with a number of intermediate @samp{O@var{output}} console output
36520 packets. @emph{Implementors should note that providing access to a
36521 stubs's interpreter may have security implications}.
36526 A command response with no output.
36528 A command response with the hex encoded output string @var{OUTPUT}.
36530 Indicate a badly formed request.
36532 An empty reply indicates that @samp{qRcmd} is not recognized.
36535 (Note that the @code{qRcmd} packet's name is separated from the
36536 command by a @samp{,}, not a @samp{:}, contrary to the naming
36537 conventions above. Please don't use this packet as a model for new
36540 @item qSearch:memory:@var{address};@var{length};@var{search-pattern}
36541 @cindex searching memory, in remote debugging
36543 @cindex @samp{qSearch:memory} packet
36545 @cindex @samp{qSearch memory} packet
36546 @anchor{qSearch memory}
36547 Search @var{length} bytes at @var{address} for @var{search-pattern}.
36548 Both @var{address} and @var{length} are encoded in hex;
36549 @var{search-pattern} is a sequence of bytes, also hex encoded.
36554 The pattern was not found.
36556 The pattern was found at @var{address}.
36558 A badly formed request or an error was encountered while searching memory.
36560 An empty reply indicates that @samp{qSearch:memory} is not recognized.
36563 @item QStartNoAckMode
36564 @cindex @samp{QStartNoAckMode} packet
36565 @anchor{QStartNoAckMode}
36566 Request that the remote stub disable the normal @samp{+}/@samp{-}
36567 protocol acknowledgments (@pxref{Packet Acknowledgment}).
36572 The stub has switched to no-acknowledgment mode.
36573 @value{GDBN} acknowledges this reponse,
36574 but neither the stub nor @value{GDBN} shall send or expect further
36575 @samp{+}/@samp{-} acknowledgments in the current connection.
36577 An empty reply indicates that the stub does not support no-acknowledgment mode.
36580 @item qSupported @r{[}:@var{gdbfeature} @r{[};@var{gdbfeature}@r{]}@dots{} @r{]}
36581 @cindex supported packets, remote query
36582 @cindex features of the remote protocol
36583 @cindex @samp{qSupported} packet
36584 @anchor{qSupported}
36585 Tell the remote stub about features supported by @value{GDBN}, and
36586 query the stub for features it supports. This packet allows
36587 @value{GDBN} and the remote stub to take advantage of each others'
36588 features. @samp{qSupported} also consolidates multiple feature probes
36589 at startup, to improve @value{GDBN} performance---a single larger
36590 packet performs better than multiple smaller probe packets on
36591 high-latency links. Some features may enable behavior which must not
36592 be on by default, e.g.@: because it would confuse older clients or
36593 stubs. Other features may describe packets which could be
36594 automatically probed for, but are not. These features must be
36595 reported before @value{GDBN} will use them. This ``default
36596 unsupported'' behavior is not appropriate for all packets, but it
36597 helps to keep the initial connection time under control with new
36598 versions of @value{GDBN} which support increasing numbers of packets.
36602 @item @var{stubfeature} @r{[};@var{stubfeature}@r{]}@dots{}
36603 The stub supports or does not support each returned @var{stubfeature},
36604 depending on the form of each @var{stubfeature} (see below for the
36607 An empty reply indicates that @samp{qSupported} is not recognized,
36608 or that no features needed to be reported to @value{GDBN}.
36611 The allowed forms for each feature (either a @var{gdbfeature} in the
36612 @samp{qSupported} packet, or a @var{stubfeature} in the response)
36616 @item @var{name}=@var{value}
36617 The remote protocol feature @var{name} is supported, and associated
36618 with the specified @var{value}. The format of @var{value} depends
36619 on the feature, but it must not include a semicolon.
36621 The remote protocol feature @var{name} is supported, and does not
36622 need an associated value.
36624 The remote protocol feature @var{name} is not supported.
36626 The remote protocol feature @var{name} may be supported, and
36627 @value{GDBN} should auto-detect support in some other way when it is
36628 needed. This form will not be used for @var{gdbfeature} notifications,
36629 but may be used for @var{stubfeature} responses.
36632 Whenever the stub receives a @samp{qSupported} request, the
36633 supplied set of @value{GDBN} features should override any previous
36634 request. This allows @value{GDBN} to put the stub in a known
36635 state, even if the stub had previously been communicating with
36636 a different version of @value{GDBN}.
36638 The following values of @var{gdbfeature} (for the packet sent by @value{GDBN})
36643 This feature indicates whether @value{GDBN} supports multiprocess
36644 extensions to the remote protocol. @value{GDBN} does not use such
36645 extensions unless the stub also reports that it supports them by
36646 including @samp{multiprocess+} in its @samp{qSupported} reply.
36647 @xref{multiprocess extensions}, for details.
36650 This feature indicates that @value{GDBN} supports the XML target
36651 description. If the stub sees @samp{xmlRegisters=} with target
36652 specific strings separated by a comma, it will report register
36656 This feature indicates whether @value{GDBN} supports the
36657 @samp{qRelocInsn} packet (@pxref{Tracepoint Packets,,Relocate
36658 instruction reply packet}).
36661 This feature indicates whether @value{GDBN} supports the swbreak stop
36662 reason in stop replies. @xref{swbreak stop reason}, for details.
36665 This feature indicates whether @value{GDBN} supports the hwbreak stop
36666 reason in stop replies. @xref{swbreak stop reason}, for details.
36669 This feature indicates whether @value{GDBN} supports fork event
36670 extensions to the remote protocol. @value{GDBN} does not use such
36671 extensions unless the stub also reports that it supports them by
36672 including @samp{fork-events+} in its @samp{qSupported} reply.
36675 This feature indicates whether @value{GDBN} supports vfork event
36676 extensions to the remote protocol. @value{GDBN} does not use such
36677 extensions unless the stub also reports that it supports them by
36678 including @samp{vfork-events+} in its @samp{qSupported} reply.
36681 This feature indicates whether @value{GDBN} supports exec event
36682 extensions to the remote protocol. @value{GDBN} does not use such
36683 extensions unless the stub also reports that it supports them by
36684 including @samp{exec-events+} in its @samp{qSupported} reply.
36686 @item vContSupported
36687 This feature indicates whether @value{GDBN} wants to know the
36688 supported actions in the reply to @samp{vCont?} packet.
36691 Stubs should ignore any unknown values for
36692 @var{gdbfeature}. Any @value{GDBN} which sends a @samp{qSupported}
36693 packet supports receiving packets of unlimited length (earlier
36694 versions of @value{GDBN} may reject overly long responses). Additional values
36695 for @var{gdbfeature} may be defined in the future to let the stub take
36696 advantage of new features in @value{GDBN}, e.g.@: incompatible
36697 improvements in the remote protocol---the @samp{multiprocess} feature is
36698 an example of such a feature. The stub's reply should be independent
36699 of the @var{gdbfeature} entries sent by @value{GDBN}; first @value{GDBN}
36700 describes all the features it supports, and then the stub replies with
36701 all the features it supports.
36703 Similarly, @value{GDBN} will silently ignore unrecognized stub feature
36704 responses, as long as each response uses one of the standard forms.
36706 Some features are flags. A stub which supports a flag feature
36707 should respond with a @samp{+} form response. Other features
36708 require values, and the stub should respond with an @samp{=}
36711 Each feature has a default value, which @value{GDBN} will use if
36712 @samp{qSupported} is not available or if the feature is not mentioned
36713 in the @samp{qSupported} response. The default values are fixed; a
36714 stub is free to omit any feature responses that match the defaults.
36716 Not all features can be probed, but for those which can, the probing
36717 mechanism is useful: in some cases, a stub's internal
36718 architecture may not allow the protocol layer to know some information
36719 about the underlying target in advance. This is especially common in
36720 stubs which may be configured for multiple targets.
36722 These are the currently defined stub features and their properties:
36724 @multitable @columnfractions 0.35 0.2 0.12 0.2
36725 @c NOTE: The first row should be @headitem, but we do not yet require
36726 @c a new enough version of Texinfo (4.7) to use @headitem.
36728 @tab Value Required
36732 @item @samp{PacketSize}
36737 @item @samp{qXfer:auxv:read}
36742 @item @samp{qXfer:btrace:read}
36747 @item @samp{qXfer:btrace-conf:read}
36752 @item @samp{qXfer:exec-file:read}
36757 @item @samp{qXfer:features:read}
36762 @item @samp{qXfer:libraries:read}
36767 @item @samp{qXfer:libraries-svr4:read}
36772 @item @samp{augmented-libraries-svr4-read}
36777 @item @samp{qXfer:memory-map:read}
36782 @item @samp{qXfer:sdata:read}
36787 @item @samp{qXfer:spu:read}
36792 @item @samp{qXfer:spu:write}
36797 @item @samp{qXfer:siginfo:read}
36802 @item @samp{qXfer:siginfo:write}
36807 @item @samp{qXfer:threads:read}
36812 @item @samp{qXfer:traceframe-info:read}
36817 @item @samp{qXfer:uib:read}
36822 @item @samp{qXfer:fdpic:read}
36827 @item @samp{Qbtrace:off}
36832 @item @samp{Qbtrace:bts}
36837 @item @samp{Qbtrace:pt}
36842 @item @samp{Qbtrace-conf:bts:size}
36847 @item @samp{Qbtrace-conf:pt:size}
36852 @item @samp{QNonStop}
36857 @item @samp{QCatchSyscalls}
36862 @item @samp{QPassSignals}
36867 @item @samp{QStartNoAckMode}
36872 @item @samp{multiprocess}
36877 @item @samp{ConditionalBreakpoints}
36882 @item @samp{ConditionalTracepoints}
36887 @item @samp{ReverseContinue}
36892 @item @samp{ReverseStep}
36897 @item @samp{TracepointSource}
36902 @item @samp{QAgent}
36907 @item @samp{QAllow}
36912 @item @samp{QDisableRandomization}
36917 @item @samp{EnableDisableTracepoints}
36922 @item @samp{QTBuffer:size}
36927 @item @samp{tracenz}
36932 @item @samp{BreakpointCommands}
36937 @item @samp{swbreak}
36942 @item @samp{hwbreak}
36947 @item @samp{fork-events}
36952 @item @samp{vfork-events}
36957 @item @samp{exec-events}
36962 @item @samp{QThreadEvents}
36967 @item @samp{no-resumed}
36974 These are the currently defined stub features, in more detail:
36977 @cindex packet size, remote protocol
36978 @item PacketSize=@var{bytes}
36979 The remote stub can accept packets up to at least @var{bytes} in
36980 length. @value{GDBN} will send packets up to this size for bulk
36981 transfers, and will never send larger packets. This is a limit on the
36982 data characters in the packet, including the frame and checksum.
36983 There is no trailing NUL byte in a remote protocol packet; if the stub
36984 stores packets in a NUL-terminated format, it should allow an extra
36985 byte in its buffer for the NUL. If this stub feature is not supported,
36986 @value{GDBN} guesses based on the size of the @samp{g} packet response.
36988 @item qXfer:auxv:read
36989 The remote stub understands the @samp{qXfer:auxv:read} packet
36990 (@pxref{qXfer auxiliary vector read}).
36992 @item qXfer:btrace:read
36993 The remote stub understands the @samp{qXfer:btrace:read}
36994 packet (@pxref{qXfer btrace read}).
36996 @item qXfer:btrace-conf:read
36997 The remote stub understands the @samp{qXfer:btrace-conf:read}
36998 packet (@pxref{qXfer btrace-conf read}).
37000 @item qXfer:exec-file:read
37001 The remote stub understands the @samp{qXfer:exec-file:read} packet
37002 (@pxref{qXfer executable filename read}).
37004 @item qXfer:features:read
37005 The remote stub understands the @samp{qXfer:features:read} packet
37006 (@pxref{qXfer target description read}).
37008 @item qXfer:libraries:read
37009 The remote stub understands the @samp{qXfer:libraries:read} packet
37010 (@pxref{qXfer library list read}).
37012 @item qXfer:libraries-svr4:read
37013 The remote stub understands the @samp{qXfer:libraries-svr4:read} packet
37014 (@pxref{qXfer svr4 library list read}).
37016 @item augmented-libraries-svr4-read
37017 The remote stub understands the augmented form of the
37018 @samp{qXfer:libraries-svr4:read} packet
37019 (@pxref{qXfer svr4 library list read}).
37021 @item qXfer:memory-map:read
37022 The remote stub understands the @samp{qXfer:memory-map:read} packet
37023 (@pxref{qXfer memory map read}).
37025 @item qXfer:sdata:read
37026 The remote stub understands the @samp{qXfer:sdata:read} packet
37027 (@pxref{qXfer sdata read}).
37029 @item qXfer:spu:read
37030 The remote stub understands the @samp{qXfer:spu:read} packet
37031 (@pxref{qXfer spu read}).
37033 @item qXfer:spu:write
37034 The remote stub understands the @samp{qXfer:spu:write} packet
37035 (@pxref{qXfer spu write}).
37037 @item qXfer:siginfo:read
37038 The remote stub understands the @samp{qXfer:siginfo:read} packet
37039 (@pxref{qXfer siginfo read}).
37041 @item qXfer:siginfo:write
37042 The remote stub understands the @samp{qXfer:siginfo:write} packet
37043 (@pxref{qXfer siginfo write}).
37045 @item qXfer:threads:read
37046 The remote stub understands the @samp{qXfer:threads:read} packet
37047 (@pxref{qXfer threads read}).
37049 @item qXfer:traceframe-info:read
37050 The remote stub understands the @samp{qXfer:traceframe-info:read}
37051 packet (@pxref{qXfer traceframe info read}).
37053 @item qXfer:uib:read
37054 The remote stub understands the @samp{qXfer:uib:read}
37055 packet (@pxref{qXfer unwind info block}).
37057 @item qXfer:fdpic:read
37058 The remote stub understands the @samp{qXfer:fdpic:read}
37059 packet (@pxref{qXfer fdpic loadmap read}).
37062 The remote stub understands the @samp{QNonStop} packet
37063 (@pxref{QNonStop}).
37065 @item QCatchSyscalls
37066 The remote stub understands the @samp{QCatchSyscalls} packet
37067 (@pxref{QCatchSyscalls}).
37070 The remote stub understands the @samp{QPassSignals} packet
37071 (@pxref{QPassSignals}).
37073 @item QStartNoAckMode
37074 The remote stub understands the @samp{QStartNoAckMode} packet and
37075 prefers to operate in no-acknowledgment mode. @xref{Packet Acknowledgment}.
37078 @anchor{multiprocess extensions}
37079 @cindex multiprocess extensions, in remote protocol
37080 The remote stub understands the multiprocess extensions to the remote
37081 protocol syntax. The multiprocess extensions affect the syntax of
37082 thread IDs in both packets and replies (@pxref{thread-id syntax}), and
37083 add process IDs to the @samp{D} packet and @samp{W} and @samp{X}
37084 replies. Note that reporting this feature indicates support for the
37085 syntactic extensions only, not that the stub necessarily supports
37086 debugging of more than one process at a time. The stub must not use
37087 multiprocess extensions in packet replies unless @value{GDBN} has also
37088 indicated it supports them in its @samp{qSupported} request.
37090 @item qXfer:osdata:read
37091 The remote stub understands the @samp{qXfer:osdata:read} packet
37092 ((@pxref{qXfer osdata read}).
37094 @item ConditionalBreakpoints
37095 The target accepts and implements evaluation of conditional expressions
37096 defined for breakpoints. The target will only report breakpoint triggers
37097 when such conditions are true (@pxref{Conditions, ,Break Conditions}).
37099 @item ConditionalTracepoints
37100 The remote stub accepts and implements conditional expressions defined
37101 for tracepoints (@pxref{Tracepoint Conditions}).
37103 @item ReverseContinue
37104 The remote stub accepts and implements the reverse continue packet
37108 The remote stub accepts and implements the reverse step packet
37111 @item TracepointSource
37112 The remote stub understands the @samp{QTDPsrc} packet that supplies
37113 the source form of tracepoint definitions.
37116 The remote stub understands the @samp{QAgent} packet.
37119 The remote stub understands the @samp{QAllow} packet.
37121 @item QDisableRandomization
37122 The remote stub understands the @samp{QDisableRandomization} packet.
37124 @item StaticTracepoint
37125 @cindex static tracepoints, in remote protocol
37126 The remote stub supports static tracepoints.
37128 @item InstallInTrace
37129 @anchor{install tracepoint in tracing}
37130 The remote stub supports installing tracepoint in tracing.
37132 @item EnableDisableTracepoints
37133 The remote stub supports the @samp{QTEnable} (@pxref{QTEnable}) and
37134 @samp{QTDisable} (@pxref{QTDisable}) packets that allow tracepoints
37135 to be enabled and disabled while a trace experiment is running.
37137 @item QTBuffer:size
37138 The remote stub supports the @samp{QTBuffer:size} (@pxref{QTBuffer-size})
37139 packet that allows to change the size of the trace buffer.
37142 @cindex string tracing, in remote protocol
37143 The remote stub supports the @samp{tracenz} bytecode for collecting strings.
37144 See @ref{Bytecode Descriptions} for details about the bytecode.
37146 @item BreakpointCommands
37147 @cindex breakpoint commands, in remote protocol
37148 The remote stub supports running a breakpoint's command list itself,
37149 rather than reporting the hit to @value{GDBN}.
37152 The remote stub understands the @samp{Qbtrace:off} packet.
37155 The remote stub understands the @samp{Qbtrace:bts} packet.
37158 The remote stub understands the @samp{Qbtrace:pt} packet.
37160 @item Qbtrace-conf:bts:size
37161 The remote stub understands the @samp{Qbtrace-conf:bts:size} packet.
37163 @item Qbtrace-conf:pt:size
37164 The remote stub understands the @samp{Qbtrace-conf:pt:size} packet.
37167 The remote stub reports the @samp{swbreak} stop reason for memory
37171 The remote stub reports the @samp{hwbreak} stop reason for hardware
37175 The remote stub reports the @samp{fork} stop reason for fork events.
37178 The remote stub reports the @samp{vfork} stop reason for vfork events
37179 and vforkdone events.
37182 The remote stub reports the @samp{exec} stop reason for exec events.
37184 @item vContSupported
37185 The remote stub reports the supported actions in the reply to
37186 @samp{vCont?} packet.
37188 @item QThreadEvents
37189 The remote stub understands the @samp{QThreadEvents} packet.
37192 The remote stub reports the @samp{N} stop reply.
37197 @cindex symbol lookup, remote request
37198 @cindex @samp{qSymbol} packet
37199 Notify the target that @value{GDBN} is prepared to serve symbol lookup
37200 requests. Accept requests from the target for the values of symbols.
37205 The target does not need to look up any (more) symbols.
37206 @item qSymbol:@var{sym_name}
37207 The target requests the value of symbol @var{sym_name} (hex encoded).
37208 @value{GDBN} may provide the value by using the
37209 @samp{qSymbol:@var{sym_value}:@var{sym_name}} message, described
37213 @item qSymbol:@var{sym_value}:@var{sym_name}
37214 Set the value of @var{sym_name} to @var{sym_value}.
37216 @var{sym_name} (hex encoded) is the name of a symbol whose value the
37217 target has previously requested.
37219 @var{sym_value} (hex) is the value for symbol @var{sym_name}. If
37220 @value{GDBN} cannot supply a value for @var{sym_name}, then this field
37226 The target does not need to look up any (more) symbols.
37227 @item qSymbol:@var{sym_name}
37228 The target requests the value of a new symbol @var{sym_name} (hex
37229 encoded). @value{GDBN} will continue to supply the values of symbols
37230 (if available), until the target ceases to request them.
37235 @itemx QTDisconnected
37242 @itemx qTMinFTPILen
37244 @xref{Tracepoint Packets}.
37246 @item qThreadExtraInfo,@var{thread-id}
37247 @cindex thread attributes info, remote request
37248 @cindex @samp{qThreadExtraInfo} packet
37249 Obtain from the target OS a printable string description of thread
37250 attributes for the thread @var{thread-id}; see @ref{thread-id syntax},
37251 for the forms of @var{thread-id}. This
37252 string may contain anything that the target OS thinks is interesting
37253 for @value{GDBN} to tell the user about the thread. The string is
37254 displayed in @value{GDBN}'s @code{info threads} display. Some
37255 examples of possible thread extra info strings are @samp{Runnable}, or
37256 @samp{Blocked on Mutex}.
37260 @item @var{XX}@dots{}
37261 Where @samp{@var{XX}@dots{}} is a hex encoding of @sc{ascii} data,
37262 comprising the printable string containing the extra information about
37263 the thread's attributes.
37266 (Note that the @code{qThreadExtraInfo} packet's name is separated from
37267 the command by a @samp{,}, not a @samp{:}, contrary to the naming
37268 conventions above. Please don't use this packet as a model for new
37287 @xref{Tracepoint Packets}.
37289 @item qXfer:@var{object}:read:@var{annex}:@var{offset},@var{length}
37290 @cindex read special object, remote request
37291 @cindex @samp{qXfer} packet
37292 @anchor{qXfer read}
37293 Read uninterpreted bytes from the target's special data area
37294 identified by the keyword @var{object}. Request @var{length} bytes
37295 starting at @var{offset} bytes into the data. The content and
37296 encoding of @var{annex} is specific to @var{object}; it can supply
37297 additional details about what data to access.
37299 Here are the specific requests of this form defined so far. All
37300 @samp{qXfer:@var{object}:read:@dots{}} requests use the same reply
37301 formats, listed below.
37304 @item qXfer:auxv:read::@var{offset},@var{length}
37305 @anchor{qXfer auxiliary vector read}
37306 Access the target's @dfn{auxiliary vector}. @xref{OS Information,
37307 auxiliary vector}. Note @var{annex} must be empty.
37309 This packet is not probed by default; the remote stub must request it,
37310 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
37312 @item qXfer:btrace:read:@var{annex}:@var{offset},@var{length}
37313 @anchor{qXfer btrace read}
37315 Return a description of the current branch trace.
37316 @xref{Branch Trace Format}. The annex part of the generic @samp{qXfer}
37317 packet may have one of the following values:
37321 Returns all available branch trace.
37324 Returns all available branch trace if the branch trace changed since
37325 the last read request.
37328 Returns the new branch trace since the last read request. Adds a new
37329 block to the end of the trace that begins at zero and ends at the source
37330 location of the first branch in the trace buffer. This extra block is
37331 used to stitch traces together.
37333 If the trace buffer overflowed, returns an error indicating the overflow.
37336 This packet is not probed by default; the remote stub must request it
37337 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
37339 @item qXfer:btrace-conf:read::@var{offset},@var{length}
37340 @anchor{qXfer btrace-conf read}
37342 Return a description of the current branch trace configuration.
37343 @xref{Branch Trace Configuration Format}.
37345 This packet is not probed by default; the remote stub must request it
37346 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
37348 @item qXfer:exec-file:read:@var{annex}:@var{offset},@var{length}
37349 @anchor{qXfer executable filename read}
37350 Return the full absolute name of the file that was executed to create
37351 a process running on the remote system. The annex specifies the
37352 numeric process ID of the process to query, encoded as a hexadecimal
37353 number. If the annex part is empty the remote stub should return the
37354 filename corresponding to the currently executing process.
37356 This packet is not probed by default; the remote stub must request it,
37357 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
37359 @item qXfer:features:read:@var{annex}:@var{offset},@var{length}
37360 @anchor{qXfer target description read}
37361 Access the @dfn{target description}. @xref{Target Descriptions}. The
37362 annex specifies which XML document to access. The main description is
37363 always loaded from the @samp{target.xml} annex.
37365 This packet is not probed by default; the remote stub must request it,
37366 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
37368 @item qXfer:libraries:read:@var{annex}:@var{offset},@var{length}
37369 @anchor{qXfer library list read}
37370 Access the target's list of loaded libraries. @xref{Library List Format}.
37371 The annex part of the generic @samp{qXfer} packet must be empty
37372 (@pxref{qXfer read}).
37374 Targets which maintain a list of libraries in the program's memory do
37375 not need to implement this packet; it is designed for platforms where
37376 the operating system manages the list of loaded libraries.
37378 This packet is not probed by default; the remote stub must request it,
37379 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
37381 @item qXfer:libraries-svr4:read:@var{annex}:@var{offset},@var{length}
37382 @anchor{qXfer svr4 library list read}
37383 Access the target's list of loaded libraries when the target is an SVR4
37384 platform. @xref{Library List Format for SVR4 Targets}. The annex part
37385 of the generic @samp{qXfer} packet must be empty unless the remote
37386 stub indicated it supports the augmented form of this packet
37387 by supplying an appropriate @samp{qSupported} response
37388 (@pxref{qXfer read}, @ref{qSupported}).
37390 This packet is optional for better performance on SVR4 targets.
37391 @value{GDBN} uses memory read packets to read the SVR4 library list otherwise.
37393 This packet is not probed by default; the remote stub must request it,
37394 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
37396 If the remote stub indicates it supports the augmented form of this
37397 packet then the annex part of the generic @samp{qXfer} packet may
37398 contain a semicolon-separated list of @samp{@var{name}=@var{value}}
37399 arguments. The currently supported arguments are:
37402 @item start=@var{address}
37403 A hexadecimal number specifying the address of the @samp{struct
37404 link_map} to start reading the library list from. If unset or zero
37405 then the first @samp{struct link_map} in the library list will be
37406 chosen as the starting point.
37408 @item prev=@var{address}
37409 A hexadecimal number specifying the address of the @samp{struct
37410 link_map} immediately preceding the @samp{struct link_map}
37411 specified by the @samp{start} argument. If unset or zero then
37412 the remote stub will expect that no @samp{struct link_map}
37413 exists prior to the starting point.
37417 Arguments that are not understood by the remote stub will be silently
37420 @item qXfer:memory-map:read::@var{offset},@var{length}
37421 @anchor{qXfer memory map read}
37422 Access the target's @dfn{memory-map}. @xref{Memory Map Format}. The
37423 annex part of the generic @samp{qXfer} packet must be empty
37424 (@pxref{qXfer read}).
37426 This packet is not probed by default; the remote stub must request it,
37427 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
37429 @item qXfer:sdata:read::@var{offset},@var{length}
37430 @anchor{qXfer sdata read}
37432 Read contents of the extra collected static tracepoint marker
37433 information. The annex part of the generic @samp{qXfer} packet must
37434 be empty (@pxref{qXfer read}). @xref{Tracepoint Actions,,Tracepoint
37437 This packet is not probed by default; the remote stub must request it,
37438 by supplying an appropriate @samp{qSupported} response
37439 (@pxref{qSupported}).
37441 @item qXfer:siginfo:read::@var{offset},@var{length}
37442 @anchor{qXfer siginfo read}
37443 Read contents of the extra signal information on the target
37444 system. The annex part of the generic @samp{qXfer} packet must be
37445 empty (@pxref{qXfer read}).
37447 This packet is not probed by default; the remote stub must request it,
37448 by supplying an appropriate @samp{qSupported} response
37449 (@pxref{qSupported}).
37451 @item qXfer:spu:read:@var{annex}:@var{offset},@var{length}
37452 @anchor{qXfer spu read}
37453 Read contents of an @code{spufs} file on the target system. The
37454 annex specifies which file to read; it must be of the form
37455 @file{@var{id}/@var{name}}, where @var{id} specifies an SPU context ID
37456 in the target process, and @var{name} identifes the @code{spufs} file
37457 in that context to be accessed.
37459 This packet is not probed by default; the remote stub must request it,
37460 by supplying an appropriate @samp{qSupported} response
37461 (@pxref{qSupported}).
37463 @item qXfer:threads:read::@var{offset},@var{length}
37464 @anchor{qXfer threads read}
37465 Access the list of threads on target. @xref{Thread List Format}. The
37466 annex part of the generic @samp{qXfer} packet must be empty
37467 (@pxref{qXfer read}).
37469 This packet is not probed by default; the remote stub must request it,
37470 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
37472 @item qXfer:traceframe-info:read::@var{offset},@var{length}
37473 @anchor{qXfer traceframe info read}
37475 Return a description of the current traceframe's contents.
37476 @xref{Traceframe Info Format}. The annex part of the generic
37477 @samp{qXfer} packet must be empty (@pxref{qXfer read}).
37479 This packet is not probed by default; the remote stub must request it,
37480 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
37482 @item qXfer:uib:read:@var{pc}:@var{offset},@var{length}
37483 @anchor{qXfer unwind info block}
37485 Return the unwind information block for @var{pc}. This packet is used
37486 on OpenVMS/ia64 to ask the kernel unwind information.
37488 This packet is not probed by default.
37490 @item qXfer:fdpic:read:@var{annex}:@var{offset},@var{length}
37491 @anchor{qXfer fdpic loadmap read}
37492 Read contents of @code{loadmap}s on the target system. The
37493 annex, either @samp{exec} or @samp{interp}, specifies which @code{loadmap},
37494 executable @code{loadmap} or interpreter @code{loadmap} to read.
37496 This packet is not probed by default; the remote stub must request it,
37497 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
37499 @item qXfer:osdata:read::@var{offset},@var{length}
37500 @anchor{qXfer osdata read}
37501 Access the target's @dfn{operating system information}.
37502 @xref{Operating System Information}.
37509 Data @var{data} (@pxref{Binary Data}) has been read from the
37510 target. There may be more data at a higher address (although
37511 it is permitted to return @samp{m} even for the last valid
37512 block of data, as long as at least one byte of data was read).
37513 It is possible for @var{data} to have fewer bytes than the @var{length} in the
37517 Data @var{data} (@pxref{Binary Data}) has been read from the target.
37518 There is no more data to be read. It is possible for @var{data} to
37519 have fewer bytes than the @var{length} in the request.
37522 The @var{offset} in the request is at the end of the data.
37523 There is no more data to be read.
37526 The request was malformed, or @var{annex} was invalid.
37529 The offset was invalid, or there was an error encountered reading the data.
37530 The @var{nn} part is a hex-encoded @code{errno} value.
37533 An empty reply indicates the @var{object} string was not recognized by
37534 the stub, or that the object does not support reading.
37537 @item qXfer:@var{object}:write:@var{annex}:@var{offset}:@var{data}@dots{}
37538 @cindex write data into object, remote request
37539 @anchor{qXfer write}
37540 Write uninterpreted bytes into the target's special data area
37541 identified by the keyword @var{object}, starting at @var{offset} bytes
37542 into the data. The binary-encoded data (@pxref{Binary Data}) to be
37543 written is given by @var{data}@dots{}. The content and encoding of @var{annex}
37544 is specific to @var{object}; it can supply additional details about what data
37547 Here are the specific requests of this form defined so far. All
37548 @samp{qXfer:@var{object}:write:@dots{}} requests use the same reply
37549 formats, listed below.
37552 @item qXfer:siginfo:write::@var{offset}:@var{data}@dots{}
37553 @anchor{qXfer siginfo write}
37554 Write @var{data} to the extra signal information on the target system.
37555 The annex part of the generic @samp{qXfer} packet must be
37556 empty (@pxref{qXfer write}).
37558 This packet is not probed by default; the remote stub must request it,
37559 by supplying an appropriate @samp{qSupported} response
37560 (@pxref{qSupported}).
37562 @item qXfer:spu:write:@var{annex}:@var{offset}:@var{data}@dots{}
37563 @anchor{qXfer spu write}
37564 Write @var{data} to an @code{spufs} file on the target system. The
37565 annex specifies which file to write; it must be of the form
37566 @file{@var{id}/@var{name}}, where @var{id} specifies an SPU context ID
37567 in the target process, and @var{name} identifes the @code{spufs} file
37568 in that context to be accessed.
37570 This packet is not probed by default; the remote stub must request it,
37571 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
37577 @var{nn} (hex encoded) is the number of bytes written.
37578 This may be fewer bytes than supplied in the request.
37581 The request was malformed, or @var{annex} was invalid.
37584 The offset was invalid, or there was an error encountered writing the data.
37585 The @var{nn} part is a hex-encoded @code{errno} value.
37588 An empty reply indicates the @var{object} string was not
37589 recognized by the stub, or that the object does not support writing.
37592 @item qXfer:@var{object}:@var{operation}:@dots{}
37593 Requests of this form may be added in the future. When a stub does
37594 not recognize the @var{object} keyword, or its support for
37595 @var{object} does not recognize the @var{operation} keyword, the stub
37596 must respond with an empty packet.
37598 @item qAttached:@var{pid}
37599 @cindex query attached, remote request
37600 @cindex @samp{qAttached} packet
37601 Return an indication of whether the remote server attached to an
37602 existing process or created a new process. When the multiprocess
37603 protocol extensions are supported (@pxref{multiprocess extensions}),
37604 @var{pid} is an integer in hexadecimal format identifying the target
37605 process. Otherwise, @value{GDBN} will omit the @var{pid} field and
37606 the query packet will be simplified as @samp{qAttached}.
37608 This query is used, for example, to know whether the remote process
37609 should be detached or killed when a @value{GDBN} session is ended with
37610 the @code{quit} command.
37615 The remote server attached to an existing process.
37617 The remote server created a new process.
37619 A badly formed request or an error was encountered.
37623 Enable branch tracing for the current thread using Branch Trace Store.
37628 Branch tracing has been enabled.
37630 A badly formed request or an error was encountered.
37634 Enable branch tracing for the current thread using Intel Processor Trace.
37639 Branch tracing has been enabled.
37641 A badly formed request or an error was encountered.
37645 Disable branch tracing for the current thread.
37650 Branch tracing has been disabled.
37652 A badly formed request or an error was encountered.
37655 @item Qbtrace-conf:bts:size=@var{value}
37656 Set the requested ring buffer size for new threads that use the
37657 btrace recording method in bts format.
37662 The ring buffer size has been set.
37664 A badly formed request or an error was encountered.
37667 @item Qbtrace-conf:pt:size=@var{value}
37668 Set the requested ring buffer size for new threads that use the
37669 btrace recording method in pt format.
37674 The ring buffer size has been set.
37676 A badly formed request or an error was encountered.
37681 @node Architecture-Specific Protocol Details
37682 @section Architecture-Specific Protocol Details
37684 This section describes how the remote protocol is applied to specific
37685 target architectures. Also see @ref{Standard Target Features}, for
37686 details of XML target descriptions for each architecture.
37689 * ARM-Specific Protocol Details::
37690 * MIPS-Specific Protocol Details::
37693 @node ARM-Specific Protocol Details
37694 @subsection @acronym{ARM}-specific Protocol Details
37697 * ARM Breakpoint Kinds::
37700 @node ARM Breakpoint Kinds
37701 @subsubsection @acronym{ARM} Breakpoint Kinds
37702 @cindex breakpoint kinds, @acronym{ARM}
37704 These breakpoint kinds are defined for the @samp{Z0} and @samp{Z1} packets.
37709 16-bit Thumb mode breakpoint.
37712 32-bit Thumb mode (Thumb-2) breakpoint.
37715 32-bit @acronym{ARM} mode breakpoint.
37719 @node MIPS-Specific Protocol Details
37720 @subsection @acronym{MIPS}-specific Protocol Details
37723 * MIPS Register packet Format::
37724 * MIPS Breakpoint Kinds::
37727 @node MIPS Register packet Format
37728 @subsubsection @acronym{MIPS} Register Packet Format
37729 @cindex register packet format, @acronym{MIPS}
37731 The following @code{g}/@code{G} packets have previously been defined.
37732 In the below, some thirty-two bit registers are transferred as
37733 sixty-four bits. Those registers should be zero/sign extended (which?)
37734 to fill the space allocated. Register bytes are transferred in target
37735 byte order. The two nibbles within a register byte are transferred
37736 most-significant -- least-significant.
37741 All registers are transferred as thirty-two bit quantities in the order:
37742 32 general-purpose; sr; lo; hi; bad; cause; pc; 32 floating-point
37743 registers; fsr; fir; fp.
37746 All registers are transferred as sixty-four bit quantities (including
37747 thirty-two bit registers such as @code{sr}). The ordering is the same
37752 @node MIPS Breakpoint Kinds
37753 @subsubsection @acronym{MIPS} Breakpoint Kinds
37754 @cindex breakpoint kinds, @acronym{MIPS}
37756 These breakpoint kinds are defined for the @samp{Z0} and @samp{Z1} packets.
37761 16-bit @acronym{MIPS16} mode breakpoint.
37764 16-bit @acronym{microMIPS} mode breakpoint.
37767 32-bit standard @acronym{MIPS} mode breakpoint.
37770 32-bit @acronym{microMIPS} mode breakpoint.
37774 @node Tracepoint Packets
37775 @section Tracepoint Packets
37776 @cindex tracepoint packets
37777 @cindex packets, tracepoint
37779 Here we describe the packets @value{GDBN} uses to implement
37780 tracepoints (@pxref{Tracepoints}).
37784 @item QTDP:@var{n}:@var{addr}:@var{ena}:@var{step}:@var{pass}[:F@var{flen}][:X@var{len},@var{bytes}]@r{[}-@r{]}
37785 @cindex @samp{QTDP} packet
37786 Create a new tracepoint, number @var{n}, at @var{addr}. If @var{ena}
37787 is @samp{E}, then the tracepoint is enabled; if it is @samp{D}, then
37788 the tracepoint is disabled. The @var{step} gives the tracepoint's step
37789 count, and @var{pass} gives its pass count. If an @samp{F} is present,
37790 then the tracepoint is to be a fast tracepoint, and the @var{flen} is
37791 the number of bytes that the target should copy elsewhere to make room
37792 for the tracepoint. If an @samp{X} is present, it introduces a
37793 tracepoint condition, which consists of a hexadecimal length, followed
37794 by a comma and hex-encoded bytes, in a manner similar to action
37795 encodings as described below. If the trailing @samp{-} is present,
37796 further @samp{QTDP} packets will follow to specify this tracepoint's
37802 The packet was understood and carried out.
37804 @xref{Tracepoint Packets,,Relocate instruction reply packet}.
37806 The packet was not recognized.
37809 @item QTDP:-@var{n}:@var{addr}:@r{[}S@r{]}@var{action}@dots{}@r{[}-@r{]}
37810 Define actions to be taken when a tracepoint is hit. The @var{n} and
37811 @var{addr} must be the same as in the initial @samp{QTDP} packet for
37812 this tracepoint. This packet may only be sent immediately after
37813 another @samp{QTDP} packet that ended with a @samp{-}. If the
37814 trailing @samp{-} is present, further @samp{QTDP} packets will follow,
37815 specifying more actions for this tracepoint.
37817 In the series of action packets for a given tracepoint, at most one
37818 can have an @samp{S} before its first @var{action}. If such a packet
37819 is sent, it and the following packets define ``while-stepping''
37820 actions. Any prior packets define ordinary actions --- that is, those
37821 taken when the tracepoint is first hit. If no action packet has an
37822 @samp{S}, then all the packets in the series specify ordinary
37823 tracepoint actions.
37825 The @samp{@var{action}@dots{}} portion of the packet is a series of
37826 actions, concatenated without separators. Each action has one of the
37832 Collect the registers whose bits are set in @var{mask},
37833 a hexadecimal number whose @var{i}'th bit is set if register number
37834 @var{i} should be collected. (The least significant bit is numbered
37835 zero.) Note that @var{mask} may be any number of digits long; it may
37836 not fit in a 32-bit word.
37838 @item M @var{basereg},@var{offset},@var{len}
37839 Collect @var{len} bytes of memory starting at the address in register
37840 number @var{basereg}, plus @var{offset}. If @var{basereg} is
37841 @samp{-1}, then the range has a fixed address: @var{offset} is the
37842 address of the lowest byte to collect. The @var{basereg},
37843 @var{offset}, and @var{len} parameters are all unsigned hexadecimal
37844 values (the @samp{-1} value for @var{basereg} is a special case).
37846 @item X @var{len},@var{expr}
37847 Evaluate @var{expr}, whose length is @var{len}, and collect memory as
37848 it directs. The agent expression @var{expr} is as described in
37849 @ref{Agent Expressions}. Each byte of the expression is encoded as a
37850 two-digit hex number in the packet; @var{len} is the number of bytes
37851 in the expression (and thus one-half the number of hex digits in the
37856 Any number of actions may be packed together in a single @samp{QTDP}
37857 packet, as long as the packet does not exceed the maximum packet
37858 length (400 bytes, for many stubs). There may be only one @samp{R}
37859 action per tracepoint, and it must precede any @samp{M} or @samp{X}
37860 actions. Any registers referred to by @samp{M} and @samp{X} actions
37861 must be collected by a preceding @samp{R} action. (The
37862 ``while-stepping'' actions are treated as if they were attached to a
37863 separate tracepoint, as far as these restrictions are concerned.)
37868 The packet was understood and carried out.
37870 @xref{Tracepoint Packets,,Relocate instruction reply packet}.
37872 The packet was not recognized.
37875 @item QTDPsrc:@var{n}:@var{addr}:@var{type}:@var{start}:@var{slen}:@var{bytes}
37876 @cindex @samp{QTDPsrc} packet
37877 Specify a source string of tracepoint @var{n} at address @var{addr}.
37878 This is useful to get accurate reproduction of the tracepoints
37879 originally downloaded at the beginning of the trace run. The @var{type}
37880 is the name of the tracepoint part, such as @samp{cond} for the
37881 tracepoint's conditional expression (see below for a list of types), while
37882 @var{bytes} is the string, encoded in hexadecimal.
37884 @var{start} is the offset of the @var{bytes} within the overall source
37885 string, while @var{slen} is the total length of the source string.
37886 This is intended for handling source strings that are longer than will
37887 fit in a single packet.
37888 @c Add detailed example when this info is moved into a dedicated
37889 @c tracepoint descriptions section.
37891 The available string types are @samp{at} for the location,
37892 @samp{cond} for the conditional, and @samp{cmd} for an action command.
37893 @value{GDBN} sends a separate packet for each command in the action
37894 list, in the same order in which the commands are stored in the list.
37896 The target does not need to do anything with source strings except
37897 report them back as part of the replies to the @samp{qTfP}/@samp{qTsP}
37900 Although this packet is optional, and @value{GDBN} will only send it
37901 if the target replies with @samp{TracepointSource} @xref{General
37902 Query Packets}, it makes both disconnected tracing and trace files
37903 much easier to use. Otherwise the user must be careful that the
37904 tracepoints in effect while looking at trace frames are identical to
37905 the ones in effect during the trace run; even a small discrepancy
37906 could cause @samp{tdump} not to work, or a particular trace frame not
37909 @item QTDV:@var{n}:@var{value}:@var{builtin}:@var{name}
37910 @cindex define trace state variable, remote request
37911 @cindex @samp{QTDV} packet
37912 Create a new trace state variable, number @var{n}, with an initial
37913 value of @var{value}, which is a 64-bit signed integer. Both @var{n}
37914 and @var{value} are encoded as hexadecimal values. @value{GDBN} has
37915 the option of not using this packet for initial values of zero; the
37916 target should simply create the trace state variables as they are
37917 mentioned in expressions. The value @var{builtin} should be 1 (one)
37918 if the trace state variable is builtin and 0 (zero) if it is not builtin.
37919 @value{GDBN} only sets @var{builtin} to 1 if a previous @samp{qTfV} or
37920 @samp{qTsV} packet had it set. The contents of @var{name} is the
37921 hex-encoded name (without the leading @samp{$}) of the trace state
37924 @item QTFrame:@var{n}
37925 @cindex @samp{QTFrame} packet
37926 Select the @var{n}'th tracepoint frame from the buffer, and use the
37927 register and memory contents recorded there to answer subsequent
37928 request packets from @value{GDBN}.
37930 A successful reply from the stub indicates that the stub has found the
37931 requested frame. The response is a series of parts, concatenated
37932 without separators, describing the frame we selected. Each part has
37933 one of the following forms:
37937 The selected frame is number @var{n} in the trace frame buffer;
37938 @var{f} is a hexadecimal number. If @var{f} is @samp{-1}, then there
37939 was no frame matching the criteria in the request packet.
37942 The selected trace frame records a hit of tracepoint number @var{t};
37943 @var{t} is a hexadecimal number.
37947 @item QTFrame:pc:@var{addr}
37948 Like @samp{QTFrame:@var{n}}, but select the first tracepoint frame after the
37949 currently selected frame whose PC is @var{addr};
37950 @var{addr} is a hexadecimal number.
37952 @item QTFrame:tdp:@var{t}
37953 Like @samp{QTFrame:@var{n}}, but select the first tracepoint frame after the
37954 currently selected frame that is a hit of tracepoint @var{t}; @var{t}
37955 is a hexadecimal number.
37957 @item QTFrame:range:@var{start}:@var{end}
37958 Like @samp{QTFrame:@var{n}}, but select the first tracepoint frame after the
37959 currently selected frame whose PC is between @var{start} (inclusive)
37960 and @var{end} (inclusive); @var{start} and @var{end} are hexadecimal
37963 @item QTFrame:outside:@var{start}:@var{end}
37964 Like @samp{QTFrame:range:@var{start}:@var{end}}, but select the first
37965 frame @emph{outside} the given range of addresses (exclusive).
37968 @cindex @samp{qTMinFTPILen} packet
37969 This packet requests the minimum length of instruction at which a fast
37970 tracepoint (@pxref{Set Tracepoints}) may be placed. For instance, on
37971 the 32-bit x86 architecture, it is possible to use a 4-byte jump, but
37972 it depends on the target system being able to create trampolines in
37973 the first 64K of memory, which might or might not be possible for that
37974 system. So the reply to this packet will be 4 if it is able to
37981 The minimum instruction length is currently unknown.
37983 The minimum instruction length is @var{length}, where @var{length}
37984 is a hexadecimal number greater or equal to 1. A reply
37985 of 1 means that a fast tracepoint may be placed on any instruction
37986 regardless of size.
37988 An error has occurred.
37990 An empty reply indicates that the request is not supported by the stub.
37994 @cindex @samp{QTStart} packet
37995 Begin the tracepoint experiment. Begin collecting data from
37996 tracepoint hits in the trace frame buffer. This packet supports the
37997 @samp{qRelocInsn} reply (@pxref{Tracepoint Packets,,Relocate
37998 instruction reply packet}).
38001 @cindex @samp{QTStop} packet
38002 End the tracepoint experiment. Stop collecting trace frames.
38004 @item QTEnable:@var{n}:@var{addr}
38006 @cindex @samp{QTEnable} packet
38007 Enable tracepoint @var{n} at address @var{addr} in a started tracepoint
38008 experiment. If the tracepoint was previously disabled, then collection
38009 of data from it will resume.
38011 @item QTDisable:@var{n}:@var{addr}
38013 @cindex @samp{QTDisable} packet
38014 Disable tracepoint @var{n} at address @var{addr} in a started tracepoint
38015 experiment. No more data will be collected from the tracepoint unless
38016 @samp{QTEnable:@var{n}:@var{addr}} is subsequently issued.
38019 @cindex @samp{QTinit} packet
38020 Clear the table of tracepoints, and empty the trace frame buffer.
38022 @item QTro:@var{start1},@var{end1}:@var{start2},@var{end2}:@dots{}
38023 @cindex @samp{QTro} packet
38024 Establish the given ranges of memory as ``transparent''. The stub
38025 will answer requests for these ranges from memory's current contents,
38026 if they were not collected as part of the tracepoint hit.
38028 @value{GDBN} uses this to mark read-only regions of memory, like those
38029 containing program code. Since these areas never change, they should
38030 still have the same contents they did when the tracepoint was hit, so
38031 there's no reason for the stub to refuse to provide their contents.
38033 @item QTDisconnected:@var{value}
38034 @cindex @samp{QTDisconnected} packet
38035 Set the choice to what to do with the tracing run when @value{GDBN}
38036 disconnects from the target. A @var{value} of 1 directs the target to
38037 continue the tracing run, while 0 tells the target to stop tracing if
38038 @value{GDBN} is no longer in the picture.
38041 @cindex @samp{qTStatus} packet
38042 Ask the stub if there is a trace experiment running right now.
38044 The reply has the form:
38048 @item T@var{running}@r{[};@var{field}@r{]}@dots{}
38049 @var{running} is a single digit @code{1} if the trace is presently
38050 running, or @code{0} if not. It is followed by semicolon-separated
38051 optional fields that an agent may use to report additional status.
38055 If the trace is not running, the agent may report any of several
38056 explanations as one of the optional fields:
38061 No trace has been run yet.
38063 @item tstop[:@var{text}]:0
38064 The trace was stopped by a user-originated stop command. The optional
38065 @var{text} field is a user-supplied string supplied as part of the
38066 stop command (for instance, an explanation of why the trace was
38067 stopped manually). It is hex-encoded.
38070 The trace stopped because the trace buffer filled up.
38072 @item tdisconnected:0
38073 The trace stopped because @value{GDBN} disconnected from the target.
38075 @item tpasscount:@var{tpnum}
38076 The trace stopped because tracepoint @var{tpnum} exceeded its pass count.
38078 @item terror:@var{text}:@var{tpnum}
38079 The trace stopped because tracepoint @var{tpnum} had an error. The
38080 string @var{text} is available to describe the nature of the error
38081 (for instance, a divide by zero in the condition expression); it
38085 The trace stopped for some other reason.
38089 Additional optional fields supply statistical and other information.
38090 Although not required, they are extremely useful for users monitoring
38091 the progress of a trace run. If a trace has stopped, and these
38092 numbers are reported, they must reflect the state of the just-stopped
38097 @item tframes:@var{n}
38098 The number of trace frames in the buffer.
38100 @item tcreated:@var{n}
38101 The total number of trace frames created during the run. This may
38102 be larger than the trace frame count, if the buffer is circular.
38104 @item tsize:@var{n}
38105 The total size of the trace buffer, in bytes.
38107 @item tfree:@var{n}
38108 The number of bytes still unused in the buffer.
38110 @item circular:@var{n}
38111 The value of the circular trace buffer flag. @code{1} means that the
38112 trace buffer is circular and old trace frames will be discarded if
38113 necessary to make room, @code{0} means that the trace buffer is linear
38116 @item disconn:@var{n}
38117 The value of the disconnected tracing flag. @code{1} means that
38118 tracing will continue after @value{GDBN} disconnects, @code{0} means
38119 that the trace run will stop.
38123 @item qTP:@var{tp}:@var{addr}
38124 @cindex tracepoint status, remote request
38125 @cindex @samp{qTP} packet
38126 Ask the stub for the current state of tracepoint number @var{tp} at
38127 address @var{addr}.
38131 @item V@var{hits}:@var{usage}
38132 The tracepoint has been hit @var{hits} times so far during the trace
38133 run, and accounts for @var{usage} in the trace buffer. Note that
38134 @code{while-stepping} steps are not counted as separate hits, but the
38135 steps' space consumption is added into the usage number.
38139 @item qTV:@var{var}
38140 @cindex trace state variable value, remote request
38141 @cindex @samp{qTV} packet
38142 Ask the stub for the value of the trace state variable number @var{var}.
38147 The value of the variable is @var{value}. This will be the current
38148 value of the variable if the user is examining a running target, or a
38149 saved value if the variable was collected in the trace frame that the
38150 user is looking at. Note that multiple requests may result in
38151 different reply values, such as when requesting values while the
38152 program is running.
38155 The value of the variable is unknown. This would occur, for example,
38156 if the user is examining a trace frame in which the requested variable
38161 @cindex @samp{qTfP} packet
38163 @cindex @samp{qTsP} packet
38164 These packets request data about tracepoints that are being used by
38165 the target. @value{GDBN} sends @code{qTfP} to get the first piece
38166 of data, and multiple @code{qTsP} to get additional pieces. Replies
38167 to these packets generally take the form of the @code{QTDP} packets
38168 that define tracepoints. (FIXME add detailed syntax)
38171 @cindex @samp{qTfV} packet
38173 @cindex @samp{qTsV} packet
38174 These packets request data about trace state variables that are on the
38175 target. @value{GDBN} sends @code{qTfV} to get the first vari of data,
38176 and multiple @code{qTsV} to get additional variables. Replies to
38177 these packets follow the syntax of the @code{QTDV} packets that define
38178 trace state variables.
38184 @cindex @samp{qTfSTM} packet
38185 @cindex @samp{qTsSTM} packet
38186 These packets request data about static tracepoint markers that exist
38187 in the target program. @value{GDBN} sends @code{qTfSTM} to get the
38188 first piece of data, and multiple @code{qTsSTM} to get additional
38189 pieces. Replies to these packets take the following form:
38193 @item m @var{address}:@var{id}:@var{extra}
38195 @item m @var{address}:@var{id}:@var{extra},@var{address}:@var{id}:@var{extra}@dots{}
38196 a comma-separated list of markers
38198 (lower case letter @samp{L}) denotes end of list.
38200 An error occurred. The error number @var{nn} is given as hex digits.
38202 An empty reply indicates that the request is not supported by the
38206 The @var{address} is encoded in hex;
38207 @var{id} and @var{extra} are strings encoded in hex.
38209 In response to each query, the target will reply with a list of one or
38210 more markers, separated by commas. @value{GDBN} will respond to each
38211 reply with a request for more markers (using the @samp{qs} form of the
38212 query), until the target responds with @samp{l} (lower-case ell, for
38215 @item qTSTMat:@var{address}
38217 @cindex @samp{qTSTMat} packet
38218 This packets requests data about static tracepoint markers in the
38219 target program at @var{address}. Replies to this packet follow the
38220 syntax of the @samp{qTfSTM} and @code{qTsSTM} packets that list static
38221 tracepoint markers.
38223 @item QTSave:@var{filename}
38224 @cindex @samp{QTSave} packet
38225 This packet directs the target to save trace data to the file name
38226 @var{filename} in the target's filesystem. The @var{filename} is encoded
38227 as a hex string; the interpretation of the file name (relative vs
38228 absolute, wild cards, etc) is up to the target.
38230 @item qTBuffer:@var{offset},@var{len}
38231 @cindex @samp{qTBuffer} packet
38232 Return up to @var{len} bytes of the current contents of trace buffer,
38233 starting at @var{offset}. The trace buffer is treated as if it were
38234 a contiguous collection of traceframes, as per the trace file format.
38235 The reply consists as many hex-encoded bytes as the target can deliver
38236 in a packet; it is not an error to return fewer than were asked for.
38237 A reply consisting of just @code{l} indicates that no bytes are
38240 @item QTBuffer:circular:@var{value}
38241 This packet directs the target to use a circular trace buffer if
38242 @var{value} is 1, or a linear buffer if the value is 0.
38244 @item QTBuffer:size:@var{size}
38245 @anchor{QTBuffer-size}
38246 @cindex @samp{QTBuffer size} packet
38247 This packet directs the target to make the trace buffer be of size
38248 @var{size} if possible. A value of @code{-1} tells the target to
38249 use whatever size it prefers.
38251 @item QTNotes:@r{[}@var{type}:@var{text}@r{]}@r{[};@var{type}:@var{text}@r{]}@dots{}
38252 @cindex @samp{QTNotes} packet
38253 This packet adds optional textual notes to the trace run. Allowable
38254 types include @code{user}, @code{notes}, and @code{tstop}, the
38255 @var{text} fields are arbitrary strings, hex-encoded.
38259 @subsection Relocate instruction reply packet
38260 When installing fast tracepoints in memory, the target may need to
38261 relocate the instruction currently at the tracepoint address to a
38262 different address in memory. For most instructions, a simple copy is
38263 enough, but, for example, call instructions that implicitly push the
38264 return address on the stack, and relative branches or other
38265 PC-relative instructions require offset adjustment, so that the effect
38266 of executing the instruction at a different address is the same as if
38267 it had executed in the original location.
38269 In response to several of the tracepoint packets, the target may also
38270 respond with a number of intermediate @samp{qRelocInsn} request
38271 packets before the final result packet, to have @value{GDBN} handle
38272 this relocation operation. If a packet supports this mechanism, its
38273 documentation will explicitly say so. See for example the above
38274 descriptions for the @samp{QTStart} and @samp{QTDP} packets. The
38275 format of the request is:
38278 @item qRelocInsn:@var{from};@var{to}
38280 This requests @value{GDBN} to copy instruction at address @var{from}
38281 to address @var{to}, possibly adjusted so that executing the
38282 instruction at @var{to} has the same effect as executing it at
38283 @var{from}. @value{GDBN} writes the adjusted instruction to target
38284 memory starting at @var{to}.
38289 @item qRelocInsn:@var{adjusted_size}
38290 Informs the stub the relocation is complete. The @var{adjusted_size} is
38291 the length in bytes of resulting relocated instruction sequence.
38293 A badly formed request was detected, or an error was encountered while
38294 relocating the instruction.
38297 @node Host I/O Packets
38298 @section Host I/O Packets
38299 @cindex Host I/O, remote protocol
38300 @cindex file transfer, remote protocol
38302 The @dfn{Host I/O} packets allow @value{GDBN} to perform I/O
38303 operations on the far side of a remote link. For example, Host I/O is
38304 used to upload and download files to a remote target with its own
38305 filesystem. Host I/O uses the same constant values and data structure
38306 layout as the target-initiated File-I/O protocol. However, the
38307 Host I/O packets are structured differently. The target-initiated
38308 protocol relies on target memory to store parameters and buffers.
38309 Host I/O requests are initiated by @value{GDBN}, and the
38310 target's memory is not involved. @xref{File-I/O Remote Protocol
38311 Extension}, for more details on the target-initiated protocol.
38313 The Host I/O request packets all encode a single operation along with
38314 its arguments. They have this format:
38318 @item vFile:@var{operation}: @var{parameter}@dots{}
38319 @var{operation} is the name of the particular request; the target
38320 should compare the entire packet name up to the second colon when checking
38321 for a supported operation. The format of @var{parameter} depends on
38322 the operation. Numbers are always passed in hexadecimal. Negative
38323 numbers have an explicit minus sign (i.e.@: two's complement is not
38324 used). Strings (e.g.@: filenames) are encoded as a series of
38325 hexadecimal bytes. The last argument to a system call may be a
38326 buffer of escaped binary data (@pxref{Binary Data}).
38330 The valid responses to Host I/O packets are:
38334 @item F @var{result} [, @var{errno}] [; @var{attachment}]
38335 @var{result} is the integer value returned by this operation, usually
38336 non-negative for success and -1 for errors. If an error has occured,
38337 @var{errno} will be included in the result specifying a
38338 value defined by the File-I/O protocol (@pxref{Errno Values}). For
38339 operations which return data, @var{attachment} supplies the data as a
38340 binary buffer. Binary buffers in response packets are escaped in the
38341 normal way (@pxref{Binary Data}). See the individual packet
38342 documentation for the interpretation of @var{result} and
38346 An empty response indicates that this operation is not recognized.
38350 These are the supported Host I/O operations:
38353 @item vFile:open: @var{filename}, @var{flags}, @var{mode}
38354 Open a file at @var{filename} and return a file descriptor for it, or
38355 return -1 if an error occurs. The @var{filename} is a string,
38356 @var{flags} is an integer indicating a mask of open flags
38357 (@pxref{Open Flags}), and @var{mode} is an integer indicating a mask
38358 of mode bits to use if the file is created (@pxref{mode_t Values}).
38359 @xref{open}, for details of the open flags and mode values.
38361 @item vFile:close: @var{fd}
38362 Close the open file corresponding to @var{fd} and return 0, or
38363 -1 if an error occurs.
38365 @item vFile:pread: @var{fd}, @var{count}, @var{offset}
38366 Read data from the open file corresponding to @var{fd}. Up to
38367 @var{count} bytes will be read from the file, starting at @var{offset}
38368 relative to the start of the file. The target may read fewer bytes;
38369 common reasons include packet size limits and an end-of-file
38370 condition. The number of bytes read is returned. Zero should only be
38371 returned for a successful read at the end of the file, or if
38372 @var{count} was zero.
38374 The data read should be returned as a binary attachment on success.
38375 If zero bytes were read, the response should include an empty binary
38376 attachment (i.e.@: a trailing semicolon). The return value is the
38377 number of target bytes read; the binary attachment may be longer if
38378 some characters were escaped.
38380 @item vFile:pwrite: @var{fd}, @var{offset}, @var{data}
38381 Write @var{data} (a binary buffer) to the open file corresponding
38382 to @var{fd}. Start the write at @var{offset} from the start of the
38383 file. Unlike many @code{write} system calls, there is no
38384 separate @var{count} argument; the length of @var{data} in the
38385 packet is used. @samp{vFile:write} returns the number of bytes written,
38386 which may be shorter than the length of @var{data}, or -1 if an
38389 @item vFile:fstat: @var{fd}
38390 Get information about the open file corresponding to @var{fd}.
38391 On success the information is returned as a binary attachment
38392 and the return value is the size of this attachment in bytes.
38393 If an error occurs the return value is -1. The format of the
38394 returned binary attachment is as described in @ref{struct stat}.
38396 @item vFile:unlink: @var{filename}
38397 Delete the file at @var{filename} on the target. Return 0,
38398 or -1 if an error occurs. The @var{filename} is a string.
38400 @item vFile:readlink: @var{filename}
38401 Read value of symbolic link @var{filename} on the target. Return
38402 the number of bytes read, or -1 if an error occurs.
38404 The data read should be returned as a binary attachment on success.
38405 If zero bytes were read, the response should include an empty binary
38406 attachment (i.e.@: a trailing semicolon). The return value is the
38407 number of target bytes read; the binary attachment may be longer if
38408 some characters were escaped.
38410 @item vFile:setfs: @var{pid}
38411 Select the filesystem on which @code{vFile} operations with
38412 @var{filename} arguments will operate. This is required for
38413 @value{GDBN} to be able to access files on remote targets where
38414 the remote stub does not share a common filesystem with the
38417 If @var{pid} is nonzero, select the filesystem as seen by process
38418 @var{pid}. If @var{pid} is zero, select the filesystem as seen by
38419 the remote stub. Return 0 on success, or -1 if an error occurs.
38420 If @code{vFile:setfs:} indicates success, the selected filesystem
38421 remains selected until the next successful @code{vFile:setfs:}
38427 @section Interrupts
38428 @cindex interrupts (remote protocol)
38429 @anchor{interrupting remote targets}
38431 In all-stop mode, when a program on the remote target is running,
38432 @value{GDBN} may attempt to interrupt it by sending a @samp{Ctrl-C},
38433 @code{BREAK} or a @code{BREAK} followed by @code{g}, control of which
38434 is specified via @value{GDBN}'s @samp{interrupt-sequence}.
38436 The precise meaning of @code{BREAK} is defined by the transport
38437 mechanism and may, in fact, be undefined. @value{GDBN} does not
38438 currently define a @code{BREAK} mechanism for any of the network
38439 interfaces except for TCP, in which case @value{GDBN} sends the
38440 @code{telnet} BREAK sequence.
38442 @samp{Ctrl-C}, on the other hand, is defined and implemented for all
38443 transport mechanisms. It is represented by sending the single byte
38444 @code{0x03} without any of the usual packet overhead described in
38445 the Overview section (@pxref{Overview}). When a @code{0x03} byte is
38446 transmitted as part of a packet, it is considered to be packet data
38447 and does @emph{not} represent an interrupt. E.g., an @samp{X} packet
38448 (@pxref{X packet}), used for binary downloads, may include an unescaped
38449 @code{0x03} as part of its packet.
38451 @code{BREAK} followed by @code{g} is also known as Magic SysRq g.
38452 When Linux kernel receives this sequence from serial port,
38453 it stops execution and connects to gdb.
38455 In non-stop mode, because packet resumptions are asynchronous
38456 (@pxref{vCont packet}), @value{GDBN} is always free to send a remote
38457 command to the remote stub, even when the target is running. For that
38458 reason, @value{GDBN} instead sends a regular packet (@pxref{vCtrlC
38459 packet}) with the usual packet framing instead of the single byte
38462 Stubs are not required to recognize these interrupt mechanisms and the
38463 precise meaning associated with receipt of the interrupt is
38464 implementation defined. If the target supports debugging of multiple
38465 threads and/or processes, it should attempt to interrupt all
38466 currently-executing threads and processes.
38467 If the stub is successful at interrupting the
38468 running program, it should send one of the stop
38469 reply packets (@pxref{Stop Reply Packets}) to @value{GDBN} as a result
38470 of successfully stopping the program in all-stop mode, and a stop reply
38471 for each stopped thread in non-stop mode.
38472 Interrupts received while the
38473 program is stopped are queued and the program will be interrupted when
38474 it is resumed next time.
38476 @node Notification Packets
38477 @section Notification Packets
38478 @cindex notification packets
38479 @cindex packets, notification
38481 The @value{GDBN} remote serial protocol includes @dfn{notifications},
38482 packets that require no acknowledgment. Both the GDB and the stub
38483 may send notifications (although the only notifications defined at
38484 present are sent by the stub). Notifications carry information
38485 without incurring the round-trip latency of an acknowledgment, and so
38486 are useful for low-impact communications where occasional packet loss
38489 A notification packet has the form @samp{% @var{data} #
38490 @var{checksum}}, where @var{data} is the content of the notification,
38491 and @var{checksum} is a checksum of @var{data}, computed and formatted
38492 as for ordinary @value{GDBN} packets. A notification's @var{data}
38493 never contains @samp{$}, @samp{%} or @samp{#} characters. Upon
38494 receiving a notification, the recipient sends no @samp{+} or @samp{-}
38495 to acknowledge the notification's receipt or to report its corruption.
38497 Every notification's @var{data} begins with a name, which contains no
38498 colon characters, followed by a colon character.
38500 Recipients should silently ignore corrupted notifications and
38501 notifications they do not understand. Recipients should restart
38502 timeout periods on receipt of a well-formed notification, whether or
38503 not they understand it.
38505 Senders should only send the notifications described here when this
38506 protocol description specifies that they are permitted. In the
38507 future, we may extend the protocol to permit existing notifications in
38508 new contexts; this rule helps older senders avoid confusing newer
38511 (Older versions of @value{GDBN} ignore bytes received until they see
38512 the @samp{$} byte that begins an ordinary packet, so new stubs may
38513 transmit notifications without fear of confusing older clients. There
38514 are no notifications defined for @value{GDBN} to send at the moment, but we
38515 assume that most older stubs would ignore them, as well.)
38517 Each notification is comprised of three parts:
38519 @item @var{name}:@var{event}
38520 The notification packet is sent by the side that initiates the
38521 exchange (currently, only the stub does that), with @var{event}
38522 carrying the specific information about the notification, and
38523 @var{name} specifying the name of the notification.
38525 The acknowledge sent by the other side, usually @value{GDBN}, to
38526 acknowledge the exchange and request the event.
38529 The purpose of an asynchronous notification mechanism is to report to
38530 @value{GDBN} that something interesting happened in the remote stub.
38532 The remote stub may send notification @var{name}:@var{event}
38533 at any time, but @value{GDBN} acknowledges the notification when
38534 appropriate. The notification event is pending before @value{GDBN}
38535 acknowledges. Only one notification at a time may be pending; if
38536 additional events occur before @value{GDBN} has acknowledged the
38537 previous notification, they must be queued by the stub for later
38538 synchronous transmission in response to @var{ack} packets from
38539 @value{GDBN}. Because the notification mechanism is unreliable,
38540 the stub is permitted to resend a notification if it believes
38541 @value{GDBN} may not have received it.
38543 Specifically, notifications may appear when @value{GDBN} is not
38544 otherwise reading input from the stub, or when @value{GDBN} is
38545 expecting to read a normal synchronous response or a
38546 @samp{+}/@samp{-} acknowledgment to a packet it has sent.
38547 Notification packets are distinct from any other communication from
38548 the stub so there is no ambiguity.
38550 After receiving a notification, @value{GDBN} shall acknowledge it by
38551 sending a @var{ack} packet as a regular, synchronous request to the
38552 stub. Such acknowledgment is not required to happen immediately, as
38553 @value{GDBN} is permitted to send other, unrelated packets to the
38554 stub first, which the stub should process normally.
38556 Upon receiving a @var{ack} packet, if the stub has other queued
38557 events to report to @value{GDBN}, it shall respond by sending a
38558 normal @var{event}. @value{GDBN} shall then send another @var{ack}
38559 packet to solicit further responses; again, it is permitted to send
38560 other, unrelated packets as well which the stub should process
38563 If the stub receives a @var{ack} packet and there are no additional
38564 @var{event} to report, the stub shall return an @samp{OK} response.
38565 At this point, @value{GDBN} has finished processing a notification
38566 and the stub has completed sending any queued events. @value{GDBN}
38567 won't accept any new notifications until the final @samp{OK} is
38568 received . If further notification events occur, the stub shall send
38569 a new notification, @value{GDBN} shall accept the notification, and
38570 the process shall be repeated.
38572 The process of asynchronous notification can be illustrated by the
38575 <- @code{%%Stop:T0505:98e7ffbf;04:4ce6ffbf;08:b1b6e54c;thread:p7526.7526;core:0;}
38578 <- @code{T0505:68f37db7;04:40f37db7;08:63850408;thread:p7526.7528;core:0;}
38580 <- @code{T0505:68e3fdb6;04:40e3fdb6;08:63850408;thread:p7526.7529;core:0;}
38585 The following notifications are defined:
38586 @multitable @columnfractions 0.12 0.12 0.38 0.38
38595 @tab @var{reply}. The @var{reply} has the form of a stop reply, as
38596 described in @ref{Stop Reply Packets}. Refer to @ref{Remote Non-Stop},
38597 for information on how these notifications are acknowledged by
38599 @tab Report an asynchronous stop event in non-stop mode.
38603 @node Remote Non-Stop
38604 @section Remote Protocol Support for Non-Stop Mode
38606 @value{GDBN}'s remote protocol supports non-stop debugging of
38607 multi-threaded programs, as described in @ref{Non-Stop Mode}. If the stub
38608 supports non-stop mode, it should report that to @value{GDBN} by including
38609 @samp{QNonStop+} in its @samp{qSupported} response (@pxref{qSupported}).
38611 @value{GDBN} typically sends a @samp{QNonStop} packet only when
38612 establishing a new connection with the stub. Entering non-stop mode
38613 does not alter the state of any currently-running threads, but targets
38614 must stop all threads in any already-attached processes when entering
38615 all-stop mode. @value{GDBN} uses the @samp{?} packet as necessary to
38616 probe the target state after a mode change.
38618 In non-stop mode, when an attached process encounters an event that
38619 would otherwise be reported with a stop reply, it uses the
38620 asynchronous notification mechanism (@pxref{Notification Packets}) to
38621 inform @value{GDBN}. In contrast to all-stop mode, where all threads
38622 in all processes are stopped when a stop reply is sent, in non-stop
38623 mode only the thread reporting the stop event is stopped. That is,
38624 when reporting a @samp{S} or @samp{T} response to indicate completion
38625 of a step operation, hitting a breakpoint, or a fault, only the
38626 affected thread is stopped; any other still-running threads continue
38627 to run. When reporting a @samp{W} or @samp{X} response, all running
38628 threads belonging to other attached processes continue to run.
38630 In non-stop mode, the target shall respond to the @samp{?} packet as
38631 follows. First, any incomplete stop reply notification/@samp{vStopped}
38632 sequence in progress is abandoned. The target must begin a new
38633 sequence reporting stop events for all stopped threads, whether or not
38634 it has previously reported those events to @value{GDBN}. The first
38635 stop reply is sent as a synchronous reply to the @samp{?} packet, and
38636 subsequent stop replies are sent as responses to @samp{vStopped} packets
38637 using the mechanism described above. The target must not send
38638 asynchronous stop reply notifications until the sequence is complete.
38639 If all threads are running when the target receives the @samp{?} packet,
38640 or if the target is not attached to any process, it shall respond
38643 If the stub supports non-stop mode, it should also support the
38644 @samp{swbreak} stop reason if software breakpoints are supported, and
38645 the @samp{hwbreak} stop reason if hardware breakpoints are supported
38646 (@pxref{swbreak stop reason}). This is because given the asynchronous
38647 nature of non-stop mode, between the time a thread hits a breakpoint
38648 and the time the event is finally processed by @value{GDBN}, the
38649 breakpoint may have already been removed from the target. Due to
38650 this, @value{GDBN} needs to be able to tell whether a trap stop was
38651 caused by a delayed breakpoint event, which should be ignored, as
38652 opposed to a random trap signal, which should be reported to the user.
38653 Note the @samp{swbreak} feature implies that the target is responsible
38654 for adjusting the PC when a software breakpoint triggers, if
38655 necessary, such as on the x86 architecture.
38657 @node Packet Acknowledgment
38658 @section Packet Acknowledgment
38660 @cindex acknowledgment, for @value{GDBN} remote
38661 @cindex packet acknowledgment, for @value{GDBN} remote
38662 By default, when either the host or the target machine receives a packet,
38663 the first response expected is an acknowledgment: either @samp{+} (to indicate
38664 the package was received correctly) or @samp{-} (to request retransmission).
38665 This mechanism allows the @value{GDBN} remote protocol to operate over
38666 unreliable transport mechanisms, such as a serial line.
38668 In cases where the transport mechanism is itself reliable (such as a pipe or
38669 TCP connection), the @samp{+}/@samp{-} acknowledgments are redundant.
38670 It may be desirable to disable them in that case to reduce communication
38671 overhead, or for other reasons. This can be accomplished by means of the
38672 @samp{QStartNoAckMode} packet; @pxref{QStartNoAckMode}.
38674 When in no-acknowledgment mode, neither the stub nor @value{GDBN} shall send or
38675 expect @samp{+}/@samp{-} protocol acknowledgments. The packet
38676 and response format still includes the normal checksum, as described in
38677 @ref{Overview}, but the checksum may be ignored by the receiver.
38679 If the stub supports @samp{QStartNoAckMode} and prefers to operate in
38680 no-acknowledgment mode, it should report that to @value{GDBN}
38681 by including @samp{QStartNoAckMode+} in its response to @samp{qSupported};
38682 @pxref{qSupported}.
38683 If @value{GDBN} also supports @samp{QStartNoAckMode} and it has not been
38684 disabled via the @code{set remote noack-packet off} command
38685 (@pxref{Remote Configuration}),
38686 @value{GDBN} may then send a @samp{QStartNoAckMode} packet to the stub.
38687 Only then may the stub actually turn off packet acknowledgments.
38688 @value{GDBN} sends a final @samp{+} acknowledgment of the stub's @samp{OK}
38689 response, which can be safely ignored by the stub.
38691 Note that @code{set remote noack-packet} command only affects negotiation
38692 between @value{GDBN} and the stub when subsequent connections are made;
38693 it does not affect the protocol acknowledgment state for any current
38695 Since @samp{+}/@samp{-} acknowledgments are enabled by default when a
38696 new connection is established,
38697 there is also no protocol request to re-enable the acknowledgments
38698 for the current connection, once disabled.
38703 Example sequence of a target being re-started. Notice how the restart
38704 does not get any direct output:
38709 @emph{target restarts}
38712 <- @code{T001:1234123412341234}
38716 Example sequence of a target being stepped by a single instruction:
38719 -> @code{G1445@dots{}}
38724 <- @code{T001:1234123412341234}
38728 <- @code{1455@dots{}}
38732 @node File-I/O Remote Protocol Extension
38733 @section File-I/O Remote Protocol Extension
38734 @cindex File-I/O remote protocol extension
38737 * File-I/O Overview::
38738 * Protocol Basics::
38739 * The F Request Packet::
38740 * The F Reply Packet::
38741 * The Ctrl-C Message::
38743 * List of Supported Calls::
38744 * Protocol-specific Representation of Datatypes::
38746 * File-I/O Examples::
38749 @node File-I/O Overview
38750 @subsection File-I/O Overview
38751 @cindex file-i/o overview
38753 The @dfn{File I/O remote protocol extension} (short: File-I/O) allows the
38754 target to use the host's file system and console I/O to perform various
38755 system calls. System calls on the target system are translated into a
38756 remote protocol packet to the host system, which then performs the needed
38757 actions and returns a response packet to the target system.
38758 This simulates file system operations even on targets that lack file systems.
38760 The protocol is defined to be independent of both the host and target systems.
38761 It uses its own internal representation of datatypes and values. Both
38762 @value{GDBN} and the target's @value{GDBN} stub are responsible for
38763 translating the system-dependent value representations into the internal
38764 protocol representations when data is transmitted.
38766 The communication is synchronous. A system call is possible only when
38767 @value{GDBN} is waiting for a response from the @samp{C}, @samp{c}, @samp{S}
38768 or @samp{s} packets. While @value{GDBN} handles the request for a system call,
38769 the target is stopped to allow deterministic access to the target's
38770 memory. Therefore File-I/O is not interruptible by target signals. On
38771 the other hand, it is possible to interrupt File-I/O by a user interrupt
38772 (@samp{Ctrl-C}) within @value{GDBN}.
38774 The target's request to perform a host system call does not finish
38775 the latest @samp{C}, @samp{c}, @samp{S} or @samp{s} action. That means,
38776 after finishing the system call, the target returns to continuing the
38777 previous activity (continue, step). No additional continue or step
38778 request from @value{GDBN} is required.
38781 (@value{GDBP}) continue
38782 <- target requests 'system call X'
38783 target is stopped, @value{GDBN} executes system call
38784 -> @value{GDBN} returns result
38785 ... target continues, @value{GDBN} returns to wait for the target
38786 <- target hits breakpoint and sends a Txx packet
38789 The protocol only supports I/O on the console and to regular files on
38790 the host file system. Character or block special devices, pipes,
38791 named pipes, sockets or any other communication method on the host
38792 system are not supported by this protocol.
38794 File I/O is not supported in non-stop mode.
38796 @node Protocol Basics
38797 @subsection Protocol Basics
38798 @cindex protocol basics, file-i/o
38800 The File-I/O protocol uses the @code{F} packet as the request as well
38801 as reply packet. Since a File-I/O system call can only occur when
38802 @value{GDBN} is waiting for a response from the continuing or stepping target,
38803 the File-I/O request is a reply that @value{GDBN} has to expect as a result
38804 of a previous @samp{C}, @samp{c}, @samp{S} or @samp{s} packet.
38805 This @code{F} packet contains all information needed to allow @value{GDBN}
38806 to call the appropriate host system call:
38810 A unique identifier for the requested system call.
38813 All parameters to the system call. Pointers are given as addresses
38814 in the target memory address space. Pointers to strings are given as
38815 pointer/length pair. Numerical values are given as they are.
38816 Numerical control flags are given in a protocol-specific representation.
38820 At this point, @value{GDBN} has to perform the following actions.
38824 If the parameters include pointer values to data needed as input to a
38825 system call, @value{GDBN} requests this data from the target with a
38826 standard @code{m} packet request. This additional communication has to be
38827 expected by the target implementation and is handled as any other @code{m}
38831 @value{GDBN} translates all value from protocol representation to host
38832 representation as needed. Datatypes are coerced into the host types.
38835 @value{GDBN} calls the system call.
38838 It then coerces datatypes back to protocol representation.
38841 If the system call is expected to return data in buffer space specified
38842 by pointer parameters to the call, the data is transmitted to the
38843 target using a @code{M} or @code{X} packet. This packet has to be expected
38844 by the target implementation and is handled as any other @code{M} or @code{X}
38849 Eventually @value{GDBN} replies with another @code{F} packet which contains all
38850 necessary information for the target to continue. This at least contains
38857 @code{errno}, if has been changed by the system call.
38864 After having done the needed type and value coercion, the target continues
38865 the latest continue or step action.
38867 @node The F Request Packet
38868 @subsection The @code{F} Request Packet
38869 @cindex file-i/o request packet
38870 @cindex @code{F} request packet
38872 The @code{F} request packet has the following format:
38875 @item F@var{call-id},@var{parameter@dots{}}
38877 @var{call-id} is the identifier to indicate the host system call to be called.
38878 This is just the name of the function.
38880 @var{parameter@dots{}} are the parameters to the system call.
38881 Parameters are hexadecimal integer values, either the actual values in case
38882 of scalar datatypes, pointers to target buffer space in case of compound
38883 datatypes and unspecified memory areas, or pointer/length pairs in case
38884 of string parameters. These are appended to the @var{call-id} as a
38885 comma-delimited list. All values are transmitted in ASCII
38886 string representation, pointer/length pairs separated by a slash.
38892 @node The F Reply Packet
38893 @subsection The @code{F} Reply Packet
38894 @cindex file-i/o reply packet
38895 @cindex @code{F} reply packet
38897 The @code{F} reply packet has the following format:
38901 @item F@var{retcode},@var{errno},@var{Ctrl-C flag};@var{call-specific attachment}
38903 @var{retcode} is the return code of the system call as hexadecimal value.
38905 @var{errno} is the @code{errno} set by the call, in protocol-specific
38907 This parameter can be omitted if the call was successful.
38909 @var{Ctrl-C flag} is only sent if the user requested a break. In this
38910 case, @var{errno} must be sent as well, even if the call was successful.
38911 The @var{Ctrl-C flag} itself consists of the character @samp{C}:
38918 or, if the call was interrupted before the host call has been performed:
38925 assuming 4 is the protocol-specific representation of @code{EINTR}.
38930 @node The Ctrl-C Message
38931 @subsection The @samp{Ctrl-C} Message
38932 @cindex ctrl-c message, in file-i/o protocol
38934 If the @samp{Ctrl-C} flag is set in the @value{GDBN}
38935 reply packet (@pxref{The F Reply Packet}),
38936 the target should behave as if it had
38937 gotten a break message. The meaning for the target is ``system call
38938 interrupted by @code{SIGINT}''. Consequentially, the target should actually stop
38939 (as with a break message) and return to @value{GDBN} with a @code{T02}
38942 It's important for the target to know in which
38943 state the system call was interrupted. There are two possible cases:
38947 The system call hasn't been performed on the host yet.
38950 The system call on the host has been finished.
38954 These two states can be distinguished by the target by the value of the
38955 returned @code{errno}. If it's the protocol representation of @code{EINTR}, the system
38956 call hasn't been performed. This is equivalent to the @code{EINTR} handling
38957 on POSIX systems. In any other case, the target may presume that the
38958 system call has been finished --- successfully or not --- and should behave
38959 as if the break message arrived right after the system call.
38961 @value{GDBN} must behave reliably. If the system call has not been called
38962 yet, @value{GDBN} may send the @code{F} reply immediately, setting @code{EINTR} as
38963 @code{errno} in the packet. If the system call on the host has been finished
38964 before the user requests a break, the full action must be finished by
38965 @value{GDBN}. This requires sending @code{M} or @code{X} packets as necessary.
38966 The @code{F} packet may only be sent when either nothing has happened
38967 or the full action has been completed.
38970 @subsection Console I/O
38971 @cindex console i/o as part of file-i/o
38973 By default and if not explicitly closed by the target system, the file
38974 descriptors 0, 1 and 2 are connected to the @value{GDBN} console. Output
38975 on the @value{GDBN} console is handled as any other file output operation
38976 (@code{write(1, @dots{})} or @code{write(2, @dots{})}). Console input is handled
38977 by @value{GDBN} so that after the target read request from file descriptor
38978 0 all following typing is buffered until either one of the following
38983 The user types @kbd{Ctrl-c}. The behaviour is as explained above, and the
38985 system call is treated as finished.
38988 The user presses @key{RET}. This is treated as end of input with a trailing
38992 The user types @kbd{Ctrl-d}. This is treated as end of input. No trailing
38993 character (neither newline nor @samp{Ctrl-D}) is appended to the input.
38997 If the user has typed more characters than fit in the buffer given to
38998 the @code{read} call, the trailing characters are buffered in @value{GDBN} until
38999 either another @code{read(0, @dots{})} is requested by the target, or debugging
39000 is stopped at the user's request.
39003 @node List of Supported Calls
39004 @subsection List of Supported Calls
39005 @cindex list of supported file-i/o calls
39022 @unnumberedsubsubsec open
39023 @cindex open, file-i/o system call
39028 int open(const char *pathname, int flags);
39029 int open(const char *pathname, int flags, mode_t mode);
39033 @samp{Fopen,@var{pathptr}/@var{len},@var{flags},@var{mode}}
39036 @var{flags} is the bitwise @code{OR} of the following values:
39040 If the file does not exist it will be created. The host
39041 rules apply as far as file ownership and time stamps
39045 When used with @code{O_CREAT}, if the file already exists it is
39046 an error and open() fails.
39049 If the file already exists and the open mode allows
39050 writing (@code{O_RDWR} or @code{O_WRONLY} is given) it will be
39051 truncated to zero length.
39054 The file is opened in append mode.
39057 The file is opened for reading only.
39060 The file is opened for writing only.
39063 The file is opened for reading and writing.
39067 Other bits are silently ignored.
39071 @var{mode} is the bitwise @code{OR} of the following values:
39075 User has read permission.
39078 User has write permission.
39081 Group has read permission.
39084 Group has write permission.
39087 Others have read permission.
39090 Others have write permission.
39094 Other bits are silently ignored.
39097 @item Return value:
39098 @code{open} returns the new file descriptor or -1 if an error
39105 @var{pathname} already exists and @code{O_CREAT} and @code{O_EXCL} were used.
39108 @var{pathname} refers to a directory.
39111 The requested access is not allowed.
39114 @var{pathname} was too long.
39117 A directory component in @var{pathname} does not exist.
39120 @var{pathname} refers to a device, pipe, named pipe or socket.
39123 @var{pathname} refers to a file on a read-only filesystem and
39124 write access was requested.
39127 @var{pathname} is an invalid pointer value.
39130 No space on device to create the file.
39133 The process already has the maximum number of files open.
39136 The limit on the total number of files open on the system
39140 The call was interrupted by the user.
39146 @unnumberedsubsubsec close
39147 @cindex close, file-i/o system call
39156 @samp{Fclose,@var{fd}}
39158 @item Return value:
39159 @code{close} returns zero on success, or -1 if an error occurred.
39165 @var{fd} isn't a valid open file descriptor.
39168 The call was interrupted by the user.
39174 @unnumberedsubsubsec read
39175 @cindex read, file-i/o system call
39180 int read(int fd, void *buf, unsigned int count);
39184 @samp{Fread,@var{fd},@var{bufptr},@var{count}}
39186 @item Return value:
39187 On success, the number of bytes read is returned.
39188 Zero indicates end of file. If count is zero, read
39189 returns zero as well. On error, -1 is returned.
39195 @var{fd} is not a valid file descriptor or is not open for
39199 @var{bufptr} is an invalid pointer value.
39202 The call was interrupted by the user.
39208 @unnumberedsubsubsec write
39209 @cindex write, file-i/o system call
39214 int write(int fd, const void *buf, unsigned int count);
39218 @samp{Fwrite,@var{fd},@var{bufptr},@var{count}}
39220 @item Return value:
39221 On success, the number of bytes written are returned.
39222 Zero indicates nothing was written. On error, -1
39229 @var{fd} is not a valid file descriptor or is not open for
39233 @var{bufptr} is an invalid pointer value.
39236 An attempt was made to write a file that exceeds the
39237 host-specific maximum file size allowed.
39240 No space on device to write the data.
39243 The call was interrupted by the user.
39249 @unnumberedsubsubsec lseek
39250 @cindex lseek, file-i/o system call
39255 long lseek (int fd, long offset, int flag);
39259 @samp{Flseek,@var{fd},@var{offset},@var{flag}}
39261 @var{flag} is one of:
39265 The offset is set to @var{offset} bytes.
39268 The offset is set to its current location plus @var{offset}
39272 The offset is set to the size of the file plus @var{offset}
39276 @item Return value:
39277 On success, the resulting unsigned offset in bytes from
39278 the beginning of the file is returned. Otherwise, a
39279 value of -1 is returned.
39285 @var{fd} is not a valid open file descriptor.
39288 @var{fd} is associated with the @value{GDBN} console.
39291 @var{flag} is not a proper value.
39294 The call was interrupted by the user.
39300 @unnumberedsubsubsec rename
39301 @cindex rename, file-i/o system call
39306 int rename(const char *oldpath, const char *newpath);
39310 @samp{Frename,@var{oldpathptr}/@var{len},@var{newpathptr}/@var{len}}
39312 @item Return value:
39313 On success, zero is returned. On error, -1 is returned.
39319 @var{newpath} is an existing directory, but @var{oldpath} is not a
39323 @var{newpath} is a non-empty directory.
39326 @var{oldpath} or @var{newpath} is a directory that is in use by some
39330 An attempt was made to make a directory a subdirectory
39334 A component used as a directory in @var{oldpath} or new
39335 path is not a directory. Or @var{oldpath} is a directory
39336 and @var{newpath} exists but is not a directory.
39339 @var{oldpathptr} or @var{newpathptr} are invalid pointer values.
39342 No access to the file or the path of the file.
39346 @var{oldpath} or @var{newpath} was too long.
39349 A directory component in @var{oldpath} or @var{newpath} does not exist.
39352 The file is on a read-only filesystem.
39355 The device containing the file has no room for the new
39359 The call was interrupted by the user.
39365 @unnumberedsubsubsec unlink
39366 @cindex unlink, file-i/o system call
39371 int unlink(const char *pathname);
39375 @samp{Funlink,@var{pathnameptr}/@var{len}}
39377 @item Return value:
39378 On success, zero is returned. On error, -1 is returned.
39384 No access to the file or the path of the file.
39387 The system does not allow unlinking of directories.
39390 The file @var{pathname} cannot be unlinked because it's
39391 being used by another process.
39394 @var{pathnameptr} is an invalid pointer value.
39397 @var{pathname} was too long.
39400 A directory component in @var{pathname} does not exist.
39403 A component of the path is not a directory.
39406 The file is on a read-only filesystem.
39409 The call was interrupted by the user.
39415 @unnumberedsubsubsec stat/fstat
39416 @cindex fstat, file-i/o system call
39417 @cindex stat, file-i/o system call
39422 int stat(const char *pathname, struct stat *buf);
39423 int fstat(int fd, struct stat *buf);
39427 @samp{Fstat,@var{pathnameptr}/@var{len},@var{bufptr}}@*
39428 @samp{Ffstat,@var{fd},@var{bufptr}}
39430 @item Return value:
39431 On success, zero is returned. On error, -1 is returned.
39437 @var{fd} is not a valid open file.
39440 A directory component in @var{pathname} does not exist or the
39441 path is an empty string.
39444 A component of the path is not a directory.
39447 @var{pathnameptr} is an invalid pointer value.
39450 No access to the file or the path of the file.
39453 @var{pathname} was too long.
39456 The call was interrupted by the user.
39462 @unnumberedsubsubsec gettimeofday
39463 @cindex gettimeofday, file-i/o system call
39468 int gettimeofday(struct timeval *tv, void *tz);
39472 @samp{Fgettimeofday,@var{tvptr},@var{tzptr}}
39474 @item Return value:
39475 On success, 0 is returned, -1 otherwise.
39481 @var{tz} is a non-NULL pointer.
39484 @var{tvptr} and/or @var{tzptr} is an invalid pointer value.
39490 @unnumberedsubsubsec isatty
39491 @cindex isatty, file-i/o system call
39496 int isatty(int fd);
39500 @samp{Fisatty,@var{fd}}
39502 @item Return value:
39503 Returns 1 if @var{fd} refers to the @value{GDBN} console, 0 otherwise.
39509 The call was interrupted by the user.
39514 Note that the @code{isatty} call is treated as a special case: it returns
39515 1 to the target if the file descriptor is attached
39516 to the @value{GDBN} console, 0 otherwise. Implementing through system calls
39517 would require implementing @code{ioctl} and would be more complex than
39522 @unnumberedsubsubsec system
39523 @cindex system, file-i/o system call
39528 int system(const char *command);
39532 @samp{Fsystem,@var{commandptr}/@var{len}}
39534 @item Return value:
39535 If @var{len} is zero, the return value indicates whether a shell is
39536 available. A zero return value indicates a shell is not available.
39537 For non-zero @var{len}, the value returned is -1 on error and the
39538 return status of the command otherwise. Only the exit status of the
39539 command is returned, which is extracted from the host's @code{system}
39540 return value by calling @code{WEXITSTATUS(retval)}. In case
39541 @file{/bin/sh} could not be executed, 127 is returned.
39547 The call was interrupted by the user.
39552 @value{GDBN} takes over the full task of calling the necessary host calls
39553 to perform the @code{system} call. The return value of @code{system} on
39554 the host is simplified before it's returned
39555 to the target. Any termination signal information from the child process
39556 is discarded, and the return value consists
39557 entirely of the exit status of the called command.
39559 Due to security concerns, the @code{system} call is by default refused
39560 by @value{GDBN}. The user has to allow this call explicitly with the
39561 @code{set remote system-call-allowed 1} command.
39564 @item set remote system-call-allowed
39565 @kindex set remote system-call-allowed
39566 Control whether to allow the @code{system} calls in the File I/O
39567 protocol for the remote target. The default is zero (disabled).
39569 @item show remote system-call-allowed
39570 @kindex show remote system-call-allowed
39571 Show whether the @code{system} calls are allowed in the File I/O
39575 @node Protocol-specific Representation of Datatypes
39576 @subsection Protocol-specific Representation of Datatypes
39577 @cindex protocol-specific representation of datatypes, in file-i/o protocol
39580 * Integral Datatypes::
39582 * Memory Transfer::
39587 @node Integral Datatypes
39588 @unnumberedsubsubsec Integral Datatypes
39589 @cindex integral datatypes, in file-i/o protocol
39591 The integral datatypes used in the system calls are @code{int},
39592 @code{unsigned int}, @code{long}, @code{unsigned long},
39593 @code{mode_t}, and @code{time_t}.
39595 @code{int}, @code{unsigned int}, @code{mode_t} and @code{time_t} are
39596 implemented as 32 bit values in this protocol.
39598 @code{long} and @code{unsigned long} are implemented as 64 bit types.
39600 @xref{Limits}, for corresponding MIN and MAX values (similar to those
39601 in @file{limits.h}) to allow range checking on host and target.
39603 @code{time_t} datatypes are defined as seconds since the Epoch.
39605 All integral datatypes transferred as part of a memory read or write of a
39606 structured datatype e.g.@: a @code{struct stat} have to be given in big endian
39609 @node Pointer Values
39610 @unnumberedsubsubsec Pointer Values
39611 @cindex pointer values, in file-i/o protocol
39613 Pointers to target data are transmitted as they are. An exception
39614 is made for pointers to buffers for which the length isn't
39615 transmitted as part of the function call, namely strings. Strings
39616 are transmitted as a pointer/length pair, both as hex values, e.g.@:
39623 which is a pointer to data of length 18 bytes at position 0x1aaf.
39624 The length is defined as the full string length in bytes, including
39625 the trailing null byte. For example, the string @code{"hello world"}
39626 at address 0x123456 is transmitted as
39632 @node Memory Transfer
39633 @unnumberedsubsubsec Memory Transfer
39634 @cindex memory transfer, in file-i/o protocol
39636 Structured data which is transferred using a memory read or write (for
39637 example, a @code{struct stat}) is expected to be in a protocol-specific format
39638 with all scalar multibyte datatypes being big endian. Translation to
39639 this representation needs to be done both by the target before the @code{F}
39640 packet is sent, and by @value{GDBN} before
39641 it transfers memory to the target. Transferred pointers to structured
39642 data should point to the already-coerced data at any time.
39646 @unnumberedsubsubsec struct stat
39647 @cindex struct stat, in file-i/o protocol
39649 The buffer of type @code{struct stat} used by the target and @value{GDBN}
39650 is defined as follows:
39654 unsigned int st_dev; /* device */
39655 unsigned int st_ino; /* inode */
39656 mode_t st_mode; /* protection */
39657 unsigned int st_nlink; /* number of hard links */
39658 unsigned int st_uid; /* user ID of owner */
39659 unsigned int st_gid; /* group ID of owner */
39660 unsigned int st_rdev; /* device type (if inode device) */
39661 unsigned long st_size; /* total size, in bytes */
39662 unsigned long st_blksize; /* blocksize for filesystem I/O */
39663 unsigned long st_blocks; /* number of blocks allocated */
39664 time_t st_atime; /* time of last access */
39665 time_t st_mtime; /* time of last modification */
39666 time_t st_ctime; /* time of last change */
39670 The integral datatypes conform to the definitions given in the
39671 appropriate section (see @ref{Integral Datatypes}, for details) so this
39672 structure is of size 64 bytes.
39674 The values of several fields have a restricted meaning and/or
39680 A value of 0 represents a file, 1 the console.
39683 No valid meaning for the target. Transmitted unchanged.
39686 Valid mode bits are described in @ref{Constants}. Any other
39687 bits have currently no meaning for the target.
39692 No valid meaning for the target. Transmitted unchanged.
39697 These values have a host and file system dependent
39698 accuracy. Especially on Windows hosts, the file system may not
39699 support exact timing values.
39702 The target gets a @code{struct stat} of the above representation and is
39703 responsible for coercing it to the target representation before
39706 Note that due to size differences between the host, target, and protocol
39707 representations of @code{struct stat} members, these members could eventually
39708 get truncated on the target.
39710 @node struct timeval
39711 @unnumberedsubsubsec struct timeval
39712 @cindex struct timeval, in file-i/o protocol
39714 The buffer of type @code{struct timeval} used by the File-I/O protocol
39715 is defined as follows:
39719 time_t tv_sec; /* second */
39720 long tv_usec; /* microsecond */
39724 The integral datatypes conform to the definitions given in the
39725 appropriate section (see @ref{Integral Datatypes}, for details) so this
39726 structure is of size 8 bytes.
39729 @subsection Constants
39730 @cindex constants, in file-i/o protocol
39732 The following values are used for the constants inside of the
39733 protocol. @value{GDBN} and target are responsible for translating these
39734 values before and after the call as needed.
39745 @unnumberedsubsubsec Open Flags
39746 @cindex open flags, in file-i/o protocol
39748 All values are given in hexadecimal representation.
39760 @node mode_t Values
39761 @unnumberedsubsubsec mode_t Values
39762 @cindex mode_t values, in file-i/o protocol
39764 All values are given in octal representation.
39781 @unnumberedsubsubsec Errno Values
39782 @cindex errno values, in file-i/o protocol
39784 All values are given in decimal representation.
39809 @code{EUNKNOWN} is used as a fallback error value if a host system returns
39810 any error value not in the list of supported error numbers.
39813 @unnumberedsubsubsec Lseek Flags
39814 @cindex lseek flags, in file-i/o protocol
39823 @unnumberedsubsubsec Limits
39824 @cindex limits, in file-i/o protocol
39826 All values are given in decimal representation.
39829 INT_MIN -2147483648
39831 UINT_MAX 4294967295
39832 LONG_MIN -9223372036854775808
39833 LONG_MAX 9223372036854775807
39834 ULONG_MAX 18446744073709551615
39837 @node File-I/O Examples
39838 @subsection File-I/O Examples
39839 @cindex file-i/o examples
39841 Example sequence of a write call, file descriptor 3, buffer is at target
39842 address 0x1234, 6 bytes should be written:
39845 <- @code{Fwrite,3,1234,6}
39846 @emph{request memory read from target}
39849 @emph{return "6 bytes written"}
39853 Example sequence of a read call, file descriptor 3, buffer is at target
39854 address 0x1234, 6 bytes should be read:
39857 <- @code{Fread,3,1234,6}
39858 @emph{request memory write to target}
39859 -> @code{X1234,6:XXXXXX}
39860 @emph{return "6 bytes read"}
39864 Example sequence of a read call, call fails on the host due to invalid
39865 file descriptor (@code{EBADF}):
39868 <- @code{Fread,3,1234,6}
39872 Example sequence of a read call, user presses @kbd{Ctrl-c} before syscall on
39876 <- @code{Fread,3,1234,6}
39881 Example sequence of a read call, user presses @kbd{Ctrl-c} after syscall on
39885 <- @code{Fread,3,1234,6}
39886 -> @code{X1234,6:XXXXXX}
39890 @node Library List Format
39891 @section Library List Format
39892 @cindex library list format, remote protocol
39894 On some platforms, a dynamic loader (e.g.@: @file{ld.so}) runs in the
39895 same process as your application to manage libraries. In this case,
39896 @value{GDBN} can use the loader's symbol table and normal memory
39897 operations to maintain a list of shared libraries. On other
39898 platforms, the operating system manages loaded libraries.
39899 @value{GDBN} can not retrieve the list of currently loaded libraries
39900 through memory operations, so it uses the @samp{qXfer:libraries:read}
39901 packet (@pxref{qXfer library list read}) instead. The remote stub
39902 queries the target's operating system and reports which libraries
39905 The @samp{qXfer:libraries:read} packet returns an XML document which
39906 lists loaded libraries and their offsets. Each library has an
39907 associated name and one or more segment or section base addresses,
39908 which report where the library was loaded in memory.
39910 For the common case of libraries that are fully linked binaries, the
39911 library should have a list of segments. If the target supports
39912 dynamic linking of a relocatable object file, its library XML element
39913 should instead include a list of allocated sections. The segment or
39914 section bases are start addresses, not relocation offsets; they do not
39915 depend on the library's link-time base addresses.
39917 @value{GDBN} must be linked with the Expat library to support XML
39918 library lists. @xref{Expat}.
39920 A simple memory map, with one loaded library relocated by a single
39921 offset, looks like this:
39925 <library name="/lib/libc.so.6">
39926 <segment address="0x10000000"/>
39931 Another simple memory map, with one loaded library with three
39932 allocated sections (.text, .data, .bss), looks like this:
39936 <library name="sharedlib.o">
39937 <section address="0x10000000"/>
39938 <section address="0x20000000"/>
39939 <section address="0x30000000"/>
39944 The format of a library list is described by this DTD:
39947 <!-- library-list: Root element with versioning -->
39948 <!ELEMENT library-list (library)*>
39949 <!ATTLIST library-list version CDATA #FIXED "1.0">
39950 <!ELEMENT library (segment*, section*)>
39951 <!ATTLIST library name CDATA #REQUIRED>
39952 <!ELEMENT segment EMPTY>
39953 <!ATTLIST segment address CDATA #REQUIRED>
39954 <!ELEMENT section EMPTY>
39955 <!ATTLIST section address CDATA #REQUIRED>
39958 In addition, segments and section descriptors cannot be mixed within a
39959 single library element, and you must supply at least one segment or
39960 section for each library.
39962 @node Library List Format for SVR4 Targets
39963 @section Library List Format for SVR4 Targets
39964 @cindex library list format, remote protocol
39966 On SVR4 platforms @value{GDBN} can use the symbol table of a dynamic loader
39967 (e.g.@: @file{ld.so}) and normal memory operations to maintain a list of
39968 shared libraries. Still a special library list provided by this packet is
39969 more efficient for the @value{GDBN} remote protocol.
39971 The @samp{qXfer:libraries-svr4:read} packet returns an XML document which lists
39972 loaded libraries and their SVR4 linker parameters. For each library on SVR4
39973 target, the following parameters are reported:
39977 @code{name}, the absolute file name from the @code{l_name} field of
39978 @code{struct link_map}.
39980 @code{lm} with address of @code{struct link_map} used for TLS
39981 (Thread Local Storage) access.
39983 @code{l_addr}, the displacement as read from the field @code{l_addr} of
39984 @code{struct link_map}. For prelinked libraries this is not an absolute
39985 memory address. It is a displacement of absolute memory address against
39986 address the file was prelinked to during the library load.
39988 @code{l_ld}, which is memory address of the @code{PT_DYNAMIC} segment
39991 Additionally the single @code{main-lm} attribute specifies address of
39992 @code{struct link_map} used for the main executable. This parameter is used
39993 for TLS access and its presence is optional.
39995 @value{GDBN} must be linked with the Expat library to support XML
39996 SVR4 library lists. @xref{Expat}.
39998 A simple memory map, with two loaded libraries (which do not use prelink),
40002 <library-list-svr4 version="1.0" main-lm="0xe4f8f8">
40003 <library name="/lib/ld-linux.so.2" lm="0xe4f51c" l_addr="0xe2d000"
40005 <library name="/lib/libc.so.6" lm="0xe4fbe8" l_addr="0x154000"
40007 </library-list-svr>
40010 The format of an SVR4 library list is described by this DTD:
40013 <!-- library-list-svr4: Root element with versioning -->
40014 <!ELEMENT library-list-svr4 (library)*>
40015 <!ATTLIST library-list-svr4 version CDATA #FIXED "1.0">
40016 <!ATTLIST library-list-svr4 main-lm CDATA #IMPLIED>
40017 <!ELEMENT library EMPTY>
40018 <!ATTLIST library name CDATA #REQUIRED>
40019 <!ATTLIST library lm CDATA #REQUIRED>
40020 <!ATTLIST library l_addr CDATA #REQUIRED>
40021 <!ATTLIST library l_ld CDATA #REQUIRED>
40024 @node Memory Map Format
40025 @section Memory Map Format
40026 @cindex memory map format
40028 To be able to write into flash memory, @value{GDBN} needs to obtain a
40029 memory map from the target. This section describes the format of the
40032 The memory map is obtained using the @samp{qXfer:memory-map:read}
40033 (@pxref{qXfer memory map read}) packet and is an XML document that
40034 lists memory regions.
40036 @value{GDBN} must be linked with the Expat library to support XML
40037 memory maps. @xref{Expat}.
40039 The top-level structure of the document is shown below:
40042 <?xml version="1.0"?>
40043 <!DOCTYPE memory-map
40044 PUBLIC "+//IDN gnu.org//DTD GDB Memory Map V1.0//EN"
40045 "http://sourceware.org/gdb/gdb-memory-map.dtd">
40051 Each region can be either:
40056 A region of RAM starting at @var{addr} and extending for @var{length}
40060 <memory type="ram" start="@var{addr}" length="@var{length}"/>
40065 A region of read-only memory:
40068 <memory type="rom" start="@var{addr}" length="@var{length}"/>
40073 A region of flash memory, with erasure blocks @var{blocksize}
40077 <memory type="flash" start="@var{addr}" length="@var{length}">
40078 <property name="blocksize">@var{blocksize}</property>
40084 Regions must not overlap. @value{GDBN} assumes that areas of memory not covered
40085 by the memory map are RAM, and uses the ordinary @samp{M} and @samp{X}
40086 packets to write to addresses in such ranges.
40088 The formal DTD for memory map format is given below:
40091 <!-- ................................................... -->
40092 <!-- Memory Map XML DTD ................................ -->
40093 <!-- File: memory-map.dtd .............................. -->
40094 <!-- .................................... .............. -->
40095 <!-- memory-map.dtd -->
40096 <!-- memory-map: Root element with versioning -->
40097 <!ELEMENT memory-map (memory | property)>
40098 <!ATTLIST memory-map version CDATA #FIXED "1.0.0">
40099 <!ELEMENT memory (property)>
40100 <!-- memory: Specifies a memory region,
40101 and its type, or device. -->
40102 <!ATTLIST memory type CDATA #REQUIRED
40103 start CDATA #REQUIRED
40104 length CDATA #REQUIRED
40105 device CDATA #IMPLIED>
40106 <!-- property: Generic attribute tag -->
40107 <!ELEMENT property (#PCDATA | property)*>
40108 <!ATTLIST property name CDATA #REQUIRED>
40111 @node Thread List Format
40112 @section Thread List Format
40113 @cindex thread list format
40115 To efficiently update the list of threads and their attributes,
40116 @value{GDBN} issues the @samp{qXfer:threads:read} packet
40117 (@pxref{qXfer threads read}) and obtains the XML document with
40118 the following structure:
40121 <?xml version="1.0"?>
40123 <thread id="id" core="0" name="name">
40124 ... description ...
40129 Each @samp{thread} element must have the @samp{id} attribute that
40130 identifies the thread (@pxref{thread-id syntax}). The
40131 @samp{core} attribute, if present, specifies which processor core
40132 the thread was last executing on. The @samp{name} attribute, if
40133 present, specifies the human-readable name of the thread. The content
40134 of the of @samp{thread} element is interpreted as human-readable
40135 auxiliary information.
40137 @node Traceframe Info Format
40138 @section Traceframe Info Format
40139 @cindex traceframe info format
40141 To be able to know which objects in the inferior can be examined when
40142 inspecting a tracepoint hit, @value{GDBN} needs to obtain the list of
40143 memory ranges, registers and trace state variables that have been
40144 collected in a traceframe.
40146 This list is obtained using the @samp{qXfer:traceframe-info:read}
40147 (@pxref{qXfer traceframe info read}) packet and is an XML document.
40149 @value{GDBN} must be linked with the Expat library to support XML
40150 traceframe info discovery. @xref{Expat}.
40152 The top-level structure of the document is shown below:
40155 <?xml version="1.0"?>
40156 <!DOCTYPE traceframe-info
40157 PUBLIC "+//IDN gnu.org//DTD GDB Memory Map V1.0//EN"
40158 "http://sourceware.org/gdb/gdb-traceframe-info.dtd">
40164 Each traceframe block can be either:
40169 A region of collected memory starting at @var{addr} and extending for
40170 @var{length} bytes from there:
40173 <memory start="@var{addr}" length="@var{length}"/>
40177 A block indicating trace state variable numbered @var{number} has been
40181 <tvar id="@var{number}"/>
40186 The formal DTD for the traceframe info format is given below:
40189 <!ELEMENT traceframe-info (memory | tvar)* >
40190 <!ATTLIST traceframe-info version CDATA #FIXED "1.0">
40192 <!ELEMENT memory EMPTY>
40193 <!ATTLIST memory start CDATA #REQUIRED
40194 length CDATA #REQUIRED>
40196 <!ATTLIST tvar id CDATA #REQUIRED>
40199 @node Branch Trace Format
40200 @section Branch Trace Format
40201 @cindex branch trace format
40203 In order to display the branch trace of an inferior thread,
40204 @value{GDBN} needs to obtain the list of branches. This list is
40205 represented as list of sequential code blocks that are connected via
40206 branches. The code in each block has been executed sequentially.
40208 This list is obtained using the @samp{qXfer:btrace:read}
40209 (@pxref{qXfer btrace read}) packet and is an XML document.
40211 @value{GDBN} must be linked with the Expat library to support XML
40212 traceframe info discovery. @xref{Expat}.
40214 The top-level structure of the document is shown below:
40217 <?xml version="1.0"?>
40219 PUBLIC "+//IDN gnu.org//DTD GDB Branch Trace V1.0//EN"
40220 "http://sourceware.org/gdb/gdb-btrace.dtd">
40229 A block of sequentially executed instructions starting at @var{begin}
40230 and ending at @var{end}:
40233 <block begin="@var{begin}" end="@var{end}"/>
40238 The formal DTD for the branch trace format is given below:
40241 <!ELEMENT btrace (block* | pt) >
40242 <!ATTLIST btrace version CDATA #FIXED "1.0">
40244 <!ELEMENT block EMPTY>
40245 <!ATTLIST block begin CDATA #REQUIRED
40246 end CDATA #REQUIRED>
40248 <!ELEMENT pt (pt-config?, raw?)>
40250 <!ELEMENT pt-config (cpu?)>
40252 <!ELEMENT cpu EMPTY>
40253 <!ATTLIST cpu vendor CDATA #REQUIRED
40254 family CDATA #REQUIRED
40255 model CDATA #REQUIRED
40256 stepping CDATA #REQUIRED>
40258 <!ELEMENT raw (#PCDATA)>
40261 @node Branch Trace Configuration Format
40262 @section Branch Trace Configuration Format
40263 @cindex branch trace configuration format
40265 For each inferior thread, @value{GDBN} can obtain the branch trace
40266 configuration using the @samp{qXfer:btrace-conf:read}
40267 (@pxref{qXfer btrace-conf read}) packet.
40269 The configuration describes the branch trace format and configuration
40270 settings for that format. The following information is described:
40274 This thread uses the @dfn{Branch Trace Store} (@acronym{BTS}) format.
40277 The size of the @acronym{BTS} ring buffer in bytes.
40280 This thread uses the @dfn{Intel Processor Trace} (@acronym{Intel
40284 The size of the @acronym{Intel PT} ring buffer in bytes.
40288 @value{GDBN} must be linked with the Expat library to support XML
40289 branch trace configuration discovery. @xref{Expat}.
40291 The formal DTD for the branch trace configuration format is given below:
40294 <!ELEMENT btrace-conf (bts?, pt?)>
40295 <!ATTLIST btrace-conf version CDATA #FIXED "1.0">
40297 <!ELEMENT bts EMPTY>
40298 <!ATTLIST bts size CDATA #IMPLIED>
40300 <!ELEMENT pt EMPTY>
40301 <!ATTLIST pt size CDATA #IMPLIED>
40304 @include agentexpr.texi
40306 @node Target Descriptions
40307 @appendix Target Descriptions
40308 @cindex target descriptions
40310 One of the challenges of using @value{GDBN} to debug embedded systems
40311 is that there are so many minor variants of each processor
40312 architecture in use. It is common practice for vendors to start with
40313 a standard processor core --- ARM, PowerPC, or @acronym{MIPS}, for example ---
40314 and then make changes to adapt it to a particular market niche. Some
40315 architectures have hundreds of variants, available from dozens of
40316 vendors. This leads to a number of problems:
40320 With so many different customized processors, it is difficult for
40321 the @value{GDBN} maintainers to keep up with the changes.
40323 Since individual variants may have short lifetimes or limited
40324 audiences, it may not be worthwhile to carry information about every
40325 variant in the @value{GDBN} source tree.
40327 When @value{GDBN} does support the architecture of the embedded system
40328 at hand, the task of finding the correct architecture name to give the
40329 @command{set architecture} command can be error-prone.
40332 To address these problems, the @value{GDBN} remote protocol allows a
40333 target system to not only identify itself to @value{GDBN}, but to
40334 actually describe its own features. This lets @value{GDBN} support
40335 processor variants it has never seen before --- to the extent that the
40336 descriptions are accurate, and that @value{GDBN} understands them.
40338 @value{GDBN} must be linked with the Expat library to support XML
40339 target descriptions. @xref{Expat}.
40342 * Retrieving Descriptions:: How descriptions are fetched from a target.
40343 * Target Description Format:: The contents of a target description.
40344 * Predefined Target Types:: Standard types available for target
40346 * Standard Target Features:: Features @value{GDBN} knows about.
40349 @node Retrieving Descriptions
40350 @section Retrieving Descriptions
40352 Target descriptions can be read from the target automatically, or
40353 specified by the user manually. The default behavior is to read the
40354 description from the target. @value{GDBN} retrieves it via the remote
40355 protocol using @samp{qXfer} requests (@pxref{General Query Packets,
40356 qXfer}). The @var{annex} in the @samp{qXfer} packet will be
40357 @samp{target.xml}. The contents of the @samp{target.xml} annex are an
40358 XML document, of the form described in @ref{Target Description
40361 Alternatively, you can specify a file to read for the target description.
40362 If a file is set, the target will not be queried. The commands to
40363 specify a file are:
40366 @cindex set tdesc filename
40367 @item set tdesc filename @var{path}
40368 Read the target description from @var{path}.
40370 @cindex unset tdesc filename
40371 @item unset tdesc filename
40372 Do not read the XML target description from a file. @value{GDBN}
40373 will use the description supplied by the current target.
40375 @cindex show tdesc filename
40376 @item show tdesc filename
40377 Show the filename to read for a target description, if any.
40381 @node Target Description Format
40382 @section Target Description Format
40383 @cindex target descriptions, XML format
40385 A target description annex is an @uref{http://www.w3.org/XML/, XML}
40386 document which complies with the Document Type Definition provided in
40387 the @value{GDBN} sources in @file{gdb/features/gdb-target.dtd}. This
40388 means you can use generally available tools like @command{xmllint} to
40389 check that your feature descriptions are well-formed and valid.
40390 However, to help people unfamiliar with XML write descriptions for
40391 their targets, we also describe the grammar here.
40393 Target descriptions can identify the architecture of the remote target
40394 and (for some architectures) provide information about custom register
40395 sets. They can also identify the OS ABI of the remote target.
40396 @value{GDBN} can use this information to autoconfigure for your
40397 target, or to warn you if you connect to an unsupported target.
40399 Here is a simple target description:
40402 <target version="1.0">
40403 <architecture>i386:x86-64</architecture>
40408 This minimal description only says that the target uses
40409 the x86-64 architecture.
40411 A target description has the following overall form, with [ ] marking
40412 optional elements and @dots{} marking repeatable elements. The elements
40413 are explained further below.
40416 <?xml version="1.0"?>
40417 <!DOCTYPE target SYSTEM "gdb-target.dtd">
40418 <target version="1.0">
40419 @r{[}@var{architecture}@r{]}
40420 @r{[}@var{osabi}@r{]}
40421 @r{[}@var{compatible}@r{]}
40422 @r{[}@var{feature}@dots{}@r{]}
40427 The description is generally insensitive to whitespace and line
40428 breaks, under the usual common-sense rules. The XML version
40429 declaration and document type declaration can generally be omitted
40430 (@value{GDBN} does not require them), but specifying them may be
40431 useful for XML validation tools. The @samp{version} attribute for
40432 @samp{<target>} may also be omitted, but we recommend
40433 including it; if future versions of @value{GDBN} use an incompatible
40434 revision of @file{gdb-target.dtd}, they will detect and report
40435 the version mismatch.
40437 @subsection Inclusion
40438 @cindex target descriptions, inclusion
40441 @cindex <xi:include>
40444 It can sometimes be valuable to split a target description up into
40445 several different annexes, either for organizational purposes, or to
40446 share files between different possible target descriptions. You can
40447 divide a description into multiple files by replacing any element of
40448 the target description with an inclusion directive of the form:
40451 <xi:include href="@var{document}"/>
40455 When @value{GDBN} encounters an element of this form, it will retrieve
40456 the named XML @var{document}, and replace the inclusion directive with
40457 the contents of that document. If the current description was read
40458 using @samp{qXfer}, then so will be the included document;
40459 @var{document} will be interpreted as the name of an annex. If the
40460 current description was read from a file, @value{GDBN} will look for
40461 @var{document} as a file in the same directory where it found the
40462 original description.
40464 @subsection Architecture
40465 @cindex <architecture>
40467 An @samp{<architecture>} element has this form:
40470 <architecture>@var{arch}</architecture>
40473 @var{arch} is one of the architectures from the set accepted by
40474 @code{set architecture} (@pxref{Targets, ,Specifying a Debugging Target}).
40477 @cindex @code{<osabi>}
40479 This optional field was introduced in @value{GDBN} version 7.0.
40480 Previous versions of @value{GDBN} ignore it.
40482 An @samp{<osabi>} element has this form:
40485 <osabi>@var{abi-name}</osabi>
40488 @var{abi-name} is an OS ABI name from the same selection accepted by
40489 @w{@code{set osabi}} (@pxref{ABI, ,Configuring the Current ABI}).
40491 @subsection Compatible Architecture
40492 @cindex @code{<compatible>}
40494 This optional field was introduced in @value{GDBN} version 7.0.
40495 Previous versions of @value{GDBN} ignore it.
40497 A @samp{<compatible>} element has this form:
40500 <compatible>@var{arch}</compatible>
40503 @var{arch} is one of the architectures from the set accepted by
40504 @code{set architecture} (@pxref{Targets, ,Specifying a Debugging Target}).
40506 A @samp{<compatible>} element is used to specify that the target
40507 is able to run binaries in some other than the main target architecture
40508 given by the @samp{<architecture>} element. For example, on the
40509 Cell Broadband Engine, the main architecture is @code{powerpc:common}
40510 or @code{powerpc:common64}, but the system is able to run binaries
40511 in the @code{spu} architecture as well. The way to describe this
40512 capability with @samp{<compatible>} is as follows:
40515 <architecture>powerpc:common</architecture>
40516 <compatible>spu</compatible>
40519 @subsection Features
40522 Each @samp{<feature>} describes some logical portion of the target
40523 system. Features are currently used to describe available CPU
40524 registers and the types of their contents. A @samp{<feature>} element
40528 <feature name="@var{name}">
40529 @r{[}@var{type}@dots{}@r{]}
40535 Each feature's name should be unique within the description. The name
40536 of a feature does not matter unless @value{GDBN} has some special
40537 knowledge of the contents of that feature; if it does, the feature
40538 should have its standard name. @xref{Standard Target Features}.
40542 Any register's value is a collection of bits which @value{GDBN} must
40543 interpret. The default interpretation is a two's complement integer,
40544 but other types can be requested by name in the register description.
40545 Some predefined types are provided by @value{GDBN} (@pxref{Predefined
40546 Target Types}), and the description can define additional composite types.
40548 Each type element must have an @samp{id} attribute, which gives
40549 a unique (within the containing @samp{<feature>}) name to the type.
40550 Types must be defined before they are used.
40553 Some targets offer vector registers, which can be treated as arrays
40554 of scalar elements. These types are written as @samp{<vector>} elements,
40555 specifying the array element type, @var{type}, and the number of elements,
40559 <vector id="@var{id}" type="@var{type}" count="@var{count}"/>
40563 If a register's value is usefully viewed in multiple ways, define it
40564 with a union type containing the useful representations. The
40565 @samp{<union>} element contains one or more @samp{<field>} elements,
40566 each of which has a @var{name} and a @var{type}:
40569 <union id="@var{id}">
40570 <field name="@var{name}" type="@var{type}"/>
40576 If a register's value is composed from several separate values, define
40577 it with a structure type. There are two forms of the @samp{<struct>}
40578 element; a @samp{<struct>} element must either contain only bitfields
40579 or contain no bitfields. If the structure contains only bitfields,
40580 its total size in bytes must be specified, each bitfield must have an
40581 explicit start and end, and bitfields are automatically assigned an
40582 integer type. The field's @var{start} should be less than or
40583 equal to its @var{end}, and zero represents the least significant bit.
40586 <struct id="@var{id}" size="@var{size}">
40587 <field name="@var{name}" start="@var{start}" end="@var{end}"/>
40592 If the structure contains no bitfields, then each field has an
40593 explicit type, and no implicit padding is added.
40596 <struct id="@var{id}">
40597 <field name="@var{name}" type="@var{type}"/>
40603 If a register's value is a series of single-bit flags, define it with
40604 a flags type. The @samp{<flags>} element has an explicit @var{size}
40605 and contains one or more @samp{<field>} elements. Each field has a
40606 @var{name}, a @var{start}, and an @var{end}. Only single-bit flags
40610 <flags id="@var{id}" size="@var{size}">
40611 <field name="@var{name}" start="@var{start}" end="@var{end}"/>
40616 @subsection Registers
40619 Each register is represented as an element with this form:
40622 <reg name="@var{name}"
40623 bitsize="@var{size}"
40624 @r{[}regnum="@var{num}"@r{]}
40625 @r{[}save-restore="@var{save-restore}"@r{]}
40626 @r{[}type="@var{type}"@r{]}
40627 @r{[}group="@var{group}"@r{]}/>
40631 The components are as follows:
40636 The register's name; it must be unique within the target description.
40639 The register's size, in bits.
40642 The register's number. If omitted, a register's number is one greater
40643 than that of the previous register (either in the current feature or in
40644 a preceding feature); the first register in the target description
40645 defaults to zero. This register number is used to read or write
40646 the register; e.g.@: it is used in the remote @code{p} and @code{P}
40647 packets, and registers appear in the @code{g} and @code{G} packets
40648 in order of increasing register number.
40651 Whether the register should be preserved across inferior function
40652 calls; this must be either @code{yes} or @code{no}. The default is
40653 @code{yes}, which is appropriate for most registers except for
40654 some system control registers; this is not related to the target's
40658 The type of the register. It may be a predefined type, a type
40659 defined in the current feature, or one of the special types @code{int}
40660 and @code{float}. @code{int} is an integer type of the correct size
40661 for @var{bitsize}, and @code{float} is a floating point type (in the
40662 architecture's normal floating point format) of the correct size for
40663 @var{bitsize}. The default is @code{int}.
40666 The register group to which this register belongs. It must
40667 be either @code{general}, @code{float}, or @code{vector}. If no
40668 @var{group} is specified, @value{GDBN} will not display the register
40669 in @code{info registers}.
40673 @node Predefined Target Types
40674 @section Predefined Target Types
40675 @cindex target descriptions, predefined types
40677 Type definitions in the self-description can build up composite types
40678 from basic building blocks, but can not define fundamental types. Instead,
40679 standard identifiers are provided by @value{GDBN} for the fundamental
40680 types. The currently supported types are:
40689 Signed integer types holding the specified number of bits.
40696 Unsigned integer types holding the specified number of bits.
40700 Pointers to unspecified code and data. The program counter and
40701 any dedicated return address register may be marked as code
40702 pointers; printing a code pointer converts it into a symbolic
40703 address. The stack pointer and any dedicated address registers
40704 may be marked as data pointers.
40707 Single precision IEEE floating point.
40710 Double precision IEEE floating point.
40713 The 12-byte extended precision format used by ARM FPA registers.
40716 The 10-byte extended precision format used by x87 registers.
40719 32bit @sc{eflags} register used by x86.
40722 32bit @sc{mxcsr} register used by x86.
40726 @node Standard Target Features
40727 @section Standard Target Features
40728 @cindex target descriptions, standard features
40730 A target description must contain either no registers or all the
40731 target's registers. If the description contains no registers, then
40732 @value{GDBN} will assume a default register layout, selected based on
40733 the architecture. If the description contains any registers, the
40734 default layout will not be used; the standard registers must be
40735 described in the target description, in such a way that @value{GDBN}
40736 can recognize them.
40738 This is accomplished by giving specific names to feature elements
40739 which contain standard registers. @value{GDBN} will look for features
40740 with those names and verify that they contain the expected registers;
40741 if any known feature is missing required registers, or if any required
40742 feature is missing, @value{GDBN} will reject the target
40743 description. You can add additional registers to any of the
40744 standard features --- @value{GDBN} will display them just as if
40745 they were added to an unrecognized feature.
40747 This section lists the known features and their expected contents.
40748 Sample XML documents for these features are included in the
40749 @value{GDBN} source tree, in the directory @file{gdb/features}.
40751 Names recognized by @value{GDBN} should include the name of the
40752 company or organization which selected the name, and the overall
40753 architecture to which the feature applies; so e.g.@: the feature
40754 containing ARM core registers is named @samp{org.gnu.gdb.arm.core}.
40756 The names of registers are not case sensitive for the purpose
40757 of recognizing standard features, but @value{GDBN} will only display
40758 registers using the capitalization used in the description.
40761 * AArch64 Features::
40764 * MicroBlaze Features::
40767 * Nios II Features::
40768 * PowerPC Features::
40769 * S/390 and System z Features::
40774 @node AArch64 Features
40775 @subsection AArch64 Features
40776 @cindex target descriptions, AArch64 features
40778 The @samp{org.gnu.gdb.aarch64.core} feature is required for AArch64
40779 targets. It should contain registers @samp{x0} through @samp{x30},
40780 @samp{sp}, @samp{pc}, and @samp{cpsr}.
40782 The @samp{org.gnu.gdb.aarch64.fpu} feature is optional. If present,
40783 it should contain registers @samp{v0} through @samp{v31}, @samp{fpsr},
40787 @subsection ARM Features
40788 @cindex target descriptions, ARM features
40790 The @samp{org.gnu.gdb.arm.core} feature is required for non-M-profile
40792 It should contain registers @samp{r0} through @samp{r13}, @samp{sp},
40793 @samp{lr}, @samp{pc}, and @samp{cpsr}.
40795 For M-profile targets (e.g. Cortex-M3), the @samp{org.gnu.gdb.arm.core}
40796 feature is replaced by @samp{org.gnu.gdb.arm.m-profile}. It should contain
40797 registers @samp{r0} through @samp{r13}, @samp{sp}, @samp{lr}, @samp{pc},
40800 The @samp{org.gnu.gdb.arm.fpa} feature is optional. If present, it
40801 should contain registers @samp{f0} through @samp{f7} and @samp{fps}.
40803 The @samp{org.gnu.gdb.xscale.iwmmxt} feature is optional. If present,
40804 it should contain at least registers @samp{wR0} through @samp{wR15} and
40805 @samp{wCGR0} through @samp{wCGR3}. The @samp{wCID}, @samp{wCon},
40806 @samp{wCSSF}, and @samp{wCASF} registers are optional.
40808 The @samp{org.gnu.gdb.arm.vfp} feature is optional. If present, it
40809 should contain at least registers @samp{d0} through @samp{d15}. If
40810 they are present, @samp{d16} through @samp{d31} should also be included.
40811 @value{GDBN} will synthesize the single-precision registers from
40812 halves of the double-precision registers.
40814 The @samp{org.gnu.gdb.arm.neon} feature is optional. It does not
40815 need to contain registers; it instructs @value{GDBN} to display the
40816 VFP double-precision registers as vectors and to synthesize the
40817 quad-precision registers from pairs of double-precision registers.
40818 If this feature is present, @samp{org.gnu.gdb.arm.vfp} must also
40819 be present and include 32 double-precision registers.
40821 @node i386 Features
40822 @subsection i386 Features
40823 @cindex target descriptions, i386 features
40825 The @samp{org.gnu.gdb.i386.core} feature is required for i386/amd64
40826 targets. It should describe the following registers:
40830 @samp{eax} through @samp{edi} plus @samp{eip} for i386
40832 @samp{rax} through @samp{r15} plus @samp{rip} for amd64
40834 @samp{eflags}, @samp{cs}, @samp{ss}, @samp{ds}, @samp{es},
40835 @samp{fs}, @samp{gs}
40837 @samp{st0} through @samp{st7}
40839 @samp{fctrl}, @samp{fstat}, @samp{ftag}, @samp{fiseg}, @samp{fioff},
40840 @samp{foseg}, @samp{fooff} and @samp{fop}
40843 The register sets may be different, depending on the target.
40845 The @samp{org.gnu.gdb.i386.sse} feature is optional. It should
40846 describe registers:
40850 @samp{xmm0} through @samp{xmm7} for i386
40852 @samp{xmm0} through @samp{xmm15} for amd64
40857 The @samp{org.gnu.gdb.i386.avx} feature is optional and requires the
40858 @samp{org.gnu.gdb.i386.sse} feature. It should
40859 describe the upper 128 bits of @sc{ymm} registers:
40863 @samp{ymm0h} through @samp{ymm7h} for i386
40865 @samp{ymm0h} through @samp{ymm15h} for amd64
40868 The @samp{org.gnu.gdb.i386.mpx} is an optional feature representing Intel
40869 Memory Protection Extension (MPX). It should describe the following registers:
40873 @samp{bnd0raw} through @samp{bnd3raw} for i386 and amd64.
40875 @samp{bndcfgu} and @samp{bndstatus} for i386 and amd64.
40878 The @samp{org.gnu.gdb.i386.linux} feature is optional. It should
40879 describe a single register, @samp{orig_eax}.
40881 The @samp{org.gnu.gdb.i386.avx512} feature is optional and requires the
40882 @samp{org.gnu.gdb.i386.avx} feature. It should
40883 describe additional @sc{xmm} registers:
40887 @samp{xmm16h} through @samp{xmm31h}, only valid for amd64.
40890 It should describe the upper 128 bits of additional @sc{ymm} registers:
40894 @samp{ymm16h} through @samp{ymm31h}, only valid for amd64.
40898 describe the upper 256 bits of @sc{zmm} registers:
40902 @samp{zmm0h} through @samp{zmm7h} for i386.
40904 @samp{zmm0h} through @samp{zmm15h} for amd64.
40908 describe the additional @sc{zmm} registers:
40912 @samp{zmm16h} through @samp{zmm31h}, only valid for amd64.
40915 @node MicroBlaze Features
40916 @subsection MicroBlaze Features
40917 @cindex target descriptions, MicroBlaze features
40919 The @samp{org.gnu.gdb.microblaze.core} feature is required for MicroBlaze
40920 targets. It should contain registers @samp{r0} through @samp{r31},
40921 @samp{rpc}, @samp{rmsr}, @samp{rear}, @samp{resr}, @samp{rfsr}, @samp{rbtr},
40922 @samp{rpvr}, @samp{rpvr1} through @samp{rpvr11}, @samp{redr}, @samp{rpid},
40923 @samp{rzpr}, @samp{rtlbx}, @samp{rtlbsx}, @samp{rtlblo}, and @samp{rtlbhi}.
40925 The @samp{org.gnu.gdb.microblaze.stack-protect} feature is optional.
40926 If present, it should contain registers @samp{rshr} and @samp{rslr}
40928 @node MIPS Features
40929 @subsection @acronym{MIPS} Features
40930 @cindex target descriptions, @acronym{MIPS} features
40932 The @samp{org.gnu.gdb.mips.cpu} feature is required for @acronym{MIPS} targets.
40933 It should contain registers @samp{r0} through @samp{r31}, @samp{lo},
40934 @samp{hi}, and @samp{pc}. They may be 32-bit or 64-bit depending
40937 The @samp{org.gnu.gdb.mips.cp0} feature is also required. It should
40938 contain at least the @samp{status}, @samp{badvaddr}, and @samp{cause}
40939 registers. They may be 32-bit or 64-bit depending on the target.
40941 The @samp{org.gnu.gdb.mips.fpu} feature is currently required, though
40942 it may be optional in a future version of @value{GDBN}. It should
40943 contain registers @samp{f0} through @samp{f31}, @samp{fcsr}, and
40944 @samp{fir}. They may be 32-bit or 64-bit depending on the target.
40946 The @samp{org.gnu.gdb.mips.dsp} feature is optional. It should
40947 contain registers @samp{hi1} through @samp{hi3}, @samp{lo1} through
40948 @samp{lo3}, and @samp{dspctl}. The @samp{dspctl} register should
40949 be 32-bit and the rest may be 32-bit or 64-bit depending on the target.
40951 The @samp{org.gnu.gdb.mips.linux} feature is optional. It should
40952 contain a single register, @samp{restart}, which is used by the
40953 Linux kernel to control restartable syscalls.
40955 @node M68K Features
40956 @subsection M68K Features
40957 @cindex target descriptions, M68K features
40960 @item @samp{org.gnu.gdb.m68k.core}
40961 @itemx @samp{org.gnu.gdb.coldfire.core}
40962 @itemx @samp{org.gnu.gdb.fido.core}
40963 One of those features must be always present.
40964 The feature that is present determines which flavor of m68k is
40965 used. The feature that is present should contain registers
40966 @samp{d0} through @samp{d7}, @samp{a0} through @samp{a5}, @samp{fp},
40967 @samp{sp}, @samp{ps} and @samp{pc}.
40969 @item @samp{org.gnu.gdb.coldfire.fp}
40970 This feature is optional. If present, it should contain registers
40971 @samp{fp0} through @samp{fp7}, @samp{fpcontrol}, @samp{fpstatus} and
40975 @node Nios II Features
40976 @subsection Nios II Features
40977 @cindex target descriptions, Nios II features
40979 The @samp{org.gnu.gdb.nios2.cpu} feature is required for Nios II
40980 targets. It should contain the 32 core registers (@samp{zero},
40981 @samp{at}, @samp{r2} through @samp{r23}, @samp{et} through @samp{ra}),
40982 @samp{pc}, and the 16 control registers (@samp{status} through
40985 @node PowerPC Features
40986 @subsection PowerPC Features
40987 @cindex target descriptions, PowerPC features
40989 The @samp{org.gnu.gdb.power.core} feature is required for PowerPC
40990 targets. It should contain registers @samp{r0} through @samp{r31},
40991 @samp{pc}, @samp{msr}, @samp{cr}, @samp{lr}, @samp{ctr}, and
40992 @samp{xer}. They may be 32-bit or 64-bit depending on the target.
40994 The @samp{org.gnu.gdb.power.fpu} feature is optional. It should
40995 contain registers @samp{f0} through @samp{f31} and @samp{fpscr}.
40997 The @samp{org.gnu.gdb.power.altivec} feature is optional. It should
40998 contain registers @samp{vr0} through @samp{vr31}, @samp{vscr},
41001 The @samp{org.gnu.gdb.power.vsx} feature is optional. It should
41002 contain registers @samp{vs0h} through @samp{vs31h}. @value{GDBN}
41003 will combine these registers with the floating point registers
41004 (@samp{f0} through @samp{f31}) and the altivec registers (@samp{vr0}
41005 through @samp{vr31}) to present the 128-bit wide registers @samp{vs0}
41006 through @samp{vs63}, the set of vector registers for POWER7.
41008 The @samp{org.gnu.gdb.power.spe} feature is optional. It should
41009 contain registers @samp{ev0h} through @samp{ev31h}, @samp{acc}, and
41010 @samp{spefscr}. SPE targets should provide 32-bit registers in
41011 @samp{org.gnu.gdb.power.core} and provide the upper halves in
41012 @samp{ev0h} through @samp{ev31h}. @value{GDBN} will combine
41013 these to present registers @samp{ev0} through @samp{ev31} to the
41016 @node S/390 and System z Features
41017 @subsection S/390 and System z Features
41018 @cindex target descriptions, S/390 features
41019 @cindex target descriptions, System z features
41021 The @samp{org.gnu.gdb.s390.core} feature is required for S/390 and
41022 System z targets. It should contain the PSW and the 16 general
41023 registers. In particular, System z targets should provide the 64-bit
41024 registers @samp{pswm}, @samp{pswa}, and @samp{r0} through @samp{r15}.
41025 S/390 targets should provide the 32-bit versions of these registers.
41026 A System z target that runs in 31-bit addressing mode should provide
41027 32-bit versions of @samp{pswm} and @samp{pswa}, as well as the general
41028 register's upper halves @samp{r0h} through @samp{r15h}, and their
41029 lower halves @samp{r0l} through @samp{r15l}.
41031 The @samp{org.gnu.gdb.s390.fpr} feature is required. It should
41032 contain the 64-bit registers @samp{f0} through @samp{f15}, and
41035 The @samp{org.gnu.gdb.s390.acr} feature is required. It should
41036 contain the 32-bit registers @samp{acr0} through @samp{acr15}.
41038 The @samp{org.gnu.gdb.s390.linux} feature is optional. It should
41039 contain the register @samp{orig_r2}, which is 64-bit wide on System z
41040 targets and 32-bit otherwise. In addition, the feature may contain
41041 the @samp{last_break} register, whose width depends on the addressing
41042 mode, as well as the @samp{system_call} register, which is always
41045 The @samp{org.gnu.gdb.s390.tdb} feature is optional. It should
41046 contain the 64-bit registers @samp{tdb0}, @samp{tac}, @samp{tct},
41047 @samp{atia}, and @samp{tr0} through @samp{tr15}.
41049 The @samp{org.gnu.gdb.s390.vx} feature is optional. It should contain
41050 64-bit wide registers @samp{v0l} through @samp{v15l}, which will be
41051 combined by @value{GDBN} with the floating point registers @samp{f0}
41052 through @samp{f15} to present the 128-bit wide vector registers
41053 @samp{v0} through @samp{v15}. In addition, this feature should
41054 contain the 128-bit wide vector registers @samp{v16} through
41057 @node TIC6x Features
41058 @subsection TMS320C6x Features
41059 @cindex target descriptions, TIC6x features
41060 @cindex target descriptions, TMS320C6x features
41061 The @samp{org.gnu.gdb.tic6x.core} feature is required for TMS320C6x
41062 targets. It should contain registers @samp{A0} through @samp{A15},
41063 registers @samp{B0} through @samp{B15}, @samp{CSR} and @samp{PC}.
41065 The @samp{org.gnu.gdb.tic6x.gp} feature is optional. It should
41066 contain registers @samp{A16} through @samp{A31} and @samp{B16}
41067 through @samp{B31}.
41069 The @samp{org.gnu.gdb.tic6x.c6xp} feature is optional. It should
41070 contain registers @samp{TSR}, @samp{ILC} and @samp{RILC}.
41072 @node Operating System Information
41073 @appendix Operating System Information
41074 @cindex operating system information
41080 Users of @value{GDBN} often wish to obtain information about the state of
41081 the operating system running on the target---for example the list of
41082 processes, or the list of open files. This section describes the
41083 mechanism that makes it possible. This mechanism is similar to the
41084 target features mechanism (@pxref{Target Descriptions}), but focuses
41085 on a different aspect of target.
41087 Operating system information is retrived from the target via the
41088 remote protocol, using @samp{qXfer} requests (@pxref{qXfer osdata
41089 read}). The object name in the request should be @samp{osdata}, and
41090 the @var{annex} identifies the data to be fetched.
41093 @appendixsection Process list
41094 @cindex operating system information, process list
41096 When requesting the process list, the @var{annex} field in the
41097 @samp{qXfer} request should be @samp{processes}. The returned data is
41098 an XML document. The formal syntax of this document is defined in
41099 @file{gdb/features/osdata.dtd}.
41101 An example document is:
41104 <?xml version="1.0"?>
41105 <!DOCTYPE target SYSTEM "osdata.dtd">
41106 <osdata type="processes">
41108 <column name="pid">1</column>
41109 <column name="user">root</column>
41110 <column name="command">/sbin/init</column>
41111 <column name="cores">1,2,3</column>
41116 Each item should include a column whose name is @samp{pid}. The value
41117 of that column should identify the process on the target. The
41118 @samp{user} and @samp{command} columns are optional, and will be
41119 displayed by @value{GDBN}. The @samp{cores} column, if present,
41120 should contain a comma-separated list of cores that this process
41121 is running on. Target may provide additional columns,
41122 which @value{GDBN} currently ignores.
41124 @node Trace File Format
41125 @appendix Trace File Format
41126 @cindex trace file format
41128 The trace file comes in three parts: a header, a textual description
41129 section, and a trace frame section with binary data.
41131 The header has the form @code{\x7fTRACE0\n}. The first byte is
41132 @code{0x7f} so as to indicate that the file contains binary data,
41133 while the @code{0} is a version number that may have different values
41136 The description section consists of multiple lines of @sc{ascii} text
41137 separated by newline characters (@code{0xa}). The lines may include a
41138 variety of optional descriptive or context-setting information, such
41139 as tracepoint definitions or register set size. @value{GDBN} will
41140 ignore any line that it does not recognize. An empty line marks the end
41145 Specifies the size of a register block in bytes. This is equal to the
41146 size of a @code{g} packet payload in the remote protocol. @var{size}
41147 is an ascii decimal number. There should be only one such line in
41148 a single trace file.
41150 @item status @var{status}
41151 Trace status. @var{status} has the same format as a @code{qTStatus}
41152 remote packet reply. There should be only one such line in a single trace
41155 @item tp @var{payload}
41156 Tracepoint definition. The @var{payload} has the same format as
41157 @code{qTfP}/@code{qTsP} remote packet reply payload. A single tracepoint
41158 may take multiple lines of definition, corresponding to the multiple
41161 @item tsv @var{payload}
41162 Trace state variable definition. The @var{payload} has the same format as
41163 @code{qTfV}/@code{qTsV} remote packet reply payload. A single variable
41164 may take multiple lines of definition, corresponding to the multiple
41167 @item tdesc @var{payload}
41168 Target description in XML format. The @var{payload} is a single line of
41169 the XML file. All such lines should be concatenated together to get
41170 the original XML file. This file is in the same format as @code{qXfer}
41171 @code{features} payload, and corresponds to the main @code{target.xml}
41172 file. Includes are not allowed.
41176 The trace frame section consists of a number of consecutive frames.
41177 Each frame begins with a two-byte tracepoint number, followed by a
41178 four-byte size giving the amount of data in the frame. The data in
41179 the frame consists of a number of blocks, each introduced by a
41180 character indicating its type (at least register, memory, and trace
41181 state variable). The data in this section is raw binary, not a
41182 hexadecimal or other encoding; its endianness matches the target's
41185 @c FIXME bi-arch may require endianness/arch info in description section
41188 @item R @var{bytes}
41189 Register block. The number and ordering of bytes matches that of a
41190 @code{g} packet in the remote protocol. Note that these are the
41191 actual bytes, in target order, not a hexadecimal encoding.
41193 @item M @var{address} @var{length} @var{bytes}...
41194 Memory block. This is a contiguous block of memory, at the 8-byte
41195 address @var{address}, with a 2-byte length @var{length}, followed by
41196 @var{length} bytes.
41198 @item V @var{number} @var{value}
41199 Trace state variable block. This records the 8-byte signed value
41200 @var{value} of trace state variable numbered @var{number}.
41204 Future enhancements of the trace file format may include additional types
41207 @node Index Section Format
41208 @appendix @code{.gdb_index} section format
41209 @cindex .gdb_index section format
41210 @cindex index section format
41212 This section documents the index section that is created by @code{save
41213 gdb-index} (@pxref{Index Files}). The index section is
41214 DWARF-specific; some knowledge of DWARF is assumed in this
41217 The mapped index file format is designed to be directly
41218 @code{mmap}able on any architecture. In most cases, a datum is
41219 represented using a little-endian 32-bit integer value, called an
41220 @code{offset_type}. Big endian machines must byte-swap the values
41221 before using them. Exceptions to this rule are noted. The data is
41222 laid out such that alignment is always respected.
41224 A mapped index consists of several areas, laid out in order.
41228 The file header. This is a sequence of values, of @code{offset_type}
41229 unless otherwise noted:
41233 The version number, currently 8. Versions 1, 2 and 3 are obsolete.
41234 Version 4 uses a different hashing function from versions 5 and 6.
41235 Version 6 includes symbols for inlined functions, whereas versions 4
41236 and 5 do not. Version 7 adds attributes to the CU indices in the
41237 symbol table. Version 8 specifies that symbols from DWARF type units
41238 (@samp{DW_TAG_type_unit}) refer to the type unit's symbol table and not the
41239 compilation unit (@samp{DW_TAG_comp_unit}) using the type.
41241 @value{GDBN} will only read version 4, 5, or 6 indices
41242 by specifying @code{set use-deprecated-index-sections on}.
41243 GDB has a workaround for potentially broken version 7 indices so it is
41244 currently not flagged as deprecated.
41247 The offset, from the start of the file, of the CU list.
41250 The offset, from the start of the file, of the types CU list. Note
41251 that this area can be empty, in which case this offset will be equal
41252 to the next offset.
41255 The offset, from the start of the file, of the address area.
41258 The offset, from the start of the file, of the symbol table.
41261 The offset, from the start of the file, of the constant pool.
41265 The CU list. This is a sequence of pairs of 64-bit little-endian
41266 values, sorted by the CU offset. The first element in each pair is
41267 the offset of a CU in the @code{.debug_info} section. The second
41268 element in each pair is the length of that CU. References to a CU
41269 elsewhere in the map are done using a CU index, which is just the
41270 0-based index into this table. Note that if there are type CUs, then
41271 conceptually CUs and type CUs form a single list for the purposes of
41275 The types CU list. This is a sequence of triplets of 64-bit
41276 little-endian values. In a triplet, the first value is the CU offset,
41277 the second value is the type offset in the CU, and the third value is
41278 the type signature. The types CU list is not sorted.
41281 The address area. The address area consists of a sequence of address
41282 entries. Each address entry has three elements:
41286 The low address. This is a 64-bit little-endian value.
41289 The high address. This is a 64-bit little-endian value. Like
41290 @code{DW_AT_high_pc}, the value is one byte beyond the end.
41293 The CU index. This is an @code{offset_type} value.
41297 The symbol table. This is an open-addressed hash table. The size of
41298 the hash table is always a power of 2.
41300 Each slot in the hash table consists of a pair of @code{offset_type}
41301 values. The first value is the offset of the symbol's name in the
41302 constant pool. The second value is the offset of the CU vector in the
41305 If both values are 0, then this slot in the hash table is empty. This
41306 is ok because while 0 is a valid constant pool index, it cannot be a
41307 valid index for both a string and a CU vector.
41309 The hash value for a table entry is computed by applying an
41310 iterative hash function to the symbol's name. Starting with an
41311 initial value of @code{r = 0}, each (unsigned) character @samp{c} in
41312 the string is incorporated into the hash using the formula depending on the
41317 The formula is @code{r = r * 67 + c - 113}.
41319 @item Versions 5 to 7
41320 The formula is @code{r = r * 67 + tolower (c) - 113}.
41323 The terminating @samp{\0} is not incorporated into the hash.
41325 The step size used in the hash table is computed via
41326 @code{((hash * 17) & (size - 1)) | 1}, where @samp{hash} is the hash
41327 value, and @samp{size} is the size of the hash table. The step size
41328 is used to find the next candidate slot when handling a hash
41331 The names of C@t{++} symbols in the hash table are canonicalized. We
41332 don't currently have a simple description of the canonicalization
41333 algorithm; if you intend to create new index sections, you must read
41337 The constant pool. This is simply a bunch of bytes. It is organized
41338 so that alignment is correct: CU vectors are stored first, followed by
41341 A CU vector in the constant pool is a sequence of @code{offset_type}
41342 values. The first value is the number of CU indices in the vector.
41343 Each subsequent value is the index and symbol attributes of a CU in
41344 the CU list. This element in the hash table is used to indicate which
41345 CUs define the symbol and how the symbol is used.
41346 See below for the format of each CU index+attributes entry.
41348 A string in the constant pool is zero-terminated.
41351 Attributes were added to CU index values in @code{.gdb_index} version 7.
41352 If a symbol has multiple uses within a CU then there is one
41353 CU index+attributes value for each use.
41355 The format of each CU index+attributes entry is as follows
41361 This is the index of the CU in the CU list.
41363 These bits are reserved for future purposes and must be zero.
41365 The kind of the symbol in the CU.
41369 This value is reserved and should not be used.
41370 By reserving zero the full @code{offset_type} value is backwards compatible
41371 with previous versions of the index.
41373 The symbol is a type.
41375 The symbol is a variable or an enum value.
41377 The symbol is a function.
41379 Any other kind of symbol.
41381 These values are reserved.
41385 This bit is zero if the value is global and one if it is static.
41387 The determination of whether a symbol is global or static is complicated.
41388 The authorative reference is the file @file{dwarf2read.c} in
41389 @value{GDBN} sources.
41393 This pseudo-code describes the computation of a symbol's kind and
41394 global/static attributes in the index.
41397 is_external = get_attribute (die, DW_AT_external);
41398 language = get_attribute (cu_die, DW_AT_language);
41401 case DW_TAG_typedef:
41402 case DW_TAG_base_type:
41403 case DW_TAG_subrange_type:
41407 case DW_TAG_enumerator:
41409 is_static = (language != CPLUS && language != JAVA);
41411 case DW_TAG_subprogram:
41413 is_static = ! (is_external || language == ADA);
41415 case DW_TAG_constant:
41417 is_static = ! is_external;
41419 case DW_TAG_variable:
41421 is_static = ! is_external;
41423 case DW_TAG_namespace:
41427 case DW_TAG_class_type:
41428 case DW_TAG_interface_type:
41429 case DW_TAG_structure_type:
41430 case DW_TAG_union_type:
41431 case DW_TAG_enumeration_type:
41433 is_static = (language != CPLUS && language != JAVA);
41441 @appendix Manual pages
41445 * gdb man:: The GNU Debugger man page
41446 * gdbserver man:: Remote Server for the GNU Debugger man page
41447 * gcore man:: Generate a core file of a running program
41448 * gdbinit man:: gdbinit scripts
41454 @c man title gdb The GNU Debugger
41456 @c man begin SYNOPSIS gdb
41457 gdb [@option{-help}] [@option{-nh}] [@option{-nx}] [@option{-q}]
41458 [@option{-batch}] [@option{-cd=}@var{dir}] [@option{-f}]
41459 [@option{-b}@w{ }@var{bps}]
41460 [@option{-tty=}@var{dev}] [@option{-s} @var{symfile}]
41461 [@option{-e}@w{ }@var{prog}] [@option{-se}@w{ }@var{prog}]
41462 [@option{-c}@w{ }@var{core}] [@option{-p}@w{ }@var{procID}]
41463 [@option{-x}@w{ }@var{cmds}] [@option{-d}@w{ }@var{dir}]
41464 [@var{prog}|@var{prog} @var{procID}|@var{prog} @var{core}]
41467 @c man begin DESCRIPTION gdb
41468 The purpose of a debugger such as @value{GDBN} is to allow you to see what is
41469 going on ``inside'' another program while it executes -- or what another
41470 program was doing at the moment it crashed.
41472 @value{GDBN} can do four main kinds of things (plus other things in support of
41473 these) to help you catch bugs in the act:
41477 Start your program, specifying anything that might affect its behavior.
41480 Make your program stop on specified conditions.
41483 Examine what has happened, when your program has stopped.
41486 Change things in your program, so you can experiment with correcting the
41487 effects of one bug and go on to learn about another.
41490 You can use @value{GDBN} to debug programs written in C, C@t{++}, Fortran and
41493 @value{GDBN} is invoked with the shell command @code{gdb}. Once started, it reads
41494 commands from the terminal until you tell it to exit with the @value{GDBN}
41495 command @code{quit}. You can get online help from @value{GDBN} itself
41496 by using the command @code{help}.
41498 You can run @code{gdb} with no arguments or options; but the most
41499 usual way to start @value{GDBN} is with one argument or two, specifying an
41500 executable program as the argument:
41506 You can also start with both an executable program and a core file specified:
41512 You can, instead, specify a process ID as a second argument, if you want
41513 to debug a running process:
41521 would attach @value{GDBN} to process @code{1234} (unless you also have a file
41522 named @file{1234}; @value{GDBN} does check for a core file first).
41523 With option @option{-p} you can omit the @var{program} filename.
41525 Here are some of the most frequently needed @value{GDBN} commands:
41527 @c pod2man highlights the right hand side of the @item lines.
41529 @item break [@var{file}:]@var{functiop}
41530 Set a breakpoint at @var{function} (in @var{file}).
41532 @item run [@var{arglist}]
41533 Start your program (with @var{arglist}, if specified).
41536 Backtrace: display the program stack.
41538 @item print @var{expr}
41539 Display the value of an expression.
41542 Continue running your program (after stopping, e.g. at a breakpoint).
41545 Execute next program line (after stopping); step @emph{over} any
41546 function calls in the line.
41548 @item edit [@var{file}:]@var{function}
41549 look at the program line where it is presently stopped.
41551 @item list [@var{file}:]@var{function}
41552 type the text of the program in the vicinity of where it is presently stopped.
41555 Execute next program line (after stopping); step @emph{into} any
41556 function calls in the line.
41558 @item help [@var{name}]
41559 Show information about @value{GDBN} command @var{name}, or general information
41560 about using @value{GDBN}.
41563 Exit from @value{GDBN}.
41567 For full details on @value{GDBN},
41568 see @cite{Using GDB: A Guide to the GNU Source-Level Debugger},
41569 by Richard M. Stallman and Roland H. Pesch. The same text is available online
41570 as the @code{gdb} entry in the @code{info} program.
41574 @c man begin OPTIONS gdb
41575 Any arguments other than options specify an executable
41576 file and core file (or process ID); that is, the first argument
41577 encountered with no
41578 associated option flag is equivalent to a @option{-se} option, and the second,
41579 if any, is equivalent to a @option{-c} option if it's the name of a file.
41581 both long and short forms; both are shown here. The long forms are also
41582 recognized if you truncate them, so long as enough of the option is
41583 present to be unambiguous. (If you prefer, you can flag option
41584 arguments with @option{+} rather than @option{-}, though we illustrate the
41585 more usual convention.)
41587 All the options and command line arguments you give are processed
41588 in sequential order. The order makes a difference when the @option{-x}
41594 List all options, with brief explanations.
41596 @item -symbols=@var{file}
41597 @itemx -s @var{file}
41598 Read symbol table from file @var{file}.
41601 Enable writing into executable and core files.
41603 @item -exec=@var{file}
41604 @itemx -e @var{file}
41605 Use file @var{file} as the executable file to execute when
41606 appropriate, and for examining pure data in conjunction with a core
41609 @item -se=@var{file}
41610 Read symbol table from file @var{file} and use it as the executable
41613 @item -core=@var{file}
41614 @itemx -c @var{file}
41615 Use file @var{file} as a core dump to examine.
41617 @item -command=@var{file}
41618 @itemx -x @var{file}
41619 Execute @value{GDBN} commands from file @var{file}.
41621 @item -ex @var{command}
41622 Execute given @value{GDBN} @var{command}.
41624 @item -directory=@var{directory}
41625 @itemx -d @var{directory}
41626 Add @var{directory} to the path to search for source files.
41629 Do not execute commands from @file{~/.gdbinit}.
41633 Do not execute commands from any @file{.gdbinit} initialization files.
41637 ``Quiet''. Do not print the introductory and copyright messages. These
41638 messages are also suppressed in batch mode.
41641 Run in batch mode. Exit with status @code{0} after processing all the command
41642 files specified with @option{-x} (and @file{.gdbinit}, if not inhibited).
41643 Exit with nonzero status if an error occurs in executing the @value{GDBN}
41644 commands in the command files.
41646 Batch mode may be useful for running @value{GDBN} as a filter, for example to
41647 download and run a program on another computer; in order to make this
41648 more useful, the message
41651 Program exited normally.
41655 (which is ordinarily issued whenever a program running under @value{GDBN} control
41656 terminates) is not issued when running in batch mode.
41658 @item -cd=@var{directory}
41659 Run @value{GDBN} using @var{directory} as its working directory,
41660 instead of the current directory.
41664 Emacs sets this option when it runs @value{GDBN} as a subprocess. It tells
41665 @value{GDBN} to output the full file name and line number in a standard,
41666 recognizable fashion each time a stack frame is displayed (which
41667 includes each time the program stops). This recognizable format looks
41668 like two @samp{\032} characters, followed by the file name, line number
41669 and character position separated by colons, and a newline. The
41670 Emacs-to-@value{GDBN} interface program uses the two @samp{\032}
41671 characters as a signal to display the source code for the frame.
41674 Set the line speed (baud rate or bits per second) of any serial
41675 interface used by @value{GDBN} for remote debugging.
41677 @item -tty=@var{device}
41678 Run using @var{device} for your program's standard input and output.
41682 @c man begin SEEALSO gdb
41684 The full documentation for @value{GDBN} is maintained as a Texinfo manual.
41685 If the @code{info} and @code{gdb} programs and @value{GDBN}'s Texinfo
41686 documentation are properly installed at your site, the command
41693 should give you access to the complete manual.
41695 @cite{Using GDB: A Guide to the GNU Source-Level Debugger},
41696 Richard M. Stallman and Roland H. Pesch, July 1991.
41700 @node gdbserver man
41701 @heading gdbserver man
41703 @c man title gdbserver Remote Server for the GNU Debugger
41705 @c man begin SYNOPSIS gdbserver
41706 gdbserver @var{comm} @var{prog} [@var{args}@dots{}]
41708 gdbserver --attach @var{comm} @var{pid}
41710 gdbserver --multi @var{comm}
41714 @c man begin DESCRIPTION gdbserver
41715 @command{gdbserver} is a program that allows you to run @value{GDBN} on a different machine
41716 than the one which is running the program being debugged.
41719 @subheading Usage (server (target) side)
41722 Usage (server (target) side):
41725 First, you need to have a copy of the program you want to debug put onto
41726 the target system. The program can be stripped to save space if needed, as
41727 @command{gdbserver} doesn't care about symbols. All symbol handling is taken care of by
41728 the @value{GDBN} running on the host system.
41730 To use the server, you log on to the target system, and run the @command{gdbserver}
41731 program. You must tell it (a) how to communicate with @value{GDBN}, (b) the name of
41732 your program, and (c) its arguments. The general syntax is:
41735 target> gdbserver @var{comm} @var{program} [@var{args} ...]
41738 For example, using a serial port, you might say:
41742 @c @file would wrap it as F</dev/com1>.
41743 target> gdbserver /dev/com1 emacs foo.txt
41746 target> gdbserver @file{/dev/com1} emacs foo.txt
41750 This tells @command{gdbserver} to debug emacs with an argument of foo.txt, and
41751 to communicate with @value{GDBN} via @file{/dev/com1}. @command{gdbserver} now
41752 waits patiently for the host @value{GDBN} to communicate with it.
41754 To use a TCP connection, you could say:
41757 target> gdbserver host:2345 emacs foo.txt
41760 This says pretty much the same thing as the last example, except that we are
41761 going to communicate with the @code{host} @value{GDBN} via TCP. The @code{host:2345} argument means
41762 that we are expecting to see a TCP connection from @code{host} to local TCP port
41763 2345. (Currently, the @code{host} part is ignored.) You can choose any number you
41764 want for the port number as long as it does not conflict with any existing TCP
41765 ports on the target system. This same port number must be used in the host
41766 @value{GDBN}s @code{target remote} command, which will be described shortly. Note that if
41767 you chose a port number that conflicts with another service, @command{gdbserver} will
41768 print an error message and exit.
41770 @command{gdbserver} can also attach to running programs.
41771 This is accomplished via the @option{--attach} argument. The syntax is:
41774 target> gdbserver --attach @var{comm} @var{pid}
41777 @var{pid} is the process ID of a currently running process. It isn't
41778 necessary to point @command{gdbserver} at a binary for the running process.
41780 To start @code{gdbserver} without supplying an initial command to run
41781 or process ID to attach, use the @option{--multi} command line option.
41782 In such case you should connect using @kbd{target extended-remote} to start
41783 the program you want to debug.
41786 target> gdbserver --multi @var{comm}
41790 @subheading Usage (host side)
41796 You need an unstripped copy of the target program on your host system, since
41797 @value{GDBN} needs to examine it's symbol tables and such. Start up @value{GDBN} as you normally
41798 would, with the target program as the first argument. (You may need to use the
41799 @option{--baud} option if the serial line is running at anything except 9600 baud.)
41800 That is @code{gdb TARGET-PROG}, or @code{gdb --baud BAUD TARGET-PROG}. After that, the only
41801 new command you need to know about is @code{target remote}
41802 (or @code{target extended-remote}). Its argument is either
41803 a device name (usually a serial device, like @file{/dev/ttyb}), or a @code{HOST:PORT}
41804 descriptor. For example:
41808 @c @file would wrap it as F</dev/ttyb>.
41809 (gdb) target remote /dev/ttyb
41812 (gdb) target remote @file{/dev/ttyb}
41817 communicates with the server via serial line @file{/dev/ttyb}, and:
41820 (gdb) target remote the-target:2345
41824 communicates via a TCP connection to port 2345 on host `the-target', where
41825 you previously started up @command{gdbserver} with the same port number. Note that for
41826 TCP connections, you must start up @command{gdbserver} prior to using the `target remote'
41827 command, otherwise you may get an error that looks something like
41828 `Connection refused'.
41830 @command{gdbserver} can also debug multiple inferiors at once,
41833 the @value{GDBN} manual in node @code{Inferiors and Programs}
41834 -- shell command @code{info -f gdb -n 'Inferiors and Programs'}.
41837 @ref{Inferiors and Programs}.
41839 In such case use the @code{extended-remote} @value{GDBN} command variant:
41842 (gdb) target extended-remote the-target:2345
41845 The @command{gdbserver} option @option{--multi} may or may not be used in such
41849 @c man begin OPTIONS gdbserver
41850 There are three different modes for invoking @command{gdbserver}:
41855 Debug a specific program specified by its program name:
41858 gdbserver @var{comm} @var{prog} [@var{args}@dots{}]
41861 The @var{comm} parameter specifies how should the server communicate
41862 with @value{GDBN}; it is either a device name (to use a serial line),
41863 a TCP port number (@code{:1234}), or @code{-} or @code{stdio} to use
41864 stdin/stdout of @code{gdbserver}. Specify the name of the program to
41865 debug in @var{prog}. Any remaining arguments will be passed to the
41866 program verbatim. When the program exits, @value{GDBN} will close the
41867 connection, and @code{gdbserver} will exit.
41870 Debug a specific program by specifying the process ID of a running
41874 gdbserver --attach @var{comm} @var{pid}
41877 The @var{comm} parameter is as described above. Supply the process ID
41878 of a running program in @var{pid}; @value{GDBN} will do everything
41879 else. Like with the previous mode, when the process @var{pid} exits,
41880 @value{GDBN} will close the connection, and @code{gdbserver} will exit.
41883 Multi-process mode -- debug more than one program/process:
41886 gdbserver --multi @var{comm}
41889 In this mode, @value{GDBN} can instruct @command{gdbserver} which
41890 command(s) to run. Unlike the other 2 modes, @value{GDBN} will not
41891 close the connection when a process being debugged exits, so you can
41892 debug several processes in the same session.
41895 In each of the modes you may specify these options:
41900 List all options, with brief explanations.
41903 This option causes @command{gdbserver} to print its version number and exit.
41906 @command{gdbserver} will attach to a running program. The syntax is:
41909 target> gdbserver --attach @var{comm} @var{pid}
41912 @var{pid} is the process ID of a currently running process. It isn't
41913 necessary to point @command{gdbserver} at a binary for the running process.
41916 To start @code{gdbserver} without supplying an initial command to run
41917 or process ID to attach, use this command line option.
41918 Then you can connect using @kbd{target extended-remote} and start
41919 the program you want to debug. The syntax is:
41922 target> gdbserver --multi @var{comm}
41926 Instruct @code{gdbserver} to display extra status information about the debugging
41928 This option is intended for @code{gdbserver} development and for bug reports to
41931 @item --remote-debug
41932 Instruct @code{gdbserver} to display remote protocol debug output.
41933 This option is intended for @code{gdbserver} development and for bug reports to
41936 @item --debug-format=option1@r{[},option2,...@r{]}
41937 Instruct @code{gdbserver} to include extra information in each line
41938 of debugging output.
41939 @xref{Other Command-Line Arguments for gdbserver}.
41942 Specify a wrapper to launch programs
41943 for debugging. The option should be followed by the name of the
41944 wrapper, then any command-line arguments to pass to the wrapper, then
41945 @kbd{--} indicating the end of the wrapper arguments.
41948 By default, @command{gdbserver} keeps the listening TCP port open, so that
41949 additional connections are possible. However, if you start @code{gdbserver}
41950 with the @option{--once} option, it will stop listening for any further
41951 connection attempts after connecting to the first @value{GDBN} session.
41953 @c --disable-packet is not documented for users.
41955 @c --disable-randomization and --no-disable-randomization are superseded by
41956 @c QDisableRandomization.
41961 @c man begin SEEALSO gdbserver
41963 The full documentation for @value{GDBN} is maintained as a Texinfo manual.
41964 If the @code{info} and @code{gdb} programs and @value{GDBN}'s Texinfo
41965 documentation are properly installed at your site, the command
41971 should give you access to the complete manual.
41973 @cite{Using GDB: A Guide to the GNU Source-Level Debugger},
41974 Richard M. Stallman and Roland H. Pesch, July 1991.
41981 @c man title gcore Generate a core file of a running program
41984 @c man begin SYNOPSIS gcore
41985 gcore [-o @var{filename}] @var{pid}
41989 @c man begin DESCRIPTION gcore
41990 Generate a core dump of a running program with process ID @var{pid}.
41991 Produced file is equivalent to a kernel produced core file as if the process
41992 crashed (and if @kbd{ulimit -c} were used to set up an appropriate core dump
41993 limit). Unlike after a crash, after @command{gcore} the program remains
41994 running without any change.
41997 @c man begin OPTIONS gcore
41999 @item -o @var{filename}
42000 The optional argument
42001 @var{filename} specifies the file name where to put the core dump.
42002 If not specified, the file name defaults to @file{core.@var{pid}},
42003 where @var{pid} is the running program process ID.
42007 @c man begin SEEALSO gcore
42009 The full documentation for @value{GDBN} is maintained as a Texinfo manual.
42010 If the @code{info} and @code{gdb} programs and @value{GDBN}'s Texinfo
42011 documentation are properly installed at your site, the command
42018 should give you access to the complete manual.
42020 @cite{Using GDB: A Guide to the GNU Source-Level Debugger},
42021 Richard M. Stallman and Roland H. Pesch, July 1991.
42028 @c man title gdbinit GDB initialization scripts
42031 @c man begin SYNOPSIS gdbinit
42032 @ifset SYSTEM_GDBINIT
42033 @value{SYSTEM_GDBINIT}
42042 @c man begin DESCRIPTION gdbinit
42043 These files contain @value{GDBN} commands to automatically execute during
42044 @value{GDBN} startup. The lines of contents are canned sequences of commands,
42047 the @value{GDBN} manual in node @code{Sequences}
42048 -- shell command @code{info -f gdb -n Sequences}.
42054 Please read more in
42056 the @value{GDBN} manual in node @code{Startup}
42057 -- shell command @code{info -f gdb -n Startup}.
42064 @ifset SYSTEM_GDBINIT
42065 @item @value{SYSTEM_GDBINIT}
42067 @ifclear SYSTEM_GDBINIT
42068 @item (not enabled with @code{--with-system-gdbinit} during compilation)
42070 System-wide initialization file. It is executed unless user specified
42071 @value{GDBN} option @code{-nx} or @code{-n}.
42074 the @value{GDBN} manual in node @code{System-wide configuration}
42075 -- shell command @code{info -f gdb -n 'System-wide configuration'}.
42078 @ref{System-wide configuration}.
42082 User initialization file. It is executed unless user specified
42083 @value{GDBN} options @code{-nx}, @code{-n} or @code{-nh}.
42086 Initialization file for current directory. It may need to be enabled with
42087 @value{GDBN} security command @code{set auto-load local-gdbinit}.
42090 the @value{GDBN} manual in node @code{Init File in the Current Directory}
42091 -- shell command @code{info -f gdb -n 'Init File in the Current Directory'}.
42094 @ref{Init File in the Current Directory}.
42099 @c man begin SEEALSO gdbinit
42101 gdb(1), @code{info -f gdb -n Startup}
42103 The full documentation for @value{GDBN} is maintained as a Texinfo manual.
42104 If the @code{info} and @code{gdb} programs and @value{GDBN}'s Texinfo
42105 documentation are properly installed at your site, the command
42111 should give you access to the complete manual.
42113 @cite{Using GDB: A Guide to the GNU Source-Level Debugger},
42114 Richard M. Stallman and Roland H. Pesch, July 1991.
42120 @node GNU Free Documentation License
42121 @appendix GNU Free Documentation License
42124 @node Concept Index
42125 @unnumbered Concept Index
42129 @node Command and Variable Index
42130 @unnumbered Command, Variable, and Function Index
42135 % I think something like @@colophon should be in texinfo. In the
42137 \long\def\colophon{\hbox to0pt{}\vfill
42138 \centerline{The body of this manual is set in}
42139 \centerline{\fontname\tenrm,}
42140 \centerline{with headings in {\bf\fontname\tenbf}}
42141 \centerline{and examples in {\tt\fontname\tentt}.}
42142 \centerline{{\it\fontname\tenit\/},}
42143 \centerline{{\bf\fontname\tenbf}, and}
42144 \centerline{{\sl\fontname\tensl\/}}
42145 \centerline{are used for emphasis.}\vfill}
42147 % Blame: doc@@cygnus.com, 1991.