1 \input texinfo @c -*-texinfo-*-
2 @c Copyright (C) 1988-2019 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-2019 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-2019 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.
544 Initial support for the FreeBSD/mips target and native configuration
545 was developed by SRI International and the University of Cambridge
546 Computer Laboratory under DARPA/AFRL contract FA8750-10-C-0237
547 ("CTSRD"), as part of the DARPA CRASH research programme.
549 Initial support for the FreeBSD/riscv target and native configuration
550 was developed by SRI International and the University of Cambridge
551 Computer Laboratory (Department of Computer Science and Technology)
552 under DARPA contract HR0011-18-C-0016 ("ECATS"), as part of the DARPA
553 SSITH research programme.
555 The original port to the OpenRISC 1000 is believed to be due to
556 Alessandro Forin and Per Bothner. More recent ports have been the work
557 of Jeremy Bennett, Franck Jullien, Stefan Wallentowitz and
561 @chapter A Sample @value{GDBN} Session
563 You can use this manual at your leisure to read all about @value{GDBN}.
564 However, a handful of commands are enough to get started using the
565 debugger. This chapter illustrates those commands.
568 In this sample session, we emphasize user input like this: @b{input},
569 to make it easier to pick out from the surrounding output.
572 @c FIXME: this example may not be appropriate for some configs, where
573 @c FIXME...primary interest is in remote use.
575 One of the preliminary versions of @sc{gnu} @code{m4} (a generic macro
576 processor) exhibits the following bug: sometimes, when we change its
577 quote strings from the default, the commands used to capture one macro
578 definition within another stop working. In the following short @code{m4}
579 session, we define a macro @code{foo} which expands to @code{0000}; we
580 then use the @code{m4} built-in @code{defn} to define @code{bar} as the
581 same thing. However, when we change the open quote string to
582 @code{<QUOTE>} and the close quote string to @code{<UNQUOTE>}, the same
583 procedure fails to define a new synonym @code{baz}:
592 @b{define(bar,defn(`foo'))}
596 @b{changequote(<QUOTE>,<UNQUOTE>)}
598 @b{define(baz,defn(<QUOTE>foo<UNQUOTE>))}
601 m4: End of input: 0: fatal error: EOF in string
605 Let us use @value{GDBN} to try to see what is going on.
608 $ @b{@value{GDBP} m4}
609 @c FIXME: this falsifies the exact text played out, to permit smallbook
610 @c FIXME... format to come out better.
611 @value{GDBN} is free software and you are welcome to distribute copies
612 of it under certain conditions; type "show copying" to see
614 There is absolutely no warranty for @value{GDBN}; type "show warranty"
617 @value{GDBN} @value{GDBVN}, Copyright 1999 Free Software Foundation, Inc...
622 @value{GDBN} reads only enough symbol data to know where to find the
623 rest when needed; as a result, the first prompt comes up very quickly.
624 We now tell @value{GDBN} to use a narrower display width than usual, so
625 that examples fit in this manual.
628 (@value{GDBP}) @b{set width 70}
632 We need to see how the @code{m4} built-in @code{changequote} works.
633 Having looked at the source, we know the relevant subroutine is
634 @code{m4_changequote}, so we set a breakpoint there with the @value{GDBN}
635 @code{break} command.
638 (@value{GDBP}) @b{break m4_changequote}
639 Breakpoint 1 at 0x62f4: file builtin.c, line 879.
643 Using the @code{run} command, we start @code{m4} running under @value{GDBN}
644 control; as long as control does not reach the @code{m4_changequote}
645 subroutine, the program runs as usual:
648 (@value{GDBP}) @b{run}
649 Starting program: /work/Editorial/gdb/gnu/m4/m4
657 To trigger the breakpoint, we call @code{changequote}. @value{GDBN}
658 suspends execution of @code{m4}, displaying information about the
659 context where it stops.
662 @b{changequote(<QUOTE>,<UNQUOTE>)}
664 Breakpoint 1, m4_changequote (argc=3, argv=0x33c70)
666 879 if (bad_argc(TOKEN_DATA_TEXT(argv[0]),argc,1,3))
670 Now we use the command @code{n} (@code{next}) to advance execution to
671 the next line of the current function.
675 882 set_quotes((argc >= 2) ? TOKEN_DATA_TEXT(argv[1])\
680 @code{set_quotes} looks like a promising subroutine. We can go into it
681 by using the command @code{s} (@code{step}) instead of @code{next}.
682 @code{step} goes to the next line to be executed in @emph{any}
683 subroutine, so it steps into @code{set_quotes}.
687 set_quotes (lq=0x34c78 "<QUOTE>", rq=0x34c88 "<UNQUOTE>")
689 530 if (lquote != def_lquote)
693 The display that shows the subroutine where @code{m4} is now
694 suspended (and its arguments) is called a stack frame display. It
695 shows a summary of the stack. We can use the @code{backtrace}
696 command (which can also be spelled @code{bt}), to see where we are
697 in the stack as a whole: the @code{backtrace} command displays a
698 stack frame for each active subroutine.
701 (@value{GDBP}) @b{bt}
702 #0 set_quotes (lq=0x34c78 "<QUOTE>", rq=0x34c88 "<UNQUOTE>")
704 #1 0x6344 in m4_changequote (argc=3, argv=0x33c70)
706 #2 0x8174 in expand_macro (sym=0x33320) at macro.c:242
707 #3 0x7a88 in expand_token (obs=0x0, t=209696, td=0xf7fffa30)
709 #4 0x79dc in expand_input () at macro.c:40
710 #5 0x2930 in main (argc=0, argv=0xf7fffb20) at m4.c:195
714 We step through a few more lines to see what happens. The first two
715 times, we can use @samp{s}; the next two times we use @code{n} to avoid
716 falling into the @code{xstrdup} subroutine.
720 0x3b5c 532 if (rquote != def_rquote)
722 0x3b80 535 lquote = (lq == nil || *lq == '\0') ? \
723 def_lquote : xstrdup(lq);
725 536 rquote = (rq == nil || *rq == '\0') ? def_rquote\
728 538 len_lquote = strlen(rquote);
732 The last line displayed looks a little odd; we can examine the variables
733 @code{lquote} and @code{rquote} to see if they are in fact the new left
734 and right quotes we specified. We use the command @code{p}
735 (@code{print}) to see their values.
738 (@value{GDBP}) @b{p lquote}
739 $1 = 0x35d40 "<QUOTE>"
740 (@value{GDBP}) @b{p rquote}
741 $2 = 0x35d50 "<UNQUOTE>"
745 @code{lquote} and @code{rquote} are indeed the new left and right quotes.
746 To look at some context, we can display ten lines of source
747 surrounding the current line with the @code{l} (@code{list}) command.
753 535 lquote = (lq == nil || *lq == '\0') ? def_lquote\
755 536 rquote = (rq == nil || *rq == '\0') ? def_rquote\
758 538 len_lquote = strlen(rquote);
759 539 len_rquote = strlen(lquote);
766 Let us step past the two lines that set @code{len_lquote} and
767 @code{len_rquote}, and then examine the values of those variables.
771 539 len_rquote = strlen(lquote);
774 (@value{GDBP}) @b{p len_lquote}
776 (@value{GDBP}) @b{p len_rquote}
781 That certainly looks wrong, assuming @code{len_lquote} and
782 @code{len_rquote} are meant to be the lengths of @code{lquote} and
783 @code{rquote} respectively. We can set them to better values using
784 the @code{p} command, since it can print the value of
785 any expression---and that expression can include subroutine calls and
789 (@value{GDBP}) @b{p len_lquote=strlen(lquote)}
791 (@value{GDBP}) @b{p len_rquote=strlen(rquote)}
796 Is that enough to fix the problem of using the new quotes with the
797 @code{m4} built-in @code{defn}? We can allow @code{m4} to continue
798 executing with the @code{c} (@code{continue}) command, and then try the
799 example that caused trouble initially:
805 @b{define(baz,defn(<QUOTE>foo<UNQUOTE>))}
812 Success! The new quotes now work just as well as the default ones. The
813 problem seems to have been just the two typos defining the wrong
814 lengths. We allow @code{m4} exit by giving it an EOF as input:
818 Program exited normally.
822 The message @samp{Program exited normally.} is from @value{GDBN}; it
823 indicates @code{m4} has finished executing. We can end our @value{GDBN}
824 session with the @value{GDBN} @code{quit} command.
827 (@value{GDBP}) @b{quit}
831 @chapter Getting In and Out of @value{GDBN}
833 This chapter discusses how to start @value{GDBN}, and how to get out of it.
837 type @samp{@value{GDBP}} to start @value{GDBN}.
839 type @kbd{quit} or @kbd{Ctrl-d} to exit.
843 * Invoking GDB:: How to start @value{GDBN}
844 * Quitting GDB:: How to quit @value{GDBN}
845 * Shell Commands:: How to use shell commands inside @value{GDBN}
846 * Logging Output:: How to log @value{GDBN}'s output to a file
850 @section Invoking @value{GDBN}
852 Invoke @value{GDBN} by running the program @code{@value{GDBP}}. Once started,
853 @value{GDBN} reads commands from the terminal until you tell it to exit.
855 You can also run @code{@value{GDBP}} with a variety of arguments and options,
856 to specify more of your debugging environment at the outset.
858 The command-line options described here are designed
859 to cover a variety of situations; in some environments, some of these
860 options may effectively be unavailable.
862 The most usual way to start @value{GDBN} is with one argument,
863 specifying an executable program:
866 @value{GDBP} @var{program}
870 You can also start with both an executable program and a core file
874 @value{GDBP} @var{program} @var{core}
877 You can, instead, specify a process ID as a second argument, if you want
878 to debug a running process:
881 @value{GDBP} @var{program} 1234
885 would attach @value{GDBN} to process @code{1234} (unless you also have a file
886 named @file{1234}; @value{GDBN} does check for a core file first).
888 Taking advantage of the second command-line argument requires a fairly
889 complete operating system; when you use @value{GDBN} as a remote
890 debugger attached to a bare board, there may not be any notion of
891 ``process'', and there is often no way to get a core dump. @value{GDBN}
892 will warn you if it is unable to attach or to read core dumps.
894 You can optionally have @code{@value{GDBP}} pass any arguments after the
895 executable file to the inferior using @code{--args}. This option stops
898 @value{GDBP} --args gcc -O2 -c foo.c
900 This will cause @code{@value{GDBP}} to debug @code{gcc}, and to set
901 @code{gcc}'s command-line arguments (@pxref{Arguments}) to @samp{-O2 -c foo.c}.
903 You can run @code{@value{GDBP}} without printing the front material, which describes
904 @value{GDBN}'s non-warranty, by specifying @code{--silent}
905 (or @code{-q}/@code{--quiet}):
908 @value{GDBP} --silent
912 You can further control how @value{GDBN} starts up by using command-line
913 options. @value{GDBN} itself can remind you of the options available.
923 to display all available options and briefly describe their use
924 (@samp{@value{GDBP} -h} is a shorter equivalent).
926 All options and command line arguments you give are processed
927 in sequential order. The order makes a difference when the
928 @samp{-x} option is used.
932 * File Options:: Choosing files
933 * Mode Options:: Choosing modes
934 * Startup:: What @value{GDBN} does during startup
938 @subsection Choosing Files
940 When @value{GDBN} starts, it reads any arguments other than options as
941 specifying an executable file and core file (or process ID). This is
942 the same as if the arguments were specified by the @samp{-se} and
943 @samp{-c} (or @samp{-p}) options respectively. (@value{GDBN} reads the
944 first argument that does not have an associated option flag as
945 equivalent to the @samp{-se} option followed by that argument; and the
946 second argument that does not have an associated option flag, if any, as
947 equivalent to the @samp{-c}/@samp{-p} option followed by that argument.)
948 If the second argument begins with a decimal digit, @value{GDBN} will
949 first attempt to attach to it as a process, and if that fails, attempt
950 to open it as a corefile. If you have a corefile whose name begins with
951 a digit, you can prevent @value{GDBN} from treating it as a pid by
952 prefixing it with @file{./}, e.g.@: @file{./12345}.
954 If @value{GDBN} has not been configured to included core file support,
955 such as for most embedded targets, then it will complain about a second
956 argument and ignore it.
958 Many options have both long and short forms; both are shown in the
959 following list. @value{GDBN} also recognizes the long forms if you truncate
960 them, so long as enough of the option is present to be unambiguous.
961 (If you prefer, you can flag option arguments with @samp{--} rather
962 than @samp{-}, though we illustrate the more usual convention.)
964 @c NOTE: the @cindex entries here use double dashes ON PURPOSE. This
965 @c way, both those who look for -foo and --foo in the index, will find
969 @item -symbols @var{file}
971 @cindex @code{--symbols}
973 Read symbol table from file @var{file}.
975 @item -exec @var{file}
977 @cindex @code{--exec}
979 Use file @var{file} as the executable file to execute when appropriate,
980 and for examining pure data in conjunction with a core dump.
984 Read symbol table from file @var{file} and use it as the executable
987 @item -core @var{file}
989 @cindex @code{--core}
991 Use file @var{file} as a core dump to examine.
993 @item -pid @var{number}
994 @itemx -p @var{number}
997 Connect to process ID @var{number}, as with the @code{attach} command.
999 @item -command @var{file}
1000 @itemx -x @var{file}
1001 @cindex @code{--command}
1003 Execute commands from file @var{file}. The contents of this file is
1004 evaluated exactly as the @code{source} command would.
1005 @xref{Command Files,, Command files}.
1007 @item -eval-command @var{command}
1008 @itemx -ex @var{command}
1009 @cindex @code{--eval-command}
1011 Execute a single @value{GDBN} command.
1013 This option may be used multiple times to call multiple commands. It may
1014 also be interleaved with @samp{-command} as required.
1017 @value{GDBP} -ex 'target sim' -ex 'load' \
1018 -x setbreakpoints -ex 'run' a.out
1021 @item -init-command @var{file}
1022 @itemx -ix @var{file}
1023 @cindex @code{--init-command}
1025 Execute commands from file @var{file} before loading the inferior (but
1026 after loading gdbinit files).
1029 @item -init-eval-command @var{command}
1030 @itemx -iex @var{command}
1031 @cindex @code{--init-eval-command}
1033 Execute a single @value{GDBN} command before loading the inferior (but
1034 after loading gdbinit files).
1037 @item -directory @var{directory}
1038 @itemx -d @var{directory}
1039 @cindex @code{--directory}
1041 Add @var{directory} to the path to search for source and script files.
1045 @cindex @code{--readnow}
1047 Read each symbol file's entire symbol table immediately, rather than
1048 the default, which is to read it incrementally as it is needed.
1049 This makes startup slower, but makes future operations faster.
1052 @anchor{--readnever}
1053 @cindex @code{--readnever}, command-line option
1054 Do not read each symbol file's symbolic debug information. This makes
1055 startup faster but at the expense of not being able to perform
1056 symbolic debugging. DWARF unwind information is also not read,
1057 meaning backtraces may become incomplete or inaccurate. One use of
1058 this is when a user simply wants to do the following sequence: attach,
1059 dump core, detach. Loading the debugging information in this case is
1060 an unnecessary cause of delay.
1064 @subsection Choosing Modes
1066 You can run @value{GDBN} in various alternative modes---for example, in
1067 batch mode or quiet mode.
1075 Do not execute commands found in any initialization file.
1076 There are three init files, loaded in the following order:
1079 @item @file{system.gdbinit}
1080 This is the system-wide init file.
1081 Its location is specified with the @code{--with-system-gdbinit}
1082 configure option (@pxref{System-wide configuration}).
1083 It is loaded first when @value{GDBN} starts, before command line options
1084 have been processed.
1085 @item @file{~/.gdbinit}
1086 This is the init file in your home directory.
1087 It is loaded next, after @file{system.gdbinit}, and before
1088 command options have been processed.
1089 @item @file{./.gdbinit}
1090 This is the init file in the current directory.
1091 It is loaded last, after command line options other than @code{-x} and
1092 @code{-ex} have been processed. Command line options @code{-x} and
1093 @code{-ex} are processed last, after @file{./.gdbinit} has been loaded.
1096 For further documentation on startup processing, @xref{Startup}.
1097 For documentation on how to write command files,
1098 @xref{Command Files,,Command Files}.
1103 Do not execute commands found in @file{~/.gdbinit}, the init file
1104 in your home directory.
1110 @cindex @code{--quiet}
1111 @cindex @code{--silent}
1113 ``Quiet''. Do not print the introductory and copyright messages. These
1114 messages are also suppressed in batch mode.
1117 @cindex @code{--batch}
1118 Run in batch mode. Exit with status @code{0} after processing all the
1119 command files specified with @samp{-x} (and all commands from
1120 initialization files, if not inhibited with @samp{-n}). Exit with
1121 nonzero status if an error occurs in executing the @value{GDBN} commands
1122 in the command files. Batch mode also disables pagination, sets unlimited
1123 terminal width and height @pxref{Screen Size}, and acts as if @kbd{set confirm
1124 off} were in effect (@pxref{Messages/Warnings}).
1126 Batch mode may be useful for running @value{GDBN} as a filter, for
1127 example to download and run a program on another computer; in order to
1128 make this more useful, the message
1131 Program exited normally.
1135 (which is ordinarily issued whenever a program running under
1136 @value{GDBN} control terminates) is not issued when running in batch
1140 @cindex @code{--batch-silent}
1141 Run in batch mode exactly like @samp{-batch}, but totally silently. All
1142 @value{GDBN} output to @code{stdout} is prevented (@code{stderr} is
1143 unaffected). This is much quieter than @samp{-silent} and would be useless
1144 for an interactive session.
1146 This is particularly useful when using targets that give @samp{Loading section}
1147 messages, for example.
1149 Note that targets that give their output via @value{GDBN}, as opposed to
1150 writing directly to @code{stdout}, will also be made silent.
1152 @item -return-child-result
1153 @cindex @code{--return-child-result}
1154 The return code from @value{GDBN} will be the return code from the child
1155 process (the process being debugged), with the following exceptions:
1159 @value{GDBN} exits abnormally. E.g., due to an incorrect argument or an
1160 internal error. In this case the exit code is the same as it would have been
1161 without @samp{-return-child-result}.
1163 The user quits with an explicit value. E.g., @samp{quit 1}.
1165 The child process never runs, or is not allowed to terminate, in which case
1166 the exit code will be -1.
1169 This option is useful in conjunction with @samp{-batch} or @samp{-batch-silent},
1170 when @value{GDBN} is being used as a remote program loader or simulator
1175 @cindex @code{--nowindows}
1177 ``No windows''. If @value{GDBN} comes with a graphical user interface
1178 (GUI) built in, then this option tells @value{GDBN} to only use the command-line
1179 interface. If no GUI is available, this option has no effect.
1183 @cindex @code{--windows}
1185 If @value{GDBN} includes a GUI, then this option requires it to be
1188 @item -cd @var{directory}
1190 Run @value{GDBN} using @var{directory} as its working directory,
1191 instead of the current directory.
1193 @item -data-directory @var{directory}
1194 @itemx -D @var{directory}
1195 @cindex @code{--data-directory}
1197 Run @value{GDBN} using @var{directory} as its data directory.
1198 The data directory is where @value{GDBN} searches for its
1199 auxiliary files. @xref{Data Files}.
1203 @cindex @code{--fullname}
1205 @sc{gnu} Emacs sets this option when it runs @value{GDBN} as a
1206 subprocess. It tells @value{GDBN} to output the full file name and line
1207 number in a standard, recognizable fashion each time a stack frame is
1208 displayed (which includes each time your program stops). This
1209 recognizable format looks like two @samp{\032} characters, followed by
1210 the file name, line number and character position separated by colons,
1211 and a newline. The Emacs-to-@value{GDBN} interface program uses the two
1212 @samp{\032} characters as a signal to display the source code for the
1215 @item -annotate @var{level}
1216 @cindex @code{--annotate}
1217 This option sets the @dfn{annotation level} inside @value{GDBN}. Its
1218 effect is identical to using @samp{set annotate @var{level}}
1219 (@pxref{Annotations}). The annotation @var{level} controls how much
1220 information @value{GDBN} prints together with its prompt, values of
1221 expressions, source lines, and other types of output. Level 0 is the
1222 normal, level 1 is for use when @value{GDBN} is run as a subprocess of
1223 @sc{gnu} Emacs, level 3 is the maximum annotation suitable for programs
1224 that control @value{GDBN}, and level 2 has been deprecated.
1226 The annotation mechanism has largely been superseded by @sc{gdb/mi}
1230 @cindex @code{--args}
1231 Change interpretation of command line so that arguments following the
1232 executable file are passed as command line arguments to the inferior.
1233 This option stops option processing.
1235 @item -baud @var{bps}
1237 @cindex @code{--baud}
1239 Set the line speed (baud rate or bits per second) of any serial
1240 interface used by @value{GDBN} for remote debugging.
1242 @item -l @var{timeout}
1244 Set the timeout (in seconds) of any communication used by @value{GDBN}
1245 for remote debugging.
1247 @item -tty @var{device}
1248 @itemx -t @var{device}
1249 @cindex @code{--tty}
1251 Run using @var{device} for your program's standard input and output.
1252 @c FIXME: kingdon thinks there is more to -tty. Investigate.
1254 @c resolve the situation of these eventually
1256 @cindex @code{--tui}
1257 Activate the @dfn{Text User Interface} when starting. The Text User
1258 Interface manages several text windows on the terminal, showing
1259 source, assembly, registers and @value{GDBN} command outputs
1260 (@pxref{TUI, ,@value{GDBN} Text User Interface}). Do not use this
1261 option if you run @value{GDBN} from Emacs (@pxref{Emacs, ,
1262 Using @value{GDBN} under @sc{gnu} Emacs}).
1264 @item -interpreter @var{interp}
1265 @cindex @code{--interpreter}
1266 Use the interpreter @var{interp} for interface with the controlling
1267 program or device. This option is meant to be set by programs which
1268 communicate with @value{GDBN} using it as a back end.
1269 @xref{Interpreters, , Command Interpreters}.
1271 @samp{--interpreter=mi} (or @samp{--interpreter=mi2}) causes
1272 @value{GDBN} to use the @dfn{@sc{gdb/mi} interface} (@pxref{GDB/MI, ,
1273 The @sc{gdb/mi} Interface}) included since @value{GDBN} version 6.0. The
1274 previous @sc{gdb/mi} interface, included in @value{GDBN} version 5.3 and
1275 selected with @samp{--interpreter=mi1}, is deprecated. Earlier
1276 @sc{gdb/mi} interfaces are no longer supported.
1279 @cindex @code{--write}
1280 Open the executable and core files for both reading and writing. This
1281 is equivalent to the @samp{set write on} command inside @value{GDBN}
1285 @cindex @code{--statistics}
1286 This option causes @value{GDBN} to print statistics about time and
1287 memory usage after it completes each command and returns to the prompt.
1290 @cindex @code{--version}
1291 This option causes @value{GDBN} to print its version number and
1292 no-warranty blurb, and exit.
1294 @item -configuration
1295 @cindex @code{--configuration}
1296 This option causes @value{GDBN} to print details about its build-time
1297 configuration parameters, and then exit. These details can be
1298 important when reporting @value{GDBN} bugs (@pxref{GDB Bugs}).
1303 @subsection What @value{GDBN} Does During Startup
1304 @cindex @value{GDBN} startup
1306 Here's the description of what @value{GDBN} does during session startup:
1310 Sets up the command interpreter as specified by the command line
1311 (@pxref{Mode Options, interpreter}).
1315 Reads the system-wide @dfn{init file} (if @option{--with-system-gdbinit} was
1316 used when building @value{GDBN}; @pxref{System-wide configuration,
1317 ,System-wide configuration and settings}) and executes all the commands in
1320 @anchor{Home Directory Init File}
1322 Reads the init file (if any) in your home directory@footnote{On
1323 DOS/Windows systems, the home directory is the one pointed to by the
1324 @code{HOME} environment variable.} and executes all the commands in
1327 @anchor{Option -init-eval-command}
1329 Executes commands and command files specified by the @samp{-iex} and
1330 @samp{-ix} options in their specified order. Usually you should use the
1331 @samp{-ex} and @samp{-x} options instead, but this way you can apply
1332 settings before @value{GDBN} init files get executed and before inferior
1336 Processes command line options and operands.
1338 @anchor{Init File in the Current Directory during Startup}
1340 Reads and executes the commands from init file (if any) in the current
1341 working directory as long as @samp{set auto-load local-gdbinit} is set to
1342 @samp{on} (@pxref{Init File in the Current Directory}).
1343 This is only done if the current directory is
1344 different from your home directory. Thus, you can have more than one
1345 init file, one generic in your home directory, and another, specific
1346 to the program you are debugging, in the directory where you invoke
1350 If the command line specified a program to debug, or a process to
1351 attach to, or a core file, @value{GDBN} loads any auto-loaded
1352 scripts provided for the program or for its loaded shared libraries.
1353 @xref{Auto-loading}.
1355 If you wish to disable the auto-loading during startup,
1356 you must do something like the following:
1359 $ gdb -iex "set auto-load python-scripts off" myprogram
1362 Option @samp{-ex} does not work because the auto-loading is then turned
1366 Executes commands and command files specified by the @samp{-ex} and
1367 @samp{-x} options in their specified order. @xref{Command Files}, for
1368 more details about @value{GDBN} command files.
1371 Reads the command history recorded in the @dfn{history file}.
1372 @xref{Command History}, for more details about the command history and the
1373 files where @value{GDBN} records it.
1376 Init files use the same syntax as @dfn{command files} (@pxref{Command
1377 Files}) and are processed by @value{GDBN} in the same way. The init
1378 file in your home directory can set options (such as @samp{set
1379 complaints}) that affect subsequent processing of command line options
1380 and operands. Init files are not executed if you use the @samp{-nx}
1381 option (@pxref{Mode Options, ,Choosing Modes}).
1383 To display the list of init files loaded by gdb at startup, you
1384 can use @kbd{gdb --help}.
1386 @cindex init file name
1387 @cindex @file{.gdbinit}
1388 @cindex @file{gdb.ini}
1389 The @value{GDBN} init files are normally called @file{.gdbinit}.
1390 The DJGPP port of @value{GDBN} uses the name @file{gdb.ini}, due to
1391 the limitations of file names imposed by DOS filesystems. The Windows
1392 port of @value{GDBN} uses the standard name, but if it finds a
1393 @file{gdb.ini} file in your home directory, it warns you about that
1394 and suggests to rename the file to the standard name.
1398 @section Quitting @value{GDBN}
1399 @cindex exiting @value{GDBN}
1400 @cindex leaving @value{GDBN}
1403 @kindex quit @r{[}@var{expression}@r{]}
1404 @kindex q @r{(@code{quit})}
1405 @item quit @r{[}@var{expression}@r{]}
1407 To exit @value{GDBN}, use the @code{quit} command (abbreviated
1408 @code{q}), or type an end-of-file character (usually @kbd{Ctrl-d}). If you
1409 do not supply @var{expression}, @value{GDBN} will terminate normally;
1410 otherwise it will terminate using the result of @var{expression} as the
1415 An interrupt (often @kbd{Ctrl-c}) does not exit from @value{GDBN}, but rather
1416 terminates the action of any @value{GDBN} command that is in progress and
1417 returns to @value{GDBN} command level. It is safe to type the interrupt
1418 character at any time because @value{GDBN} does not allow it to take effect
1419 until a time when it is safe.
1421 If you have been using @value{GDBN} to control an attached process or
1422 device, you can release it with the @code{detach} command
1423 (@pxref{Attach, ,Debugging an Already-running Process}).
1425 @node Shell Commands
1426 @section Shell Commands
1428 If you need to execute occasional shell commands during your
1429 debugging session, there is no need to leave or suspend @value{GDBN}; you can
1430 just use the @code{shell} command.
1435 @cindex shell escape
1436 @item shell @var{command-string}
1437 @itemx !@var{command-string}
1438 Invoke a standard shell to execute @var{command-string}.
1439 Note that no space is needed between @code{!} and @var{command-string}.
1440 If it exists, the environment variable @code{SHELL} determines which
1441 shell to run. Otherwise @value{GDBN} uses the default shell
1442 (@file{/bin/sh} on Unix systems, @file{COMMAND.COM} on MS-DOS, etc.).
1445 The utility @code{make} is often needed in development environments.
1446 You do not have to use the @code{shell} command for this purpose in
1451 @cindex calling make
1452 @item make @var{make-args}
1453 Execute the @code{make} program with the specified
1454 arguments. This is equivalent to @samp{shell make @var{make-args}}.
1457 @node Logging Output
1458 @section Logging Output
1459 @cindex logging @value{GDBN} output
1460 @cindex save @value{GDBN} output to a file
1462 You may want to save the output of @value{GDBN} commands to a file.
1463 There are several commands to control @value{GDBN}'s logging.
1467 @item set logging on
1469 @item set logging off
1471 @cindex logging file name
1472 @item set logging file @var{file}
1473 Change the name of the current logfile. The default logfile is @file{gdb.txt}.
1474 @item set logging overwrite [on|off]
1475 By default, @value{GDBN} will append to the logfile. Set @code{overwrite} if
1476 you want @code{set logging on} to overwrite the logfile instead.
1477 @item set logging redirect [on|off]
1478 By default, @value{GDBN} output will go to both the terminal and the logfile.
1479 Set @code{redirect} if you want output to go only to the log file.
1480 @kindex show logging
1482 Show the current values of the logging settings.
1486 @chapter @value{GDBN} Commands
1488 You can abbreviate a @value{GDBN} command to the first few letters of the command
1489 name, if that abbreviation is unambiguous; and you can repeat certain
1490 @value{GDBN} commands by typing just @key{RET}. You can also use the @key{TAB}
1491 key to get @value{GDBN} to fill out the rest of a word in a command (or to
1492 show you the alternatives available, if there is more than one possibility).
1495 * Command Syntax:: How to give commands to @value{GDBN}
1496 * Completion:: Command completion
1497 * Help:: How to ask @value{GDBN} for help
1500 @node Command Syntax
1501 @section Command Syntax
1503 A @value{GDBN} command is a single line of input. There is no limit on
1504 how long it can be. It starts with a command name, which is followed by
1505 arguments whose meaning depends on the command name. For example, the
1506 command @code{step} accepts an argument which is the number of times to
1507 step, as in @samp{step 5}. You can also use the @code{step} command
1508 with no arguments. Some commands do not allow any arguments.
1510 @cindex abbreviation
1511 @value{GDBN} command names may always be truncated if that abbreviation is
1512 unambiguous. Other possible command abbreviations are listed in the
1513 documentation for individual commands. In some cases, even ambiguous
1514 abbreviations are allowed; for example, @code{s} is specially defined as
1515 equivalent to @code{step} even though there are other commands whose
1516 names start with @code{s}. You can test abbreviations by using them as
1517 arguments to the @code{help} command.
1519 @cindex repeating commands
1520 @kindex RET @r{(repeat last command)}
1521 A blank line as input to @value{GDBN} (typing just @key{RET}) means to
1522 repeat the previous command. Certain commands (for example, @code{run})
1523 will not repeat this way; these are commands whose unintentional
1524 repetition might cause trouble and which you are unlikely to want to
1525 repeat. User-defined commands can disable this feature; see
1526 @ref{Define, dont-repeat}.
1528 The @code{list} and @code{x} commands, when you repeat them with
1529 @key{RET}, construct new arguments rather than repeating
1530 exactly as typed. This permits easy scanning of source or memory.
1532 @value{GDBN} can also use @key{RET} in another way: to partition lengthy
1533 output, in a way similar to the common utility @code{more}
1534 (@pxref{Screen Size,,Screen Size}). Since it is easy to press one
1535 @key{RET} too many in this situation, @value{GDBN} disables command
1536 repetition after any command that generates this sort of display.
1538 @kindex # @r{(a comment)}
1540 Any text from a @kbd{#} to the end of the line is a comment; it does
1541 nothing. This is useful mainly in command files (@pxref{Command
1542 Files,,Command Files}).
1544 @cindex repeating command sequences
1545 @kindex Ctrl-o @r{(operate-and-get-next)}
1546 The @kbd{Ctrl-o} binding is useful for repeating a complex sequence of
1547 commands. This command accepts the current line, like @key{RET}, and
1548 then fetches the next line relative to the current line from the history
1552 @section Command Completion
1555 @cindex word completion
1556 @value{GDBN} can fill in the rest of a word in a command for you, if there is
1557 only one possibility; it can also show you what the valid possibilities
1558 are for the next word in a command, at any time. This works for @value{GDBN}
1559 commands, @value{GDBN} subcommands, and the names of symbols in your program.
1561 Press the @key{TAB} key whenever you want @value{GDBN} to fill out the rest
1562 of a word. If there is only one possibility, @value{GDBN} fills in the
1563 word, and waits for you to finish the command (or press @key{RET} to
1564 enter it). For example, if you type
1566 @c FIXME "@key" does not distinguish its argument sufficiently to permit
1567 @c complete accuracy in these examples; space introduced for clarity.
1568 @c If texinfo enhancements make it unnecessary, it would be nice to
1569 @c replace " @key" by "@key" in the following...
1571 (@value{GDBP}) info bre @key{TAB}
1575 @value{GDBN} fills in the rest of the word @samp{breakpoints}, since that is
1576 the only @code{info} subcommand beginning with @samp{bre}:
1579 (@value{GDBP}) info breakpoints
1583 You can either press @key{RET} at this point, to run the @code{info
1584 breakpoints} command, or backspace and enter something else, if
1585 @samp{breakpoints} does not look like the command you expected. (If you
1586 were sure you wanted @code{info breakpoints} in the first place, you
1587 might as well just type @key{RET} immediately after @samp{info bre},
1588 to exploit command abbreviations rather than command completion).
1590 If there is more than one possibility for the next word when you press
1591 @key{TAB}, @value{GDBN} sounds a bell. You can either supply more
1592 characters and try again, or just press @key{TAB} a second time;
1593 @value{GDBN} displays all the possible completions for that word. For
1594 example, you might want to set a breakpoint on a subroutine whose name
1595 begins with @samp{make_}, but when you type @kbd{b make_@key{TAB}} @value{GDBN}
1596 just sounds the bell. Typing @key{TAB} again displays all the
1597 function names in your program that begin with those characters, for
1601 (@value{GDBP}) b make_ @key{TAB}
1602 @exdent @value{GDBN} sounds bell; press @key{TAB} again, to see:
1603 make_a_section_from_file make_environ
1604 make_abs_section make_function_type
1605 make_blockvector make_pointer_type
1606 make_cleanup make_reference_type
1607 make_command make_symbol_completion_list
1608 (@value{GDBP}) b make_
1612 After displaying the available possibilities, @value{GDBN} copies your
1613 partial input (@samp{b make_} in the example) so you can finish the
1616 If you just want to see the list of alternatives in the first place, you
1617 can press @kbd{M-?} rather than pressing @key{TAB} twice. @kbd{M-?}
1618 means @kbd{@key{META} ?}. You can type this either by holding down a
1619 key designated as the @key{META} shift on your keyboard (if there is
1620 one) while typing @kbd{?}, or as @key{ESC} followed by @kbd{?}.
1622 If the number of possible completions is large, @value{GDBN} will
1623 print as much of the list as it has collected, as well as a message
1624 indicating that the list may be truncated.
1627 (@value{GDBP}) b m@key{TAB}@key{TAB}
1629 <... the rest of the possible completions ...>
1630 *** List may be truncated, max-completions reached. ***
1635 This behavior can be controlled with the following commands:
1638 @kindex set max-completions
1639 @item set max-completions @var{limit}
1640 @itemx set max-completions unlimited
1641 Set the maximum number of completion candidates. @value{GDBN} will
1642 stop looking for more completions once it collects this many candidates.
1643 This is useful when completing on things like function names as collecting
1644 all the possible candidates can be time consuming.
1645 The default value is 200. A value of zero disables tab-completion.
1646 Note that setting either no limit or a very large limit can make
1648 @kindex show max-completions
1649 @item show max-completions
1650 Show the maximum number of candidates that @value{GDBN} will collect and show
1654 @cindex quotes in commands
1655 @cindex completion of quoted strings
1656 Sometimes the string you need, while logically a ``word'', may contain
1657 parentheses or other characters that @value{GDBN} normally excludes from
1658 its notion of a word. To permit word completion to work in this
1659 situation, you may enclose words in @code{'} (single quote marks) in
1660 @value{GDBN} commands.
1662 A likely situation where you might need this is in typing an
1663 expression that involves a C@t{++} symbol name with template
1664 parameters. This is because when completing expressions, GDB treats
1665 the @samp{<} character as word delimiter, assuming that it's the
1666 less-than comparison operator (@pxref{C Operators, , C and C@t{++}
1669 For example, when you want to call a C@t{++} template function
1670 interactively using the @code{print} or @code{call} commands, you may
1671 need to distinguish whether you mean the version of @code{name} that
1672 was specialized for @code{int}, @code{name<int>()}, or the version
1673 that was specialized for @code{float}, @code{name<float>()}. To use
1674 the word-completion facilities in this situation, type a single quote
1675 @code{'} at the beginning of the function name. This alerts
1676 @value{GDBN} that it may need to consider more information than usual
1677 when you press @key{TAB} or @kbd{M-?} to request word completion:
1680 (@value{GDBP}) p 'func< @kbd{M-?}
1681 func<int>() func<float>()
1682 (@value{GDBP}) p 'func<
1685 When setting breakpoints however (@pxref{Specify Location}), you don't
1686 usually need to type a quote before the function name, because
1687 @value{GDBN} understands that you want to set a breakpoint on a
1691 (@value{GDBP}) b func< @kbd{M-?}
1692 func<int>() func<float>()
1693 (@value{GDBP}) b func<
1696 This is true even in the case of typing the name of C@t{++} overloaded
1697 functions (multiple definitions of the same function, distinguished by
1698 argument type). For example, when you want to set a breakpoint you
1699 don't need to distinguish whether you mean the version of @code{name}
1700 that takes an @code{int} parameter, @code{name(int)}, or the version
1701 that takes a @code{float} parameter, @code{name(float)}.
1704 (@value{GDBP}) b bubble( @kbd{M-?}
1705 bubble(int) bubble(double)
1706 (@value{GDBP}) b bubble(dou @kbd{M-?}
1710 See @ref{quoting names} for a description of other scenarios that
1713 For more information about overloaded functions, see @ref{C Plus Plus
1714 Expressions, ,C@t{++} Expressions}. You can use the command @code{set
1715 overload-resolution off} to disable overload resolution;
1716 see @ref{Debugging C Plus Plus, ,@value{GDBN} Features for C@t{++}}.
1718 @cindex completion of structure field names
1719 @cindex structure field name completion
1720 @cindex completion of union field names
1721 @cindex union field name completion
1722 When completing in an expression which looks up a field in a
1723 structure, @value{GDBN} also tries@footnote{The completer can be
1724 confused by certain kinds of invalid expressions. Also, it only
1725 examines the static type of the expression, not the dynamic type.} to
1726 limit completions to the field names available in the type of the
1730 (@value{GDBP}) p gdb_stdout.@kbd{M-?}
1731 magic to_fputs to_rewind
1732 to_data to_isatty to_write
1733 to_delete to_put to_write_async_safe
1738 This is because the @code{gdb_stdout} is a variable of the type
1739 @code{struct ui_file} that is defined in @value{GDBN} sources as
1746 ui_file_flush_ftype *to_flush;
1747 ui_file_write_ftype *to_write;
1748 ui_file_write_async_safe_ftype *to_write_async_safe;
1749 ui_file_fputs_ftype *to_fputs;
1750 ui_file_read_ftype *to_read;
1751 ui_file_delete_ftype *to_delete;
1752 ui_file_isatty_ftype *to_isatty;
1753 ui_file_rewind_ftype *to_rewind;
1754 ui_file_put_ftype *to_put;
1761 @section Getting Help
1762 @cindex online documentation
1765 You can always ask @value{GDBN} itself for information on its commands,
1766 using the command @code{help}.
1769 @kindex h @r{(@code{help})}
1772 You can use @code{help} (abbreviated @code{h}) with no arguments to
1773 display a short list of named classes of commands:
1777 List of classes of commands:
1779 aliases -- Aliases of other commands
1780 breakpoints -- Making program stop at certain points
1781 data -- Examining data
1782 files -- Specifying and examining files
1783 internals -- Maintenance commands
1784 obscure -- Obscure features
1785 running -- Running the program
1786 stack -- Examining the stack
1787 status -- Status inquiries
1788 support -- Support facilities
1789 tracepoints -- Tracing of program execution without
1790 stopping the program
1791 user-defined -- User-defined commands
1793 Type "help" followed by a class name for a list of
1794 commands in that class.
1795 Type "help" followed by command name for full
1797 Command name abbreviations are allowed if unambiguous.
1800 @c the above line break eliminates huge line overfull...
1802 @item help @var{class}
1803 Using one of the general help classes as an argument, you can get a
1804 list of the individual commands in that class. For example, here is the
1805 help display for the class @code{status}:
1808 (@value{GDBP}) help status
1813 @c Line break in "show" line falsifies real output, but needed
1814 @c to fit in smallbook page size.
1815 info -- Generic command for showing things
1816 about the program being debugged
1817 show -- Generic command for showing things
1820 Type "help" followed by command name for full
1822 Command name abbreviations are allowed if unambiguous.
1826 @item help @var{command}
1827 With a command name as @code{help} argument, @value{GDBN} displays a
1828 short paragraph on how to use that command.
1831 @item apropos @var{args}
1832 The @code{apropos} command searches through all of the @value{GDBN}
1833 commands, and their documentation, for the regular expression specified in
1834 @var{args}. It prints out all matches found. For example:
1845 alias -- Define a new command that is an alias of an existing command
1846 aliases -- Aliases of other commands
1847 d -- Delete some breakpoints or auto-display expressions
1848 del -- Delete some breakpoints or auto-display expressions
1849 delete -- Delete some breakpoints or auto-display expressions
1854 @item complete @var{args}
1855 The @code{complete @var{args}} command lists all the possible completions
1856 for the beginning of a command. Use @var{args} to specify the beginning of the
1857 command you want completed. For example:
1863 @noindent results in:
1874 @noindent This is intended for use by @sc{gnu} Emacs.
1877 In addition to @code{help}, you can use the @value{GDBN} commands @code{info}
1878 and @code{show} to inquire about the state of your program, or the state
1879 of @value{GDBN} itself. Each command supports many topics of inquiry; this
1880 manual introduces each of them in the appropriate context. The listings
1881 under @code{info} and under @code{show} in the Command, Variable, and
1882 Function Index point to all the sub-commands. @xref{Command and Variable
1888 @kindex i @r{(@code{info})}
1890 This command (abbreviated @code{i}) is for describing the state of your
1891 program. For example, you can show the arguments passed to a function
1892 with @code{info args}, list the registers currently in use with @code{info
1893 registers}, or list the breakpoints you have set with @code{info breakpoints}.
1894 You can get a complete list of the @code{info} sub-commands with
1895 @w{@code{help info}}.
1899 You can assign the result of an expression to an environment variable with
1900 @code{set}. For example, you can set the @value{GDBN} prompt to a $-sign with
1901 @code{set prompt $}.
1905 In contrast to @code{info}, @code{show} is for describing the state of
1906 @value{GDBN} itself.
1907 You can change most of the things you can @code{show}, by using the
1908 related command @code{set}; for example, you can control what number
1909 system is used for displays with @code{set radix}, or simply inquire
1910 which is currently in use with @code{show radix}.
1913 To display all the settable parameters and their current
1914 values, you can use @code{show} with no arguments; you may also use
1915 @code{info set}. Both commands produce the same display.
1916 @c FIXME: "info set" violates the rule that "info" is for state of
1917 @c FIXME...program. Ck w/ GNU: "info set" to be called something else,
1918 @c FIXME...or change desc of rule---eg "state of prog and debugging session"?
1922 Here are several miscellaneous @code{show} subcommands, all of which are
1923 exceptional in lacking corresponding @code{set} commands:
1926 @kindex show version
1927 @cindex @value{GDBN} version number
1929 Show what version of @value{GDBN} is running. You should include this
1930 information in @value{GDBN} bug-reports. If multiple versions of
1931 @value{GDBN} are in use at your site, you may need to determine which
1932 version of @value{GDBN} you are running; as @value{GDBN} evolves, new
1933 commands are introduced, and old ones may wither away. Also, many
1934 system vendors ship variant versions of @value{GDBN}, and there are
1935 variant versions of @value{GDBN} in @sc{gnu}/Linux distributions as well.
1936 The version number is the same as the one announced when you start
1939 @kindex show copying
1940 @kindex info copying
1941 @cindex display @value{GDBN} copyright
1944 Display information about permission for copying @value{GDBN}.
1946 @kindex show warranty
1947 @kindex info warranty
1949 @itemx info warranty
1950 Display the @sc{gnu} ``NO WARRANTY'' statement, or a warranty,
1951 if your version of @value{GDBN} comes with one.
1953 @kindex show configuration
1954 @item show configuration
1955 Display detailed information about the way @value{GDBN} was configured
1956 when it was built. This displays the optional arguments passed to the
1957 @file{configure} script and also configuration parameters detected
1958 automatically by @command{configure}. When reporting a @value{GDBN}
1959 bug (@pxref{GDB Bugs}), it is important to include this information in
1965 @chapter Running Programs Under @value{GDBN}
1967 When you run a program under @value{GDBN}, you must first generate
1968 debugging information when you compile it.
1970 You may start @value{GDBN} with its arguments, if any, in an environment
1971 of your choice. If you are doing native debugging, you may redirect
1972 your program's input and output, debug an already running process, or
1973 kill a child process.
1976 * Compilation:: Compiling for debugging
1977 * Starting:: Starting your program
1978 * Arguments:: Your program's arguments
1979 * Environment:: Your program's environment
1981 * Working Directory:: Your program's working directory
1982 * Input/Output:: Your program's input and output
1983 * Attach:: Debugging an already-running process
1984 * Kill Process:: Killing the child process
1986 * Inferiors and Programs:: Debugging multiple inferiors and programs
1987 * Threads:: Debugging programs with multiple threads
1988 * Forks:: Debugging forks
1989 * Checkpoint/Restart:: Setting a @emph{bookmark} to return to later
1993 @section Compiling for Debugging
1995 In order to debug a program effectively, you need to generate
1996 debugging information when you compile it. This debugging information
1997 is stored in the object file; it describes the data type of each
1998 variable or function and the correspondence between source line numbers
1999 and addresses in the executable code.
2001 To request debugging information, specify the @samp{-g} option when you run
2004 Programs that are to be shipped to your customers are compiled with
2005 optimizations, using the @samp{-O} compiler option. However, some
2006 compilers are unable to handle the @samp{-g} and @samp{-O} options
2007 together. Using those compilers, you cannot generate optimized
2008 executables containing debugging information.
2010 @value{NGCC}, the @sc{gnu} C/C@t{++} compiler, supports @samp{-g} with or
2011 without @samp{-O}, making it possible to debug optimized code. We
2012 recommend that you @emph{always} use @samp{-g} whenever you compile a
2013 program. You may think your program is correct, but there is no sense
2014 in pushing your luck. For more information, see @ref{Optimized Code}.
2016 Older versions of the @sc{gnu} C compiler permitted a variant option
2017 @w{@samp{-gg}} for debugging information. @value{GDBN} no longer supports this
2018 format; if your @sc{gnu} C compiler has this option, do not use it.
2020 @value{GDBN} knows about preprocessor macros and can show you their
2021 expansion (@pxref{Macros}). Most compilers do not include information
2022 about preprocessor macros in the debugging information if you specify
2023 the @option{-g} flag alone. Version 3.1 and later of @value{NGCC},
2024 the @sc{gnu} C compiler, provides macro information if you are using
2025 the DWARF debugging format, and specify the option @option{-g3}.
2027 @xref{Debugging Options,,Options for Debugging Your Program or GCC,
2028 gcc, Using the @sc{gnu} Compiler Collection (GCC)}, for more
2029 information on @value{NGCC} options affecting debug information.
2031 You will have the best debugging experience if you use the latest
2032 version of the DWARF debugging format that your compiler supports.
2033 DWARF is currently the most expressive and best supported debugging
2034 format in @value{GDBN}.
2038 @section Starting your Program
2044 @kindex r @r{(@code{run})}
2047 Use the @code{run} command to start your program under @value{GDBN}.
2048 You must first specify the program name with an argument to
2049 @value{GDBN} (@pxref{Invocation, ,Getting In and Out of
2050 @value{GDBN}}), or by using the @code{file} or @code{exec-file}
2051 command (@pxref{Files, ,Commands to Specify Files}).
2055 If you are running your program in an execution environment that
2056 supports processes, @code{run} creates an inferior process and makes
2057 that process run your program. In some environments without processes,
2058 @code{run} jumps to the start of your program. Other targets,
2059 like @samp{remote}, are always running. If you get an error
2060 message like this one:
2063 The "remote" target does not support "run".
2064 Try "help target" or "continue".
2068 then use @code{continue} to run your program. You may need @code{load}
2069 first (@pxref{load}).
2071 The execution of a program is affected by certain information it
2072 receives from its superior. @value{GDBN} provides ways to specify this
2073 information, which you must do @emph{before} starting your program. (You
2074 can change it after starting your program, but such changes only affect
2075 your program the next time you start it.) This information may be
2076 divided into four categories:
2079 @item The @emph{arguments.}
2080 Specify the arguments to give your program as the arguments of the
2081 @code{run} command. If a shell is available on your target, the shell
2082 is used to pass the arguments, so that you may use normal conventions
2083 (such as wildcard expansion or variable substitution) in describing
2085 In Unix systems, you can control which shell is used with the
2086 @code{SHELL} environment variable. If you do not define @code{SHELL},
2087 @value{GDBN} uses the default shell (@file{/bin/sh}). You can disable
2088 use of any shell with the @code{set startup-with-shell} command (see
2091 @item The @emph{environment.}
2092 Your program normally inherits its environment from @value{GDBN}, but you can
2093 use the @value{GDBN} commands @code{set environment} and @code{unset
2094 environment} to change parts of the environment that affect
2095 your program. @xref{Environment, ,Your Program's Environment}.
2097 @item The @emph{working directory.}
2098 You can set your program's working directory with the command
2099 @kbd{set cwd}. If you do not set any working directory with this
2100 command, your program will inherit @value{GDBN}'s working directory if
2101 native debugging, or the remote server's working directory if remote
2102 debugging. @xref{Working Directory, ,Your Program's Working
2105 @item The @emph{standard input and output.}
2106 Your program normally uses the same device for standard input and
2107 standard output as @value{GDBN} is using. You can redirect input and output
2108 in the @code{run} command line, or you can use the @code{tty} command to
2109 set a different device for your program.
2110 @xref{Input/Output, ,Your Program's Input and Output}.
2113 @emph{Warning:} While input and output redirection work, you cannot use
2114 pipes to pass the output of the program you are debugging to another
2115 program; if you attempt this, @value{GDBN} is likely to wind up debugging the
2119 When you issue the @code{run} command, your program begins to execute
2120 immediately. @xref{Stopping, ,Stopping and Continuing}, for discussion
2121 of how to arrange for your program to stop. Once your program has
2122 stopped, you may call functions in your program, using the @code{print}
2123 or @code{call} commands. @xref{Data, ,Examining Data}.
2125 If the modification time of your symbol file has changed since the last
2126 time @value{GDBN} read its symbols, @value{GDBN} discards its symbol
2127 table, and reads it again. When it does this, @value{GDBN} tries to retain
2128 your current breakpoints.
2133 @cindex run to main procedure
2134 The name of the main procedure can vary from language to language.
2135 With C or C@t{++}, the main procedure name is always @code{main}, but
2136 other languages such as Ada do not require a specific name for their
2137 main procedure. The debugger provides a convenient way to start the
2138 execution of the program and to stop at the beginning of the main
2139 procedure, depending on the language used.
2141 The @samp{start} command does the equivalent of setting a temporary
2142 breakpoint at the beginning of the main procedure and then invoking
2143 the @samp{run} command.
2145 @cindex elaboration phase
2146 Some programs contain an @dfn{elaboration} phase where some startup code is
2147 executed before the main procedure is called. This depends on the
2148 languages used to write your program. In C@t{++}, for instance,
2149 constructors for static and global objects are executed before
2150 @code{main} is called. It is therefore possible that the debugger stops
2151 before reaching the main procedure. However, the temporary breakpoint
2152 will remain to halt execution.
2154 Specify the arguments to give to your program as arguments to the
2155 @samp{start} command. These arguments will be given verbatim to the
2156 underlying @samp{run} command. Note that the same arguments will be
2157 reused if no argument is provided during subsequent calls to
2158 @samp{start} or @samp{run}.
2160 It is sometimes necessary to debug the program during elaboration. In
2161 these cases, using the @code{start} command would stop the execution
2162 of your program too late, as the program would have already completed
2163 the elaboration phase. Under these circumstances, either insert
2164 breakpoints in your elaboration code before running your program or
2165 use the @code{starti} command.
2169 @cindex run to first instruction
2170 The @samp{starti} command does the equivalent of setting a temporary
2171 breakpoint at the first instruction of a program's execution and then
2172 invoking the @samp{run} command. For programs containing an
2173 elaboration phase, the @code{starti} command will stop execution at
2174 the start of the elaboration phase.
2176 @anchor{set exec-wrapper}
2177 @kindex set exec-wrapper
2178 @item set exec-wrapper @var{wrapper}
2179 @itemx show exec-wrapper
2180 @itemx unset exec-wrapper
2181 When @samp{exec-wrapper} is set, the specified wrapper is used to
2182 launch programs for debugging. @value{GDBN} starts your program
2183 with a shell command of the form @kbd{exec @var{wrapper}
2184 @var{program}}. Quoting is added to @var{program} and its
2185 arguments, but not to @var{wrapper}, so you should add quotes if
2186 appropriate for your shell. The wrapper runs until it executes
2187 your program, and then @value{GDBN} takes control.
2189 You can use any program that eventually calls @code{execve} with
2190 its arguments as a wrapper. Several standard Unix utilities do
2191 this, e.g.@: @code{env} and @code{nohup}. Any Unix shell script ending
2192 with @code{exec "$@@"} will also work.
2194 For example, you can use @code{env} to pass an environment variable to
2195 the debugged program, without setting the variable in your shell's
2199 (@value{GDBP}) set exec-wrapper env 'LD_PRELOAD=libtest.so'
2203 This command is available when debugging locally on most targets, excluding
2204 @sc{djgpp}, Cygwin, MS Windows, and QNX Neutrino.
2206 @kindex set startup-with-shell
2207 @anchor{set startup-with-shell}
2208 @item set startup-with-shell
2209 @itemx set startup-with-shell on
2210 @itemx set startup-with-shell off
2211 @itemx show startup-with-shell
2212 On Unix systems, by default, if a shell is available on your target,
2213 @value{GDBN}) uses it to start your program. Arguments of the
2214 @code{run} command are passed to the shell, which does variable
2215 substitution, expands wildcard characters and performs redirection of
2216 I/O. In some circumstances, it may be useful to disable such use of a
2217 shell, for example, when debugging the shell itself or diagnosing
2218 startup failures such as:
2222 Starting program: ./a.out
2223 During startup program terminated with signal SIGSEGV, Segmentation fault.
2227 which indicates the shell or the wrapper specified with
2228 @samp{exec-wrapper} crashed, not your program. Most often, this is
2229 caused by something odd in your shell's non-interactive mode
2230 initialization file---such as @file{.cshrc} for C-shell,
2231 $@file{.zshenv} for the Z shell, or the file specified in the
2232 @samp{BASH_ENV} environment variable for BASH.
2234 @anchor{set auto-connect-native-target}
2235 @kindex set auto-connect-native-target
2236 @item set auto-connect-native-target
2237 @itemx set auto-connect-native-target on
2238 @itemx set auto-connect-native-target off
2239 @itemx show auto-connect-native-target
2241 By default, if not connected to any target yet (e.g., with
2242 @code{target remote}), the @code{run} command starts your program as a
2243 native process under @value{GDBN}, on your local machine. If you're
2244 sure you don't want to debug programs on your local machine, you can
2245 tell @value{GDBN} to not connect to the native target automatically
2246 with the @code{set auto-connect-native-target off} command.
2248 If @code{on}, which is the default, and if @value{GDBN} is not
2249 connected to a target already, the @code{run} command automaticaly
2250 connects to the native target, if one is available.
2252 If @code{off}, and if @value{GDBN} is not connected to a target
2253 already, the @code{run} command fails with an error:
2257 Don't know how to run. Try "help target".
2260 If @value{GDBN} is already connected to a target, @value{GDBN} always
2261 uses it with the @code{run} command.
2263 In any case, you can explicitly connect to the native target with the
2264 @code{target native} command. For example,
2267 (@value{GDBP}) set auto-connect-native-target off
2269 Don't know how to run. Try "help target".
2270 (@value{GDBP}) target native
2272 Starting program: ./a.out
2273 [Inferior 1 (process 10421) exited normally]
2276 In case you connected explicitly to the @code{native} target,
2277 @value{GDBN} remains connected even if all inferiors exit, ready for
2278 the next @code{run} command. Use the @code{disconnect} command to
2281 Examples of other commands that likewise respect the
2282 @code{auto-connect-native-target} setting: @code{attach}, @code{info
2283 proc}, @code{info os}.
2285 @kindex set disable-randomization
2286 @item set disable-randomization
2287 @itemx set disable-randomization on
2288 This option (enabled by default in @value{GDBN}) will turn off the native
2289 randomization of the virtual address space of the started program. This option
2290 is useful for multiple debugging sessions to make the execution better
2291 reproducible and memory addresses reusable across debugging sessions.
2293 This feature is implemented only on certain targets, including @sc{gnu}/Linux.
2294 On @sc{gnu}/Linux you can get the same behavior using
2297 (@value{GDBP}) set exec-wrapper setarch `uname -m` -R
2300 @item set disable-randomization off
2301 Leave the behavior of the started executable unchanged. Some bugs rear their
2302 ugly heads only when the program is loaded at certain addresses. If your bug
2303 disappears when you run the program under @value{GDBN}, that might be because
2304 @value{GDBN} by default disables the address randomization on platforms, such
2305 as @sc{gnu}/Linux, which do that for stand-alone programs. Use @kbd{set
2306 disable-randomization off} to try to reproduce such elusive bugs.
2308 On targets where it is available, virtual address space randomization
2309 protects the programs against certain kinds of security attacks. In these
2310 cases the attacker needs to know the exact location of a concrete executable
2311 code. Randomizing its location makes it impossible to inject jumps misusing
2312 a code at its expected addresses.
2314 Prelinking shared libraries provides a startup performance advantage but it
2315 makes addresses in these libraries predictable for privileged processes by
2316 having just unprivileged access at the target system. Reading the shared
2317 library binary gives enough information for assembling the malicious code
2318 misusing it. Still even a prelinked shared library can get loaded at a new
2319 random address just requiring the regular relocation process during the
2320 startup. Shared libraries not already prelinked are always loaded at
2321 a randomly chosen address.
2323 Position independent executables (PIE) contain position independent code
2324 similar to the shared libraries and therefore such executables get loaded at
2325 a randomly chosen address upon startup. PIE executables always load even
2326 already prelinked shared libraries at a random address. You can build such
2327 executable using @command{gcc -fPIE -pie}.
2329 Heap (malloc storage), stack and custom mmap areas are always placed randomly
2330 (as long as the randomization is enabled).
2332 @item show disable-randomization
2333 Show the current setting of the explicit disable of the native randomization of
2334 the virtual address space of the started program.
2339 @section Your Program's Arguments
2341 @cindex arguments (to your program)
2342 The arguments to your program can be specified by the arguments of the
2344 They are passed to a shell, which expands wildcard characters and
2345 performs redirection of I/O, and thence to your program. Your
2346 @code{SHELL} environment variable (if it exists) specifies what shell
2347 @value{GDBN} uses. If you do not define @code{SHELL}, @value{GDBN} uses
2348 the default shell (@file{/bin/sh} on Unix).
2350 On non-Unix systems, the program is usually invoked directly by
2351 @value{GDBN}, which emulates I/O redirection via the appropriate system
2352 calls, and the wildcard characters are expanded by the startup code of
2353 the program, not by the shell.
2355 @code{run} with no arguments uses the same arguments used by the previous
2356 @code{run}, or those set by the @code{set args} command.
2361 Specify the arguments to be used the next time your program is run. If
2362 @code{set args} has no arguments, @code{run} executes your program
2363 with no arguments. Once you have run your program with arguments,
2364 using @code{set args} before the next @code{run} is the only way to run
2365 it again without arguments.
2369 Show the arguments to give your program when it is started.
2373 @section Your Program's Environment
2375 @cindex environment (of your program)
2376 The @dfn{environment} consists of a set of environment variables and
2377 their values. Environment variables conventionally record such things as
2378 your user name, your home directory, your terminal type, and your search
2379 path for programs to run. Usually you set up environment variables with
2380 the shell and they are inherited by all the other programs you run. When
2381 debugging, it can be useful to try running your program with a modified
2382 environment without having to start @value{GDBN} over again.
2386 @item path @var{directory}
2387 Add @var{directory} to the front of the @code{PATH} environment variable
2388 (the search path for executables) that will be passed to your program.
2389 The value of @code{PATH} used by @value{GDBN} does not change.
2390 You may specify several directory names, separated by whitespace or by a
2391 system-dependent separator character (@samp{:} on Unix, @samp{;} on
2392 MS-DOS and MS-Windows). If @var{directory} is already in the path, it
2393 is moved to the front, so it is searched sooner.
2395 You can use the string @samp{$cwd} to refer to whatever is the current
2396 working directory at the time @value{GDBN} searches the path. If you
2397 use @samp{.} instead, it refers to the directory where you executed the
2398 @code{path} command. @value{GDBN} replaces @samp{.} in the
2399 @var{directory} argument (with the current path) before adding
2400 @var{directory} to the search path.
2401 @c 'path' is explicitly nonrepeatable, but RMS points out it is silly to
2402 @c document that, since repeating it would be a no-op.
2406 Display the list of search paths for executables (the @code{PATH}
2407 environment variable).
2409 @kindex show environment
2410 @item show environment @r{[}@var{varname}@r{]}
2411 Print the value of environment variable @var{varname} to be given to
2412 your program when it starts. If you do not supply @var{varname},
2413 print the names and values of all environment variables to be given to
2414 your program. You can abbreviate @code{environment} as @code{env}.
2416 @kindex set environment
2417 @anchor{set environment}
2418 @item set environment @var{varname} @r{[}=@var{value}@r{]}
2419 Set environment variable @var{varname} to @var{value}. The value
2420 changes for your program (and the shell @value{GDBN} uses to launch
2421 it), not for @value{GDBN} itself. The @var{value} may be any string; the
2422 values of environment variables are just strings, and any
2423 interpretation is supplied by your program itself. The @var{value}
2424 parameter is optional; if it is eliminated, the variable is set to a
2426 @c "any string" here does not include leading, trailing
2427 @c blanks. Gnu asks: does anyone care?
2429 For example, this command:
2436 tells the debugged program, when subsequently run, that its user is named
2437 @samp{foo}. (The spaces around @samp{=} are used for clarity here; they
2438 are not actually required.)
2440 Note that on Unix systems, @value{GDBN} runs your program via a shell,
2441 which also inherits the environment set with @code{set environment}.
2442 If necessary, you can avoid that by using the @samp{env} program as a
2443 wrapper instead of using @code{set environment}. @xref{set
2444 exec-wrapper}, for an example doing just that.
2446 Environment variables that are set by the user are also transmitted to
2447 @command{gdbserver} to be used when starting the remote inferior.
2448 @pxref{QEnvironmentHexEncoded}.
2450 @kindex unset environment
2451 @anchor{unset environment}
2452 @item unset environment @var{varname}
2453 Remove variable @var{varname} from the environment to be passed to your
2454 program. This is different from @samp{set env @var{varname} =};
2455 @code{unset environment} removes the variable from the environment,
2456 rather than assigning it an empty value.
2458 Environment variables that are unset by the user are also unset on
2459 @command{gdbserver} when starting the remote inferior.
2460 @pxref{QEnvironmentUnset}.
2463 @emph{Warning:} On Unix systems, @value{GDBN} runs your program using
2464 the shell indicated by your @code{SHELL} environment variable if it
2465 exists (or @code{/bin/sh} if not). If your @code{SHELL} variable
2466 names a shell that runs an initialization file when started
2467 non-interactively---such as @file{.cshrc} for C-shell, $@file{.zshenv}
2468 for the Z shell, or the file specified in the @samp{BASH_ENV}
2469 environment variable for BASH---any variables you set in that file
2470 affect your program. You may wish to move setting of environment
2471 variables to files that are only run when you sign on, such as
2472 @file{.login} or @file{.profile}.
2474 @node Working Directory
2475 @section Your Program's Working Directory
2477 @cindex working directory (of your program)
2478 Each time you start your program with @code{run}, the inferior will be
2479 initialized with the current working directory specified by the
2480 @kbd{set cwd} command. If no directory has been specified by this
2481 command, then the inferior will inherit @value{GDBN}'s current working
2482 directory as its working directory if native debugging, or it will
2483 inherit the remote server's current working directory if remote
2488 @cindex change inferior's working directory
2489 @anchor{set cwd command}
2490 @item set cwd @r{[}@var{directory}@r{]}
2491 Set the inferior's working directory to @var{directory}, which will be
2492 @code{glob}-expanded in order to resolve tildes (@file{~}). If no
2493 argument has been specified, the command clears the setting and resets
2494 it to an empty state. This setting has no effect on @value{GDBN}'s
2495 working directory, and it only takes effect the next time you start
2496 the inferior. The @file{~} in @var{directory} is a short for the
2497 @dfn{home directory}, usually pointed to by the @env{HOME} environment
2498 variable. On MS-Windows, if @env{HOME} is not defined, @value{GDBN}
2499 uses the concatenation of @env{HOMEDRIVE} and @env{HOMEPATH} as
2502 You can also change @value{GDBN}'s current working directory by using
2503 the @code{cd} command.
2507 @cindex show inferior's working directory
2509 Show the inferior's working directory. If no directory has been
2510 specified by @kbd{set cwd}, then the default inferior's working
2511 directory is the same as @value{GDBN}'s working directory.
2514 @cindex change @value{GDBN}'s working directory
2516 @item cd @r{[}@var{directory}@r{]}
2517 Set the @value{GDBN} working directory to @var{directory}. If not
2518 given, @var{directory} uses @file{'~'}.
2520 The @value{GDBN} working directory serves as a default for the
2521 commands that specify files for @value{GDBN} to operate on.
2522 @xref{Files, ,Commands to Specify Files}.
2523 @xref{set cwd command}.
2527 Print the @value{GDBN} working directory.
2530 It is generally impossible to find the current working directory of
2531 the process being debugged (since a program can change its directory
2532 during its run). If you work on a system where @value{GDBN} supports
2533 the @code{info proc} command (@pxref{Process Information}), you can
2534 use the @code{info proc} command to find out the
2535 current working directory of the debuggee.
2538 @section Your Program's Input and Output
2543 By default, the program you run under @value{GDBN} does input and output to
2544 the same terminal that @value{GDBN} uses. @value{GDBN} switches the terminal
2545 to its own terminal modes to interact with you, but it records the terminal
2546 modes your program was using and switches back to them when you continue
2547 running your program.
2550 @kindex info terminal
2552 Displays information recorded by @value{GDBN} about the terminal modes your
2556 You can redirect your program's input and/or output using shell
2557 redirection with the @code{run} command. For example,
2564 starts your program, diverting its output to the file @file{outfile}.
2567 @cindex controlling terminal
2568 Another way to specify where your program should do input and output is
2569 with the @code{tty} command. This command accepts a file name as
2570 argument, and causes this file to be the default for future @code{run}
2571 commands. It also resets the controlling terminal for the child
2572 process, for future @code{run} commands. For example,
2579 directs that processes started with subsequent @code{run} commands
2580 default to do input and output on the terminal @file{/dev/ttyb} and have
2581 that as their controlling terminal.
2583 An explicit redirection in @code{run} overrides the @code{tty} command's
2584 effect on the input/output device, but not its effect on the controlling
2587 When you use the @code{tty} command or redirect input in the @code{run}
2588 command, only the input @emph{for your program} is affected. The input
2589 for @value{GDBN} still comes from your terminal. @code{tty} is an alias
2590 for @code{set inferior-tty}.
2592 @cindex inferior tty
2593 @cindex set inferior controlling terminal
2594 You can use the @code{show inferior-tty} command to tell @value{GDBN} to
2595 display the name of the terminal that will be used for future runs of your
2599 @item set inferior-tty [ @var{tty} ]
2600 @kindex set inferior-tty
2601 Set the tty for the program being debugged to @var{tty}. Omitting @var{tty}
2602 restores the default behavior, which is to use the same terminal as
2605 @item show inferior-tty
2606 @kindex show inferior-tty
2607 Show the current tty for the program being debugged.
2611 @section Debugging an Already-running Process
2616 @item attach @var{process-id}
2617 This command attaches to a running process---one that was started
2618 outside @value{GDBN}. (@code{info files} shows your active
2619 targets.) The command takes as argument a process ID. The usual way to
2620 find out the @var{process-id} of a Unix process is with the @code{ps} utility,
2621 or with the @samp{jobs -l} shell command.
2623 @code{attach} does not repeat if you press @key{RET} a second time after
2624 executing the command.
2627 To use @code{attach}, your program must be running in an environment
2628 which supports processes; for example, @code{attach} does not work for
2629 programs on bare-board targets that lack an operating system. You must
2630 also have permission to send the process a signal.
2632 When you use @code{attach}, the debugger finds the program running in
2633 the process first by looking in the current working directory, then (if
2634 the program is not found) by using the source file search path
2635 (@pxref{Source Path, ,Specifying Source Directories}). You can also use
2636 the @code{file} command to load the program. @xref{Files, ,Commands to
2639 The first thing @value{GDBN} does after arranging to debug the specified
2640 process is to stop it. You can examine and modify an attached process
2641 with all the @value{GDBN} commands that are ordinarily available when
2642 you start processes with @code{run}. You can insert breakpoints; you
2643 can step and continue; you can modify storage. If you would rather the
2644 process continue running, you may use the @code{continue} command after
2645 attaching @value{GDBN} to the process.
2650 When you have finished debugging the attached process, you can use the
2651 @code{detach} command to release it from @value{GDBN} control. Detaching
2652 the process continues its execution. After the @code{detach} command,
2653 that process and @value{GDBN} become completely independent once more, and you
2654 are ready to @code{attach} another process or start one with @code{run}.
2655 @code{detach} does not repeat if you press @key{RET} again after
2656 executing the command.
2659 If you exit @value{GDBN} while you have an attached process, you detach
2660 that process. If you use the @code{run} command, you kill that process.
2661 By default, @value{GDBN} asks for confirmation if you try to do either of these
2662 things; you can control whether or not you need to confirm by using the
2663 @code{set confirm} command (@pxref{Messages/Warnings, ,Optional Warnings and
2667 @section Killing the Child Process
2672 Kill the child process in which your program is running under @value{GDBN}.
2675 This command is useful if you wish to debug a core dump instead of a
2676 running process. @value{GDBN} ignores any core dump file while your program
2679 On some operating systems, a program cannot be executed outside @value{GDBN}
2680 while you have breakpoints set on it inside @value{GDBN}. You can use the
2681 @code{kill} command in this situation to permit running your program
2682 outside the debugger.
2684 The @code{kill} command is also useful if you wish to recompile and
2685 relink your program, since on many systems it is impossible to modify an
2686 executable file while it is running in a process. In this case, when you
2687 next type @code{run}, @value{GDBN} notices that the file has changed, and
2688 reads the symbol table again (while trying to preserve your current
2689 breakpoint settings).
2691 @node Inferiors and Programs
2692 @section Debugging Multiple Inferiors and Programs
2694 @value{GDBN} lets you run and debug multiple programs in a single
2695 session. In addition, @value{GDBN} on some systems may let you run
2696 several programs simultaneously (otherwise you have to exit from one
2697 before starting another). In the most general case, you can have
2698 multiple threads of execution in each of multiple processes, launched
2699 from multiple executables.
2702 @value{GDBN} represents the state of each program execution with an
2703 object called an @dfn{inferior}. An inferior typically corresponds to
2704 a process, but is more general and applies also to targets that do not
2705 have processes. Inferiors may be created before a process runs, and
2706 may be retained after a process exits. Inferiors have unique
2707 identifiers that are different from process ids. Usually each
2708 inferior will also have its own distinct address space, although some
2709 embedded targets may have several inferiors running in different parts
2710 of a single address space. Each inferior may in turn have multiple
2711 threads running in it.
2713 To find out what inferiors exist at any moment, use @w{@code{info
2717 @kindex info inferiors [ @var{id}@dots{} ]
2718 @item info inferiors
2719 Print a list of all inferiors currently being managed by @value{GDBN}.
2720 By default all inferiors are printed, but the argument @var{id}@dots{}
2721 -- a space separated list of inferior numbers -- can be used to limit
2722 the display to just the requested inferiors.
2724 @value{GDBN} displays for each inferior (in this order):
2728 the inferior number assigned by @value{GDBN}
2731 the target system's inferior identifier
2734 the name of the executable the inferior is running.
2739 An asterisk @samp{*} preceding the @value{GDBN} inferior number
2740 indicates the current inferior.
2744 @c end table here to get a little more width for example
2747 (@value{GDBP}) info inferiors
2748 Num Description Executable
2749 2 process 2307 hello
2750 * 1 process 3401 goodbye
2753 To switch focus between inferiors, use the @code{inferior} command:
2756 @kindex inferior @var{infno}
2757 @item inferior @var{infno}
2758 Make inferior number @var{infno} the current inferior. The argument
2759 @var{infno} is the inferior number assigned by @value{GDBN}, as shown
2760 in the first field of the @samp{info inferiors} display.
2763 @vindex $_inferior@r{, convenience variable}
2764 The debugger convenience variable @samp{$_inferior} contains the
2765 number of the current inferior. You may find this useful in writing
2766 breakpoint conditional expressions, command scripts, and so forth.
2767 @xref{Convenience Vars,, Convenience Variables}, for general
2768 information on convenience variables.
2770 You can get multiple executables into a debugging session via the
2771 @code{add-inferior} and @w{@code{clone-inferior}} commands. On some
2772 systems @value{GDBN} can add inferiors to the debug session
2773 automatically by following calls to @code{fork} and @code{exec}. To
2774 remove inferiors from the debugging session use the
2775 @w{@code{remove-inferiors}} command.
2778 @kindex add-inferior
2779 @item add-inferior [ -copies @var{n} ] [ -exec @var{executable} ]
2780 Adds @var{n} inferiors to be run using @var{executable} as the
2781 executable; @var{n} defaults to 1. If no executable is specified,
2782 the inferiors begins empty, with no program. You can still assign or
2783 change the program assigned to the inferior at any time by using the
2784 @code{file} command with the executable name as its argument.
2786 @kindex clone-inferior
2787 @item clone-inferior [ -copies @var{n} ] [ @var{infno} ]
2788 Adds @var{n} inferiors ready to execute the same program as inferior
2789 @var{infno}; @var{n} defaults to 1, and @var{infno} defaults to the
2790 number of the current inferior. This is a convenient command when you
2791 want to run another instance of the inferior you are debugging.
2794 (@value{GDBP}) info inferiors
2795 Num Description Executable
2796 * 1 process 29964 helloworld
2797 (@value{GDBP}) clone-inferior
2800 (@value{GDBP}) info inferiors
2801 Num Description Executable
2803 * 1 process 29964 helloworld
2806 You can now simply switch focus to inferior 2 and run it.
2808 @kindex remove-inferiors
2809 @item remove-inferiors @var{infno}@dots{}
2810 Removes the inferior or inferiors @var{infno}@dots{}. It is not
2811 possible to remove an inferior that is running with this command. For
2812 those, use the @code{kill} or @code{detach} command first.
2816 To quit debugging one of the running inferiors that is not the current
2817 inferior, you can either detach from it by using the @w{@code{detach
2818 inferior}} command (allowing it to run independently), or kill it
2819 using the @w{@code{kill inferiors}} command:
2822 @kindex detach inferiors @var{infno}@dots{}
2823 @item detach inferior @var{infno}@dots{}
2824 Detach from the inferior or inferiors identified by @value{GDBN}
2825 inferior number(s) @var{infno}@dots{}. Note that the inferior's entry
2826 still stays on the list of inferiors shown by @code{info inferiors},
2827 but its Description will show @samp{<null>}.
2829 @kindex kill inferiors @var{infno}@dots{}
2830 @item kill inferiors @var{infno}@dots{}
2831 Kill the inferior or inferiors identified by @value{GDBN} inferior
2832 number(s) @var{infno}@dots{}. Note that the inferior's entry still
2833 stays on the list of inferiors shown by @code{info inferiors}, but its
2834 Description will show @samp{<null>}.
2837 After the successful completion of a command such as @code{detach},
2838 @code{detach inferiors}, @code{kill} or @code{kill inferiors}, or after
2839 a normal process exit, the inferior is still valid and listed with
2840 @code{info inferiors}, ready to be restarted.
2843 To be notified when inferiors are started or exit under @value{GDBN}'s
2844 control use @w{@code{set print inferior-events}}:
2847 @kindex set print inferior-events
2848 @cindex print messages on inferior start and exit
2849 @item set print inferior-events
2850 @itemx set print inferior-events on
2851 @itemx set print inferior-events off
2852 The @code{set print inferior-events} command allows you to enable or
2853 disable printing of messages when @value{GDBN} notices that new
2854 inferiors have started or that inferiors have exited or have been
2855 detached. By default, these messages will not be printed.
2857 @kindex show print inferior-events
2858 @item show print inferior-events
2859 Show whether messages will be printed when @value{GDBN} detects that
2860 inferiors have started, exited or have been detached.
2863 Many commands will work the same with multiple programs as with a
2864 single program: e.g., @code{print myglobal} will simply display the
2865 value of @code{myglobal} in the current inferior.
2868 Occasionaly, when debugging @value{GDBN} itself, it may be useful to
2869 get more info about the relationship of inferiors, programs, address
2870 spaces in a debug session. You can do that with the @w{@code{maint
2871 info program-spaces}} command.
2874 @kindex maint info program-spaces
2875 @item maint info program-spaces
2876 Print a list of all program spaces currently being managed by
2879 @value{GDBN} displays for each program space (in this order):
2883 the program space number assigned by @value{GDBN}
2886 the name of the executable loaded into the program space, with e.g.,
2887 the @code{file} command.
2892 An asterisk @samp{*} preceding the @value{GDBN} program space number
2893 indicates the current program space.
2895 In addition, below each program space line, @value{GDBN} prints extra
2896 information that isn't suitable to display in tabular form. For
2897 example, the list of inferiors bound to the program space.
2900 (@value{GDBP}) maint info program-spaces
2904 Bound inferiors: ID 1 (process 21561)
2907 Here we can see that no inferior is running the program @code{hello},
2908 while @code{process 21561} is running the program @code{goodbye}. On
2909 some targets, it is possible that multiple inferiors are bound to the
2910 same program space. The most common example is that of debugging both
2911 the parent and child processes of a @code{vfork} call. For example,
2914 (@value{GDBP}) maint info program-spaces
2917 Bound inferiors: ID 2 (process 18050), ID 1 (process 18045)
2920 Here, both inferior 2 and inferior 1 are running in the same program
2921 space as a result of inferior 1 having executed a @code{vfork} call.
2925 @section Debugging Programs with Multiple Threads
2927 @cindex threads of execution
2928 @cindex multiple threads
2929 @cindex switching threads
2930 In some operating systems, such as GNU/Linux and Solaris, a single program
2931 may have more than one @dfn{thread} of execution. The precise semantics
2932 of threads differ from one operating system to another, but in general
2933 the threads of a single program are akin to multiple processes---except
2934 that they share one address space (that is, they can all examine and
2935 modify the same variables). On the other hand, each thread has its own
2936 registers and execution stack, and perhaps private memory.
2938 @value{GDBN} provides these facilities for debugging multi-thread
2942 @item automatic notification of new threads
2943 @item @samp{thread @var{thread-id}}, a command to switch among threads
2944 @item @samp{info threads}, a command to inquire about existing threads
2945 @item @samp{thread apply [@var{thread-id-list} | all] @var{args}},
2946 a command to apply a command to a list of threads
2947 @item thread-specific breakpoints
2948 @item @samp{set print thread-events}, which controls printing of
2949 messages on thread start and exit.
2950 @item @samp{set libthread-db-search-path @var{path}}, which lets
2951 the user specify which @code{libthread_db} to use if the default choice
2952 isn't compatible with the program.
2955 @cindex focus of debugging
2956 @cindex current thread
2957 The @value{GDBN} thread debugging facility allows you to observe all
2958 threads while your program runs---but whenever @value{GDBN} takes
2959 control, one thread in particular is always the focus of debugging.
2960 This thread is called the @dfn{current thread}. Debugging commands show
2961 program information from the perspective of the current thread.
2963 @cindex @code{New} @var{systag} message
2964 @cindex thread identifier (system)
2965 @c FIXME-implementors!! It would be more helpful if the [New...] message
2966 @c included GDB's numeric thread handle, so you could just go to that
2967 @c thread without first checking `info threads'.
2968 Whenever @value{GDBN} detects a new thread in your program, it displays
2969 the target system's identification for the thread with a message in the
2970 form @samp{[New @var{systag}]}, where @var{systag} is a thread identifier
2971 whose form varies depending on the particular system. For example, on
2972 @sc{gnu}/Linux, you might see
2975 [New Thread 0x41e02940 (LWP 25582)]
2979 when @value{GDBN} notices a new thread. In contrast, on other systems,
2980 the @var{systag} is simply something like @samp{process 368}, with no
2983 @c FIXME!! (1) Does the [New...] message appear even for the very first
2984 @c thread of a program, or does it only appear for the
2985 @c second---i.e.@: when it becomes obvious we have a multithread
2987 @c (2) *Is* there necessarily a first thread always? Or do some
2988 @c multithread systems permit starting a program with multiple
2989 @c threads ab initio?
2991 @anchor{thread numbers}
2992 @cindex thread number, per inferior
2993 @cindex thread identifier (GDB)
2994 For debugging purposes, @value{GDBN} associates its own thread number
2995 ---always a single integer---with each thread of an inferior. This
2996 number is unique between all threads of an inferior, but not unique
2997 between threads of different inferiors.
2999 @cindex qualified thread ID
3000 You can refer to a given thread in an inferior using the qualified
3001 @var{inferior-num}.@var{thread-num} syntax, also known as
3002 @dfn{qualified thread ID}, with @var{inferior-num} being the inferior
3003 number and @var{thread-num} being the thread number of the given
3004 inferior. For example, thread @code{2.3} refers to thread number 3 of
3005 inferior 2. If you omit @var{inferior-num} (e.g., @code{thread 3}),
3006 then @value{GDBN} infers you're referring to a thread of the current
3009 Until you create a second inferior, @value{GDBN} does not show the
3010 @var{inferior-num} part of thread IDs, even though you can always use
3011 the full @var{inferior-num}.@var{thread-num} form to refer to threads
3012 of inferior 1, the initial inferior.
3014 @anchor{thread ID lists}
3015 @cindex thread ID lists
3016 Some commands accept a space-separated @dfn{thread ID list} as
3017 argument. A list element can be:
3021 A thread ID as shown in the first field of the @samp{info threads}
3022 display, with or without an inferior qualifier. E.g., @samp{2.1} or
3026 A range of thread numbers, again with or without an inferior
3027 qualifier, as in @var{inf}.@var{thr1}-@var{thr2} or
3028 @var{thr1}-@var{thr2}. E.g., @samp{1.2-4} or @samp{2-4}.
3031 All threads of an inferior, specified with a star wildcard, with or
3032 without an inferior qualifier, as in @var{inf}.@code{*} (e.g.,
3033 @samp{1.*}) or @code{*}. The former refers to all threads of the
3034 given inferior, and the latter form without an inferior qualifier
3035 refers to all threads of the current inferior.
3039 For example, if the current inferior is 1, and inferior 7 has one
3040 thread with ID 7.1, the thread list @samp{1 2-3 4.5 6.7-9 7.*}
3041 includes threads 1 to 3 of inferior 1, thread 5 of inferior 4, threads
3042 7 to 9 of inferior 6 and all threads of inferior 7. That is, in
3043 expanded qualified form, the same as @samp{1.1 1.2 1.3 4.5 6.7 6.8 6.9
3047 @anchor{global thread numbers}
3048 @cindex global thread number
3049 @cindex global thread identifier (GDB)
3050 In addition to a @emph{per-inferior} number, each thread is also
3051 assigned a unique @emph{global} number, also known as @dfn{global
3052 thread ID}, a single integer. Unlike the thread number component of
3053 the thread ID, no two threads have the same global ID, even when
3054 you're debugging multiple inferiors.
3056 From @value{GDBN}'s perspective, a process always has at least one
3057 thread. In other words, @value{GDBN} assigns a thread number to the
3058 program's ``main thread'' even if the program is not multi-threaded.
3060 @vindex $_thread@r{, convenience variable}
3061 @vindex $_gthread@r{, convenience variable}
3062 The debugger convenience variables @samp{$_thread} and
3063 @samp{$_gthread} contain, respectively, the per-inferior thread number
3064 and the global thread number of the current thread. You may find this
3065 useful in writing breakpoint conditional expressions, command scripts,
3066 and so forth. @xref{Convenience Vars,, Convenience Variables}, for
3067 general information on convenience variables.
3069 If @value{GDBN} detects the program is multi-threaded, it augments the
3070 usual message about stopping at a breakpoint with the ID and name of
3071 the thread that hit the breakpoint.
3074 Thread 2 "client" hit Breakpoint 1, send_message () at client.c:68
3077 Likewise when the program receives a signal:
3080 Thread 1 "main" received signal SIGINT, Interrupt.
3084 @kindex info threads
3085 @item info threads @r{[}@var{thread-id-list}@r{]}
3087 Display information about one or more threads. With no arguments
3088 displays information about all threads. You can specify the list of
3089 threads that you want to display using the thread ID list syntax
3090 (@pxref{thread ID lists}).
3092 @value{GDBN} displays for each thread (in this order):
3096 the per-inferior thread number assigned by @value{GDBN}
3099 the global thread number assigned by @value{GDBN}, if the @samp{-gid}
3100 option was specified
3103 the target system's thread identifier (@var{systag})
3106 the thread's name, if one is known. A thread can either be named by
3107 the user (see @code{thread name}, below), or, in some cases, by the
3111 the current stack frame summary for that thread
3115 An asterisk @samp{*} to the left of the @value{GDBN} thread number
3116 indicates the current thread.
3120 @c end table here to get a little more width for example
3123 (@value{GDBP}) info threads
3125 * 1 process 35 thread 13 main (argc=1, argv=0x7ffffff8)
3126 2 process 35 thread 23 0x34e5 in sigpause ()
3127 3 process 35 thread 27 0x34e5 in sigpause ()
3131 If you're debugging multiple inferiors, @value{GDBN} displays thread
3132 IDs using the qualified @var{inferior-num}.@var{thread-num} format.
3133 Otherwise, only @var{thread-num} is shown.
3135 If you specify the @samp{-gid} option, @value{GDBN} displays a column
3136 indicating each thread's global thread ID:
3139 (@value{GDBP}) info threads
3140 Id GId Target Id Frame
3141 1.1 1 process 35 thread 13 main (argc=1, argv=0x7ffffff8)
3142 1.2 3 process 35 thread 23 0x34e5 in sigpause ()
3143 1.3 4 process 35 thread 27 0x34e5 in sigpause ()
3144 * 2.1 2 process 65 thread 1 main (argc=1, argv=0x7ffffff8)
3147 On Solaris, you can display more information about user threads with a
3148 Solaris-specific command:
3151 @item maint info sol-threads
3152 @kindex maint info sol-threads
3153 @cindex thread info (Solaris)
3154 Display info on Solaris user threads.
3158 @kindex thread @var{thread-id}
3159 @item thread @var{thread-id}
3160 Make thread ID @var{thread-id} the current thread. The command
3161 argument @var{thread-id} is the @value{GDBN} thread ID, as shown in
3162 the first field of the @samp{info threads} display, with or without an
3163 inferior qualifier (e.g., @samp{2.1} or @samp{1}).
3165 @value{GDBN} responds by displaying the system identifier of the
3166 thread you selected, and its current stack frame summary:
3169 (@value{GDBP}) thread 2
3170 [Switching to thread 2 (Thread 0xb7fdab70 (LWP 12747))]
3171 #0 some_function (ignore=0x0) at example.c:8
3172 8 printf ("hello\n");
3176 As with the @samp{[New @dots{}]} message, the form of the text after
3177 @samp{Switching to} depends on your system's conventions for identifying
3180 @kindex thread apply
3181 @cindex apply command to several threads
3182 @item thread apply [@var{thread-id-list} | all [-ascending]] [@var{flag}]@dots{} @var{command}
3183 The @code{thread apply} command allows you to apply the named
3184 @var{command} to one or more threads. Specify the threads that you
3185 want affected using the thread ID list syntax (@pxref{thread ID
3186 lists}), or specify @code{all} to apply to all threads. To apply a
3187 command to all threads in descending order, type @kbd{thread apply all
3188 @var{command}}. To apply a command to all threads in ascending order,
3189 type @kbd{thread apply all -ascending @var{command}}.
3191 The @var{flag} arguments control what output to produce and how to handle
3192 errors raised when applying @var{command} to a thread. @var{flag}
3193 must start with a @code{-} directly followed by one letter in
3194 @code{qcs}. If several flags are provided, they must be given
3195 individually, such as @code{-c -q}.
3197 By default, @value{GDBN} displays some thread information before the
3198 output produced by @var{command}, and an error raised during the
3199 execution of a @var{command} will abort @code{thread apply}. The
3200 following flags can be used to fine-tune this behavior:
3204 The flag @code{-c}, which stands for @samp{continue}, causes any
3205 errors in @var{command} to be displayed, and the execution of
3206 @code{thread apply} then continues.
3208 The flag @code{-s}, which stands for @samp{silent}, causes any errors
3209 or empty output produced by a @var{command} to be silently ignored.
3210 That is, the execution continues, but the thread information and errors
3213 The flag @code{-q} (@samp{quiet}) disables printing the thread
3217 Flags @code{-c} and @code{-s} cannot be used together.
3220 @cindex apply command to all threads (ignoring errors and empty output)
3221 @item taas @var{command}
3222 Shortcut for @code{thread apply all -s @var{command}}.
3223 Applies @var{command} on all threads, ignoring errors and empty output.
3226 @cindex apply a command to all frames of all threads (ignoring errors and empty output)
3227 @item tfaas @var{command}
3228 Shortcut for @code{thread apply all -s frame apply all -s @var{command}}.
3229 Applies @var{command} on all frames of all threads, ignoring errors
3230 and empty output. Note that the flag @code{-s} is specified twice:
3231 The first @code{-s} ensures that @code{thread apply} only shows the thread
3232 information of the threads for which @code{frame apply} produces
3233 some output. The second @code{-s} is needed to ensure that @code{frame
3234 apply} shows the frame information of a frame only if the
3235 @var{command} successfully produced some output.
3237 It can for example be used to print a local variable or a function
3238 argument without knowing the thread or frame where this variable or argument
3241 (@value{GDBP}) tfaas p some_local_var_i_do_not_remember_where_it_is
3246 @cindex name a thread
3247 @item thread name [@var{name}]
3248 This command assigns a name to the current thread. If no argument is
3249 given, any existing user-specified name is removed. The thread name
3250 appears in the @samp{info threads} display.
3252 On some systems, such as @sc{gnu}/Linux, @value{GDBN} is able to
3253 determine the name of the thread as given by the OS. On these
3254 systems, a name specified with @samp{thread name} will override the
3255 system-give name, and removing the user-specified name will cause
3256 @value{GDBN} to once again display the system-specified name.
3259 @cindex search for a thread
3260 @item thread find [@var{regexp}]
3261 Search for and display thread ids whose name or @var{systag}
3262 matches the supplied regular expression.
3264 As well as being the complement to the @samp{thread name} command,
3265 this command also allows you to identify a thread by its target
3266 @var{systag}. For instance, on @sc{gnu}/Linux, the target @var{systag}
3270 (@value{GDBN}) thread find 26688
3271 Thread 4 has target id 'Thread 0x41e02940 (LWP 26688)'
3272 (@value{GDBN}) info thread 4
3274 4 Thread 0x41e02940 (LWP 26688) 0x00000031ca6cd372 in select ()
3277 @kindex set print thread-events
3278 @cindex print messages on thread start and exit
3279 @item set print thread-events
3280 @itemx set print thread-events on
3281 @itemx set print thread-events off
3282 The @code{set print thread-events} command allows you to enable or
3283 disable printing of messages when @value{GDBN} notices that new threads have
3284 started or that threads have exited. By default, these messages will
3285 be printed if detection of these events is supported by the target.
3286 Note that these messages cannot be disabled on all targets.
3288 @kindex show print thread-events
3289 @item show print thread-events
3290 Show whether messages will be printed when @value{GDBN} detects that threads
3291 have started and exited.
3294 @xref{Thread Stops,,Stopping and Starting Multi-thread Programs}, for
3295 more information about how @value{GDBN} behaves when you stop and start
3296 programs with multiple threads.
3298 @xref{Set Watchpoints,,Setting Watchpoints}, for information about
3299 watchpoints in programs with multiple threads.
3301 @anchor{set libthread-db-search-path}
3303 @kindex set libthread-db-search-path
3304 @cindex search path for @code{libthread_db}
3305 @item set libthread-db-search-path @r{[}@var{path}@r{]}
3306 If this variable is set, @var{path} is a colon-separated list of
3307 directories @value{GDBN} will use to search for @code{libthread_db}.
3308 If you omit @var{path}, @samp{libthread-db-search-path} will be reset to
3309 its default value (@code{$sdir:$pdir} on @sc{gnu}/Linux and Solaris systems).
3310 Internally, the default value comes from the @code{LIBTHREAD_DB_SEARCH_PATH}
3313 On @sc{gnu}/Linux and Solaris systems, @value{GDBN} uses a ``helper''
3314 @code{libthread_db} library to obtain information about threads in the
3315 inferior process. @value{GDBN} will use @samp{libthread-db-search-path}
3316 to find @code{libthread_db}. @value{GDBN} also consults first if inferior
3317 specific thread debugging library loading is enabled
3318 by @samp{set auto-load libthread-db} (@pxref{libthread_db.so.1 file}).
3320 A special entry @samp{$sdir} for @samp{libthread-db-search-path}
3321 refers to the default system directories that are
3322 normally searched for loading shared libraries. The @samp{$sdir} entry
3323 is the only kind not needing to be enabled by @samp{set auto-load libthread-db}
3324 (@pxref{libthread_db.so.1 file}).
3326 A special entry @samp{$pdir} for @samp{libthread-db-search-path}
3327 refers to the directory from which @code{libpthread}
3328 was loaded in the inferior process.
3330 For any @code{libthread_db} library @value{GDBN} finds in above directories,
3331 @value{GDBN} attempts to initialize it with the current inferior process.
3332 If this initialization fails (which could happen because of a version
3333 mismatch between @code{libthread_db} and @code{libpthread}), @value{GDBN}
3334 will unload @code{libthread_db}, and continue with the next directory.
3335 If none of @code{libthread_db} libraries initialize successfully,
3336 @value{GDBN} will issue a warning and thread debugging will be disabled.
3338 Setting @code{libthread-db-search-path} is currently implemented
3339 only on some platforms.
3341 @kindex show libthread-db-search-path
3342 @item show libthread-db-search-path
3343 Display current libthread_db search path.
3345 @kindex set debug libthread-db
3346 @kindex show debug libthread-db
3347 @cindex debugging @code{libthread_db}
3348 @item set debug libthread-db
3349 @itemx show debug libthread-db
3350 Turns on or off display of @code{libthread_db}-related events.
3351 Use @code{1} to enable, @code{0} to disable.
3355 @section Debugging Forks
3357 @cindex fork, debugging programs which call
3358 @cindex multiple processes
3359 @cindex processes, multiple
3360 On most systems, @value{GDBN} has no special support for debugging
3361 programs which create additional processes using the @code{fork}
3362 function. When a program forks, @value{GDBN} will continue to debug the
3363 parent process and the child process will run unimpeded. If you have
3364 set a breakpoint in any code which the child then executes, the child
3365 will get a @code{SIGTRAP} signal which (unless it catches the signal)
3366 will cause it to terminate.
3368 However, if you want to debug the child process there is a workaround
3369 which isn't too painful. Put a call to @code{sleep} in the code which
3370 the child process executes after the fork. It may be useful to sleep
3371 only if a certain environment variable is set, or a certain file exists,
3372 so that the delay need not occur when you don't want to run @value{GDBN}
3373 on the child. While the child is sleeping, use the @code{ps} program to
3374 get its process ID. Then tell @value{GDBN} (a new invocation of
3375 @value{GDBN} if you are also debugging the parent process) to attach to
3376 the child process (@pxref{Attach}). From that point on you can debug
3377 the child process just like any other process which you attached to.
3379 On some systems, @value{GDBN} provides support for debugging programs
3380 that create additional processes using the @code{fork} or @code{vfork}
3381 functions. On @sc{gnu}/Linux platforms, this feature is supported
3382 with kernel version 2.5.46 and later.
3384 The fork debugging commands are supported in native mode and when
3385 connected to @code{gdbserver} in either @code{target remote} mode or
3386 @code{target extended-remote} mode.
3388 By default, when a program forks, @value{GDBN} will continue to debug
3389 the parent process and the child process will run unimpeded.
3391 If you want to follow the child process instead of the parent process,
3392 use the command @w{@code{set follow-fork-mode}}.
3395 @kindex set follow-fork-mode
3396 @item set follow-fork-mode @var{mode}
3397 Set the debugger response to a program call of @code{fork} or
3398 @code{vfork}. A call to @code{fork} or @code{vfork} creates a new
3399 process. The @var{mode} argument can be:
3403 The original process is debugged after a fork. The child process runs
3404 unimpeded. This is the default.
3407 The new process is debugged after a fork. The parent process runs
3412 @kindex show follow-fork-mode
3413 @item show follow-fork-mode
3414 Display the current debugger response to a @code{fork} or @code{vfork} call.
3417 @cindex debugging multiple processes
3418 On Linux, if you want to debug both the parent and child processes, use the
3419 command @w{@code{set detach-on-fork}}.
3422 @kindex set detach-on-fork
3423 @item set detach-on-fork @var{mode}
3424 Tells gdb whether to detach one of the processes after a fork, or
3425 retain debugger control over them both.
3429 The child process (or parent process, depending on the value of
3430 @code{follow-fork-mode}) will be detached and allowed to run
3431 independently. This is the default.
3434 Both processes will be held under the control of @value{GDBN}.
3435 One process (child or parent, depending on the value of
3436 @code{follow-fork-mode}) is debugged as usual, while the other
3441 @kindex show detach-on-fork
3442 @item show detach-on-fork
3443 Show whether detach-on-fork mode is on/off.
3446 If you choose to set @samp{detach-on-fork} mode off, then @value{GDBN}
3447 will retain control of all forked processes (including nested forks).
3448 You can list the forked processes under the control of @value{GDBN} by
3449 using the @w{@code{info inferiors}} command, and switch from one fork
3450 to another by using the @code{inferior} command (@pxref{Inferiors and
3451 Programs, ,Debugging Multiple Inferiors and Programs}).
3453 To quit debugging one of the forked processes, you can either detach
3454 from it by using the @w{@code{detach inferiors}} command (allowing it
3455 to run independently), or kill it using the @w{@code{kill inferiors}}
3456 command. @xref{Inferiors and Programs, ,Debugging Multiple Inferiors
3459 If you ask to debug a child process and a @code{vfork} is followed by an
3460 @code{exec}, @value{GDBN} executes the new target up to the first
3461 breakpoint in the new target. If you have a breakpoint set on
3462 @code{main} in your original program, the breakpoint will also be set on
3463 the child process's @code{main}.
3465 On some systems, when a child process is spawned by @code{vfork}, you
3466 cannot debug the child or parent until an @code{exec} call completes.
3468 If you issue a @code{run} command to @value{GDBN} after an @code{exec}
3469 call executes, the new target restarts. To restart the parent
3470 process, use the @code{file} command with the parent executable name
3471 as its argument. By default, after an @code{exec} call executes,
3472 @value{GDBN} discards the symbols of the previous executable image.
3473 You can change this behaviour with the @w{@code{set follow-exec-mode}}
3477 @kindex set follow-exec-mode
3478 @item set follow-exec-mode @var{mode}
3480 Set debugger response to a program call of @code{exec}. An
3481 @code{exec} call replaces the program image of a process.
3483 @code{follow-exec-mode} can be:
3487 @value{GDBN} creates a new inferior and rebinds the process to this
3488 new inferior. The program the process was running before the
3489 @code{exec} call can be restarted afterwards by restarting the
3495 (@value{GDBP}) info inferiors
3497 Id Description Executable
3500 process 12020 is executing new program: prog2
3501 Program exited normally.
3502 (@value{GDBP}) info inferiors
3503 Id Description Executable
3509 @value{GDBN} keeps the process bound to the same inferior. The new
3510 executable image replaces the previous executable loaded in the
3511 inferior. Restarting the inferior after the @code{exec} call, with
3512 e.g., the @code{run} command, restarts the executable the process was
3513 running after the @code{exec} call. This is the default mode.
3518 (@value{GDBP}) info inferiors
3519 Id Description Executable
3522 process 12020 is executing new program: prog2
3523 Program exited normally.
3524 (@value{GDBP}) info inferiors
3525 Id Description Executable
3532 @code{follow-exec-mode} is supported in native mode and
3533 @code{target extended-remote} mode.
3535 You can use the @code{catch} command to make @value{GDBN} stop whenever
3536 a @code{fork}, @code{vfork}, or @code{exec} call is made. @xref{Set
3537 Catchpoints, ,Setting Catchpoints}.
3539 @node Checkpoint/Restart
3540 @section Setting a @emph{Bookmark} to Return to Later
3545 @cindex snapshot of a process
3546 @cindex rewind program state
3548 On certain operating systems@footnote{Currently, only
3549 @sc{gnu}/Linux.}, @value{GDBN} is able to save a @dfn{snapshot} of a
3550 program's state, called a @dfn{checkpoint}, and come back to it
3553 Returning to a checkpoint effectively undoes everything that has
3554 happened in the program since the @code{checkpoint} was saved. This
3555 includes changes in memory, registers, and even (within some limits)
3556 system state. Effectively, it is like going back in time to the
3557 moment when the checkpoint was saved.
3559 Thus, if you're stepping thru a program and you think you're
3560 getting close to the point where things go wrong, you can save
3561 a checkpoint. Then, if you accidentally go too far and miss
3562 the critical statement, instead of having to restart your program
3563 from the beginning, you can just go back to the checkpoint and
3564 start again from there.
3566 This can be especially useful if it takes a lot of time or
3567 steps to reach the point where you think the bug occurs.
3569 To use the @code{checkpoint}/@code{restart} method of debugging:
3574 Save a snapshot of the debugged program's current execution state.
3575 The @code{checkpoint} command takes no arguments, but each checkpoint
3576 is assigned a small integer id, similar to a breakpoint id.
3578 @kindex info checkpoints
3579 @item info checkpoints
3580 List the checkpoints that have been saved in the current debugging
3581 session. For each checkpoint, the following information will be
3588 @item Source line, or label
3591 @kindex restart @var{checkpoint-id}
3592 @item restart @var{checkpoint-id}
3593 Restore the program state that was saved as checkpoint number
3594 @var{checkpoint-id}. All program variables, registers, stack frames
3595 etc.@: will be returned to the values that they had when the checkpoint
3596 was saved. In essence, gdb will ``wind back the clock'' to the point
3597 in time when the checkpoint was saved.
3599 Note that breakpoints, @value{GDBN} variables, command history etc.
3600 are not affected by restoring a checkpoint. In general, a checkpoint
3601 only restores things that reside in the program being debugged, not in
3604 @kindex delete checkpoint @var{checkpoint-id}
3605 @item delete checkpoint @var{checkpoint-id}
3606 Delete the previously-saved checkpoint identified by @var{checkpoint-id}.
3610 Returning to a previously saved checkpoint will restore the user state
3611 of the program being debugged, plus a significant subset of the system
3612 (OS) state, including file pointers. It won't ``un-write'' data from
3613 a file, but it will rewind the file pointer to the previous location,
3614 so that the previously written data can be overwritten. For files
3615 opened in read mode, the pointer will also be restored so that the
3616 previously read data can be read again.
3618 Of course, characters that have been sent to a printer (or other
3619 external device) cannot be ``snatched back'', and characters received
3620 from eg.@: a serial device can be removed from internal program buffers,
3621 but they cannot be ``pushed back'' into the serial pipeline, ready to
3622 be received again. Similarly, the actual contents of files that have
3623 been changed cannot be restored (at this time).
3625 However, within those constraints, you actually can ``rewind'' your
3626 program to a previously saved point in time, and begin debugging it
3627 again --- and you can change the course of events so as to debug a
3628 different execution path this time.
3630 @cindex checkpoints and process id
3631 Finally, there is one bit of internal program state that will be
3632 different when you return to a checkpoint --- the program's process
3633 id. Each checkpoint will have a unique process id (or @var{pid}),
3634 and each will be different from the program's original @var{pid}.
3635 If your program has saved a local copy of its process id, this could
3636 potentially pose a problem.
3638 @subsection A Non-obvious Benefit of Using Checkpoints
3640 On some systems such as @sc{gnu}/Linux, address space randomization
3641 is performed on new processes for security reasons. This makes it
3642 difficult or impossible to set a breakpoint, or watchpoint, on an
3643 absolute address if you have to restart the program, since the
3644 absolute location of a symbol will change from one execution to the
3647 A checkpoint, however, is an @emph{identical} copy of a process.
3648 Therefore if you create a checkpoint at (eg.@:) the start of main,
3649 and simply return to that checkpoint instead of restarting the
3650 process, you can avoid the effects of address randomization and
3651 your symbols will all stay in the same place.
3654 @chapter Stopping and Continuing
3656 The principal purposes of using a debugger are so that you can stop your
3657 program before it terminates; or so that, if your program runs into
3658 trouble, you can investigate and find out why.
3660 Inside @value{GDBN}, your program may stop for any of several reasons,
3661 such as a signal, a breakpoint, or reaching a new line after a
3662 @value{GDBN} command such as @code{step}. You may then examine and
3663 change variables, set new breakpoints or remove old ones, and then
3664 continue execution. Usually, the messages shown by @value{GDBN} provide
3665 ample explanation of the status of your program---but you can also
3666 explicitly request this information at any time.
3669 @kindex info program
3671 Display information about the status of your program: whether it is
3672 running or not, what process it is, and why it stopped.
3676 * Breakpoints:: Breakpoints, watchpoints, and catchpoints
3677 * Continuing and Stepping:: Resuming execution
3678 * Skipping Over Functions and Files::
3679 Skipping over functions and files
3681 * Thread Stops:: Stopping and starting multi-thread programs
3685 @section Breakpoints, Watchpoints, and Catchpoints
3688 A @dfn{breakpoint} makes your program stop whenever a certain point in
3689 the program is reached. For each breakpoint, you can add conditions to
3690 control in finer detail whether your program stops. You can set
3691 breakpoints with the @code{break} command and its variants (@pxref{Set
3692 Breaks, ,Setting Breakpoints}), to specify the place where your program
3693 should stop by line number, function name or exact address in the
3696 On some systems, you can set breakpoints in shared libraries before
3697 the executable is run.
3700 @cindex data breakpoints
3701 @cindex memory tracing
3702 @cindex breakpoint on memory address
3703 @cindex breakpoint on variable modification
3704 A @dfn{watchpoint} is a special breakpoint that stops your program
3705 when the value of an expression changes. The expression may be a value
3706 of a variable, or it could involve values of one or more variables
3707 combined by operators, such as @samp{a + b}. This is sometimes called
3708 @dfn{data breakpoints}. You must use a different command to set
3709 watchpoints (@pxref{Set Watchpoints, ,Setting Watchpoints}), but aside
3710 from that, you can manage a watchpoint like any other breakpoint: you
3711 enable, disable, and delete both breakpoints and watchpoints using the
3714 You can arrange to have values from your program displayed automatically
3715 whenever @value{GDBN} stops at a breakpoint. @xref{Auto Display,,
3719 @cindex breakpoint on events
3720 A @dfn{catchpoint} is another special breakpoint that stops your program
3721 when a certain kind of event occurs, such as the throwing of a C@t{++}
3722 exception or the loading of a library. As with watchpoints, you use a
3723 different command to set a catchpoint (@pxref{Set Catchpoints, ,Setting
3724 Catchpoints}), but aside from that, you can manage a catchpoint like any
3725 other breakpoint. (To stop when your program receives a signal, use the
3726 @code{handle} command; see @ref{Signals, ,Signals}.)
3728 @cindex breakpoint numbers
3729 @cindex numbers for breakpoints
3730 @value{GDBN} assigns a number to each breakpoint, watchpoint, or
3731 catchpoint when you create it; these numbers are successive integers
3732 starting with one. In many of the commands for controlling various
3733 features of breakpoints you use the breakpoint number to say which
3734 breakpoint you want to change. Each breakpoint may be @dfn{enabled} or
3735 @dfn{disabled}; if disabled, it has no effect on your program until you
3738 @cindex breakpoint ranges
3739 @cindex breakpoint lists
3740 @cindex ranges of breakpoints
3741 @cindex lists of breakpoints
3742 Some @value{GDBN} commands accept a space-separated list of breakpoints
3743 on which to operate. A list element can be either a single breakpoint number,
3744 like @samp{5}, or a range of such numbers, like @samp{5-7}.
3745 When a breakpoint list is given to a command, all breakpoints in that list
3749 * Set Breaks:: Setting breakpoints
3750 * Set Watchpoints:: Setting watchpoints
3751 * Set Catchpoints:: Setting catchpoints
3752 * Delete Breaks:: Deleting breakpoints
3753 * Disabling:: Disabling breakpoints
3754 * Conditions:: Break conditions
3755 * Break Commands:: Breakpoint command lists
3756 * Dynamic Printf:: Dynamic printf
3757 * Save Breakpoints:: How to save breakpoints in a file
3758 * Static Probe Points:: Listing static probe points
3759 * Error in Breakpoints:: ``Cannot insert breakpoints''
3760 * Breakpoint-related Warnings:: ``Breakpoint address adjusted...''
3764 @subsection Setting Breakpoints
3766 @c FIXME LMB what does GDB do if no code on line of breakpt?
3767 @c consider in particular declaration with/without initialization.
3769 @c FIXME 2 is there stuff on this already? break at fun start, already init?
3772 @kindex b @r{(@code{break})}
3773 @vindex $bpnum@r{, convenience variable}
3774 @cindex latest breakpoint
3775 Breakpoints are set with the @code{break} command (abbreviated
3776 @code{b}). The debugger convenience variable @samp{$bpnum} records the
3777 number of the breakpoint you've set most recently; see @ref{Convenience
3778 Vars,, Convenience Variables}, for a discussion of what you can do with
3779 convenience variables.
3782 @item break @var{location}
3783 Set a breakpoint at the given @var{location}, which can specify a
3784 function name, a line number, or an address of an instruction.
3785 (@xref{Specify Location}, for a list of all the possible ways to
3786 specify a @var{location}.) The breakpoint will stop your program just
3787 before it executes any of the code in the specified @var{location}.
3789 When using source languages that permit overloading of symbols, such as
3790 C@t{++}, a function name may refer to more than one possible place to break.
3791 @xref{Ambiguous Expressions,,Ambiguous Expressions}, for a discussion of
3794 It is also possible to insert a breakpoint that will stop the program
3795 only if a specific thread (@pxref{Thread-Specific Breakpoints})
3796 or a specific task (@pxref{Ada Tasks}) hits that breakpoint.
3799 When called without any arguments, @code{break} sets a breakpoint at
3800 the next instruction to be executed in the selected stack frame
3801 (@pxref{Stack, ,Examining the Stack}). In any selected frame but the
3802 innermost, this makes your program stop as soon as control
3803 returns to that frame. This is similar to the effect of a
3804 @code{finish} command in the frame inside the selected frame---except
3805 that @code{finish} does not leave an active breakpoint. If you use
3806 @code{break} without an argument in the innermost frame, @value{GDBN} stops
3807 the next time it reaches the current location; this may be useful
3810 @value{GDBN} normally ignores breakpoints when it resumes execution, until at
3811 least one instruction has been executed. If it did not do this, you
3812 would be unable to proceed past a breakpoint without first disabling the
3813 breakpoint. This rule applies whether or not the breakpoint already
3814 existed when your program stopped.
3816 @item break @dots{} if @var{cond}
3817 Set a breakpoint with condition @var{cond}; evaluate the expression
3818 @var{cond} each time the breakpoint is reached, and stop only if the
3819 value is nonzero---that is, if @var{cond} evaluates as true.
3820 @samp{@dots{}} stands for one of the possible arguments described
3821 above (or no argument) specifying where to break. @xref{Conditions,
3822 ,Break Conditions}, for more information on breakpoint conditions.
3825 @item tbreak @var{args}
3826 Set a breakpoint enabled only for one stop. The @var{args} are the
3827 same as for the @code{break} command, and the breakpoint is set in the same
3828 way, but the breakpoint is automatically deleted after the first time your
3829 program stops there. @xref{Disabling, ,Disabling Breakpoints}.
3832 @cindex hardware breakpoints
3833 @item hbreak @var{args}
3834 Set a hardware-assisted breakpoint. The @var{args} are the same as for the
3835 @code{break} command and the breakpoint is set in the same way, but the
3836 breakpoint requires hardware support and some target hardware may not
3837 have this support. The main purpose of this is EPROM/ROM code
3838 debugging, so you can set a breakpoint at an instruction without
3839 changing the instruction. This can be used with the new trap-generation
3840 provided by SPARClite DSU and most x86-based targets. These targets
3841 will generate traps when a program accesses some data or instruction
3842 address that is assigned to the debug registers. However the hardware
3843 breakpoint registers can take a limited number of breakpoints. For
3844 example, on the DSU, only two data breakpoints can be set at a time, and
3845 @value{GDBN} will reject this command if more than two are used. Delete
3846 or disable unused hardware breakpoints before setting new ones
3847 (@pxref{Disabling, ,Disabling Breakpoints}).
3848 @xref{Conditions, ,Break Conditions}.
3849 For remote targets, you can restrict the number of hardware
3850 breakpoints @value{GDBN} will use, see @ref{set remote
3851 hardware-breakpoint-limit}.
3854 @item thbreak @var{args}
3855 Set a hardware-assisted breakpoint enabled only for one stop. The @var{args}
3856 are the same as for the @code{hbreak} command and the breakpoint is set in
3857 the same way. However, like the @code{tbreak} command,
3858 the breakpoint is automatically deleted after the
3859 first time your program stops there. Also, like the @code{hbreak}
3860 command, the breakpoint requires hardware support and some target hardware
3861 may not have this support. @xref{Disabling, ,Disabling Breakpoints}.
3862 See also @ref{Conditions, ,Break Conditions}.
3865 @cindex regular expression
3866 @cindex breakpoints at functions matching a regexp
3867 @cindex set breakpoints in many functions
3868 @item rbreak @var{regex}
3869 Set breakpoints on all functions matching the regular expression
3870 @var{regex}. This command sets an unconditional breakpoint on all
3871 matches, printing a list of all breakpoints it set. Once these
3872 breakpoints are set, they are treated just like the breakpoints set with
3873 the @code{break} command. You can delete them, disable them, or make
3874 them conditional the same way as any other breakpoint.
3876 In programs using different languages, @value{GDBN} chooses the syntax
3877 to print the list of all breakpoints it sets according to the
3878 @samp{set language} value: using @samp{set language auto}
3879 (see @ref{Automatically, ,Set Language Automatically}) means to use the
3880 language of the breakpoint's function, other values mean to use
3881 the manually specified language (see @ref{Manually, ,Set Language Manually}).
3883 The syntax of the regular expression is the standard one used with tools
3884 like @file{grep}. Note that this is different from the syntax used by
3885 shells, so for instance @code{foo*} matches all functions that include
3886 an @code{fo} followed by zero or more @code{o}s. There is an implicit
3887 @code{.*} leading and trailing the regular expression you supply, so to
3888 match only functions that begin with @code{foo}, use @code{^foo}.
3890 @cindex non-member C@t{++} functions, set breakpoint in
3891 When debugging C@t{++} programs, @code{rbreak} is useful for setting
3892 breakpoints on overloaded functions that are not members of any special
3895 @cindex set breakpoints on all functions
3896 The @code{rbreak} command can be used to set breakpoints in
3897 @strong{all} the functions in a program, like this:
3900 (@value{GDBP}) rbreak .
3903 @item rbreak @var{file}:@var{regex}
3904 If @code{rbreak} is called with a filename qualification, it limits
3905 the search for functions matching the given regular expression to the
3906 specified @var{file}. This can be used, for example, to set breakpoints on
3907 every function in a given file:
3910 (@value{GDBP}) rbreak file.c:.
3913 The colon separating the filename qualifier from the regex may
3914 optionally be surrounded by spaces.
3916 @kindex info breakpoints
3917 @cindex @code{$_} and @code{info breakpoints}
3918 @item info breakpoints @r{[}@var{list}@dots{}@r{]}
3919 @itemx info break @r{[}@var{list}@dots{}@r{]}
3920 Print a table of all breakpoints, watchpoints, and catchpoints set and
3921 not deleted. Optional argument @var{n} means print information only
3922 about the specified breakpoint(s) (or watchpoint(s) or catchpoint(s)).
3923 For each breakpoint, following columns are printed:
3926 @item Breakpoint Numbers
3928 Breakpoint, watchpoint, or catchpoint.
3930 Whether the breakpoint is marked to be disabled or deleted when hit.
3931 @item Enabled or Disabled
3932 Enabled breakpoints are marked with @samp{y}. @samp{n} marks breakpoints
3933 that are not enabled.
3935 Where the breakpoint is in your program, as a memory address. For a
3936 pending breakpoint whose address is not yet known, this field will
3937 contain @samp{<PENDING>}. Such breakpoint won't fire until a shared
3938 library that has the symbol or line referred by breakpoint is loaded.
3939 See below for details. A breakpoint with several locations will
3940 have @samp{<MULTIPLE>} in this field---see below for details.
3942 Where the breakpoint is in the source for your program, as a file and
3943 line number. For a pending breakpoint, the original string passed to
3944 the breakpoint command will be listed as it cannot be resolved until
3945 the appropriate shared library is loaded in the future.
3949 If a breakpoint is conditional, there are two evaluation modes: ``host'' and
3950 ``target''. If mode is ``host'', breakpoint condition evaluation is done by
3951 @value{GDBN} on the host's side. If it is ``target'', then the condition
3952 is evaluated by the target. The @code{info break} command shows
3953 the condition on the line following the affected breakpoint, together with
3954 its condition evaluation mode in between parentheses.
3956 Breakpoint commands, if any, are listed after that. A pending breakpoint is
3957 allowed to have a condition specified for it. The condition is not parsed for
3958 validity until a shared library is loaded that allows the pending
3959 breakpoint to resolve to a valid location.
3962 @code{info break} with a breakpoint
3963 number @var{n} as argument lists only that breakpoint. The
3964 convenience variable @code{$_} and the default examining-address for
3965 the @code{x} command are set to the address of the last breakpoint
3966 listed (@pxref{Memory, ,Examining Memory}).
3969 @code{info break} displays a count of the number of times the breakpoint
3970 has been hit. This is especially useful in conjunction with the
3971 @code{ignore} command. You can ignore a large number of breakpoint
3972 hits, look at the breakpoint info to see how many times the breakpoint
3973 was hit, and then run again, ignoring one less than that number. This
3974 will get you quickly to the last hit of that breakpoint.
3977 For a breakpoints with an enable count (xref) greater than 1,
3978 @code{info break} also displays that count.
3982 @value{GDBN} allows you to set any number of breakpoints at the same place in
3983 your program. There is nothing silly or meaningless about this. When
3984 the breakpoints are conditional, this is even useful
3985 (@pxref{Conditions, ,Break Conditions}).
3987 @cindex multiple locations, breakpoints
3988 @cindex breakpoints, multiple locations
3989 It is possible that a breakpoint corresponds to several locations
3990 in your program. Examples of this situation are:
3994 Multiple functions in the program may have the same name.
3997 For a C@t{++} constructor, the @value{NGCC} compiler generates several
3998 instances of the function body, used in different cases.
4001 For a C@t{++} template function, a given line in the function can
4002 correspond to any number of instantiations.
4005 For an inlined function, a given source line can correspond to
4006 several places where that function is inlined.
4009 In all those cases, @value{GDBN} will insert a breakpoint at all
4010 the relevant locations.
4012 A breakpoint with multiple locations is displayed in the breakpoint
4013 table using several rows---one header row, followed by one row for
4014 each breakpoint location. The header row has @samp{<MULTIPLE>} in the
4015 address column. The rows for individual locations contain the actual
4016 addresses for locations, and show the functions to which those
4017 locations belong. The number column for a location is of the form
4018 @var{breakpoint-number}.@var{location-number}.
4023 Num Type Disp Enb Address What
4024 1 breakpoint keep y <MULTIPLE>
4026 breakpoint already hit 1 time
4027 1.1 y 0x080486a2 in void foo<int>() at t.cc:8
4028 1.2 y 0x080486ca in void foo<double>() at t.cc:8
4031 You cannot delete the individual locations from a breakpoint. However,
4032 each location can be individually enabled or disabled by passing
4033 @var{breakpoint-number}.@var{location-number} as argument to the
4034 @code{enable} and @code{disable} commands. It's also possible to
4035 @code{enable} and @code{disable} a range of @var{location-number}
4036 locations using a @var{breakpoint-number} and two @var{location-number}s,
4037 in increasing order, separated by a hyphen, like
4038 @kbd{@var{breakpoint-number}.@var{location-number1}-@var{location-number2}},
4039 in which case @value{GDBN} acts on all the locations in the range (inclusive).
4040 Disabling or enabling the parent breakpoint (@pxref{Disabling}) affects
4041 all of the locations that belong to that breakpoint.
4043 @cindex pending breakpoints
4044 It's quite common to have a breakpoint inside a shared library.
4045 Shared libraries can be loaded and unloaded explicitly,
4046 and possibly repeatedly, as the program is executed. To support
4047 this use case, @value{GDBN} updates breakpoint locations whenever
4048 any shared library is loaded or unloaded. Typically, you would
4049 set a breakpoint in a shared library at the beginning of your
4050 debugging session, when the library is not loaded, and when the
4051 symbols from the library are not available. When you try to set
4052 breakpoint, @value{GDBN} will ask you if you want to set
4053 a so called @dfn{pending breakpoint}---breakpoint whose address
4054 is not yet resolved.
4056 After the program is run, whenever a new shared library is loaded,
4057 @value{GDBN} reevaluates all the breakpoints. When a newly loaded
4058 shared library contains the symbol or line referred to by some
4059 pending breakpoint, that breakpoint is resolved and becomes an
4060 ordinary breakpoint. When a library is unloaded, all breakpoints
4061 that refer to its symbols or source lines become pending again.
4063 This logic works for breakpoints with multiple locations, too. For
4064 example, if you have a breakpoint in a C@t{++} template function, and
4065 a newly loaded shared library has an instantiation of that template,
4066 a new location is added to the list of locations for the breakpoint.
4068 Except for having unresolved address, pending breakpoints do not
4069 differ from regular breakpoints. You can set conditions or commands,
4070 enable and disable them and perform other breakpoint operations.
4072 @value{GDBN} provides some additional commands for controlling what
4073 happens when the @samp{break} command cannot resolve breakpoint
4074 address specification to an address:
4076 @kindex set breakpoint pending
4077 @kindex show breakpoint pending
4079 @item set breakpoint pending auto
4080 This is the default behavior. When @value{GDBN} cannot find the breakpoint
4081 location, it queries you whether a pending breakpoint should be created.
4083 @item set breakpoint pending on
4084 This indicates that an unrecognized breakpoint location should automatically
4085 result in a pending breakpoint being created.
4087 @item set breakpoint pending off
4088 This indicates that pending breakpoints are not to be created. Any
4089 unrecognized breakpoint location results in an error. This setting does
4090 not affect any pending breakpoints previously created.
4092 @item show breakpoint pending
4093 Show the current behavior setting for creating pending breakpoints.
4096 The settings above only affect the @code{break} command and its
4097 variants. Once breakpoint is set, it will be automatically updated
4098 as shared libraries are loaded and unloaded.
4100 @cindex automatic hardware breakpoints
4101 For some targets, @value{GDBN} can automatically decide if hardware or
4102 software breakpoints should be used, depending on whether the
4103 breakpoint address is read-only or read-write. This applies to
4104 breakpoints set with the @code{break} command as well as to internal
4105 breakpoints set by commands like @code{next} and @code{finish}. For
4106 breakpoints set with @code{hbreak}, @value{GDBN} will always use hardware
4109 You can control this automatic behaviour with the following commands:
4111 @kindex set breakpoint auto-hw
4112 @kindex show breakpoint auto-hw
4114 @item set breakpoint auto-hw on
4115 This is the default behavior. When @value{GDBN} sets a breakpoint, it
4116 will try to use the target memory map to decide if software or hardware
4117 breakpoint must be used.
4119 @item set breakpoint auto-hw off
4120 This indicates @value{GDBN} should not automatically select breakpoint
4121 type. If the target provides a memory map, @value{GDBN} will warn when
4122 trying to set software breakpoint at a read-only address.
4125 @value{GDBN} normally implements breakpoints by replacing the program code
4126 at the breakpoint address with a special instruction, which, when
4127 executed, given control to the debugger. By default, the program
4128 code is so modified only when the program is resumed. As soon as
4129 the program stops, @value{GDBN} restores the original instructions. This
4130 behaviour guards against leaving breakpoints inserted in the
4131 target should gdb abrubptly disconnect. However, with slow remote
4132 targets, inserting and removing breakpoint can reduce the performance.
4133 This behavior can be controlled with the following commands::
4135 @kindex set breakpoint always-inserted
4136 @kindex show breakpoint always-inserted
4138 @item set breakpoint always-inserted off
4139 All breakpoints, including newly added by the user, are inserted in
4140 the target only when the target is resumed. All breakpoints are
4141 removed from the target when it stops. This is the default mode.
4143 @item set breakpoint always-inserted on
4144 Causes all breakpoints to be inserted in the target at all times. If
4145 the user adds a new breakpoint, or changes an existing breakpoint, the
4146 breakpoints in the target are updated immediately. A breakpoint is
4147 removed from the target only when breakpoint itself is deleted.
4150 @value{GDBN} handles conditional breakpoints by evaluating these conditions
4151 when a breakpoint breaks. If the condition is true, then the process being
4152 debugged stops, otherwise the process is resumed.
4154 If the target supports evaluating conditions on its end, @value{GDBN} may
4155 download the breakpoint, together with its conditions, to it.
4157 This feature can be controlled via the following commands:
4159 @kindex set breakpoint condition-evaluation
4160 @kindex show breakpoint condition-evaluation
4162 @item set breakpoint condition-evaluation host
4163 This option commands @value{GDBN} to evaluate the breakpoint
4164 conditions on the host's side. Unconditional breakpoints are sent to
4165 the target which in turn receives the triggers and reports them back to GDB
4166 for condition evaluation. This is the standard evaluation mode.
4168 @item set breakpoint condition-evaluation target
4169 This option commands @value{GDBN} to download breakpoint conditions
4170 to the target at the moment of their insertion. The target
4171 is responsible for evaluating the conditional expression and reporting
4172 breakpoint stop events back to @value{GDBN} whenever the condition
4173 is true. Due to limitations of target-side evaluation, some conditions
4174 cannot be evaluated there, e.g., conditions that depend on local data
4175 that is only known to the host. Examples include
4176 conditional expressions involving convenience variables, complex types
4177 that cannot be handled by the agent expression parser and expressions
4178 that are too long to be sent over to the target, specially when the
4179 target is a remote system. In these cases, the conditions will be
4180 evaluated by @value{GDBN}.
4182 @item set breakpoint condition-evaluation auto
4183 This is the default mode. If the target supports evaluating breakpoint
4184 conditions on its end, @value{GDBN} will download breakpoint conditions to
4185 the target (limitations mentioned previously apply). If the target does
4186 not support breakpoint condition evaluation, then @value{GDBN} will fallback
4187 to evaluating all these conditions on the host's side.
4191 @cindex negative breakpoint numbers
4192 @cindex internal @value{GDBN} breakpoints
4193 @value{GDBN} itself sometimes sets breakpoints in your program for
4194 special purposes, such as proper handling of @code{longjmp} (in C
4195 programs). These internal breakpoints are assigned negative numbers,
4196 starting with @code{-1}; @samp{info breakpoints} does not display them.
4197 You can see these breakpoints with the @value{GDBN} maintenance command
4198 @samp{maint info breakpoints} (@pxref{maint info breakpoints}).
4201 @node Set Watchpoints
4202 @subsection Setting Watchpoints
4204 @cindex setting watchpoints
4205 You can use a watchpoint to stop execution whenever the value of an
4206 expression changes, without having to predict a particular place where
4207 this may happen. (This is sometimes called a @dfn{data breakpoint}.)
4208 The expression may be as simple as the value of a single variable, or
4209 as complex as many variables combined by operators. Examples include:
4213 A reference to the value of a single variable.
4216 An address cast to an appropriate data type. For example,
4217 @samp{*(int *)0x12345678} will watch a 4-byte region at the specified
4218 address (assuming an @code{int} occupies 4 bytes).
4221 An arbitrarily complex expression, such as @samp{a*b + c/d}. The
4222 expression can use any operators valid in the program's native
4223 language (@pxref{Languages}).
4226 You can set a watchpoint on an expression even if the expression can
4227 not be evaluated yet. For instance, you can set a watchpoint on
4228 @samp{*global_ptr} before @samp{global_ptr} is initialized.
4229 @value{GDBN} will stop when your program sets @samp{global_ptr} and
4230 the expression produces a valid value. If the expression becomes
4231 valid in some other way than changing a variable (e.g.@: if the memory
4232 pointed to by @samp{*global_ptr} becomes readable as the result of a
4233 @code{malloc} call), @value{GDBN} may not stop until the next time
4234 the expression changes.
4236 @cindex software watchpoints
4237 @cindex hardware watchpoints
4238 Depending on your system, watchpoints may be implemented in software or
4239 hardware. @value{GDBN} does software watchpointing by single-stepping your
4240 program and testing the variable's value each time, which is hundreds of
4241 times slower than normal execution. (But this may still be worth it, to
4242 catch errors where you have no clue what part of your program is the
4245 On some systems, such as most PowerPC or x86-based targets,
4246 @value{GDBN} includes support for hardware watchpoints, which do not
4247 slow down the running of your program.
4251 @item watch @r{[}-l@r{|}-location@r{]} @var{expr} @r{[}thread @var{thread-id}@r{]} @r{[}mask @var{maskvalue}@r{]}
4252 Set a watchpoint for an expression. @value{GDBN} will break when the
4253 expression @var{expr} is written into by the program and its value
4254 changes. The simplest (and the most popular) use of this command is
4255 to watch the value of a single variable:
4258 (@value{GDBP}) watch foo
4261 If the command includes a @code{@r{[}thread @var{thread-id}@r{]}}
4262 argument, @value{GDBN} breaks only when the thread identified by
4263 @var{thread-id} changes the value of @var{expr}. If any other threads
4264 change the value of @var{expr}, @value{GDBN} will not break. Note
4265 that watchpoints restricted to a single thread in this way only work
4266 with Hardware Watchpoints.
4268 Ordinarily a watchpoint respects the scope of variables in @var{expr}
4269 (see below). The @code{-location} argument tells @value{GDBN} to
4270 instead watch the memory referred to by @var{expr}. In this case,
4271 @value{GDBN} will evaluate @var{expr}, take the address of the result,
4272 and watch the memory at that address. The type of the result is used
4273 to determine the size of the watched memory. If the expression's
4274 result does not have an address, then @value{GDBN} will print an
4277 The @code{@r{[}mask @var{maskvalue}@r{]}} argument allows creation
4278 of masked watchpoints, if the current architecture supports this
4279 feature (e.g., PowerPC Embedded architecture, see @ref{PowerPC
4280 Embedded}.) A @dfn{masked watchpoint} specifies a mask in addition
4281 to an address to watch. The mask specifies that some bits of an address
4282 (the bits which are reset in the mask) should be ignored when matching
4283 the address accessed by the inferior against the watchpoint address.
4284 Thus, a masked watchpoint watches many addresses simultaneously---those
4285 addresses whose unmasked bits are identical to the unmasked bits in the
4286 watchpoint address. The @code{mask} argument implies @code{-location}.
4290 (@value{GDBP}) watch foo mask 0xffff00ff
4291 (@value{GDBP}) watch *0xdeadbeef mask 0xffffff00
4295 @item rwatch @r{[}-l@r{|}-location@r{]} @var{expr} @r{[}thread @var{thread-id}@r{]} @r{[}mask @var{maskvalue}@r{]}
4296 Set a watchpoint that will break when the value of @var{expr} is read
4300 @item awatch @r{[}-l@r{|}-location@r{]} @var{expr} @r{[}thread @var{thread-id}@r{]} @r{[}mask @var{maskvalue}@r{]}
4301 Set a watchpoint that will break when @var{expr} is either read from
4302 or written into by the program.
4304 @kindex info watchpoints @r{[}@var{list}@dots{}@r{]}
4305 @item info watchpoints @r{[}@var{list}@dots{}@r{]}
4306 This command prints a list of watchpoints, using the same format as
4307 @code{info break} (@pxref{Set Breaks}).
4310 If you watch for a change in a numerically entered address you need to
4311 dereference it, as the address itself is just a constant number which will
4312 never change. @value{GDBN} refuses to create a watchpoint that watches
4313 a never-changing value:
4316 (@value{GDBP}) watch 0x600850
4317 Cannot watch constant value 0x600850.
4318 (@value{GDBP}) watch *(int *) 0x600850
4319 Watchpoint 1: *(int *) 6293584
4322 @value{GDBN} sets a @dfn{hardware watchpoint} if possible. Hardware
4323 watchpoints execute very quickly, and the debugger reports a change in
4324 value at the exact instruction where the change occurs. If @value{GDBN}
4325 cannot set a hardware watchpoint, it sets a software watchpoint, which
4326 executes more slowly and reports the change in value at the next
4327 @emph{statement}, not the instruction, after the change occurs.
4329 @cindex use only software watchpoints
4330 You can force @value{GDBN} to use only software watchpoints with the
4331 @kbd{set can-use-hw-watchpoints 0} command. With this variable set to
4332 zero, @value{GDBN} will never try to use hardware watchpoints, even if
4333 the underlying system supports them. (Note that hardware-assisted
4334 watchpoints that were set @emph{before} setting
4335 @code{can-use-hw-watchpoints} to zero will still use the hardware
4336 mechanism of watching expression values.)
4339 @item set can-use-hw-watchpoints
4340 @kindex set can-use-hw-watchpoints
4341 Set whether or not to use hardware watchpoints.
4343 @item show can-use-hw-watchpoints
4344 @kindex show can-use-hw-watchpoints
4345 Show the current mode of using hardware watchpoints.
4348 For remote targets, you can restrict the number of hardware
4349 watchpoints @value{GDBN} will use, see @ref{set remote
4350 hardware-breakpoint-limit}.
4352 When you issue the @code{watch} command, @value{GDBN} reports
4355 Hardware watchpoint @var{num}: @var{expr}
4359 if it was able to set a hardware watchpoint.
4361 Currently, the @code{awatch} and @code{rwatch} commands can only set
4362 hardware watchpoints, because accesses to data that don't change the
4363 value of the watched expression cannot be detected without examining
4364 every instruction as it is being executed, and @value{GDBN} does not do
4365 that currently. If @value{GDBN} finds that it is unable to set a
4366 hardware breakpoint with the @code{awatch} or @code{rwatch} command, it
4367 will print a message like this:
4370 Expression cannot be implemented with read/access watchpoint.
4373 Sometimes, @value{GDBN} cannot set a hardware watchpoint because the
4374 data type of the watched expression is wider than what a hardware
4375 watchpoint on the target machine can handle. For example, some systems
4376 can only watch regions that are up to 4 bytes wide; on such systems you
4377 cannot set hardware watchpoints for an expression that yields a
4378 double-precision floating-point number (which is typically 8 bytes
4379 wide). As a work-around, it might be possible to break the large region
4380 into a series of smaller ones and watch them with separate watchpoints.
4382 If you set too many hardware watchpoints, @value{GDBN} might be unable
4383 to insert all of them when you resume the execution of your program.
4384 Since the precise number of active watchpoints is unknown until such
4385 time as the program is about to be resumed, @value{GDBN} might not be
4386 able to warn you about this when you set the watchpoints, and the
4387 warning will be printed only when the program is resumed:
4390 Hardware watchpoint @var{num}: Could not insert watchpoint
4394 If this happens, delete or disable some of the watchpoints.
4396 Watching complex expressions that reference many variables can also
4397 exhaust the resources available for hardware-assisted watchpoints.
4398 That's because @value{GDBN} needs to watch every variable in the
4399 expression with separately allocated resources.
4401 If you call a function interactively using @code{print} or @code{call},
4402 any watchpoints you have set will be inactive until @value{GDBN} reaches another
4403 kind of breakpoint or the call completes.
4405 @value{GDBN} automatically deletes watchpoints that watch local
4406 (automatic) variables, or expressions that involve such variables, when
4407 they go out of scope, that is, when the execution leaves the block in
4408 which these variables were defined. In particular, when the program
4409 being debugged terminates, @emph{all} local variables go out of scope,
4410 and so only watchpoints that watch global variables remain set. If you
4411 rerun the program, you will need to set all such watchpoints again. One
4412 way of doing that would be to set a code breakpoint at the entry to the
4413 @code{main} function and when it breaks, set all the watchpoints.
4415 @cindex watchpoints and threads
4416 @cindex threads and watchpoints
4417 In multi-threaded programs, watchpoints will detect changes to the
4418 watched expression from every thread.
4421 @emph{Warning:} In multi-threaded programs, software watchpoints
4422 have only limited usefulness. If @value{GDBN} creates a software
4423 watchpoint, it can only watch the value of an expression @emph{in a
4424 single thread}. If you are confident that the expression can only
4425 change due to the current thread's activity (and if you are also
4426 confident that no other thread can become current), then you can use
4427 software watchpoints as usual. However, @value{GDBN} may not notice
4428 when a non-current thread's activity changes the expression. (Hardware
4429 watchpoints, in contrast, watch an expression in all threads.)
4432 @xref{set remote hardware-watchpoint-limit}.
4434 @node Set Catchpoints
4435 @subsection Setting Catchpoints
4436 @cindex catchpoints, setting
4437 @cindex exception handlers
4438 @cindex event handling
4440 You can use @dfn{catchpoints} to cause the debugger to stop for certain
4441 kinds of program events, such as C@t{++} exceptions or the loading of a
4442 shared library. Use the @code{catch} command to set a catchpoint.
4446 @item catch @var{event}
4447 Stop when @var{event} occurs. The @var{event} can be any of the following:
4450 @item throw @r{[}@var{regexp}@r{]}
4451 @itemx rethrow @r{[}@var{regexp}@r{]}
4452 @itemx catch @r{[}@var{regexp}@r{]}
4454 @kindex catch rethrow
4456 @cindex stop on C@t{++} exceptions
4457 The throwing, re-throwing, or catching of a C@t{++} exception.
4459 If @var{regexp} is given, then only exceptions whose type matches the
4460 regular expression will be caught.
4462 @vindex $_exception@r{, convenience variable}
4463 The convenience variable @code{$_exception} is available at an
4464 exception-related catchpoint, on some systems. This holds the
4465 exception being thrown.
4467 There are currently some limitations to C@t{++} exception handling in
4472 The support for these commands is system-dependent. Currently, only
4473 systems using the @samp{gnu-v3} C@t{++} ABI (@pxref{ABI}) are
4477 The regular expression feature and the @code{$_exception} convenience
4478 variable rely on the presence of some SDT probes in @code{libstdc++}.
4479 If these probes are not present, then these features cannot be used.
4480 These probes were first available in the GCC 4.8 release, but whether
4481 or not they are available in your GCC also depends on how it was
4485 The @code{$_exception} convenience variable is only valid at the
4486 instruction at which an exception-related catchpoint is set.
4489 When an exception-related catchpoint is hit, @value{GDBN} stops at a
4490 location in the system library which implements runtime exception
4491 support for C@t{++}, usually @code{libstdc++}. You can use @code{up}
4492 (@pxref{Selection}) to get to your code.
4495 If you call a function interactively, @value{GDBN} normally returns
4496 control to you when the function has finished executing. If the call
4497 raises an exception, however, the call may bypass the mechanism that
4498 returns control to you and cause your program either to abort or to
4499 simply continue running until it hits a breakpoint, catches a signal
4500 that @value{GDBN} is listening for, or exits. This is the case even if
4501 you set a catchpoint for the exception; catchpoints on exceptions are
4502 disabled within interactive calls. @xref{Calling}, for information on
4503 controlling this with @code{set unwind-on-terminating-exception}.
4506 You cannot raise an exception interactively.
4509 You cannot install an exception handler interactively.
4513 @kindex catch exception
4514 @cindex Ada exception catching
4515 @cindex catch Ada exceptions
4516 An Ada exception being raised. If an exception name is specified
4517 at the end of the command (eg @code{catch exception Program_Error}),
4518 the debugger will stop only when this specific exception is raised.
4519 Otherwise, the debugger stops execution when any Ada exception is raised.
4521 When inserting an exception catchpoint on a user-defined exception whose
4522 name is identical to one of the exceptions defined by the language, the
4523 fully qualified name must be used as the exception name. Otherwise,
4524 @value{GDBN} will assume that it should stop on the pre-defined exception
4525 rather than the user-defined one. For instance, assuming an exception
4526 called @code{Constraint_Error} is defined in package @code{Pck}, then
4527 the command to use to catch such exceptions is @kbd{catch exception
4528 Pck.Constraint_Error}.
4531 @kindex catch handlers
4532 @cindex Ada exception handlers catching
4533 @cindex catch Ada exceptions when handled
4534 An Ada exception being handled. If an exception name is
4535 specified at the end of the command
4536 (eg @kbd{catch handlers Program_Error}), the debugger will stop
4537 only when this specific exception is handled.
4538 Otherwise, the debugger stops execution when any Ada exception is handled.
4540 When inserting a handlers catchpoint on a user-defined
4541 exception whose name is identical to one of the exceptions
4542 defined by the language, the fully qualified name must be used
4543 as the exception name. Otherwise, @value{GDBN} will assume that it
4544 should stop on the pre-defined exception rather than the
4545 user-defined one. For instance, assuming an exception called
4546 @code{Constraint_Error} is defined in package @code{Pck}, then the
4547 command to use to catch such exceptions handling is
4548 @kbd{catch handlers Pck.Constraint_Error}.
4550 @item exception unhandled
4551 @kindex catch exception unhandled
4552 An exception that was raised but is not handled by the program.
4555 @kindex catch assert
4556 A failed Ada assertion.
4560 @cindex break on fork/exec
4561 A call to @code{exec}.
4563 @anchor{catch syscall}
4565 @itemx syscall @r{[}@var{name} @r{|} @var{number} @r{|} @r{group:}@var{groupname} @r{|} @r{g:}@var{groupname}@r{]} @dots{}
4566 @kindex catch syscall
4567 @cindex break on a system call.
4568 A call to or return from a system call, a.k.a.@: @dfn{syscall}. A
4569 syscall is a mechanism for application programs to request a service
4570 from the operating system (OS) or one of the OS system services.
4571 @value{GDBN} can catch some or all of the syscalls issued by the
4572 debuggee, and show the related information for each syscall. If no
4573 argument is specified, calls to and returns from all system calls
4576 @var{name} can be any system call name that is valid for the
4577 underlying OS. Just what syscalls are valid depends on the OS. On
4578 GNU and Unix systems, you can find the full list of valid syscall
4579 names on @file{/usr/include/asm/unistd.h}.
4581 @c For MS-Windows, the syscall names and the corresponding numbers
4582 @c can be found, e.g., on this URL:
4583 @c http://www.metasploit.com/users/opcode/syscalls.html
4584 @c but we don't support Windows syscalls yet.
4586 Normally, @value{GDBN} knows in advance which syscalls are valid for
4587 each OS, so you can use the @value{GDBN} command-line completion
4588 facilities (@pxref{Completion,, command completion}) to list the
4591 You may also specify the system call numerically. A syscall's
4592 number is the value passed to the OS's syscall dispatcher to
4593 identify the requested service. When you specify the syscall by its
4594 name, @value{GDBN} uses its database of syscalls to convert the name
4595 into the corresponding numeric code, but using the number directly
4596 may be useful if @value{GDBN}'s database does not have the complete
4597 list of syscalls on your system (e.g., because @value{GDBN} lags
4598 behind the OS upgrades).
4600 You may specify a group of related syscalls to be caught at once using
4601 the @code{group:} syntax (@code{g:} is a shorter equivalent). For
4602 instance, on some platforms @value{GDBN} allows you to catch all
4603 network related syscalls, by passing the argument @code{group:network}
4604 to @code{catch syscall}. Note that not all syscall groups are
4605 available in every system. You can use the command completion
4606 facilities (@pxref{Completion,, command completion}) to list the
4607 syscall groups available on your environment.
4609 The example below illustrates how this command works if you don't provide
4613 (@value{GDBP}) catch syscall
4614 Catchpoint 1 (syscall)
4616 Starting program: /tmp/catch-syscall
4618 Catchpoint 1 (call to syscall 'close'), \
4619 0xffffe424 in __kernel_vsyscall ()
4623 Catchpoint 1 (returned from syscall 'close'), \
4624 0xffffe424 in __kernel_vsyscall ()
4628 Here is an example of catching a system call by name:
4631 (@value{GDBP}) catch syscall chroot
4632 Catchpoint 1 (syscall 'chroot' [61])
4634 Starting program: /tmp/catch-syscall
4636 Catchpoint 1 (call to syscall 'chroot'), \
4637 0xffffe424 in __kernel_vsyscall ()
4641 Catchpoint 1 (returned from syscall 'chroot'), \
4642 0xffffe424 in __kernel_vsyscall ()
4646 An example of specifying a system call numerically. In the case
4647 below, the syscall number has a corresponding entry in the XML
4648 file, so @value{GDBN} finds its name and prints it:
4651 (@value{GDBP}) catch syscall 252
4652 Catchpoint 1 (syscall(s) 'exit_group')
4654 Starting program: /tmp/catch-syscall
4656 Catchpoint 1 (call to syscall 'exit_group'), \
4657 0xffffe424 in __kernel_vsyscall ()
4661 Program exited normally.
4665 Here is an example of catching a syscall group:
4668 (@value{GDBP}) catch syscall group:process
4669 Catchpoint 1 (syscalls 'exit' [1] 'fork' [2] 'waitpid' [7]
4670 'execve' [11] 'wait4' [114] 'clone' [120] 'vfork' [190]
4671 'exit_group' [252] 'waitid' [284] 'unshare' [310])
4673 Starting program: /tmp/catch-syscall
4675 Catchpoint 1 (call to syscall fork), 0x00007ffff7df4e27 in open64 ()
4676 from /lib64/ld-linux-x86-64.so.2
4682 However, there can be situations when there is no corresponding name
4683 in XML file for that syscall number. In this case, @value{GDBN} prints
4684 a warning message saying that it was not able to find the syscall name,
4685 but the catchpoint will be set anyway. See the example below:
4688 (@value{GDBP}) catch syscall 764
4689 warning: The number '764' does not represent a known syscall.
4690 Catchpoint 2 (syscall 764)
4694 If you configure @value{GDBN} using the @samp{--without-expat} option,
4695 it will not be able to display syscall names. Also, if your
4696 architecture does not have an XML file describing its system calls,
4697 you will not be able to see the syscall names. It is important to
4698 notice that these two features are used for accessing the syscall
4699 name database. In either case, you will see a warning like this:
4702 (@value{GDBP}) catch syscall
4703 warning: Could not open "syscalls/i386-linux.xml"
4704 warning: Could not load the syscall XML file 'syscalls/i386-linux.xml'.
4705 GDB will not be able to display syscall names.
4706 Catchpoint 1 (syscall)
4710 Of course, the file name will change depending on your architecture and system.
4712 Still using the example above, you can also try to catch a syscall by its
4713 number. In this case, you would see something like:
4716 (@value{GDBP}) catch syscall 252
4717 Catchpoint 1 (syscall(s) 252)
4720 Again, in this case @value{GDBN} would not be able to display syscall's names.
4724 A call to @code{fork}.
4728 A call to @code{vfork}.
4730 @item load @r{[}regexp@r{]}
4731 @itemx unload @r{[}regexp@r{]}
4733 @kindex catch unload
4734 The loading or unloading of a shared library. If @var{regexp} is
4735 given, then the catchpoint will stop only if the regular expression
4736 matches one of the affected libraries.
4738 @item signal @r{[}@var{signal}@dots{} @r{|} @samp{all}@r{]}
4739 @kindex catch signal
4740 The delivery of a signal.
4742 With no arguments, this catchpoint will catch any signal that is not
4743 used internally by @value{GDBN}, specifically, all signals except
4744 @samp{SIGTRAP} and @samp{SIGINT}.
4746 With the argument @samp{all}, all signals, including those used by
4747 @value{GDBN}, will be caught. This argument cannot be used with other
4750 Otherwise, the arguments are a list of signal names as given to
4751 @code{handle} (@pxref{Signals}). Only signals specified in this list
4754 One reason that @code{catch signal} can be more useful than
4755 @code{handle} is that you can attach commands and conditions to the
4758 When a signal is caught by a catchpoint, the signal's @code{stop} and
4759 @code{print} settings, as specified by @code{handle}, are ignored.
4760 However, whether the signal is still delivered to the inferior depends
4761 on the @code{pass} setting; this can be changed in the catchpoint's
4766 @item tcatch @var{event}
4768 Set a catchpoint that is enabled only for one stop. The catchpoint is
4769 automatically deleted after the first time the event is caught.
4773 Use the @code{info break} command to list the current catchpoints.
4777 @subsection Deleting Breakpoints
4779 @cindex clearing breakpoints, watchpoints, catchpoints
4780 @cindex deleting breakpoints, watchpoints, catchpoints
4781 It is often necessary to eliminate a breakpoint, watchpoint, or
4782 catchpoint once it has done its job and you no longer want your program
4783 to stop there. This is called @dfn{deleting} the breakpoint. A
4784 breakpoint that has been deleted no longer exists; it is forgotten.
4786 With the @code{clear} command you can delete breakpoints according to
4787 where they are in your program. With the @code{delete} command you can
4788 delete individual breakpoints, watchpoints, or catchpoints by specifying
4789 their breakpoint numbers.
4791 It is not necessary to delete a breakpoint to proceed past it. @value{GDBN}
4792 automatically ignores breakpoints on the first instruction to be executed
4793 when you continue execution without changing the execution address.
4798 Delete any breakpoints at the next instruction to be executed in the
4799 selected stack frame (@pxref{Selection, ,Selecting a Frame}). When
4800 the innermost frame is selected, this is a good way to delete a
4801 breakpoint where your program just stopped.
4803 @item clear @var{location}
4804 Delete any breakpoints set at the specified @var{location}.
4805 @xref{Specify Location}, for the various forms of @var{location}; the
4806 most useful ones are listed below:
4809 @item clear @var{function}
4810 @itemx clear @var{filename}:@var{function}
4811 Delete any breakpoints set at entry to the named @var{function}.
4813 @item clear @var{linenum}
4814 @itemx clear @var{filename}:@var{linenum}
4815 Delete any breakpoints set at or within the code of the specified
4816 @var{linenum} of the specified @var{filename}.
4819 @cindex delete breakpoints
4821 @kindex d @r{(@code{delete})}
4822 @item delete @r{[}breakpoints@r{]} @r{[}@var{list}@dots{}@r{]}
4823 Delete the breakpoints, watchpoints, or catchpoints of the breakpoint
4824 list specified as argument. If no argument is specified, delete all
4825 breakpoints (@value{GDBN} asks confirmation, unless you have @code{set
4826 confirm off}). You can abbreviate this command as @code{d}.
4830 @subsection Disabling Breakpoints
4832 @cindex enable/disable a breakpoint
4833 Rather than deleting a breakpoint, watchpoint, or catchpoint, you might
4834 prefer to @dfn{disable} it. This makes the breakpoint inoperative as if
4835 it had been deleted, but remembers the information on the breakpoint so
4836 that you can @dfn{enable} it again later.
4838 You disable and enable breakpoints, watchpoints, and catchpoints with
4839 the @code{enable} and @code{disable} commands, optionally specifying
4840 one or more breakpoint numbers as arguments. Use @code{info break} to
4841 print a list of all breakpoints, watchpoints, and catchpoints if you
4842 do not know which numbers to use.
4844 Disabling and enabling a breakpoint that has multiple locations
4845 affects all of its locations.
4847 A breakpoint, watchpoint, or catchpoint can have any of several
4848 different states of enablement:
4852 Enabled. The breakpoint stops your program. A breakpoint set
4853 with the @code{break} command starts out in this state.
4855 Disabled. The breakpoint has no effect on your program.
4857 Enabled once. The breakpoint stops your program, but then becomes
4860 Enabled for a count. The breakpoint stops your program for the next
4861 N times, then becomes disabled.
4863 Enabled for deletion. The breakpoint stops your program, but
4864 immediately after it does so it is deleted permanently. A breakpoint
4865 set with the @code{tbreak} command starts out in this state.
4868 You can use the following commands to enable or disable breakpoints,
4869 watchpoints, and catchpoints:
4873 @kindex dis @r{(@code{disable})}
4874 @item disable @r{[}breakpoints@r{]} @r{[}@var{list}@dots{}@r{]}
4875 Disable the specified breakpoints---or all breakpoints, if none are
4876 listed. A disabled breakpoint has no effect but is not forgotten. All
4877 options such as ignore-counts, conditions and commands are remembered in
4878 case the breakpoint is enabled again later. You may abbreviate
4879 @code{disable} as @code{dis}.
4882 @item enable @r{[}breakpoints@r{]} @r{[}@var{list}@dots{}@r{]}
4883 Enable the specified breakpoints (or all defined breakpoints). They
4884 become effective once again in stopping your program.
4886 @item enable @r{[}breakpoints@r{]} once @var{list}@dots{}
4887 Enable the specified breakpoints temporarily. @value{GDBN} disables any
4888 of these breakpoints immediately after stopping your program.
4890 @item enable @r{[}breakpoints@r{]} count @var{count} @var{list}@dots{}
4891 Enable the specified breakpoints temporarily. @value{GDBN} records
4892 @var{count} with each of the specified breakpoints, and decrements a
4893 breakpoint's count when it is hit. When any count reaches 0,
4894 @value{GDBN} disables that breakpoint. If a breakpoint has an ignore
4895 count (@pxref{Conditions, ,Break Conditions}), that will be
4896 decremented to 0 before @var{count} is affected.
4898 @item enable @r{[}breakpoints@r{]} delete @var{list}@dots{}
4899 Enable the specified breakpoints to work once, then die. @value{GDBN}
4900 deletes any of these breakpoints as soon as your program stops there.
4901 Breakpoints set by the @code{tbreak} command start out in this state.
4904 @c FIXME: I think the following ``Except for [...] @code{tbreak}'' is
4905 @c confusing: tbreak is also initially enabled.
4906 Except for a breakpoint set with @code{tbreak} (@pxref{Set Breaks,
4907 ,Setting Breakpoints}), breakpoints that you set are initially enabled;
4908 subsequently, they become disabled or enabled only when you use one of
4909 the commands above. (The command @code{until} can set and delete a
4910 breakpoint of its own, but it does not change the state of your other
4911 breakpoints; see @ref{Continuing and Stepping, ,Continuing and
4915 @subsection Break Conditions
4916 @cindex conditional breakpoints
4917 @cindex breakpoint conditions
4919 @c FIXME what is scope of break condition expr? Context where wanted?
4920 @c in particular for a watchpoint?
4921 The simplest sort of breakpoint breaks every time your program reaches a
4922 specified place. You can also specify a @dfn{condition} for a
4923 breakpoint. A condition is just a Boolean expression in your
4924 programming language (@pxref{Expressions, ,Expressions}). A breakpoint with
4925 a condition evaluates the expression each time your program reaches it,
4926 and your program stops only if the condition is @emph{true}.
4928 This is the converse of using assertions for program validation; in that
4929 situation, you want to stop when the assertion is violated---that is,
4930 when the condition is false. In C, if you want to test an assertion expressed
4931 by the condition @var{assert}, you should set the condition
4932 @samp{! @var{assert}} on the appropriate breakpoint.
4934 Conditions are also accepted for watchpoints; you may not need them,
4935 since a watchpoint is inspecting the value of an expression anyhow---but
4936 it might be simpler, say, to just set a watchpoint on a variable name,
4937 and specify a condition that tests whether the new value is an interesting
4940 Break conditions can have side effects, and may even call functions in
4941 your program. This can be useful, for example, to activate functions
4942 that log program progress, or to use your own print functions to
4943 format special data structures. The effects are completely predictable
4944 unless there is another enabled breakpoint at the same address. (In
4945 that case, @value{GDBN} might see the other breakpoint first and stop your
4946 program without checking the condition of this one.) Note that
4947 breakpoint commands are usually more convenient and flexible than break
4949 purpose of performing side effects when a breakpoint is reached
4950 (@pxref{Break Commands, ,Breakpoint Command Lists}).
4952 Breakpoint conditions can also be evaluated on the target's side if
4953 the target supports it. Instead of evaluating the conditions locally,
4954 @value{GDBN} encodes the expression into an agent expression
4955 (@pxref{Agent Expressions}) suitable for execution on the target,
4956 independently of @value{GDBN}. Global variables become raw memory
4957 locations, locals become stack accesses, and so forth.
4959 In this case, @value{GDBN} will only be notified of a breakpoint trigger
4960 when its condition evaluates to true. This mechanism may provide faster
4961 response times depending on the performance characteristics of the target
4962 since it does not need to keep @value{GDBN} informed about
4963 every breakpoint trigger, even those with false conditions.
4965 Break conditions can be specified when a breakpoint is set, by using
4966 @samp{if} in the arguments to the @code{break} command. @xref{Set
4967 Breaks, ,Setting Breakpoints}. They can also be changed at any time
4968 with the @code{condition} command.
4970 You can also use the @code{if} keyword with the @code{watch} command.
4971 The @code{catch} command does not recognize the @code{if} keyword;
4972 @code{condition} is the only way to impose a further condition on a
4977 @item condition @var{bnum} @var{expression}
4978 Specify @var{expression} as the break condition for breakpoint,
4979 watchpoint, or catchpoint number @var{bnum}. After you set a condition,
4980 breakpoint @var{bnum} stops your program only if the value of
4981 @var{expression} is true (nonzero, in C). When you use
4982 @code{condition}, @value{GDBN} checks @var{expression} immediately for
4983 syntactic correctness, and to determine whether symbols in it have
4984 referents in the context of your breakpoint. If @var{expression} uses
4985 symbols not referenced in the context of the breakpoint, @value{GDBN}
4986 prints an error message:
4989 No symbol "foo" in current context.
4994 not actually evaluate @var{expression} at the time the @code{condition}
4995 command (or a command that sets a breakpoint with a condition, like
4996 @code{break if @dots{}}) is given, however. @xref{Expressions, ,Expressions}.
4998 @item condition @var{bnum}
4999 Remove the condition from breakpoint number @var{bnum}. It becomes
5000 an ordinary unconditional breakpoint.
5003 @cindex ignore count (of breakpoint)
5004 A special case of a breakpoint condition is to stop only when the
5005 breakpoint has been reached a certain number of times. This is so
5006 useful that there is a special way to do it, using the @dfn{ignore
5007 count} of the breakpoint. Every breakpoint has an ignore count, which
5008 is an integer. Most of the time, the ignore count is zero, and
5009 therefore has no effect. But if your program reaches a breakpoint whose
5010 ignore count is positive, then instead of stopping, it just decrements
5011 the ignore count by one and continues. As a result, if the ignore count
5012 value is @var{n}, the breakpoint does not stop the next @var{n} times
5013 your program reaches it.
5017 @item ignore @var{bnum} @var{count}
5018 Set the ignore count of breakpoint number @var{bnum} to @var{count}.
5019 The next @var{count} times the breakpoint is reached, your program's
5020 execution does not stop; other than to decrement the ignore count, @value{GDBN}
5023 To make the breakpoint stop the next time it is reached, specify
5026 When you use @code{continue} to resume execution of your program from a
5027 breakpoint, you can specify an ignore count directly as an argument to
5028 @code{continue}, rather than using @code{ignore}. @xref{Continuing and
5029 Stepping,,Continuing and Stepping}.
5031 If a breakpoint has a positive ignore count and a condition, the
5032 condition is not checked. Once the ignore count reaches zero,
5033 @value{GDBN} resumes checking the condition.
5035 You could achieve the effect of the ignore count with a condition such
5036 as @w{@samp{$foo-- <= 0}} using a debugger convenience variable that
5037 is decremented each time. @xref{Convenience Vars, ,Convenience
5041 Ignore counts apply to breakpoints, watchpoints, and catchpoints.
5044 @node Break Commands
5045 @subsection Breakpoint Command Lists
5047 @cindex breakpoint commands
5048 You can give any breakpoint (or watchpoint or catchpoint) a series of
5049 commands to execute when your program stops due to that breakpoint. For
5050 example, you might want to print the values of certain expressions, or
5051 enable other breakpoints.
5055 @kindex end@r{ (breakpoint commands)}
5056 @item commands @r{[}@var{list}@dots{}@r{]}
5057 @itemx @dots{} @var{command-list} @dots{}
5059 Specify a list of commands for the given breakpoints. The commands
5060 themselves appear on the following lines. Type a line containing just
5061 @code{end} to terminate the commands.
5063 To remove all commands from a breakpoint, type @code{commands} and
5064 follow it immediately with @code{end}; that is, give no commands.
5066 With no argument, @code{commands} refers to the last breakpoint,
5067 watchpoint, or catchpoint set (not to the breakpoint most recently
5068 encountered). If the most recent breakpoints were set with a single
5069 command, then the @code{commands} will apply to all the breakpoints
5070 set by that command. This applies to breakpoints set by
5071 @code{rbreak}, and also applies when a single @code{break} command
5072 creates multiple breakpoints (@pxref{Ambiguous Expressions,,Ambiguous
5076 Pressing @key{RET} as a means of repeating the last @value{GDBN} command is
5077 disabled within a @var{command-list}.
5079 You can use breakpoint commands to start your program up again. Simply
5080 use the @code{continue} command, or @code{step}, or any other command
5081 that resumes execution.
5083 Any other commands in the command list, after a command that resumes
5084 execution, are ignored. This is because any time you resume execution
5085 (even with a simple @code{next} or @code{step}), you may encounter
5086 another breakpoint---which could have its own command list, leading to
5087 ambiguities about which list to execute.
5090 If the first command you specify in a command list is @code{silent}, the
5091 usual message about stopping at a breakpoint is not printed. This may
5092 be desirable for breakpoints that are to print a specific message and
5093 then continue. If none of the remaining commands print anything, you
5094 see no sign that the breakpoint was reached. @code{silent} is
5095 meaningful only at the beginning of a breakpoint command list.
5097 The commands @code{echo}, @code{output}, and @code{printf} allow you to
5098 print precisely controlled output, and are often useful in silent
5099 breakpoints. @xref{Output, ,Commands for Controlled Output}.
5101 For example, here is how you could use breakpoint commands to print the
5102 value of @code{x} at entry to @code{foo} whenever @code{x} is positive.
5108 printf "x is %d\n",x
5113 One application for breakpoint commands is to compensate for one bug so
5114 you can test for another. Put a breakpoint just after the erroneous line
5115 of code, give it a condition to detect the case in which something
5116 erroneous has been done, and give it commands to assign correct values
5117 to any variables that need them. End with the @code{continue} command
5118 so that your program does not stop, and start with the @code{silent}
5119 command so that no output is produced. Here is an example:
5130 @node Dynamic Printf
5131 @subsection Dynamic Printf
5133 @cindex dynamic printf
5135 The dynamic printf command @code{dprintf} combines a breakpoint with
5136 formatted printing of your program's data to give you the effect of
5137 inserting @code{printf} calls into your program on-the-fly, without
5138 having to recompile it.
5140 In its most basic form, the output goes to the GDB console. However,
5141 you can set the variable @code{dprintf-style} for alternate handling.
5142 For instance, you can ask to format the output by calling your
5143 program's @code{printf} function. This has the advantage that the
5144 characters go to the program's output device, so they can recorded in
5145 redirects to files and so forth.
5147 If you are doing remote debugging with a stub or agent, you can also
5148 ask to have the printf handled by the remote agent. In addition to
5149 ensuring that the output goes to the remote program's device along
5150 with any other output the program might produce, you can also ask that
5151 the dprintf remain active even after disconnecting from the remote
5152 target. Using the stub/agent is also more efficient, as it can do
5153 everything without needing to communicate with @value{GDBN}.
5157 @item dprintf @var{location},@var{template},@var{expression}[,@var{expression}@dots{}]
5158 Whenever execution reaches @var{location}, print the values of one or
5159 more @var{expressions} under the control of the string @var{template}.
5160 To print several values, separate them with commas.
5162 @item set dprintf-style @var{style}
5163 Set the dprintf output to be handled in one of several different
5164 styles enumerated below. A change of style affects all existing
5165 dynamic printfs immediately. (If you need individual control over the
5166 print commands, simply define normal breakpoints with
5167 explicitly-supplied command lists.)
5171 @kindex dprintf-style gdb
5172 Handle the output using the @value{GDBN} @code{printf} command.
5175 @kindex dprintf-style call
5176 Handle the output by calling a function in your program (normally
5180 @kindex dprintf-style agent
5181 Have the remote debugging agent (such as @code{gdbserver}) handle
5182 the output itself. This style is only available for agents that
5183 support running commands on the target.
5186 @item set dprintf-function @var{function}
5187 Set the function to call if the dprintf style is @code{call}. By
5188 default its value is @code{printf}. You may set it to any expression.
5189 that @value{GDBN} can evaluate to a function, as per the @code{call}
5192 @item set dprintf-channel @var{channel}
5193 Set a ``channel'' for dprintf. If set to a non-empty value,
5194 @value{GDBN} will evaluate it as an expression and pass the result as
5195 a first argument to the @code{dprintf-function}, in the manner of
5196 @code{fprintf} and similar functions. Otherwise, the dprintf format
5197 string will be the first argument, in the manner of @code{printf}.
5199 As an example, if you wanted @code{dprintf} output to go to a logfile
5200 that is a standard I/O stream assigned to the variable @code{mylog},
5201 you could do the following:
5204 (gdb) set dprintf-style call
5205 (gdb) set dprintf-function fprintf
5206 (gdb) set dprintf-channel mylog
5207 (gdb) dprintf 25,"at line 25, glob=%d\n",glob
5208 Dprintf 1 at 0x123456: file main.c, line 25.
5210 1 dprintf keep y 0x00123456 in main at main.c:25
5211 call (void) fprintf (mylog,"at line 25, glob=%d\n",glob)
5216 Note that the @code{info break} displays the dynamic printf commands
5217 as normal breakpoint commands; you can thus easily see the effect of
5218 the variable settings.
5220 @item set disconnected-dprintf on
5221 @itemx set disconnected-dprintf off
5222 @kindex set disconnected-dprintf
5223 Choose whether @code{dprintf} commands should continue to run if
5224 @value{GDBN} has disconnected from the target. This only applies
5225 if the @code{dprintf-style} is @code{agent}.
5227 @item show disconnected-dprintf off
5228 @kindex show disconnected-dprintf
5229 Show the current choice for disconnected @code{dprintf}.
5233 @value{GDBN} does not check the validity of function and channel,
5234 relying on you to supply values that are meaningful for the contexts
5235 in which they are being used. For instance, the function and channel
5236 may be the values of local variables, but if that is the case, then
5237 all enabled dynamic prints must be at locations within the scope of
5238 those locals. If evaluation fails, @value{GDBN} will report an error.
5240 @node Save Breakpoints
5241 @subsection How to save breakpoints to a file
5243 To save breakpoint definitions to a file use the @w{@code{save
5244 breakpoints}} command.
5247 @kindex save breakpoints
5248 @cindex save breakpoints to a file for future sessions
5249 @item save breakpoints [@var{filename}]
5250 This command saves all current breakpoint definitions together with
5251 their commands and ignore counts, into a file @file{@var{filename}}
5252 suitable for use in a later debugging session. This includes all
5253 types of breakpoints (breakpoints, watchpoints, catchpoints,
5254 tracepoints). To read the saved breakpoint definitions, use the
5255 @code{source} command (@pxref{Command Files}). Note that watchpoints
5256 with expressions involving local variables may fail to be recreated
5257 because it may not be possible to access the context where the
5258 watchpoint is valid anymore. Because the saved breakpoint definitions
5259 are simply a sequence of @value{GDBN} commands that recreate the
5260 breakpoints, you can edit the file in your favorite editing program,
5261 and remove the breakpoint definitions you're not interested in, or
5262 that can no longer be recreated.
5265 @node Static Probe Points
5266 @subsection Static Probe Points
5268 @cindex static probe point, SystemTap
5269 @cindex static probe point, DTrace
5270 @value{GDBN} supports @dfn{SDT} probes in the code. @acronym{SDT} stands
5271 for Statically Defined Tracing, and the probes are designed to have a tiny
5272 runtime code and data footprint, and no dynamic relocations.
5274 Currently, the following types of probes are supported on
5275 ELF-compatible systems:
5279 @item @code{SystemTap} (@uref{http://sourceware.org/systemtap/})
5280 @acronym{SDT} probes@footnote{See
5281 @uref{http://sourceware.org/systemtap/wiki/AddingUserSpaceProbingToApps}
5282 for more information on how to add @code{SystemTap} @acronym{SDT}
5283 probes in your applications.}. @code{SystemTap} probes are usable
5284 from assembly, C and C@t{++} languages@footnote{See
5285 @uref{http://sourceware.org/systemtap/wiki/UserSpaceProbeImplementation}
5286 for a good reference on how the @acronym{SDT} probes are implemented.}.
5288 @item @code{DTrace} (@uref{http://oss.oracle.com/projects/DTrace})
5289 @acronym{USDT} probes. @code{DTrace} probes are usable from C and
5293 @cindex semaphores on static probe points
5294 Some @code{SystemTap} probes have an associated semaphore variable;
5295 for instance, this happens automatically if you defined your probe
5296 using a DTrace-style @file{.d} file. If your probe has a semaphore,
5297 @value{GDBN} will automatically enable it when you specify a
5298 breakpoint using the @samp{-probe-stap} notation. But, if you put a
5299 breakpoint at a probe's location by some other method (e.g.,
5300 @code{break file:line}), then @value{GDBN} will not automatically set
5301 the semaphore. @code{DTrace} probes do not support semaphores.
5303 You can examine the available static static probes using @code{info
5304 probes}, with optional arguments:
5308 @item info probes @r{[}@var{type}@r{]} @r{[}@var{provider} @r{[}@var{name} @r{[}@var{objfile}@r{]}@r{]}@r{]}
5309 If given, @var{type} is either @code{stap} for listing
5310 @code{SystemTap} probes or @code{dtrace} for listing @code{DTrace}
5311 probes. If omitted all probes are listed regardless of their types.
5313 If given, @var{provider} is a regular expression used to match against provider
5314 names when selecting which probes to list. If omitted, probes by all
5315 probes from all providers are listed.
5317 If given, @var{name} is a regular expression to match against probe names
5318 when selecting which probes to list. If omitted, probe names are not
5319 considered when deciding whether to display them.
5321 If given, @var{objfile} is a regular expression used to select which
5322 object files (executable or shared libraries) to examine. If not
5323 given, all object files are considered.
5325 @item info probes all
5326 List the available static probes, from all types.
5329 @cindex enabling and disabling probes
5330 Some probe points can be enabled and/or disabled. The effect of
5331 enabling or disabling a probe depends on the type of probe being
5332 handled. Some @code{DTrace} probes can be enabled or
5333 disabled, but @code{SystemTap} probes cannot be disabled.
5335 You can enable (or disable) one or more probes using the following
5336 commands, with optional arguments:
5339 @kindex enable probes
5340 @item enable probes @r{[}@var{provider} @r{[}@var{name} @r{[}@var{objfile}@r{]}@r{]}@r{]}
5341 If given, @var{provider} is a regular expression used to match against
5342 provider names when selecting which probes to enable. If omitted,
5343 all probes from all providers are enabled.
5345 If given, @var{name} is a regular expression to match against probe
5346 names when selecting which probes to enable. If omitted, probe names
5347 are not considered when deciding whether to enable them.
5349 If given, @var{objfile} is a regular expression used to select which
5350 object files (executable or shared libraries) to examine. If not
5351 given, all object files are considered.
5353 @kindex disable probes
5354 @item disable probes @r{[}@var{provider} @r{[}@var{name} @r{[}@var{objfile}@r{]}@r{]}@r{]}
5355 See the @code{enable probes} command above for a description of the
5356 optional arguments accepted by this command.
5359 @vindex $_probe_arg@r{, convenience variable}
5360 A probe may specify up to twelve arguments. These are available at the
5361 point at which the probe is defined---that is, when the current PC is
5362 at the probe's location. The arguments are available using the
5363 convenience variables (@pxref{Convenience Vars})
5364 @code{$_probe_arg0}@dots{}@code{$_probe_arg11}. In @code{SystemTap}
5365 probes each probe argument is an integer of the appropriate size;
5366 types are not preserved. In @code{DTrace} probes types are preserved
5367 provided that they are recognized as such by @value{GDBN}; otherwise
5368 the value of the probe argument will be a long integer. The
5369 convenience variable @code{$_probe_argc} holds the number of arguments
5370 at the current probe point.
5372 These variables are always available, but attempts to access them at
5373 any location other than a probe point will cause @value{GDBN} to give
5377 @c @ifclear BARETARGET
5378 @node Error in Breakpoints
5379 @subsection ``Cannot insert breakpoints''
5381 If you request too many active hardware-assisted breakpoints and
5382 watchpoints, you will see this error message:
5384 @c FIXME: the precise wording of this message may change; the relevant
5385 @c source change is not committed yet (Sep 3, 1999).
5387 Stopped; cannot insert breakpoints.
5388 You may have requested too many hardware breakpoints and watchpoints.
5392 This message is printed when you attempt to resume the program, since
5393 only then @value{GDBN} knows exactly how many hardware breakpoints and
5394 watchpoints it needs to insert.
5396 When this message is printed, you need to disable or remove some of the
5397 hardware-assisted breakpoints and watchpoints, and then continue.
5399 @node Breakpoint-related Warnings
5400 @subsection ``Breakpoint address adjusted...''
5401 @cindex breakpoint address adjusted
5403 Some processor architectures place constraints on the addresses at
5404 which breakpoints may be placed. For architectures thus constrained,
5405 @value{GDBN} will attempt to adjust the breakpoint's address to comply
5406 with the constraints dictated by the architecture.
5408 One example of such an architecture is the Fujitsu FR-V. The FR-V is
5409 a VLIW architecture in which a number of RISC-like instructions may be
5410 bundled together for parallel execution. The FR-V architecture
5411 constrains the location of a breakpoint instruction within such a
5412 bundle to the instruction with the lowest address. @value{GDBN}
5413 honors this constraint by adjusting a breakpoint's address to the
5414 first in the bundle.
5416 It is not uncommon for optimized code to have bundles which contain
5417 instructions from different source statements, thus it may happen that
5418 a breakpoint's address will be adjusted from one source statement to
5419 another. Since this adjustment may significantly alter @value{GDBN}'s
5420 breakpoint related behavior from what the user expects, a warning is
5421 printed when the breakpoint is first set and also when the breakpoint
5424 A warning like the one below is printed when setting a breakpoint
5425 that's been subject to address adjustment:
5428 warning: Breakpoint address adjusted from 0x00010414 to 0x00010410.
5431 Such warnings are printed both for user settable and @value{GDBN}'s
5432 internal breakpoints. If you see one of these warnings, you should
5433 verify that a breakpoint set at the adjusted address will have the
5434 desired affect. If not, the breakpoint in question may be removed and
5435 other breakpoints may be set which will have the desired behavior.
5436 E.g., it may be sufficient to place the breakpoint at a later
5437 instruction. A conditional breakpoint may also be useful in some
5438 cases to prevent the breakpoint from triggering too often.
5440 @value{GDBN} will also issue a warning when stopping at one of these
5441 adjusted breakpoints:
5444 warning: Breakpoint 1 address previously adjusted from 0x00010414
5448 When this warning is encountered, it may be too late to take remedial
5449 action except in cases where the breakpoint is hit earlier or more
5450 frequently than expected.
5452 @node Continuing and Stepping
5453 @section Continuing and Stepping
5457 @cindex resuming execution
5458 @dfn{Continuing} means resuming program execution until your program
5459 completes normally. In contrast, @dfn{stepping} means executing just
5460 one more ``step'' of your program, where ``step'' may mean either one
5461 line of source code, or one machine instruction (depending on what
5462 particular command you use). Either when continuing or when stepping,
5463 your program may stop even sooner, due to a breakpoint or a signal. (If
5464 it stops due to a signal, you may want to use @code{handle}, or use
5465 @samp{signal 0} to resume execution (@pxref{Signals, ,Signals}),
5466 or you may step into the signal's handler (@pxref{stepping and signal
5471 @kindex c @r{(@code{continue})}
5472 @kindex fg @r{(resume foreground execution)}
5473 @item continue @r{[}@var{ignore-count}@r{]}
5474 @itemx c @r{[}@var{ignore-count}@r{]}
5475 @itemx fg @r{[}@var{ignore-count}@r{]}
5476 Resume program execution, at the address where your program last stopped;
5477 any breakpoints set at that address are bypassed. The optional argument
5478 @var{ignore-count} allows you to specify a further number of times to
5479 ignore a breakpoint at this location; its effect is like that of
5480 @code{ignore} (@pxref{Conditions, ,Break Conditions}).
5482 The argument @var{ignore-count} is meaningful only when your program
5483 stopped due to a breakpoint. At other times, the argument to
5484 @code{continue} is ignored.
5486 The synonyms @code{c} and @code{fg} (for @dfn{foreground}, as the
5487 debugged program is deemed to be the foreground program) are provided
5488 purely for convenience, and have exactly the same behavior as
5492 To resume execution at a different place, you can use @code{return}
5493 (@pxref{Returning, ,Returning from a Function}) to go back to the
5494 calling function; or @code{jump} (@pxref{Jumping, ,Continuing at a
5495 Different Address}) to go to an arbitrary location in your program.
5497 A typical technique for using stepping is to set a breakpoint
5498 (@pxref{Breakpoints, ,Breakpoints; Watchpoints; and Catchpoints}) at the
5499 beginning of the function or the section of your program where a problem
5500 is believed to lie, run your program until it stops at that breakpoint,
5501 and then step through the suspect area, examining the variables that are
5502 interesting, until you see the problem happen.
5506 @kindex s @r{(@code{step})}
5508 Continue running your program until control reaches a different source
5509 line, then stop it and return control to @value{GDBN}. This command is
5510 abbreviated @code{s}.
5513 @c "without debugging information" is imprecise; actually "without line
5514 @c numbers in the debugging information". (gcc -g1 has debugging info but
5515 @c not line numbers). But it seems complex to try to make that
5516 @c distinction here.
5517 @emph{Warning:} If you use the @code{step} command while control is
5518 within a function that was compiled without debugging information,
5519 execution proceeds until control reaches a function that does have
5520 debugging information. Likewise, it will not step into a function which
5521 is compiled without debugging information. To step through functions
5522 without debugging information, use the @code{stepi} command, described
5526 The @code{step} command only stops at the first instruction of a source
5527 line. This prevents the multiple stops that could otherwise occur in
5528 @code{switch} statements, @code{for} loops, etc. @code{step} continues
5529 to stop if a function that has debugging information is called within
5530 the line. In other words, @code{step} @emph{steps inside} any functions
5531 called within the line.
5533 Also, the @code{step} command only enters a function if there is line
5534 number information for the function. Otherwise it acts like the
5535 @code{next} command. This avoids problems when using @code{cc -gl}
5536 on @acronym{MIPS} machines. Previously, @code{step} entered subroutines if there
5537 was any debugging information about the routine.
5539 @item step @var{count}
5540 Continue running as in @code{step}, but do so @var{count} times. If a
5541 breakpoint is reached, or a signal not related to stepping occurs before
5542 @var{count} steps, stepping stops right away.
5545 @kindex n @r{(@code{next})}
5546 @item next @r{[}@var{count}@r{]}
5547 Continue to the next source line in the current (innermost) stack frame.
5548 This is similar to @code{step}, but function calls that appear within
5549 the line of code are executed without stopping. Execution stops when
5550 control reaches a different line of code at the original stack level
5551 that was executing when you gave the @code{next} command. This command
5552 is abbreviated @code{n}.
5554 An argument @var{count} is a repeat count, as for @code{step}.
5557 @c FIX ME!! Do we delete this, or is there a way it fits in with
5558 @c the following paragraph? --- Vctoria
5560 @c @code{next} within a function that lacks debugging information acts like
5561 @c @code{step}, but any function calls appearing within the code of the
5562 @c function are executed without stopping.
5564 The @code{next} command only stops at the first instruction of a
5565 source line. This prevents multiple stops that could otherwise occur in
5566 @code{switch} statements, @code{for} loops, etc.
5568 @kindex set step-mode
5570 @cindex functions without line info, and stepping
5571 @cindex stepping into functions with no line info
5572 @itemx set step-mode on
5573 The @code{set step-mode on} command causes the @code{step} command to
5574 stop at the first instruction of a function which contains no debug line
5575 information rather than stepping over it.
5577 This is useful in cases where you may be interested in inspecting the
5578 machine instructions of a function which has no symbolic info and do not
5579 want @value{GDBN} to automatically skip over this function.
5581 @item set step-mode off
5582 Causes the @code{step} command to step over any functions which contains no
5583 debug information. This is the default.
5585 @item show step-mode
5586 Show whether @value{GDBN} will stop in or step over functions without
5587 source line debug information.
5590 @kindex fin @r{(@code{finish})}
5592 Continue running until just after function in the selected stack frame
5593 returns. Print the returned value (if any). This command can be
5594 abbreviated as @code{fin}.
5596 Contrast this with the @code{return} command (@pxref{Returning,
5597 ,Returning from a Function}).
5600 @kindex u @r{(@code{until})}
5601 @cindex run until specified location
5604 Continue running until a source line past the current line, in the
5605 current stack frame, is reached. This command is used to avoid single
5606 stepping through a loop more than once. It is like the @code{next}
5607 command, except that when @code{until} encounters a jump, it
5608 automatically continues execution until the program counter is greater
5609 than the address of the jump.
5611 This means that when you reach the end of a loop after single stepping
5612 though it, @code{until} makes your program continue execution until it
5613 exits the loop. In contrast, a @code{next} command at the end of a loop
5614 simply steps back to the beginning of the loop, which forces you to step
5615 through the next iteration.
5617 @code{until} always stops your program if it attempts to exit the current
5620 @code{until} may produce somewhat counterintuitive results if the order
5621 of machine code does not match the order of the source lines. For
5622 example, in the following excerpt from a debugging session, the @code{f}
5623 (@code{frame}) command shows that execution is stopped at line
5624 @code{206}; yet when we use @code{until}, we get to line @code{195}:
5628 #0 main (argc=4, argv=0xf7fffae8) at m4.c:206
5630 (@value{GDBP}) until
5631 195 for ( ; argc > 0; NEXTARG) @{
5634 This happened because, for execution efficiency, the compiler had
5635 generated code for the loop closure test at the end, rather than the
5636 start, of the loop---even though the test in a C @code{for}-loop is
5637 written before the body of the loop. The @code{until} command appeared
5638 to step back to the beginning of the loop when it advanced to this
5639 expression; however, it has not really gone to an earlier
5640 statement---not in terms of the actual machine code.
5642 @code{until} with no argument works by means of single
5643 instruction stepping, and hence is slower than @code{until} with an
5646 @item until @var{location}
5647 @itemx u @var{location}
5648 Continue running your program until either the specified @var{location} is
5649 reached, or the current stack frame returns. The location is any of
5650 the forms described in @ref{Specify Location}.
5651 This form of the command uses temporary breakpoints, and
5652 hence is quicker than @code{until} without an argument. The specified
5653 location is actually reached only if it is in the current frame. This
5654 implies that @code{until} can be used to skip over recursive function
5655 invocations. For instance in the code below, if the current location is
5656 line @code{96}, issuing @code{until 99} will execute the program up to
5657 line @code{99} in the same invocation of factorial, i.e., after the inner
5658 invocations have returned.
5661 94 int factorial (int value)
5663 96 if (value > 1) @{
5664 97 value *= factorial (value - 1);
5671 @kindex advance @var{location}
5672 @item advance @var{location}
5673 Continue running the program up to the given @var{location}. An argument is
5674 required, which should be of one of the forms described in
5675 @ref{Specify Location}.
5676 Execution will also stop upon exit from the current stack
5677 frame. This command is similar to @code{until}, but @code{advance} will
5678 not skip over recursive function calls, and the target location doesn't
5679 have to be in the same frame as the current one.
5683 @kindex si @r{(@code{stepi})}
5685 @itemx stepi @var{arg}
5687 Execute one machine instruction, then stop and return to the debugger.
5689 It is often useful to do @samp{display/i $pc} when stepping by machine
5690 instructions. This makes @value{GDBN} automatically display the next
5691 instruction to be executed, each time your program stops. @xref{Auto
5692 Display,, Automatic Display}.
5694 An argument is a repeat count, as in @code{step}.
5698 @kindex ni @r{(@code{nexti})}
5700 @itemx nexti @var{arg}
5702 Execute one machine instruction, but if it is a function call,
5703 proceed until the function returns.
5705 An argument is a repeat count, as in @code{next}.
5709 @anchor{range stepping}
5710 @cindex range stepping
5711 @cindex target-assisted range stepping
5712 By default, and if available, @value{GDBN} makes use of
5713 target-assisted @dfn{range stepping}. In other words, whenever you
5714 use a stepping command (e.g., @code{step}, @code{next}), @value{GDBN}
5715 tells the target to step the corresponding range of instruction
5716 addresses instead of issuing multiple single-steps. This speeds up
5717 line stepping, particularly for remote targets. Ideally, there should
5718 be no reason you would want to turn range stepping off. However, it's
5719 possible that a bug in the debug info, a bug in the remote stub (for
5720 remote targets), or even a bug in @value{GDBN} could make line
5721 stepping behave incorrectly when target-assisted range stepping is
5722 enabled. You can use the following command to turn off range stepping
5726 @kindex set range-stepping
5727 @kindex show range-stepping
5728 @item set range-stepping
5729 @itemx show range-stepping
5730 Control whether range stepping is enabled.
5732 If @code{on}, and the target supports it, @value{GDBN} tells the
5733 target to step a range of addresses itself, instead of issuing
5734 multiple single-steps. If @code{off}, @value{GDBN} always issues
5735 single-steps, even if range stepping is supported by the target. The
5736 default is @code{on}.
5740 @node Skipping Over Functions and Files
5741 @section Skipping Over Functions and Files
5742 @cindex skipping over functions and files
5744 The program you are debugging may contain some functions which are
5745 uninteresting to debug. The @code{skip} command lets you tell @value{GDBN} to
5746 skip a function, all functions in a file or a particular function in
5747 a particular file when stepping.
5749 For example, consider the following C function:
5760 Suppose you wish to step into the functions @code{foo} and @code{bar}, but you
5761 are not interested in stepping through @code{boring}. If you run @code{step}
5762 at line 103, you'll enter @code{boring()}, but if you run @code{next}, you'll
5763 step over both @code{foo} and @code{boring}!
5765 One solution is to @code{step} into @code{boring} and use the @code{finish}
5766 command to immediately exit it. But this can become tedious if @code{boring}
5767 is called from many places.
5769 A more flexible solution is to execute @kbd{skip boring}. This instructs
5770 @value{GDBN} never to step into @code{boring}. Now when you execute
5771 @code{step} at line 103, you'll step over @code{boring} and directly into
5774 Functions may be skipped by providing either a function name, linespec
5775 (@pxref{Specify Location}), regular expression that matches the function's
5776 name, file name or a @code{glob}-style pattern that matches the file name.
5778 On Posix systems the form of the regular expression is
5779 ``Extended Regular Expressions''. See for example @samp{man 7 regex}
5780 on @sc{gnu}/Linux systems. On non-Posix systems the form of the regular
5781 expression is whatever is provided by the @code{regcomp} function of
5782 the underlying system.
5783 See for example @samp{man 7 glob} on @sc{gnu}/Linux systems for a
5784 description of @code{glob}-style patterns.
5788 @item skip @r{[}@var{options}@r{]}
5789 The basic form of the @code{skip} command takes zero or more options
5790 that specify what to skip.
5791 The @var{options} argument is any useful combination of the following:
5794 @item -file @var{file}
5795 @itemx -fi @var{file}
5796 Functions in @var{file} will be skipped over when stepping.
5798 @item -gfile @var{file-glob-pattern}
5799 @itemx -gfi @var{file-glob-pattern}
5800 @cindex skipping over files via glob-style patterns
5801 Functions in files matching @var{file-glob-pattern} will be skipped
5805 (gdb) skip -gfi utils/*.c
5808 @item -function @var{linespec}
5809 @itemx -fu @var{linespec}
5810 Functions named by @var{linespec} or the function containing the line
5811 named by @var{linespec} will be skipped over when stepping.
5812 @xref{Specify Location}.
5814 @item -rfunction @var{regexp}
5815 @itemx -rfu @var{regexp}
5816 @cindex skipping over functions via regular expressions
5817 Functions whose name matches @var{regexp} will be skipped over when stepping.
5819 This form is useful for complex function names.
5820 For example, there is generally no need to step into C@t{++} @code{std::string}
5821 constructors or destructors. Plus with C@t{++} templates it can be hard to
5822 write out the full name of the function, and often it doesn't matter what
5823 the template arguments are. Specifying the function to be skipped as a
5824 regular expression makes this easier.
5827 (gdb) skip -rfu ^std::(allocator|basic_string)<.*>::~?\1 *\(
5830 If you want to skip every templated C@t{++} constructor and destructor
5831 in the @code{std} namespace you can do:
5834 (gdb) skip -rfu ^std::([a-zA-z0-9_]+)<.*>::~?\1 *\(
5838 If no options are specified, the function you're currently debugging
5841 @kindex skip function
5842 @item skip function @r{[}@var{linespec}@r{]}
5843 After running this command, the function named by @var{linespec} or the
5844 function containing the line named by @var{linespec} will be skipped over when
5845 stepping. @xref{Specify Location}.
5847 If you do not specify @var{linespec}, the function you're currently debugging
5850 (If you have a function called @code{file} that you want to skip, use
5851 @kbd{skip function file}.)
5854 @item skip file @r{[}@var{filename}@r{]}
5855 After running this command, any function whose source lives in @var{filename}
5856 will be skipped over when stepping.
5859 (gdb) skip file boring.c
5860 File boring.c will be skipped when stepping.
5863 If you do not specify @var{filename}, functions whose source lives in the file
5864 you're currently debugging will be skipped.
5867 Skips can be listed, deleted, disabled, and enabled, much like breakpoints.
5868 These are the commands for managing your list of skips:
5872 @item info skip @r{[}@var{range}@r{]}
5873 Print details about the specified skip(s). If @var{range} is not specified,
5874 print a table with details about all functions and files marked for skipping.
5875 @code{info skip} prints the following information about each skip:
5879 A number identifying this skip.
5880 @item Enabled or Disabled
5881 Enabled skips are marked with @samp{y}.
5882 Disabled skips are marked with @samp{n}.
5884 If the file name is a @samp{glob} pattern this is @samp{y}.
5885 Otherwise it is @samp{n}.
5887 The name or @samp{glob} pattern of the file to be skipped.
5888 If no file is specified this is @samp{<none>}.
5890 If the function name is a @samp{regular expression} this is @samp{y}.
5891 Otherwise it is @samp{n}.
5893 The name or regular expression of the function to skip.
5894 If no function is specified this is @samp{<none>}.
5898 @item skip delete @r{[}@var{range}@r{]}
5899 Delete the specified skip(s). If @var{range} is not specified, delete all
5903 @item skip enable @r{[}@var{range}@r{]}
5904 Enable the specified skip(s). If @var{range} is not specified, enable all
5907 @kindex skip disable
5908 @item skip disable @r{[}@var{range}@r{]}
5909 Disable the specified skip(s). If @var{range} is not specified, disable all
5912 @kindex set debug skip
5913 @item set debug skip @r{[}on|off@r{]}
5914 Set whether to print the debug output about skipping files and functions.
5916 @kindex show debug skip
5917 @item show debug skip
5918 Show whether the debug output about skipping files and functions is printed.
5926 A signal is an asynchronous event that can happen in a program. The
5927 operating system defines the possible kinds of signals, and gives each
5928 kind a name and a number. For example, in Unix @code{SIGINT} is the
5929 signal a program gets when you type an interrupt character (often @kbd{Ctrl-c});
5930 @code{SIGSEGV} is the signal a program gets from referencing a place in
5931 memory far away from all the areas in use; @code{SIGALRM} occurs when
5932 the alarm clock timer goes off (which happens only if your program has
5933 requested an alarm).
5935 @cindex fatal signals
5936 Some signals, including @code{SIGALRM}, are a normal part of the
5937 functioning of your program. Others, such as @code{SIGSEGV}, indicate
5938 errors; these signals are @dfn{fatal} (they kill your program immediately) if the
5939 program has not specified in advance some other way to handle the signal.
5940 @code{SIGINT} does not indicate an error in your program, but it is normally
5941 fatal so it can carry out the purpose of the interrupt: to kill the program.
5943 @value{GDBN} has the ability to detect any occurrence of a signal in your
5944 program. You can tell @value{GDBN} in advance what to do for each kind of
5947 @cindex handling signals
5948 Normally, @value{GDBN} is set up to let the non-erroneous signals like
5949 @code{SIGALRM} be silently passed to your program
5950 (so as not to interfere with their role in the program's functioning)
5951 but to stop your program immediately whenever an error signal happens.
5952 You can change these settings with the @code{handle} command.
5955 @kindex info signals
5959 Print a table of all the kinds of signals and how @value{GDBN} has been told to
5960 handle each one. You can use this to see the signal numbers of all
5961 the defined types of signals.
5963 @item info signals @var{sig}
5964 Similar, but print information only about the specified signal number.
5966 @code{info handle} is an alias for @code{info signals}.
5968 @item catch signal @r{[}@var{signal}@dots{} @r{|} @samp{all}@r{]}
5969 Set a catchpoint for the indicated signals. @xref{Set Catchpoints},
5970 for details about this command.
5973 @item handle @var{signal} @r{[}@var{keywords}@dots{}@r{]}
5974 Change the way @value{GDBN} handles signal @var{signal}. The @var{signal}
5975 can be the number of a signal or its name (with or without the
5976 @samp{SIG} at the beginning); a list of signal numbers of the form
5977 @samp{@var{low}-@var{high}}; or the word @samp{all}, meaning all the
5978 known signals. Optional arguments @var{keywords}, described below,
5979 say what change to make.
5983 The keywords allowed by the @code{handle} command can be abbreviated.
5984 Their full names are:
5988 @value{GDBN} should not stop your program when this signal happens. It may
5989 still print a message telling you that the signal has come in.
5992 @value{GDBN} should stop your program when this signal happens. This implies
5993 the @code{print} keyword as well.
5996 @value{GDBN} should print a message when this signal happens.
5999 @value{GDBN} should not mention the occurrence of the signal at all. This
6000 implies the @code{nostop} keyword as well.
6004 @value{GDBN} should allow your program to see this signal; your program
6005 can handle the signal, or else it may terminate if the signal is fatal
6006 and not handled. @code{pass} and @code{noignore} are synonyms.
6010 @value{GDBN} should not allow your program to see this signal.
6011 @code{nopass} and @code{ignore} are synonyms.
6015 When a signal stops your program, the signal is not visible to the
6017 continue. Your program sees the signal then, if @code{pass} is in
6018 effect for the signal in question @emph{at that time}. In other words,
6019 after @value{GDBN} reports a signal, you can use the @code{handle}
6020 command with @code{pass} or @code{nopass} to control whether your
6021 program sees that signal when you continue.
6023 The default is set to @code{nostop}, @code{noprint}, @code{pass} for
6024 non-erroneous signals such as @code{SIGALRM}, @code{SIGWINCH} and
6025 @code{SIGCHLD}, and to @code{stop}, @code{print}, @code{pass} for the
6028 You can also use the @code{signal} command to prevent your program from
6029 seeing a signal, or cause it to see a signal it normally would not see,
6030 or to give it any signal at any time. For example, if your program stopped
6031 due to some sort of memory reference error, you might store correct
6032 values into the erroneous variables and continue, hoping to see more
6033 execution; but your program would probably terminate immediately as
6034 a result of the fatal signal once it saw the signal. To prevent this,
6035 you can continue with @samp{signal 0}. @xref{Signaling, ,Giving your
6038 @cindex stepping and signal handlers
6039 @anchor{stepping and signal handlers}
6041 @value{GDBN} optimizes for stepping the mainline code. If a signal
6042 that has @code{handle nostop} and @code{handle pass} set arrives while
6043 a stepping command (e.g., @code{stepi}, @code{step}, @code{next}) is
6044 in progress, @value{GDBN} lets the signal handler run and then resumes
6045 stepping the mainline code once the signal handler returns. In other
6046 words, @value{GDBN} steps over the signal handler. This prevents
6047 signals that you've specified as not interesting (with @code{handle
6048 nostop}) from changing the focus of debugging unexpectedly. Note that
6049 the signal handler itself may still hit a breakpoint, stop for another
6050 signal that has @code{handle stop} in effect, or for any other event
6051 that normally results in stopping the stepping command sooner. Also
6052 note that @value{GDBN} still informs you that the program received a
6053 signal if @code{handle print} is set.
6055 @anchor{stepping into signal handlers}
6057 If you set @code{handle pass} for a signal, and your program sets up a
6058 handler for it, then issuing a stepping command, such as @code{step}
6059 or @code{stepi}, when your program is stopped due to the signal will
6060 step @emph{into} the signal handler (if the target supports that).
6062 Likewise, if you use the @code{queue-signal} command to queue a signal
6063 to be delivered to the current thread when execution of the thread
6064 resumes (@pxref{Signaling, ,Giving your Program a Signal}), then a
6065 stepping command will step into the signal handler.
6067 Here's an example, using @code{stepi} to step to the first instruction
6068 of @code{SIGUSR1}'s handler:
6071 (@value{GDBP}) handle SIGUSR1
6072 Signal Stop Print Pass to program Description
6073 SIGUSR1 Yes Yes Yes User defined signal 1
6077 Program received signal SIGUSR1, User defined signal 1.
6078 main () sigusr1.c:28
6081 sigusr1_handler () at sigusr1.c:9
6085 The same, but using @code{queue-signal} instead of waiting for the
6086 program to receive the signal first:
6091 (@value{GDBP}) queue-signal SIGUSR1
6093 sigusr1_handler () at sigusr1.c:9
6098 @cindex extra signal information
6099 @anchor{extra signal information}
6101 On some targets, @value{GDBN} can inspect extra signal information
6102 associated with the intercepted signal, before it is actually
6103 delivered to the program being debugged. This information is exported
6104 by the convenience variable @code{$_siginfo}, and consists of data
6105 that is passed by the kernel to the signal handler at the time of the
6106 receipt of a signal. The data type of the information itself is
6107 target dependent. You can see the data type using the @code{ptype
6108 $_siginfo} command. On Unix systems, it typically corresponds to the
6109 standard @code{siginfo_t} type, as defined in the @file{signal.h}
6112 Here's an example, on a @sc{gnu}/Linux system, printing the stray
6113 referenced address that raised a segmentation fault.
6117 (@value{GDBP}) continue
6118 Program received signal SIGSEGV, Segmentation fault.
6119 0x0000000000400766 in main ()
6121 (@value{GDBP}) ptype $_siginfo
6128 struct @{...@} _kill;
6129 struct @{...@} _timer;
6131 struct @{...@} _sigchld;
6132 struct @{...@} _sigfault;
6133 struct @{...@} _sigpoll;
6136 (@value{GDBP}) ptype $_siginfo._sifields._sigfault
6140 (@value{GDBP}) p $_siginfo._sifields._sigfault.si_addr
6141 $1 = (void *) 0x7ffff7ff7000
6145 Depending on target support, @code{$_siginfo} may also be writable.
6147 @cindex Intel MPX boundary violations
6148 @cindex boundary violations, Intel MPX
6149 On some targets, a @code{SIGSEGV} can be caused by a boundary
6150 violation, i.e., accessing an address outside of the allowed range.
6151 In those cases @value{GDBN} may displays additional information,
6152 depending on how @value{GDBN} has been told to handle the signal.
6153 With @code{handle stop SIGSEGV}, @value{GDBN} displays the violation
6154 kind: "Upper" or "Lower", the memory address accessed and the
6155 bounds, while with @code{handle nostop SIGSEGV} no additional
6156 information is displayed.
6158 The usual output of a segfault is:
6160 Program received signal SIGSEGV, Segmentation fault
6161 0x0000000000400d7c in upper () at i386-mpx-sigsegv.c:68
6162 68 value = *(p + len);
6165 While a bound violation is presented as:
6167 Program received signal SIGSEGV, Segmentation fault
6168 Upper bound violation while accessing address 0x7fffffffc3b3
6169 Bounds: [lower = 0x7fffffffc390, upper = 0x7fffffffc3a3]
6170 0x0000000000400d7c in upper () at i386-mpx-sigsegv.c:68
6171 68 value = *(p + len);
6175 @section Stopping and Starting Multi-thread Programs
6177 @cindex stopped threads
6178 @cindex threads, stopped
6180 @cindex continuing threads
6181 @cindex threads, continuing
6183 @value{GDBN} supports debugging programs with multiple threads
6184 (@pxref{Threads,, Debugging Programs with Multiple Threads}). There
6185 are two modes of controlling execution of your program within the
6186 debugger. In the default mode, referred to as @dfn{all-stop mode},
6187 when any thread in your program stops (for example, at a breakpoint
6188 or while being stepped), all other threads in the program are also stopped by
6189 @value{GDBN}. On some targets, @value{GDBN} also supports
6190 @dfn{non-stop mode}, in which other threads can continue to run freely while
6191 you examine the stopped thread in the debugger.
6194 * All-Stop Mode:: All threads stop when GDB takes control
6195 * Non-Stop Mode:: Other threads continue to execute
6196 * Background Execution:: Running your program asynchronously
6197 * Thread-Specific Breakpoints:: Controlling breakpoints
6198 * Interrupted System Calls:: GDB may interfere with system calls
6199 * Observer Mode:: GDB does not alter program behavior
6203 @subsection All-Stop Mode
6205 @cindex all-stop mode
6207 In all-stop mode, whenever your program stops under @value{GDBN} for any reason,
6208 @emph{all} threads of execution stop, not just the current thread. This
6209 allows you to examine the overall state of the program, including
6210 switching between threads, without worrying that things may change
6213 Conversely, whenever you restart the program, @emph{all} threads start
6214 executing. @emph{This is true even when single-stepping} with commands
6215 like @code{step} or @code{next}.
6217 In particular, @value{GDBN} cannot single-step all threads in lockstep.
6218 Since thread scheduling is up to your debugging target's operating
6219 system (not controlled by @value{GDBN}), other threads may
6220 execute more than one statement while the current thread completes a
6221 single step. Moreover, in general other threads stop in the middle of a
6222 statement, rather than at a clean statement boundary, when the program
6225 You might even find your program stopped in another thread after
6226 continuing or even single-stepping. This happens whenever some other
6227 thread runs into a breakpoint, a signal, or an exception before the
6228 first thread completes whatever you requested.
6230 @cindex automatic thread selection
6231 @cindex switching threads automatically
6232 @cindex threads, automatic switching
6233 Whenever @value{GDBN} stops your program, due to a breakpoint or a
6234 signal, it automatically selects the thread where that breakpoint or
6235 signal happened. @value{GDBN} alerts you to the context switch with a
6236 message such as @samp{[Switching to Thread @var{n}]} to identify the
6239 On some OSes, you can modify @value{GDBN}'s default behavior by
6240 locking the OS scheduler to allow only a single thread to run.
6243 @item set scheduler-locking @var{mode}
6244 @cindex scheduler locking mode
6245 @cindex lock scheduler
6246 Set the scheduler locking mode. It applies to normal execution,
6247 record mode, and replay mode. If it is @code{off}, then there is no
6248 locking and any thread may run at any time. If @code{on}, then only
6249 the current thread may run when the inferior is resumed. The
6250 @code{step} mode optimizes for single-stepping; it prevents other
6251 threads from preempting the current thread while you are stepping, so
6252 that the focus of debugging does not change unexpectedly. Other
6253 threads never get a chance to run when you step, and they are
6254 completely free to run when you use commands like @samp{continue},
6255 @samp{until}, or @samp{finish}. However, unless another thread hits a
6256 breakpoint during its timeslice, @value{GDBN} does not change the
6257 current thread away from the thread that you are debugging. The
6258 @code{replay} mode behaves like @code{off} in record mode and like
6259 @code{on} in replay mode.
6261 @item show scheduler-locking
6262 Display the current scheduler locking mode.
6265 @cindex resume threads of multiple processes simultaneously
6266 By default, when you issue one of the execution commands such as
6267 @code{continue}, @code{next} or @code{step}, @value{GDBN} allows only
6268 threads of the current inferior to run. For example, if @value{GDBN}
6269 is attached to two inferiors, each with two threads, the
6270 @code{continue} command resumes only the two threads of the current
6271 inferior. This is useful, for example, when you debug a program that
6272 forks and you want to hold the parent stopped (so that, for instance,
6273 it doesn't run to exit), while you debug the child. In other
6274 situations, you may not be interested in inspecting the current state
6275 of any of the processes @value{GDBN} is attached to, and you may want
6276 to resume them all until some breakpoint is hit. In the latter case,
6277 you can instruct @value{GDBN} to allow all threads of all the
6278 inferiors to run with the @w{@code{set schedule-multiple}} command.
6281 @kindex set schedule-multiple
6282 @item set schedule-multiple
6283 Set the mode for allowing threads of multiple processes to be resumed
6284 when an execution command is issued. When @code{on}, all threads of
6285 all processes are allowed to run. When @code{off}, only the threads
6286 of the current process are resumed. The default is @code{off}. The
6287 @code{scheduler-locking} mode takes precedence when set to @code{on},
6288 or while you are stepping and set to @code{step}.
6290 @item show schedule-multiple
6291 Display the current mode for resuming the execution of threads of
6296 @subsection Non-Stop Mode
6298 @cindex non-stop mode
6300 @c This section is really only a place-holder, and needs to be expanded
6301 @c with more details.
6303 For some multi-threaded targets, @value{GDBN} supports an optional
6304 mode of operation in which you can examine stopped program threads in
6305 the debugger while other threads continue to execute freely. This
6306 minimizes intrusion when debugging live systems, such as programs
6307 where some threads have real-time constraints or must continue to
6308 respond to external events. This is referred to as @dfn{non-stop} mode.
6310 In non-stop mode, when a thread stops to report a debugging event,
6311 @emph{only} that thread is stopped; @value{GDBN} does not stop other
6312 threads as well, in contrast to the all-stop mode behavior. Additionally,
6313 execution commands such as @code{continue} and @code{step} apply by default
6314 only to the current thread in non-stop mode, rather than all threads as
6315 in all-stop mode. This allows you to control threads explicitly in
6316 ways that are not possible in all-stop mode --- for example, stepping
6317 one thread while allowing others to run freely, stepping
6318 one thread while holding all others stopped, or stepping several threads
6319 independently and simultaneously.
6321 To enter non-stop mode, use this sequence of commands before you run
6322 or attach to your program:
6325 # If using the CLI, pagination breaks non-stop.
6328 # Finally, turn it on!
6332 You can use these commands to manipulate the non-stop mode setting:
6335 @kindex set non-stop
6336 @item set non-stop on
6337 Enable selection of non-stop mode.
6338 @item set non-stop off
6339 Disable selection of non-stop mode.
6340 @kindex show non-stop
6342 Show the current non-stop enablement setting.
6345 Note these commands only reflect whether non-stop mode is enabled,
6346 not whether the currently-executing program is being run in non-stop mode.
6347 In particular, the @code{set non-stop} preference is only consulted when
6348 @value{GDBN} starts or connects to the target program, and it is generally
6349 not possible to switch modes once debugging has started. Furthermore,
6350 since not all targets support non-stop mode, even when you have enabled
6351 non-stop mode, @value{GDBN} may still fall back to all-stop operation by
6354 In non-stop mode, all execution commands apply only to the current thread
6355 by default. That is, @code{continue} only continues one thread.
6356 To continue all threads, issue @code{continue -a} or @code{c -a}.
6358 You can use @value{GDBN}'s background execution commands
6359 (@pxref{Background Execution}) to run some threads in the background
6360 while you continue to examine or step others from @value{GDBN}.
6361 The MI execution commands (@pxref{GDB/MI Program Execution}) are
6362 always executed asynchronously in non-stop mode.
6364 Suspending execution is done with the @code{interrupt} command when
6365 running in the background, or @kbd{Ctrl-c} during foreground execution.
6366 In all-stop mode, this stops the whole process;
6367 but in non-stop mode the interrupt applies only to the current thread.
6368 To stop the whole program, use @code{interrupt -a}.
6370 Other execution commands do not currently support the @code{-a} option.
6372 In non-stop mode, when a thread stops, @value{GDBN} doesn't automatically make
6373 that thread current, as it does in all-stop mode. This is because the
6374 thread stop notifications are asynchronous with respect to @value{GDBN}'s
6375 command interpreter, and it would be confusing if @value{GDBN} unexpectedly
6376 changed to a different thread just as you entered a command to operate on the
6377 previously current thread.
6379 @node Background Execution
6380 @subsection Background Execution
6382 @cindex foreground execution
6383 @cindex background execution
6384 @cindex asynchronous execution
6385 @cindex execution, foreground, background and asynchronous
6387 @value{GDBN}'s execution commands have two variants: the normal
6388 foreground (synchronous) behavior, and a background
6389 (asynchronous) behavior. In foreground execution, @value{GDBN} waits for
6390 the program to report that some thread has stopped before prompting for
6391 another command. In background execution, @value{GDBN} immediately gives
6392 a command prompt so that you can issue other commands while your program runs.
6394 If the target doesn't support async mode, @value{GDBN} issues an error
6395 message if you attempt to use the background execution commands.
6397 @cindex @code{&}, background execution of commands
6398 To specify background execution, add a @code{&} to the command. For example,
6399 the background form of the @code{continue} command is @code{continue&}, or
6400 just @code{c&}. The execution commands that accept background execution
6406 @xref{Starting, , Starting your Program}.
6410 @xref{Attach, , Debugging an Already-running Process}.
6414 @xref{Continuing and Stepping, step}.
6418 @xref{Continuing and Stepping, stepi}.
6422 @xref{Continuing and Stepping, next}.
6426 @xref{Continuing and Stepping, nexti}.
6430 @xref{Continuing and Stepping, continue}.
6434 @xref{Continuing and Stepping, finish}.
6438 @xref{Continuing and Stepping, until}.
6442 Background execution is especially useful in conjunction with non-stop
6443 mode for debugging programs with multiple threads; see @ref{Non-Stop Mode}.
6444 However, you can also use these commands in the normal all-stop mode with
6445 the restriction that you cannot issue another execution command until the
6446 previous one finishes. Examples of commands that are valid in all-stop
6447 mode while the program is running include @code{help} and @code{info break}.
6449 You can interrupt your program while it is running in the background by
6450 using the @code{interrupt} command.
6457 Suspend execution of the running program. In all-stop mode,
6458 @code{interrupt} stops the whole process, but in non-stop mode, it stops
6459 only the current thread. To stop the whole program in non-stop mode,
6460 use @code{interrupt -a}.
6463 @node Thread-Specific Breakpoints
6464 @subsection Thread-Specific Breakpoints
6466 When your program has multiple threads (@pxref{Threads,, Debugging
6467 Programs with Multiple Threads}), you can choose whether to set
6468 breakpoints on all threads, or on a particular thread.
6471 @cindex breakpoints and threads
6472 @cindex thread breakpoints
6473 @kindex break @dots{} thread @var{thread-id}
6474 @item break @var{location} thread @var{thread-id}
6475 @itemx break @var{location} thread @var{thread-id} if @dots{}
6476 @var{location} specifies source lines; there are several ways of
6477 writing them (@pxref{Specify Location}), but the effect is always to
6478 specify some source line.
6480 Use the qualifier @samp{thread @var{thread-id}} with a breakpoint command
6481 to specify that you only want @value{GDBN} to stop the program when a
6482 particular thread reaches this breakpoint. The @var{thread-id} specifier
6483 is one of the thread identifiers assigned by @value{GDBN}, shown
6484 in the first column of the @samp{info threads} display.
6486 If you do not specify @samp{thread @var{thread-id}} when you set a
6487 breakpoint, the breakpoint applies to @emph{all} threads of your
6490 You can use the @code{thread} qualifier on conditional breakpoints as
6491 well; in this case, place @samp{thread @var{thread-id}} before or
6492 after the breakpoint condition, like this:
6495 (@value{GDBP}) break frik.c:13 thread 28 if bartab > lim
6500 Thread-specific breakpoints are automatically deleted when
6501 @value{GDBN} detects the corresponding thread is no longer in the
6502 thread list. For example:
6506 Thread-specific breakpoint 3 deleted - thread 28 no longer in the thread list.
6509 There are several ways for a thread to disappear, such as a regular
6510 thread exit, but also when you detach from the process with the
6511 @code{detach} command (@pxref{Attach, ,Debugging an Already-running
6512 Process}), or if @value{GDBN} loses the remote connection
6513 (@pxref{Remote Debugging}), etc. Note that with some targets,
6514 @value{GDBN} is only able to detect a thread has exited when the user
6515 explictly asks for the thread list with the @code{info threads}
6518 @node Interrupted System Calls
6519 @subsection Interrupted System Calls
6521 @cindex thread breakpoints and system calls
6522 @cindex system calls and thread breakpoints
6523 @cindex premature return from system calls
6524 There is an unfortunate side effect when using @value{GDBN} to debug
6525 multi-threaded programs. If one thread stops for a
6526 breakpoint, or for some other reason, and another thread is blocked in a
6527 system call, then the system call may return prematurely. This is a
6528 consequence of the interaction between multiple threads and the signals
6529 that @value{GDBN} uses to implement breakpoints and other events that
6532 To handle this problem, your program should check the return value of
6533 each system call and react appropriately. This is good programming
6536 For example, do not write code like this:
6542 The call to @code{sleep} will return early if a different thread stops
6543 at a breakpoint or for some other reason.
6545 Instead, write this:
6550 unslept = sleep (unslept);
6553 A system call is allowed to return early, so the system is still
6554 conforming to its specification. But @value{GDBN} does cause your
6555 multi-threaded program to behave differently than it would without
6558 Also, @value{GDBN} uses internal breakpoints in the thread library to
6559 monitor certain events such as thread creation and thread destruction.
6560 When such an event happens, a system call in another thread may return
6561 prematurely, even though your program does not appear to stop.
6564 @subsection Observer Mode
6566 If you want to build on non-stop mode and observe program behavior
6567 without any chance of disruption by @value{GDBN}, you can set
6568 variables to disable all of the debugger's attempts to modify state,
6569 whether by writing memory, inserting breakpoints, etc. These operate
6570 at a low level, intercepting operations from all commands.
6572 When all of these are set to @code{off}, then @value{GDBN} is said to
6573 be @dfn{observer mode}. As a convenience, the variable
6574 @code{observer} can be set to disable these, plus enable non-stop
6577 Note that @value{GDBN} will not prevent you from making nonsensical
6578 combinations of these settings. For instance, if you have enabled
6579 @code{may-insert-breakpoints} but disabled @code{may-write-memory},
6580 then breakpoints that work by writing trap instructions into the code
6581 stream will still not be able to be placed.
6586 @item set observer on
6587 @itemx set observer off
6588 When set to @code{on}, this disables all the permission variables
6589 below (except for @code{insert-fast-tracepoints}), plus enables
6590 non-stop debugging. Setting this to @code{off} switches back to
6591 normal debugging, though remaining in non-stop mode.
6594 Show whether observer mode is on or off.
6596 @kindex may-write-registers
6597 @item set may-write-registers on
6598 @itemx set may-write-registers off
6599 This controls whether @value{GDBN} will attempt to alter the values of
6600 registers, such as with assignment expressions in @code{print}, or the
6601 @code{jump} command. It defaults to @code{on}.
6603 @item show may-write-registers
6604 Show the current permission to write registers.
6606 @kindex may-write-memory
6607 @item set may-write-memory on
6608 @itemx set may-write-memory off
6609 This controls whether @value{GDBN} will attempt to alter the contents
6610 of memory, such as with assignment expressions in @code{print}. It
6611 defaults to @code{on}.
6613 @item show may-write-memory
6614 Show the current permission to write memory.
6616 @kindex may-insert-breakpoints
6617 @item set may-insert-breakpoints on
6618 @itemx set may-insert-breakpoints off
6619 This controls whether @value{GDBN} will attempt to insert breakpoints.
6620 This affects all breakpoints, including internal breakpoints defined
6621 by @value{GDBN}. It defaults to @code{on}.
6623 @item show may-insert-breakpoints
6624 Show the current permission to insert breakpoints.
6626 @kindex may-insert-tracepoints
6627 @item set may-insert-tracepoints on
6628 @itemx set may-insert-tracepoints off
6629 This controls whether @value{GDBN} will attempt to insert (regular)
6630 tracepoints at the beginning of a tracing experiment. It affects only
6631 non-fast tracepoints, fast tracepoints being under the control of
6632 @code{may-insert-fast-tracepoints}. It defaults to @code{on}.
6634 @item show may-insert-tracepoints
6635 Show the current permission to insert tracepoints.
6637 @kindex may-insert-fast-tracepoints
6638 @item set may-insert-fast-tracepoints on
6639 @itemx set may-insert-fast-tracepoints off
6640 This controls whether @value{GDBN} will attempt to insert fast
6641 tracepoints at the beginning of a tracing experiment. It affects only
6642 fast tracepoints, regular (non-fast) tracepoints being under the
6643 control of @code{may-insert-tracepoints}. It defaults to @code{on}.
6645 @item show may-insert-fast-tracepoints
6646 Show the current permission to insert fast tracepoints.
6648 @kindex may-interrupt
6649 @item set may-interrupt on
6650 @itemx set may-interrupt off
6651 This controls whether @value{GDBN} will attempt to interrupt or stop
6652 program execution. When this variable is @code{off}, the
6653 @code{interrupt} command will have no effect, nor will
6654 @kbd{Ctrl-c}. It defaults to @code{on}.
6656 @item show may-interrupt
6657 Show the current permission to interrupt or stop the program.
6661 @node Reverse Execution
6662 @chapter Running programs backward
6663 @cindex reverse execution
6664 @cindex running programs backward
6666 When you are debugging a program, it is not unusual to realize that
6667 you have gone too far, and some event of interest has already happened.
6668 If the target environment supports it, @value{GDBN} can allow you to
6669 ``rewind'' the program by running it backward.
6671 A target environment that supports reverse execution should be able
6672 to ``undo'' the changes in machine state that have taken place as the
6673 program was executing normally. Variables, registers etc.@: should
6674 revert to their previous values. Obviously this requires a great
6675 deal of sophistication on the part of the target environment; not
6676 all target environments can support reverse execution.
6678 When a program is executed in reverse, the instructions that
6679 have most recently been executed are ``un-executed'', in reverse
6680 order. The program counter runs backward, following the previous
6681 thread of execution in reverse. As each instruction is ``un-executed'',
6682 the values of memory and/or registers that were changed by that
6683 instruction are reverted to their previous states. After executing
6684 a piece of source code in reverse, all side effects of that code
6685 should be ``undone'', and all variables should be returned to their
6686 prior values@footnote{
6687 Note that some side effects are easier to undo than others. For instance,
6688 memory and registers are relatively easy, but device I/O is hard. Some
6689 targets may be able undo things like device I/O, and some may not.
6691 The contract between @value{GDBN} and the reverse executing target
6692 requires only that the target do something reasonable when
6693 @value{GDBN} tells it to execute backwards, and then report the
6694 results back to @value{GDBN}. Whatever the target reports back to
6695 @value{GDBN}, @value{GDBN} will report back to the user. @value{GDBN}
6696 assumes that the memory and registers that the target reports are in a
6697 consistant state, but @value{GDBN} accepts whatever it is given.
6700 If you are debugging in a target environment that supports
6701 reverse execution, @value{GDBN} provides the following commands.
6704 @kindex reverse-continue
6705 @kindex rc @r{(@code{reverse-continue})}
6706 @item reverse-continue @r{[}@var{ignore-count}@r{]}
6707 @itemx rc @r{[}@var{ignore-count}@r{]}
6708 Beginning at the point where your program last stopped, start executing
6709 in reverse. Reverse execution will stop for breakpoints and synchronous
6710 exceptions (signals), just like normal execution. Behavior of
6711 asynchronous signals depends on the target environment.
6713 @kindex reverse-step
6714 @kindex rs @r{(@code{step})}
6715 @item reverse-step @r{[}@var{count}@r{]}
6716 Run the program backward until control reaches the start of a
6717 different source line; then stop it, and return control to @value{GDBN}.
6719 Like the @code{step} command, @code{reverse-step} will only stop
6720 at the beginning of a source line. It ``un-executes'' the previously
6721 executed source line. If the previous source line included calls to
6722 debuggable functions, @code{reverse-step} will step (backward) into
6723 the called function, stopping at the beginning of the @emph{last}
6724 statement in the called function (typically a return statement).
6726 Also, as with the @code{step} command, if non-debuggable functions are
6727 called, @code{reverse-step} will run thru them backward without stopping.
6729 @kindex reverse-stepi
6730 @kindex rsi @r{(@code{reverse-stepi})}
6731 @item reverse-stepi @r{[}@var{count}@r{]}
6732 Reverse-execute one machine instruction. Note that the instruction
6733 to be reverse-executed is @emph{not} the one pointed to by the program
6734 counter, but the instruction executed prior to that one. For instance,
6735 if the last instruction was a jump, @code{reverse-stepi} will take you
6736 back from the destination of the jump to the jump instruction itself.
6738 @kindex reverse-next
6739 @kindex rn @r{(@code{reverse-next})}
6740 @item reverse-next @r{[}@var{count}@r{]}
6741 Run backward to the beginning of the previous line executed in
6742 the current (innermost) stack frame. If the line contains function
6743 calls, they will be ``un-executed'' without stopping. Starting from
6744 the first line of a function, @code{reverse-next} will take you back
6745 to the caller of that function, @emph{before} the function was called,
6746 just as the normal @code{next} command would take you from the last
6747 line of a function back to its return to its caller
6748 @footnote{Unless the code is too heavily optimized.}.
6750 @kindex reverse-nexti
6751 @kindex rni @r{(@code{reverse-nexti})}
6752 @item reverse-nexti @r{[}@var{count}@r{]}
6753 Like @code{nexti}, @code{reverse-nexti} executes a single instruction
6754 in reverse, except that called functions are ``un-executed'' atomically.
6755 That is, if the previously executed instruction was a return from
6756 another function, @code{reverse-nexti} will continue to execute
6757 in reverse until the call to that function (from the current stack
6760 @kindex reverse-finish
6761 @item reverse-finish
6762 Just as the @code{finish} command takes you to the point where the
6763 current function returns, @code{reverse-finish} takes you to the point
6764 where it was called. Instead of ending up at the end of the current
6765 function invocation, you end up at the beginning.
6767 @kindex set exec-direction
6768 @item set exec-direction
6769 Set the direction of target execution.
6770 @item set exec-direction reverse
6771 @cindex execute forward or backward in time
6772 @value{GDBN} will perform all execution commands in reverse, until the
6773 exec-direction mode is changed to ``forward''. Affected commands include
6774 @code{step, stepi, next, nexti, continue, and finish}. The @code{return}
6775 command cannot be used in reverse mode.
6776 @item set exec-direction forward
6777 @value{GDBN} will perform all execution commands in the normal fashion.
6778 This is the default.
6782 @node Process Record and Replay
6783 @chapter Recording Inferior's Execution and Replaying It
6784 @cindex process record and replay
6785 @cindex recording inferior's execution and replaying it
6787 On some platforms, @value{GDBN} provides a special @dfn{process record
6788 and replay} target that can record a log of the process execution, and
6789 replay it later with both forward and reverse execution commands.
6792 When this target is in use, if the execution log includes the record
6793 for the next instruction, @value{GDBN} will debug in @dfn{replay
6794 mode}. In the replay mode, the inferior does not really execute code
6795 instructions. Instead, all the events that normally happen during
6796 code execution are taken from the execution log. While code is not
6797 really executed in replay mode, the values of registers (including the
6798 program counter register) and the memory of the inferior are still
6799 changed as they normally would. Their contents are taken from the
6803 If the record for the next instruction is not in the execution log,
6804 @value{GDBN} will debug in @dfn{record mode}. In this mode, the
6805 inferior executes normally, and @value{GDBN} records the execution log
6808 The process record and replay target supports reverse execution
6809 (@pxref{Reverse Execution}), even if the platform on which the
6810 inferior runs does not. However, the reverse execution is limited in
6811 this case by the range of the instructions recorded in the execution
6812 log. In other words, reverse execution on platforms that don't
6813 support it directly can only be done in the replay mode.
6815 When debugging in the reverse direction, @value{GDBN} will work in
6816 replay mode as long as the execution log includes the record for the
6817 previous instruction; otherwise, it will work in record mode, if the
6818 platform supports reverse execution, or stop if not.
6820 For architecture environments that support process record and replay,
6821 @value{GDBN} provides the following commands:
6824 @kindex target record
6825 @kindex target record-full
6826 @kindex target record-btrace
6829 @kindex record btrace
6830 @kindex record btrace bts
6831 @kindex record btrace pt
6837 @kindex rec btrace bts
6838 @kindex rec btrace pt
6841 @item record @var{method}
6842 This command starts the process record and replay target. The
6843 recording method can be specified as parameter. Without a parameter
6844 the command uses the @code{full} recording method. The following
6845 recording methods are available:
6849 Full record/replay recording using @value{GDBN}'s software record and
6850 replay implementation. This method allows replaying and reverse
6853 @item btrace @var{format}
6854 Hardware-supported instruction recording. This method does not record
6855 data. Further, the data is collected in a ring buffer so old data will
6856 be overwritten when the buffer is full. It allows limited reverse
6857 execution. Variables and registers are not available during reverse
6858 execution. In remote debugging, recording continues on disconnect.
6859 Recorded data can be inspected after reconnecting. The recording may
6860 be stopped using @code{record stop}.
6862 The recording format can be specified as parameter. Without a parameter
6863 the command chooses the recording format. The following recording
6864 formats are available:
6868 @cindex branch trace store
6869 Use the @dfn{Branch Trace Store} (@acronym{BTS}) recording format. In
6870 this format, the processor stores a from/to record for each executed
6871 branch in the btrace ring buffer.
6874 @cindex Intel Processor Trace
6875 Use the @dfn{Intel Processor Trace} recording format. In this
6876 format, the processor stores the execution trace in a compressed form
6877 that is afterwards decoded by @value{GDBN}.
6879 The trace can be recorded with very low overhead. The compressed
6880 trace format also allows small trace buffers to already contain a big
6881 number of instructions compared to @acronym{BTS}.
6883 Decoding the recorded execution trace, on the other hand, is more
6884 expensive than decoding @acronym{BTS} trace. This is mostly due to the
6885 increased number of instructions to process. You should increase the
6886 buffer-size with care.
6889 Not all recording formats may be available on all processors.
6892 The process record and replay target can only debug a process that is
6893 already running. Therefore, you need first to start the process with
6894 the @kbd{run} or @kbd{start} commands, and then start the recording
6895 with the @kbd{record @var{method}} command.
6897 @cindex displaced stepping, and process record and replay
6898 Displaced stepping (@pxref{Maintenance Commands,, displaced stepping})
6899 will be automatically disabled when process record and replay target
6900 is started. That's because the process record and replay target
6901 doesn't support displaced stepping.
6903 @cindex non-stop mode, and process record and replay
6904 @cindex asynchronous execution, and process record and replay
6905 If the inferior is in the non-stop mode (@pxref{Non-Stop Mode}) or in
6906 the asynchronous execution mode (@pxref{Background Execution}), not
6907 all recording methods are available. The @code{full} recording method
6908 does not support these two modes.
6913 Stop the process record and replay target. When process record and
6914 replay target stops, the entire execution log will be deleted and the
6915 inferior will either be terminated, or will remain in its final state.
6917 When you stop the process record and replay target in record mode (at
6918 the end of the execution log), the inferior will be stopped at the
6919 next instruction that would have been recorded. In other words, if
6920 you record for a while and then stop recording, the inferior process
6921 will be left in the same state as if the recording never happened.
6923 On the other hand, if the process record and replay target is stopped
6924 while in replay mode (that is, not at the end of the execution log,
6925 but at some earlier point), the inferior process will become ``live''
6926 at that earlier state, and it will then be possible to continue the
6927 usual ``live'' debugging of the process from that state.
6929 When the inferior process exits, or @value{GDBN} detaches from it,
6930 process record and replay target will automatically stop itself.
6934 Go to a specific location in the execution log. There are several
6935 ways to specify the location to go to:
6938 @item record goto begin
6939 @itemx record goto start
6940 Go to the beginning of the execution log.
6942 @item record goto end
6943 Go to the end of the execution log.
6945 @item record goto @var{n}
6946 Go to instruction number @var{n} in the execution log.
6950 @item record save @var{filename}
6951 Save the execution log to a file @file{@var{filename}}.
6952 Default filename is @file{gdb_record.@var{process_id}}, where
6953 @var{process_id} is the process ID of the inferior.
6955 This command may not be available for all recording methods.
6957 @kindex record restore
6958 @item record restore @var{filename}
6959 Restore the execution log from a file @file{@var{filename}}.
6960 File must have been created with @code{record save}.
6962 @kindex set record full
6963 @item set record full insn-number-max @var{limit}
6964 @itemx set record full insn-number-max unlimited
6965 Set the limit of instructions to be recorded for the @code{full}
6966 recording method. Default value is 200000.
6968 If @var{limit} is a positive number, then @value{GDBN} will start
6969 deleting instructions from the log once the number of the record
6970 instructions becomes greater than @var{limit}. For every new recorded
6971 instruction, @value{GDBN} will delete the earliest recorded
6972 instruction to keep the number of recorded instructions at the limit.
6973 (Since deleting recorded instructions loses information, @value{GDBN}
6974 lets you control what happens when the limit is reached, by means of
6975 the @code{stop-at-limit} option, described below.)
6977 If @var{limit} is @code{unlimited} or zero, @value{GDBN} will never
6978 delete recorded instructions from the execution log. The number of
6979 recorded instructions is limited only by the available memory.
6981 @kindex show record full
6982 @item show record full insn-number-max
6983 Show the limit of instructions to be recorded with the @code{full}
6986 @item set record full stop-at-limit
6987 Control the behavior of the @code{full} recording method when the
6988 number of recorded instructions reaches the limit. If ON (the
6989 default), @value{GDBN} will stop when the limit is reached for the
6990 first time and ask you whether you want to stop the inferior or
6991 continue running it and recording the execution log. If you decide
6992 to continue recording, each new recorded instruction will cause the
6993 oldest one to be deleted.
6995 If this option is OFF, @value{GDBN} will automatically delete the
6996 oldest record to make room for each new one, without asking.
6998 @item show record full stop-at-limit
6999 Show the current setting of @code{stop-at-limit}.
7001 @item set record full memory-query
7002 Control the behavior when @value{GDBN} is unable to record memory
7003 changes caused by an instruction for the @code{full} recording method.
7004 If ON, @value{GDBN} will query whether to stop the inferior in that
7007 If this option is OFF (the default), @value{GDBN} will automatically
7008 ignore the effect of such instructions on memory. Later, when
7009 @value{GDBN} replays this execution log, it will mark the log of this
7010 instruction as not accessible, and it will not affect the replay
7013 @item show record full memory-query
7014 Show the current setting of @code{memory-query}.
7016 @kindex set record btrace
7017 The @code{btrace} record target does not trace data. As a
7018 convenience, when replaying, @value{GDBN} reads read-only memory off
7019 the live program directly, assuming that the addresses of the
7020 read-only areas don't change. This for example makes it possible to
7021 disassemble code while replaying, but not to print variables.
7022 In some cases, being able to inspect variables might be useful.
7023 You can use the following command for that:
7025 @item set record btrace replay-memory-access
7026 Control the behavior of the @code{btrace} recording method when
7027 accessing memory during replay. If @code{read-only} (the default),
7028 @value{GDBN} will only allow accesses to read-only memory.
7029 If @code{read-write}, @value{GDBN} will allow accesses to read-only
7030 and to read-write memory. Beware that the accessed memory corresponds
7031 to the live target and not necessarily to the current replay
7034 @item set record btrace cpu @var{identifier}
7035 Set the processor to be used for enabling workarounds for processor
7036 errata when decoding the trace.
7038 Processor errata are defects in processor operation, caused by its
7039 design or manufacture. They can cause a trace not to match the
7040 specification. This, in turn, may cause trace decode to fail.
7041 @value{GDBN} can detect erroneous trace packets and correct them, thus
7042 avoiding the decoding failures. These corrections are known as
7043 @dfn{errata workarounds}, and are enabled based on the processor on
7044 which the trace was recorded.
7046 By default, @value{GDBN} attempts to detect the processor
7047 automatically, and apply the necessary workarounds for it. However,
7048 you may need to specify the processor if @value{GDBN} does not yet
7049 support it. This command allows you to do that, and also allows to
7050 disable the workarounds.
7052 The argument @var{identifier} identifies the @sc{cpu} and is of the
7053 form: @code{@var{vendor}:@var{procesor identifier}}. In addition,
7054 there are two special identifiers, @code{none} and @code{auto}
7057 The following vendor identifiers and corresponding processor
7058 identifiers are currently supported:
7060 @multitable @columnfractions .1 .9
7063 @tab @var{family}/@var{model}[/@var{stepping}]
7067 On GNU/Linux systems, the processor @var{family}, @var{model}, and
7068 @var{stepping} can be obtained from @code{/proc/cpuinfo}.
7070 If @var{identifier} is @code{auto}, enable errata workarounds for the
7071 processor on which the trace was recorded. If @var{identifier} is
7072 @code{none}, errata workarounds are disabled.
7074 For example, when using an old @value{GDBN} on a new system, decode
7075 may fail because @value{GDBN} does not support the new processor. It
7076 often suffices to specify an older processor that @value{GDBN}
7081 Active record target: record-btrace
7082 Recording format: Intel Processor Trace.
7084 Failed to configure the Intel Processor Trace decoder: unknown cpu.
7085 (gdb) set record btrace cpu intel:6/158
7087 Active record target: record-btrace
7088 Recording format: Intel Processor Trace.
7090 Recorded 84872 instructions in 3189 functions (0 gaps) for thread 1 (...).
7093 @kindex show record btrace
7094 @item show record btrace replay-memory-access
7095 Show the current setting of @code{replay-memory-access}.
7097 @item show record btrace cpu
7098 Show the processor to be used for enabling trace decode errata
7101 @kindex set record btrace bts
7102 @item set record btrace bts buffer-size @var{size}
7103 @itemx set record btrace bts buffer-size unlimited
7104 Set the requested ring buffer size for branch tracing in @acronym{BTS}
7105 format. Default is 64KB.
7107 If @var{size} is a positive number, then @value{GDBN} will try to
7108 allocate a buffer of at least @var{size} bytes for each new thread
7109 that uses the btrace recording method and the @acronym{BTS} format.
7110 The actually obtained buffer size may differ from the requested
7111 @var{size}. Use the @code{info record} command to see the actual
7112 buffer size for each thread that uses the btrace recording method and
7113 the @acronym{BTS} format.
7115 If @var{limit} is @code{unlimited} or zero, @value{GDBN} will try to
7116 allocate a buffer of 4MB.
7118 Bigger buffers mean longer traces. On the other hand, @value{GDBN} will
7119 also need longer to process the branch trace data before it can be used.
7121 @item show record btrace bts buffer-size @var{size}
7122 Show the current setting of the requested ring buffer size for branch
7123 tracing in @acronym{BTS} format.
7125 @kindex set record btrace pt
7126 @item set record btrace pt buffer-size @var{size}
7127 @itemx set record btrace pt buffer-size unlimited
7128 Set the requested ring buffer size for branch tracing in Intel
7129 Processor Trace format. Default is 16KB.
7131 If @var{size} is a positive number, then @value{GDBN} will try to
7132 allocate a buffer of at least @var{size} bytes for each new thread
7133 that uses the btrace recording method and the Intel Processor Trace
7134 format. The actually obtained buffer size may differ from the
7135 requested @var{size}. Use the @code{info record} command to see the
7136 actual buffer size for each thread.
7138 If @var{limit} is @code{unlimited} or zero, @value{GDBN} will try to
7139 allocate a buffer of 4MB.
7141 Bigger buffers mean longer traces. On the other hand, @value{GDBN} will
7142 also need longer to process the branch trace data before it can be used.
7144 @item show record btrace pt buffer-size @var{size}
7145 Show the current setting of the requested ring buffer size for branch
7146 tracing in Intel Processor Trace format.
7150 Show various statistics about the recording depending on the recording
7155 For the @code{full} recording method, it shows the state of process
7156 record and its in-memory execution log buffer, including:
7160 Whether in record mode or replay mode.
7162 Lowest recorded instruction number (counting from when the current execution log started recording instructions).
7164 Highest recorded instruction number.
7166 Current instruction about to be replayed (if in replay mode).
7168 Number of instructions contained in the execution log.
7170 Maximum number of instructions that may be contained in the execution log.
7174 For the @code{btrace} recording method, it shows:
7180 Number of instructions that have been recorded.
7182 Number of blocks of sequential control-flow formed by the recorded
7185 Whether in record mode or replay mode.
7188 For the @code{bts} recording format, it also shows:
7191 Size of the perf ring buffer.
7194 For the @code{pt} recording format, it also shows:
7197 Size of the perf ring buffer.
7201 @kindex record delete
7204 When record target runs in replay mode (``in the past''), delete the
7205 subsequent execution log and begin to record a new execution log starting
7206 from the current address. This means you will abandon the previously
7207 recorded ``future'' and begin recording a new ``future''.
7209 @kindex record instruction-history
7210 @kindex rec instruction-history
7211 @item record instruction-history
7212 Disassembles instructions from the recorded execution log. By
7213 default, ten instructions are disassembled. This can be changed using
7214 the @code{set record instruction-history-size} command. Instructions
7215 are printed in execution order.
7217 It can also print mixed source+disassembly if you specify the the
7218 @code{/m} or @code{/s} modifier, and print the raw instructions in hex
7219 as well as in symbolic form by specifying the @code{/r} modifier.
7221 The current position marker is printed for the instruction at the
7222 current program counter value. This instruction can appear multiple
7223 times in the trace and the current position marker will be printed
7224 every time. To omit the current position marker, specify the
7227 To better align the printed instructions when the trace contains
7228 instructions from more than one function, the function name may be
7229 omitted by specifying the @code{/f} modifier.
7231 Speculatively executed instructions are prefixed with @samp{?}. This
7232 feature is not available for all recording formats.
7234 There are several ways to specify what part of the execution log to
7238 @item record instruction-history @var{insn}
7239 Disassembles ten instructions starting from instruction number
7242 @item record instruction-history @var{insn}, +/-@var{n}
7243 Disassembles @var{n} instructions around instruction number
7244 @var{insn}. If @var{n} is preceded with @code{+}, disassembles
7245 @var{n} instructions after instruction number @var{insn}. If
7246 @var{n} is preceded with @code{-}, disassembles @var{n}
7247 instructions before instruction number @var{insn}.
7249 @item record instruction-history
7250 Disassembles ten more instructions after the last disassembly.
7252 @item record instruction-history -
7253 Disassembles ten more instructions before the last disassembly.
7255 @item record instruction-history @var{begin}, @var{end}
7256 Disassembles instructions beginning with instruction number
7257 @var{begin} until instruction number @var{end}. The instruction
7258 number @var{end} is included.
7261 This command may not be available for all recording methods.
7264 @item set record instruction-history-size @var{size}
7265 @itemx set record instruction-history-size unlimited
7266 Define how many instructions to disassemble in the @code{record
7267 instruction-history} command. The default value is 10.
7268 A @var{size} of @code{unlimited} means unlimited instructions.
7271 @item show record instruction-history-size
7272 Show how many instructions to disassemble in the @code{record
7273 instruction-history} command.
7275 @kindex record function-call-history
7276 @kindex rec function-call-history
7277 @item record function-call-history
7278 Prints the execution history at function granularity. It prints one
7279 line for each sequence of instructions that belong to the same
7280 function giving the name of that function, the source lines
7281 for this instruction sequence (if the @code{/l} modifier is
7282 specified), and the instructions numbers that form the sequence (if
7283 the @code{/i} modifier is specified). The function names are indented
7284 to reflect the call stack depth if the @code{/c} modifier is
7285 specified. The @code{/l}, @code{/i}, and @code{/c} modifiers can be
7289 (@value{GDBP}) @b{list 1, 10}
7300 (@value{GDBP}) @b{record function-call-history /ilc}
7301 1 bar inst 1,4 at foo.c:6,8
7302 2 foo inst 5,10 at foo.c:2,3
7303 3 bar inst 11,13 at foo.c:9,10
7306 By default, ten lines are printed. This can be changed using the
7307 @code{set record function-call-history-size} command. Functions are
7308 printed in execution order. There are several ways to specify what
7312 @item record function-call-history @var{func}
7313 Prints ten functions starting from function number @var{func}.
7315 @item record function-call-history @var{func}, +/-@var{n}
7316 Prints @var{n} functions around function number @var{func}. If
7317 @var{n} is preceded with @code{+}, prints @var{n} functions after
7318 function number @var{func}. If @var{n} is preceded with @code{-},
7319 prints @var{n} functions before function number @var{func}.
7321 @item record function-call-history
7322 Prints ten more functions after the last ten-line print.
7324 @item record function-call-history -
7325 Prints ten more functions before the last ten-line print.
7327 @item record function-call-history @var{begin}, @var{end}
7328 Prints functions beginning with function number @var{begin} until
7329 function number @var{end}. The function number @var{end} is included.
7332 This command may not be available for all recording methods.
7334 @item set record function-call-history-size @var{size}
7335 @itemx set record function-call-history-size unlimited
7336 Define how many lines to print in the
7337 @code{record function-call-history} command. The default value is 10.
7338 A size of @code{unlimited} means unlimited lines.
7340 @item show record function-call-history-size
7341 Show how many lines to print in the
7342 @code{record function-call-history} command.
7347 @chapter Examining the Stack
7349 When your program has stopped, the first thing you need to know is where it
7350 stopped and how it got there.
7353 Each time your program performs a function call, information about the call
7355 That information includes the location of the call in your program,
7356 the arguments of the call,
7357 and the local variables of the function being called.
7358 The information is saved in a block of data called a @dfn{stack frame}.
7359 The stack frames are allocated in a region of memory called the @dfn{call
7362 When your program stops, the @value{GDBN} commands for examining the
7363 stack allow you to see all of this information.
7365 @cindex selected frame
7366 One of the stack frames is @dfn{selected} by @value{GDBN} and many
7367 @value{GDBN} commands refer implicitly to the selected frame. In
7368 particular, whenever you ask @value{GDBN} for the value of a variable in
7369 your program, the value is found in the selected frame. There are
7370 special @value{GDBN} commands to select whichever frame you are
7371 interested in. @xref{Selection, ,Selecting a Frame}.
7373 When your program stops, @value{GDBN} automatically selects the
7374 currently executing frame and describes it briefly, similar to the
7375 @code{frame} command (@pxref{Frame Info, ,Information about a Frame}).
7378 * Frames:: Stack frames
7379 * Backtrace:: Backtraces
7380 * Selection:: Selecting a frame
7381 * Frame Info:: Information on a frame
7382 * Frame Apply:: Applying a command to several frames
7383 * Frame Filter Management:: Managing frame filters
7388 @section Stack Frames
7390 @cindex frame, definition
7392 The call stack is divided up into contiguous pieces called @dfn{stack
7393 frames}, or @dfn{frames} for short; each frame is the data associated
7394 with one call to one function. The frame contains the arguments given
7395 to the function, the function's local variables, and the address at
7396 which the function is executing.
7398 @cindex initial frame
7399 @cindex outermost frame
7400 @cindex innermost frame
7401 When your program is started, the stack has only one frame, that of the
7402 function @code{main}. This is called the @dfn{initial} frame or the
7403 @dfn{outermost} frame. Each time a function is called, a new frame is
7404 made. Each time a function returns, the frame for that function invocation
7405 is eliminated. If a function is recursive, there can be many frames for
7406 the same function. The frame for the function in which execution is
7407 actually occurring is called the @dfn{innermost} frame. This is the most
7408 recently created of all the stack frames that still exist.
7410 @cindex frame pointer
7411 Inside your program, stack frames are identified by their addresses. A
7412 stack frame consists of many bytes, each of which has its own address; each
7413 kind of computer has a convention for choosing one byte whose
7414 address serves as the address of the frame. Usually this address is kept
7415 in a register called the @dfn{frame pointer register}
7416 (@pxref{Registers, $fp}) while execution is going on in that frame.
7419 @cindex frame number
7420 @value{GDBN} labels each existing stack frame with a @dfn{level}, a
7421 number that is zero for the innermost frame, one for the frame that
7422 called it, and so on upward. These level numbers give you a way of
7423 designating stack frames in @value{GDBN} commands. The terms
7424 @dfn{frame number} and @dfn{frame level} can be used interchangeably to
7425 describe this number.
7427 @c The -fomit-frame-pointer below perennially causes hbox overflow
7428 @c underflow problems.
7429 @cindex frameless execution
7430 Some compilers provide a way to compile functions so that they operate
7431 without stack frames. (For example, the @value{NGCC} option
7433 @samp{-fomit-frame-pointer}
7435 generates functions without a frame.)
7436 This is occasionally done with heavily used library functions to save
7437 the frame setup time. @value{GDBN} has limited facilities for dealing
7438 with these function invocations. If the innermost function invocation
7439 has no stack frame, @value{GDBN} nevertheless regards it as though
7440 it had a separate frame, which is numbered zero as usual, allowing
7441 correct tracing of the function call chain. However, @value{GDBN} has
7442 no provision for frameless functions elsewhere in the stack.
7448 @cindex call stack traces
7449 A backtrace is a summary of how your program got where it is. It shows one
7450 line per frame, for many frames, starting with the currently executing
7451 frame (frame zero), followed by its caller (frame one), and on up the
7454 @anchor{backtrace-command}
7456 @kindex bt @r{(@code{backtrace})}
7457 To print a backtrace of the entire stack, use the @code{backtrace}
7458 command, or its alias @code{bt}. This command will print one line per
7459 frame for frames in the stack. By default, all stack frames are
7460 printed. You can stop the backtrace at any time by typing the system
7461 interrupt character, normally @kbd{Ctrl-c}.
7464 @item backtrace [@var{args}@dots{}]
7465 @itemx bt [@var{args}@dots{}]
7466 Print the backtrace of the entire stack. The optional @var{args} can
7467 be one of the following:
7472 Print only the innermost @var{n} frames, where @var{n} is a positive
7477 Print only the outermost @var{n} frames, where @var{n} is a positive
7481 Print the values of the local variables also. This can be combined
7482 with a number to limit the number of frames shown.
7485 Do not run Python frame filters on this backtrace. @xref{Frame
7486 Filter API}, for more information. Additionally use @ref{disable
7487 frame-filter all} to turn off all frame filters. This is only
7488 relevant when @value{GDBN} has been configured with @code{Python}
7492 A Python frame filter might decide to ``elide'' some frames. Normally
7493 such elided frames are still printed, but they are indented relative
7494 to the filtered frames that cause them to be elided. The @code{hide}
7495 option causes elided frames to not be printed at all.
7501 The names @code{where} and @code{info stack} (abbreviated @code{info s})
7502 are additional aliases for @code{backtrace}.
7504 @cindex multiple threads, backtrace
7505 In a multi-threaded program, @value{GDBN} by default shows the
7506 backtrace only for the current thread. To display the backtrace for
7507 several or all of the threads, use the command @code{thread apply}
7508 (@pxref{Threads, thread apply}). For example, if you type @kbd{thread
7509 apply all backtrace}, @value{GDBN} will display the backtrace for all
7510 the threads; this is handy when you debug a core dump of a
7511 multi-threaded program.
7513 Each line in the backtrace shows the frame number and the function name.
7514 The program counter value is also shown---unless you use @code{set
7515 print address off}. The backtrace also shows the source file name and
7516 line number, as well as the arguments to the function. The program
7517 counter value is omitted if it is at the beginning of the code for that
7520 Here is an example of a backtrace. It was made with the command
7521 @samp{bt 3}, so it shows the innermost three frames.
7525 #0 m4_traceon (obs=0x24eb0, argc=1, argv=0x2b8c8)
7527 #1 0x6e38 in expand_macro (sym=0x2b600, data=...) at macro.c:242
7528 #2 0x6840 in expand_token (obs=0x0, t=177664, td=0xf7fffb08)
7530 (More stack frames follow...)
7535 The display for frame zero does not begin with a program counter
7536 value, indicating that your program has stopped at the beginning of the
7537 code for line @code{993} of @code{builtin.c}.
7540 The value of parameter @code{data} in frame 1 has been replaced by
7541 @code{@dots{}}. By default, @value{GDBN} prints the value of a parameter
7542 only if it is a scalar (integer, pointer, enumeration, etc). See command
7543 @kbd{set print frame-arguments} in @ref{Print Settings} for more details
7544 on how to configure the way function parameter values are printed.
7546 @cindex optimized out, in backtrace
7547 @cindex function call arguments, optimized out
7548 If your program was compiled with optimizations, some compilers will
7549 optimize away arguments passed to functions if those arguments are
7550 never used after the call. Such optimizations generate code that
7551 passes arguments through registers, but doesn't store those arguments
7552 in the stack frame. @value{GDBN} has no way of displaying such
7553 arguments in stack frames other than the innermost one. Here's what
7554 such a backtrace might look like:
7558 #0 m4_traceon (obs=0x24eb0, argc=1, argv=0x2b8c8)
7560 #1 0x6e38 in expand_macro (sym=<optimized out>) at macro.c:242
7561 #2 0x6840 in expand_token (obs=0x0, t=<optimized out>, td=0xf7fffb08)
7563 (More stack frames follow...)
7568 The values of arguments that were not saved in their stack frames are
7569 shown as @samp{<optimized out>}.
7571 If you need to display the values of such optimized-out arguments,
7572 either deduce that from other variables whose values depend on the one
7573 you are interested in, or recompile without optimizations.
7575 @cindex backtrace beyond @code{main} function
7576 @cindex program entry point
7577 @cindex startup code, and backtrace
7578 Most programs have a standard user entry point---a place where system
7579 libraries and startup code transition into user code. For C this is
7580 @code{main}@footnote{
7581 Note that embedded programs (the so-called ``free-standing''
7582 environment) are not required to have a @code{main} function as the
7583 entry point. They could even have multiple entry points.}.
7584 When @value{GDBN} finds the entry function in a backtrace
7585 it will terminate the backtrace, to avoid tracing into highly
7586 system-specific (and generally uninteresting) code.
7588 If you need to examine the startup code, or limit the number of levels
7589 in a backtrace, you can change this behavior:
7592 @item set backtrace past-main
7593 @itemx set backtrace past-main on
7594 @kindex set backtrace
7595 Backtraces will continue past the user entry point.
7597 @item set backtrace past-main off
7598 Backtraces will stop when they encounter the user entry point. This is the
7601 @item show backtrace past-main
7602 @kindex show backtrace
7603 Display the current user entry point backtrace policy.
7605 @item set backtrace past-entry
7606 @itemx set backtrace past-entry on
7607 Backtraces will continue past the internal entry point of an application.
7608 This entry point is encoded by the linker when the application is built,
7609 and is likely before the user entry point @code{main} (or equivalent) is called.
7611 @item set backtrace past-entry off
7612 Backtraces will stop when they encounter the internal entry point of an
7613 application. This is the default.
7615 @item show backtrace past-entry
7616 Display the current internal entry point backtrace policy.
7618 @item set backtrace limit @var{n}
7619 @itemx set backtrace limit 0
7620 @itemx set backtrace limit unlimited
7621 @cindex backtrace limit
7622 Limit the backtrace to @var{n} levels. A value of @code{unlimited}
7623 or zero means unlimited levels.
7625 @item show backtrace limit
7626 Display the current limit on backtrace levels.
7629 You can control how file names are displayed.
7632 @item set filename-display
7633 @itemx set filename-display relative
7634 @cindex filename-display
7635 Display file names relative to the compilation directory. This is the default.
7637 @item set filename-display basename
7638 Display only basename of a filename.
7640 @item set filename-display absolute
7641 Display an absolute filename.
7643 @item show filename-display
7644 Show the current way to display filenames.
7648 @section Selecting a Frame
7650 Most commands for examining the stack and other data in your program work on
7651 whichever stack frame is selected at the moment. Here are the commands for
7652 selecting a stack frame; all of them finish by printing a brief description
7653 of the stack frame just selected.
7656 @kindex frame@r{, selecting}
7657 @kindex f @r{(@code{frame})}
7658 @item frame @r{[} @var{frame-selection-spec} @r{]}
7659 @item f @r{[} @var{frame-selection-spec} @r{]}
7660 The @command{frame} command allows different stack frames to be
7661 selected. The @var{frame-selection-spec} can be any of the following:
7666 @item level @var{num}
7667 Select frame level @var{num}. Recall that frame zero is the innermost
7668 (currently executing) frame, frame one is the frame that called the
7669 innermost one, and so on. The highest level frame is usually the one
7672 As this is the most common method of navigating the frame stack, the
7673 string @command{level} can be omitted. For example, the following two
7674 commands are equivalent:
7677 (@value{GDBP}) frame 3
7678 (@value{GDBP}) frame level 3
7681 @kindex frame address
7682 @item address @var{stack-address}
7683 Select the frame with stack address @var{stack-address}. The
7684 @var{stack-address} for a frame can be seen in the output of
7685 @command{info frame}, for example:
7689 Stack level 1, frame at 0x7fffffffda30:
7690 rip = 0x40066d in b (amd64-entry-value.cc:59); saved rip 0x4004c5
7691 tail call frame, caller of frame at 0x7fffffffda30
7692 source language c++.
7693 Arglist at unknown address.
7694 Locals at unknown address, Previous frame's sp is 0x7fffffffda30
7697 The @var{stack-address} for this frame is @code{0x7fffffffda30} as
7698 indicated by the line:
7701 Stack level 1, frame at 0x7fffffffda30:
7704 @kindex frame function
7705 @item function @var{function-name}
7706 Select the stack frame for function @var{function-name}. If there are
7707 multiple stack frames for function @var{function-name} then the inner
7708 most stack frame is selected.
7711 @item view @var{stack-address} @r{[} @var{pc-addr} @r{]}
7712 View a frame that is not part of @value{GDBN}'s backtrace. The frame
7713 viewed has stack address @var{stack-addr}, and optionally, a program
7714 counter address of @var{pc-addr}.
7716 This is useful mainly if the chaining of stack frames has been
7717 damaged by a bug, making it impossible for @value{GDBN} to assign
7718 numbers properly to all frames. In addition, this can be useful
7719 when your program has multiple stacks and switches between them.
7721 When viewing a frame outside the current backtrace using
7722 @command{frame view} then you can always return to the original
7723 stack using one of the previous stack frame selection instructions,
7724 for example @command{frame level 0}.
7730 Move @var{n} frames up the stack; @var{n} defaults to 1. For positive
7731 numbers @var{n}, this advances toward the outermost frame, to higher
7732 frame numbers, to frames that have existed longer.
7735 @kindex do @r{(@code{down})}
7737 Move @var{n} frames down the stack; @var{n} defaults to 1. For
7738 positive numbers @var{n}, this advances toward the innermost frame, to
7739 lower frame numbers, to frames that were created more recently.
7740 You may abbreviate @code{down} as @code{do}.
7743 All of these commands end by printing two lines of output describing the
7744 frame. The first line shows the frame number, the function name, the
7745 arguments, and the source file and line number of execution in that
7746 frame. The second line shows the text of that source line.
7754 #1 0x22f0 in main (argc=1, argv=0xf7fffbf4, env=0xf7fffbfc)
7756 10 read_input_file (argv[i]);
7760 After such a printout, the @code{list} command with no arguments
7761 prints ten lines centered on the point of execution in the frame.
7762 You can also edit the program at the point of execution with your favorite
7763 editing program by typing @code{edit}.
7764 @xref{List, ,Printing Source Lines},
7768 @kindex select-frame
7769 @item select-frame @r{[} @var{frame-selection-spec} @r{]}
7770 The @code{select-frame} command is a variant of @code{frame} that does
7771 not display the new frame after selecting it. This command is
7772 intended primarily for use in @value{GDBN} command scripts, where the
7773 output might be unnecessary and distracting. The
7774 @var{frame-selection-spec} is as for the @command{frame} command
7775 described in @ref{Selection, ,Selecting a Frame}.
7777 @kindex down-silently
7779 @item up-silently @var{n}
7780 @itemx down-silently @var{n}
7781 These two commands are variants of @code{up} and @code{down},
7782 respectively; they differ in that they do their work silently, without
7783 causing display of the new frame. They are intended primarily for use
7784 in @value{GDBN} command scripts, where the output might be unnecessary and
7789 @section Information About a Frame
7791 There are several other commands to print information about the selected
7797 When used without any argument, this command does not change which
7798 frame is selected, but prints a brief description of the currently
7799 selected stack frame. It can be abbreviated @code{f}. With an
7800 argument, this command is used to select a stack frame.
7801 @xref{Selection, ,Selecting a Frame}.
7804 @kindex info f @r{(@code{info frame})}
7807 This command prints a verbose description of the selected stack frame,
7812 the address of the frame
7814 the address of the next frame down (called by this frame)
7816 the address of the next frame up (caller of this frame)
7818 the language in which the source code corresponding to this frame is written
7820 the address of the frame's arguments
7822 the address of the frame's local variables
7824 the program counter saved in it (the address of execution in the caller frame)
7826 which registers were saved in the frame
7829 @noindent The verbose description is useful when
7830 something has gone wrong that has made the stack format fail to fit
7831 the usual conventions.
7833 @item info frame @r{[} @var{frame-selection-spec} @r{]}
7834 @itemx info f @r{[} @var{frame-selection-spec} @r{]}
7835 Print a verbose description of the frame selected by
7836 @var{frame-selection-spec}. The @var{frame-selection-spec} is the
7837 same as for the @command{frame} command (@pxref{Selection, ,Selecting
7838 a Frame}). The selected frame remains unchanged by this command.
7841 @item info args [-q]
7842 Print the arguments of the selected frame, each on a separate line.
7844 The optional flag @samp{-q}, which stands for @samp{quiet}, disables
7845 printing header information and messages explaining why no argument
7848 @item info args [-q] [-t @var{type_regexp}] [@var{regexp}]
7849 Like @kbd{info args}, but only print the arguments selected
7850 with the provided regexp(s).
7852 If @var{regexp} is provided, print only the arguments whose names
7853 match the regular expression @var{regexp}.
7855 If @var{type_regexp} is provided, print only the arguments whose
7856 types, as printed by the @code{whatis} command, match
7857 the regular expression @var{type_regexp}.
7858 If @var{type_regexp} contains space(s), it should be enclosed in
7859 quote characters. If needed, use backslash to escape the meaning
7860 of special characters or quotes.
7862 If both @var{regexp} and @var{type_regexp} are provided, an argument
7863 is printed only if its name matches @var{regexp} and its type matches
7866 @item info locals [-q]
7868 Print the local variables of the selected frame, each on a separate
7869 line. These are all variables (declared either static or automatic)
7870 accessible at the point of execution of the selected frame.
7872 The optional flag @samp{-q}, which stands for @samp{quiet}, disables
7873 printing header information and messages explaining why no local variables
7876 @item info locals [-q] [-t @var{type_regexp}] [@var{regexp}]
7877 Like @kbd{info locals}, but only print the local variables selected
7878 with the provided regexp(s).
7880 If @var{regexp} is provided, print only the local variables whose names
7881 match the regular expression @var{regexp}.
7883 If @var{type_regexp} is provided, print only the local variables whose
7884 types, as printed by the @code{whatis} command, match
7885 the regular expression @var{type_regexp}.
7886 If @var{type_regexp} contains space(s), it should be enclosed in
7887 quote characters. If needed, use backslash to escape the meaning
7888 of special characters or quotes.
7890 If both @var{regexp} and @var{type_regexp} are provided, a local variable
7891 is printed only if its name matches @var{regexp} and its type matches
7894 The command @kbd{info locals -q -t @var{type_regexp}} can usefully be
7895 combined with the commands @kbd{frame apply} and @kbd{thread apply}.
7896 For example, your program might use Resource Acquisition Is
7897 Initialization types (RAII) such as @code{lock_something_t}: each
7898 local variable of type @code{lock_something_t} automatically places a
7899 lock that is destroyed when the variable goes out of scope. You can
7900 then list all acquired locks in your program by doing
7902 thread apply all -s frame apply all -s info locals -q -t lock_something_t
7905 or the equivalent shorter form
7907 tfaas i lo -q -t lock_something_t
7913 @section Applying a Command to Several Frames.
7915 @cindex apply command to several frames
7917 @item frame apply [all | @var{count} | @var{-count} | level @var{level}@dots{}] [@var{flag}]@dots{} @var{command}
7918 The @code{frame apply} command allows you to apply the named
7919 @var{command} to one or more frames.
7923 Specify @code{all} to apply @var{command} to all frames.
7926 Use @var{count} to apply @var{command} to the innermost @var{count}
7927 frames, where @var{count} is a positive number.
7930 Use @var{-count} to apply @var{command} to the outermost @var{count}
7931 frames, where @var{count} is a positive number.
7934 Use @code{level} to apply @var{command} to the set of frames identified
7935 by the @var{level} list. @var{level} is a frame level or a range of frame
7936 levels as @var{level1}-@var{level2}. The frame level is the number shown
7937 in the first field of the @samp{backtrace} command output.
7938 E.g., @samp{2-4 6-8 3} indicates to apply @var{command} for the frames
7939 at levels 2, 3, 4, 6, 7, 8, and then again on frame at level 3.
7945 Note that the frames on which @code{frame apply} applies a command are
7946 also influenced by the @code{set backtrace} settings such as @code{set
7947 backtrace past-main} and @code{set backtrace limit N}. See
7948 @xref{Backtrace,,Backtraces}.
7950 The @var{flag} arguments control what output to produce and how to handle
7951 errors raised when applying @var{command} to a frame. @var{flag}
7952 must start with a @code{-} directly followed by one letter in
7953 @code{qcs}. If several flags are provided, they must be given
7954 individually, such as @code{-c -q}.
7956 By default, @value{GDBN} displays some frame information before the
7957 output produced by @var{command}, and an error raised during the
7958 execution of a @var{command} will abort @code{frame apply}. The
7959 following flags can be used to fine-tune this behavior:
7963 The flag @code{-c}, which stands for @samp{continue}, causes any
7964 errors in @var{command} to be displayed, and the execution of
7965 @code{frame apply} then continues.
7967 The flag @code{-s}, which stands for @samp{silent}, causes any errors
7968 or empty output produced by a @var{command} to be silently ignored.
7969 That is, the execution continues, but the frame information and errors
7972 The flag @code{-q} (@samp{quiet}) disables printing the frame
7976 The following example shows how the flags @code{-c} and @code{-s} are
7977 working when applying the command @code{p j} to all frames, where
7978 variable @code{j} can only be successfully printed in the outermost
7979 @code{#1 main} frame.
7983 (gdb) frame apply all p j
7984 #0 some_function (i=5) at fun.c:4
7985 No symbol "j" in current context.
7986 (gdb) frame apply all -c p j
7987 #0 some_function (i=5) at fun.c:4
7988 No symbol "j" in current context.
7989 #1 0x565555fb in main (argc=1, argv=0xffffd2c4) at fun.c:11
7991 (gdb) frame apply all -s p j
7992 #1 0x565555fb in main (argc=1, argv=0xffffd2c4) at fun.c:11
7998 By default, @samp{frame apply}, prints the frame location
7999 information before the command output:
8003 (gdb) frame apply all p $sp
8004 #0 some_function (i=5) at fun.c:4
8005 $4 = (void *) 0xffffd1e0
8006 #1 0x565555fb in main (argc=1, argv=0xffffd2c4) at fun.c:11
8007 $5 = (void *) 0xffffd1f0
8012 If flag @code{-q} is given, no frame information is printed:
8015 (gdb) frame apply all -q p $sp
8016 $12 = (void *) 0xffffd1e0
8017 $13 = (void *) 0xffffd1f0
8025 @cindex apply a command to all frames (ignoring errors and empty output)
8026 @item faas @var{command}
8027 Shortcut for @code{frame apply all -s @var{command}}.
8028 Applies @var{command} on all frames, ignoring errors and empty output.
8030 It can for example be used to print a local variable or a function
8031 argument without knowing the frame where this variable or argument
8034 (@value{GDBP}) faas p some_local_var_i_do_not_remember_where_it_is
8037 Note that the command @code{tfaas @var{command}} applies @var{command}
8038 on all frames of all threads. See @xref{Threads,,Threads}.
8042 @node Frame Filter Management
8043 @section Management of Frame Filters.
8044 @cindex managing frame filters
8046 Frame filters are Python based utilities to manage and decorate the
8047 output of frames. @xref{Frame Filter API}, for further information.
8049 Managing frame filters is performed by several commands available
8050 within @value{GDBN}, detailed here.
8053 @kindex info frame-filter
8054 @item info frame-filter
8055 Print a list of installed frame filters from all dictionaries, showing
8056 their name, priority and enabled status.
8058 @kindex disable frame-filter
8059 @anchor{disable frame-filter all}
8060 @item disable frame-filter @var{filter-dictionary} @var{filter-name}
8061 Disable a frame filter in the dictionary matching
8062 @var{filter-dictionary} and @var{filter-name}. The
8063 @var{filter-dictionary} may be @code{all}, @code{global},
8064 @code{progspace}, or the name of the object file where the frame filter
8065 dictionary resides. When @code{all} is specified, all frame filters
8066 across all dictionaries are disabled. The @var{filter-name} is the name
8067 of the frame filter and is used when @code{all} is not the option for
8068 @var{filter-dictionary}. A disabled frame-filter is not deleted, it
8069 may be enabled again later.
8071 @kindex enable frame-filter
8072 @item enable frame-filter @var{filter-dictionary} @var{filter-name}
8073 Enable a frame filter in the dictionary matching
8074 @var{filter-dictionary} and @var{filter-name}. The
8075 @var{filter-dictionary} may be @code{all}, @code{global},
8076 @code{progspace} or the name of the object file where the frame filter
8077 dictionary resides. When @code{all} is specified, all frame filters across
8078 all dictionaries are enabled. The @var{filter-name} is the name of the frame
8079 filter and is used when @code{all} is not the option for
8080 @var{filter-dictionary}.
8085 (gdb) info frame-filter
8087 global frame-filters:
8088 Priority Enabled Name
8089 1000 No PrimaryFunctionFilter
8092 progspace /build/test frame-filters:
8093 Priority Enabled Name
8094 100 Yes ProgspaceFilter
8096 objfile /build/test frame-filters:
8097 Priority Enabled Name
8098 999 Yes BuildProgra Filter
8100 (gdb) disable frame-filter /build/test BuildProgramFilter
8101 (gdb) info frame-filter
8103 global frame-filters:
8104 Priority Enabled Name
8105 1000 No PrimaryFunctionFilter
8108 progspace /build/test frame-filters:
8109 Priority Enabled Name
8110 100 Yes ProgspaceFilter
8112 objfile /build/test frame-filters:
8113 Priority Enabled Name
8114 999 No BuildProgramFilter
8116 (gdb) enable frame-filter global PrimaryFunctionFilter
8117 (gdb) info frame-filter
8119 global frame-filters:
8120 Priority Enabled Name
8121 1000 Yes PrimaryFunctionFilter
8124 progspace /build/test frame-filters:
8125 Priority Enabled Name
8126 100 Yes ProgspaceFilter
8128 objfile /build/test frame-filters:
8129 Priority Enabled Name
8130 999 No BuildProgramFilter
8133 @kindex set frame-filter priority
8134 @item set frame-filter priority @var{filter-dictionary} @var{filter-name} @var{priority}
8135 Set the @var{priority} of a frame filter in the dictionary matching
8136 @var{filter-dictionary}, and the frame filter name matching
8137 @var{filter-name}. The @var{filter-dictionary} may be @code{global},
8138 @code{progspace} or the name of the object file where the frame filter
8139 dictionary resides. The @var{priority} is an integer.
8141 @kindex show frame-filter priority
8142 @item show frame-filter priority @var{filter-dictionary} @var{filter-name}
8143 Show the @var{priority} of a frame filter in the dictionary matching
8144 @var{filter-dictionary}, and the frame filter name matching
8145 @var{filter-name}. The @var{filter-dictionary} may be @code{global},
8146 @code{progspace} or the name of the object file where the frame filter
8152 (gdb) info frame-filter
8154 global frame-filters:
8155 Priority Enabled Name
8156 1000 Yes PrimaryFunctionFilter
8159 progspace /build/test frame-filters:
8160 Priority Enabled Name
8161 100 Yes ProgspaceFilter
8163 objfile /build/test frame-filters:
8164 Priority Enabled Name
8165 999 No BuildProgramFilter
8167 (gdb) set frame-filter priority global Reverse 50
8168 (gdb) info frame-filter
8170 global frame-filters:
8171 Priority Enabled Name
8172 1000 Yes PrimaryFunctionFilter
8175 progspace /build/test frame-filters:
8176 Priority Enabled Name
8177 100 Yes ProgspaceFilter
8179 objfile /build/test frame-filters:
8180 Priority Enabled Name
8181 999 No BuildProgramFilter
8186 @chapter Examining Source Files
8188 @value{GDBN} can print parts of your program's source, since the debugging
8189 information recorded in the program tells @value{GDBN} what source files were
8190 used to build it. When your program stops, @value{GDBN} spontaneously prints
8191 the line where it stopped. Likewise, when you select a stack frame
8192 (@pxref{Selection, ,Selecting a Frame}), @value{GDBN} prints the line where
8193 execution in that frame has stopped. You can print other portions of
8194 source files by explicit command.
8196 If you use @value{GDBN} through its @sc{gnu} Emacs interface, you may
8197 prefer to use Emacs facilities to view source; see @ref{Emacs, ,Using
8198 @value{GDBN} under @sc{gnu} Emacs}.
8201 * List:: Printing source lines
8202 * Specify Location:: How to specify code locations
8203 * Edit:: Editing source files
8204 * Search:: Searching source files
8205 * Source Path:: Specifying source directories
8206 * Machine Code:: Source and machine code
8210 @section Printing Source Lines
8213 @kindex l @r{(@code{list})}
8214 To print lines from a source file, use the @code{list} command
8215 (abbreviated @code{l}). By default, ten lines are printed.
8216 There are several ways to specify what part of the file you want to
8217 print; see @ref{Specify Location}, for the full list.
8219 Here are the forms of the @code{list} command most commonly used:
8222 @item list @var{linenum}
8223 Print lines centered around line number @var{linenum} in the
8224 current source file.
8226 @item list @var{function}
8227 Print lines centered around the beginning of function
8231 Print more lines. If the last lines printed were printed with a
8232 @code{list} command, this prints lines following the last lines
8233 printed; however, if the last line printed was a solitary line printed
8234 as part of displaying a stack frame (@pxref{Stack, ,Examining the
8235 Stack}), this prints lines centered around that line.
8238 Print lines just before the lines last printed.
8241 @cindex @code{list}, how many lines to display
8242 By default, @value{GDBN} prints ten source lines with any of these forms of
8243 the @code{list} command. You can change this using @code{set listsize}:
8246 @kindex set listsize
8247 @item set listsize @var{count}
8248 @itemx set listsize unlimited
8249 Make the @code{list} command display @var{count} source lines (unless
8250 the @code{list} argument explicitly specifies some other number).
8251 Setting @var{count} to @code{unlimited} or 0 means there's no limit.
8253 @kindex show listsize
8255 Display the number of lines that @code{list} prints.
8258 Repeating a @code{list} command with @key{RET} discards the argument,
8259 so it is equivalent to typing just @code{list}. This is more useful
8260 than listing the same lines again. An exception is made for an
8261 argument of @samp{-}; that argument is preserved in repetition so that
8262 each repetition moves up in the source file.
8264 In general, the @code{list} command expects you to supply zero, one or two
8265 @dfn{locations}. Locations specify source lines; there are several ways
8266 of writing them (@pxref{Specify Location}), but the effect is always
8267 to specify some source line.
8269 Here is a complete description of the possible arguments for @code{list}:
8272 @item list @var{location}
8273 Print lines centered around the line specified by @var{location}.
8275 @item list @var{first},@var{last}
8276 Print lines from @var{first} to @var{last}. Both arguments are
8277 locations. When a @code{list} command has two locations, and the
8278 source file of the second location is omitted, this refers to
8279 the same source file as the first location.
8281 @item list ,@var{last}
8282 Print lines ending with @var{last}.
8284 @item list @var{first},
8285 Print lines starting with @var{first}.
8288 Print lines just after the lines last printed.
8291 Print lines just before the lines last printed.
8294 As described in the preceding table.
8297 @node Specify Location
8298 @section Specifying a Location
8299 @cindex specifying location
8301 @cindex source location
8304 * Linespec Locations:: Linespec locations
8305 * Explicit Locations:: Explicit locations
8306 * Address Locations:: Address locations
8309 Several @value{GDBN} commands accept arguments that specify a location
8310 of your program's code. Since @value{GDBN} is a source-level
8311 debugger, a location usually specifies some line in the source code.
8312 Locations may be specified using three different formats:
8313 linespec locations, explicit locations, or address locations.
8315 @node Linespec Locations
8316 @subsection Linespec Locations
8317 @cindex linespec locations
8319 A @dfn{linespec} is a colon-separated list of source location parameters such
8320 as file name, function name, etc. Here are all the different ways of
8321 specifying a linespec:
8325 Specifies the line number @var{linenum} of the current source file.
8328 @itemx +@var{offset}
8329 Specifies the line @var{offset} lines before or after the @dfn{current
8330 line}. For the @code{list} command, the current line is the last one
8331 printed; for the breakpoint commands, this is the line at which
8332 execution stopped in the currently selected @dfn{stack frame}
8333 (@pxref{Frames, ,Frames}, for a description of stack frames.) When
8334 used as the second of the two linespecs in a @code{list} command,
8335 this specifies the line @var{offset} lines up or down from the first
8338 @item @var{filename}:@var{linenum}
8339 Specifies the line @var{linenum} in the source file @var{filename}.
8340 If @var{filename} is a relative file name, then it will match any
8341 source file name with the same trailing components. For example, if
8342 @var{filename} is @samp{gcc/expr.c}, then it will match source file
8343 name of @file{/build/trunk/gcc/expr.c}, but not
8344 @file{/build/trunk/libcpp/expr.c} or @file{/build/trunk/gcc/x-expr.c}.
8346 @item @var{function}
8347 Specifies the line that begins the body of the function @var{function}.
8348 For example, in C, this is the line with the open brace.
8350 By default, in C@t{++} and Ada, @var{function} is interpreted as
8351 specifying all functions named @var{function} in all scopes. For
8352 C@t{++}, this means in all namespaces and classes. For Ada, this
8353 means in all packages.
8355 For example, assuming a program with C@t{++} symbols named
8356 @code{A::B::func} and @code{B::func}, both commands @w{@kbd{break
8357 func}} and @w{@kbd{break B::func}} set a breakpoint on both symbols.
8359 Commands that accept a linespec let you override this with the
8360 @code{-qualified} option. For example, @w{@kbd{break -qualified
8361 func}} sets a breakpoint on a free-function named @code{func} ignoring
8362 any C@t{++} class methods and namespace functions called @code{func}.
8364 @xref{Explicit Locations}.
8366 @item @var{function}:@var{label}
8367 Specifies the line where @var{label} appears in @var{function}.
8369 @item @var{filename}:@var{function}
8370 Specifies the line that begins the body of the function @var{function}
8371 in the file @var{filename}. You only need the file name with a
8372 function name to avoid ambiguity when there are identically named
8373 functions in different source files.
8376 Specifies the line at which the label named @var{label} appears
8377 in the function corresponding to the currently selected stack frame.
8378 If there is no current selected stack frame (for instance, if the inferior
8379 is not running), then @value{GDBN} will not search for a label.
8381 @cindex breakpoint at static probe point
8382 @item -pstap|-probe-stap @r{[}@var{objfile}:@r{[}@var{provider}:@r{]}@r{]}@var{name}
8383 The @sc{gnu}/Linux tool @code{SystemTap} provides a way for
8384 applications to embed static probes. @xref{Static Probe Points}, for more
8385 information on finding and using static probes. This form of linespec
8386 specifies the location of such a static probe.
8388 If @var{objfile} is given, only probes coming from that shared library
8389 or executable matching @var{objfile} as a regular expression are considered.
8390 If @var{provider} is given, then only probes from that provider are considered.
8391 If several probes match the spec, @value{GDBN} will insert a breakpoint at
8392 each one of those probes.
8395 @node Explicit Locations
8396 @subsection Explicit Locations
8397 @cindex explicit locations
8399 @dfn{Explicit locations} allow the user to directly specify the source
8400 location's parameters using option-value pairs.
8402 Explicit locations are useful when several functions, labels, or
8403 file names have the same name (base name for files) in the program's
8404 sources. In these cases, explicit locations point to the source
8405 line you meant more accurately and unambiguously. Also, using
8406 explicit locations might be faster in large programs.
8408 For example, the linespec @samp{foo:bar} may refer to a function @code{bar}
8409 defined in the file named @file{foo} or the label @code{bar} in a function
8410 named @code{foo}. @value{GDBN} must search either the file system or
8411 the symbol table to know.
8413 The list of valid explicit location options is summarized in the
8417 @item -source @var{filename}
8418 The value specifies the source file name. To differentiate between
8419 files with the same base name, prepend as many directories as is necessary
8420 to uniquely identify the desired file, e.g., @file{foo/bar/baz.c}. Otherwise
8421 @value{GDBN} will use the first file it finds with the given base
8422 name. This option requires the use of either @code{-function} or @code{-line}.
8424 @item -function @var{function}
8425 The value specifies the name of a function. Operations
8426 on function locations unmodified by other options (such as @code{-label}
8427 or @code{-line}) refer to the line that begins the body of the function.
8428 In C, for example, this is the line with the open brace.
8430 By default, in C@t{++} and Ada, @var{function} is interpreted as
8431 specifying all functions named @var{function} in all scopes. For
8432 C@t{++}, this means in all namespaces and classes. For Ada, this
8433 means in all packages.
8435 For example, assuming a program with C@t{++} symbols named
8436 @code{A::B::func} and @code{B::func}, both commands @w{@kbd{break
8437 -function func}} and @w{@kbd{break -function B::func}} set a
8438 breakpoint on both symbols.
8440 You can use the @kbd{-qualified} flag to override this (see below).
8444 This flag makes @value{GDBN} interpret a function name specified with
8445 @kbd{-function} as a complete fully-qualified name.
8447 For example, assuming a C@t{++} program with symbols named
8448 @code{A::B::func} and @code{B::func}, the @w{@kbd{break -qualified
8449 -function B::func}} command sets a breakpoint on @code{B::func}, only.
8451 (Note: the @kbd{-qualified} option can precede a linespec as well
8452 (@pxref{Linespec Locations}), so the particular example above could be
8453 simplified as @w{@kbd{break -qualified B::func}}.)
8455 @item -label @var{label}
8456 The value specifies the name of a label. When the function
8457 name is not specified, the label is searched in the function of the currently
8458 selected stack frame.
8460 @item -line @var{number}
8461 The value specifies a line offset for the location. The offset may either
8462 be absolute (@code{-line 3}) or relative (@code{-line +3}), depending on
8463 the command. When specified without any other options, the line offset is
8464 relative to the current line.
8467 Explicit location options may be abbreviated by omitting any non-unique
8468 trailing characters from the option name, e.g., @w{@kbd{break -s main.c -li 3}}.
8470 @node Address Locations
8471 @subsection Address Locations
8472 @cindex address locations
8474 @dfn{Address locations} indicate a specific program address. They have
8475 the generalized form *@var{address}.
8477 For line-oriented commands, such as @code{list} and @code{edit}, this
8478 specifies a source line that contains @var{address}. For @code{break} and
8479 other breakpoint-oriented commands, this can be used to set breakpoints in
8480 parts of your program which do not have debugging information or
8483 Here @var{address} may be any expression valid in the current working
8484 language (@pxref{Languages, working language}) that specifies a code
8485 address. In addition, as a convenience, @value{GDBN} extends the
8486 semantics of expressions used in locations to cover several situations
8487 that frequently occur during debugging. Here are the various forms
8491 @item @var{expression}
8492 Any expression valid in the current working language.
8494 @item @var{funcaddr}
8495 An address of a function or procedure derived from its name. In C,
8496 C@t{++}, Objective-C, Fortran, minimal, and assembly, this is
8497 simply the function's name @var{function} (and actually a special case
8498 of a valid expression). In Pascal and Modula-2, this is
8499 @code{&@var{function}}. In Ada, this is @code{@var{function}'Address}
8500 (although the Pascal form also works).
8502 This form specifies the address of the function's first instruction,
8503 before the stack frame and arguments have been set up.
8505 @item '@var{filename}':@var{funcaddr}
8506 Like @var{funcaddr} above, but also specifies the name of the source
8507 file explicitly. This is useful if the name of the function does not
8508 specify the function unambiguously, e.g., if there are several
8509 functions with identical names in different source files.
8513 @section Editing Source Files
8514 @cindex editing source files
8517 @kindex e @r{(@code{edit})}
8518 To edit the lines in a source file, use the @code{edit} command.
8519 The editing program of your choice
8520 is invoked with the current line set to
8521 the active line in the program.
8522 Alternatively, there are several ways to specify what part of the file you
8523 want to print if you want to see other parts of the program:
8526 @item edit @var{location}
8527 Edit the source file specified by @code{location}. Editing starts at
8528 that @var{location}, e.g., at the specified source line of the
8529 specified file. @xref{Specify Location}, for all the possible forms
8530 of the @var{location} argument; here are the forms of the @code{edit}
8531 command most commonly used:
8534 @item edit @var{number}
8535 Edit the current source file with @var{number} as the active line number.
8537 @item edit @var{function}
8538 Edit the file containing @var{function} at the beginning of its definition.
8543 @subsection Choosing your Editor
8544 You can customize @value{GDBN} to use any editor you want
8546 The only restriction is that your editor (say @code{ex}), recognizes the
8547 following command-line syntax:
8549 ex +@var{number} file
8551 The optional numeric value +@var{number} specifies the number of the line in
8552 the file where to start editing.}.
8553 By default, it is @file{@value{EDITOR}}, but you can change this
8554 by setting the environment variable @code{EDITOR} before using
8555 @value{GDBN}. For example, to configure @value{GDBN} to use the
8556 @code{vi} editor, you could use these commands with the @code{sh} shell:
8562 or in the @code{csh} shell,
8564 setenv EDITOR /usr/bin/vi
8569 @section Searching Source Files
8570 @cindex searching source files
8572 There are two commands for searching through the current source file for a
8577 @kindex forward-search
8578 @kindex fo @r{(@code{forward-search})}
8579 @item forward-search @var{regexp}
8580 @itemx search @var{regexp}
8581 The command @samp{forward-search @var{regexp}} checks each line,
8582 starting with the one following the last line listed, for a match for
8583 @var{regexp}. It lists the line that is found. You can use the
8584 synonym @samp{search @var{regexp}} or abbreviate the command name as
8587 @kindex reverse-search
8588 @item reverse-search @var{regexp}
8589 The command @samp{reverse-search @var{regexp}} checks each line, starting
8590 with the one before the last line listed and going backward, for a match
8591 for @var{regexp}. It lists the line that is found. You can abbreviate
8592 this command as @code{rev}.
8596 @section Specifying Source Directories
8599 @cindex directories for source files
8600 Executable programs sometimes do not record the directories of the source
8601 files from which they were compiled, just the names. Even when they do,
8602 the directories could be moved between the compilation and your debugging
8603 session. @value{GDBN} has a list of directories to search for source files;
8604 this is called the @dfn{source path}. Each time @value{GDBN} wants a source file,
8605 it tries all the directories in the list, in the order they are present
8606 in the list, until it finds a file with the desired name.
8608 For example, suppose an executable references the file
8609 @file{/usr/src/foo-1.0/lib/foo.c}, and our source path is
8610 @file{/mnt/cross}. The file is first looked up literally; if this
8611 fails, @file{/mnt/cross/usr/src/foo-1.0/lib/foo.c} is tried; if this
8612 fails, @file{/mnt/cross/foo.c} is opened; if this fails, an error
8613 message is printed. @value{GDBN} does not look up the parts of the
8614 source file name, such as @file{/mnt/cross/src/foo-1.0/lib/foo.c}.
8615 Likewise, the subdirectories of the source path are not searched: if
8616 the source path is @file{/mnt/cross}, and the binary refers to
8617 @file{foo.c}, @value{GDBN} would not find it under
8618 @file{/mnt/cross/usr/src/foo-1.0/lib}.
8620 Plain file names, relative file names with leading directories, file
8621 names containing dots, etc.@: are all treated as described above; for
8622 instance, if the source path is @file{/mnt/cross}, and the source file
8623 is recorded as @file{../lib/foo.c}, @value{GDBN} would first try
8624 @file{../lib/foo.c}, then @file{/mnt/cross/../lib/foo.c}, and after
8625 that---@file{/mnt/cross/foo.c}.
8627 Note that the executable search path is @emph{not} used to locate the
8630 Whenever you reset or rearrange the source path, @value{GDBN} clears out
8631 any information it has cached about where source files are found and where
8632 each line is in the file.
8636 When you start @value{GDBN}, its source path includes only @samp{cdir}
8637 and @samp{cwd}, in that order.
8638 To add other directories, use the @code{directory} command.
8640 The search path is used to find both program source files and @value{GDBN}
8641 script files (read using the @samp{-command} option and @samp{source} command).
8643 In addition to the source path, @value{GDBN} provides a set of commands
8644 that manage a list of source path substitution rules. A @dfn{substitution
8645 rule} specifies how to rewrite source directories stored in the program's
8646 debug information in case the sources were moved to a different
8647 directory between compilation and debugging. A rule is made of
8648 two strings, the first specifying what needs to be rewritten in
8649 the path, and the second specifying how it should be rewritten.
8650 In @ref{set substitute-path}, we name these two parts @var{from} and
8651 @var{to} respectively. @value{GDBN} does a simple string replacement
8652 of @var{from} with @var{to} at the start of the directory part of the
8653 source file name, and uses that result instead of the original file
8654 name to look up the sources.
8656 Using the previous example, suppose the @file{foo-1.0} tree has been
8657 moved from @file{/usr/src} to @file{/mnt/cross}, then you can tell
8658 @value{GDBN} to replace @file{/usr/src} in all source path names with
8659 @file{/mnt/cross}. The first lookup will then be
8660 @file{/mnt/cross/foo-1.0/lib/foo.c} in place of the original location
8661 of @file{/usr/src/foo-1.0/lib/foo.c}. To define a source path
8662 substitution rule, use the @code{set substitute-path} command
8663 (@pxref{set substitute-path}).
8665 To avoid unexpected substitution results, a rule is applied only if the
8666 @var{from} part of the directory name ends at a directory separator.
8667 For instance, a rule substituting @file{/usr/source} into
8668 @file{/mnt/cross} will be applied to @file{/usr/source/foo-1.0} but
8669 not to @file{/usr/sourceware/foo-2.0}. And because the substitution
8670 is applied only at the beginning of the directory name, this rule will
8671 not be applied to @file{/root/usr/source/baz.c} either.
8673 In many cases, you can achieve the same result using the @code{directory}
8674 command. However, @code{set substitute-path} can be more efficient in
8675 the case where the sources are organized in a complex tree with multiple
8676 subdirectories. With the @code{directory} command, you need to add each
8677 subdirectory of your project. If you moved the entire tree while
8678 preserving its internal organization, then @code{set substitute-path}
8679 allows you to direct the debugger to all the sources with one single
8682 @code{set substitute-path} is also more than just a shortcut command.
8683 The source path is only used if the file at the original location no
8684 longer exists. On the other hand, @code{set substitute-path} modifies
8685 the debugger behavior to look at the rewritten location instead. So, if
8686 for any reason a source file that is not relevant to your executable is
8687 located at the original location, a substitution rule is the only
8688 method available to point @value{GDBN} at the new location.
8690 @cindex @samp{--with-relocated-sources}
8691 @cindex default source path substitution
8692 You can configure a default source path substitution rule by
8693 configuring @value{GDBN} with the
8694 @samp{--with-relocated-sources=@var{dir}} option. The @var{dir}
8695 should be the name of a directory under @value{GDBN}'s configured
8696 prefix (set with @samp{--prefix} or @samp{--exec-prefix}), and
8697 directory names in debug information under @var{dir} will be adjusted
8698 automatically if the installed @value{GDBN} is moved to a new
8699 location. This is useful if @value{GDBN}, libraries or executables
8700 with debug information and corresponding source code are being moved
8704 @item directory @var{dirname} @dots{}
8705 @item dir @var{dirname} @dots{}
8706 Add directory @var{dirname} to the front of the source path. Several
8707 directory names may be given to this command, separated by @samp{:}
8708 (@samp{;} on MS-DOS and MS-Windows, where @samp{:} usually appears as
8709 part of absolute file names) or
8710 whitespace. You may specify a directory that is already in the source
8711 path; this moves it forward, so @value{GDBN} searches it sooner.
8715 @vindex $cdir@r{, convenience variable}
8716 @vindex $cwd@r{, convenience variable}
8717 @cindex compilation directory
8718 @cindex current directory
8719 @cindex working directory
8720 @cindex directory, current
8721 @cindex directory, compilation
8722 You can use the string @samp{$cdir} to refer to the compilation
8723 directory (if one is recorded), and @samp{$cwd} to refer to the current
8724 working directory. @samp{$cwd} is not the same as @samp{.}---the former
8725 tracks the current working directory as it changes during your @value{GDBN}
8726 session, while the latter is immediately expanded to the current
8727 directory at the time you add an entry to the source path.
8730 Reset the source path to its default value (@samp{$cdir:$cwd} on Unix systems). This requires confirmation.
8732 @c RET-repeat for @code{directory} is explicitly disabled, but since
8733 @c repeating it would be a no-op we do not say that. (thanks to RMS)
8735 @item set directories @var{path-list}
8736 @kindex set directories
8737 Set the source path to @var{path-list}.
8738 @samp{$cdir:$cwd} are added if missing.
8740 @item show directories
8741 @kindex show directories
8742 Print the source path: show which directories it contains.
8744 @anchor{set substitute-path}
8745 @item set substitute-path @var{from} @var{to}
8746 @kindex set substitute-path
8747 Define a source path substitution rule, and add it at the end of the
8748 current list of existing substitution rules. If a rule with the same
8749 @var{from} was already defined, then the old rule is also deleted.
8751 For example, if the file @file{/foo/bar/baz.c} was moved to
8752 @file{/mnt/cross/baz.c}, then the command
8755 (@value{GDBP}) set substitute-path /foo/bar /mnt/cross
8759 will tell @value{GDBN} to replace @samp{/foo/bar} with
8760 @samp{/mnt/cross}, which will allow @value{GDBN} to find the file
8761 @file{baz.c} even though it was moved.
8763 In the case when more than one substitution rule have been defined,
8764 the rules are evaluated one by one in the order where they have been
8765 defined. The first one matching, if any, is selected to perform
8768 For instance, if we had entered the following commands:
8771 (@value{GDBP}) set substitute-path /usr/src/include /mnt/include
8772 (@value{GDBP}) set substitute-path /usr/src /mnt/src
8776 @value{GDBN} would then rewrite @file{/usr/src/include/defs.h} into
8777 @file{/mnt/include/defs.h} by using the first rule. However, it would
8778 use the second rule to rewrite @file{/usr/src/lib/foo.c} into
8779 @file{/mnt/src/lib/foo.c}.
8782 @item unset substitute-path [path]
8783 @kindex unset substitute-path
8784 If a path is specified, search the current list of substitution rules
8785 for a rule that would rewrite that path. Delete that rule if found.
8786 A warning is emitted by the debugger if no rule could be found.
8788 If no path is specified, then all substitution rules are deleted.
8790 @item show substitute-path [path]
8791 @kindex show substitute-path
8792 If a path is specified, then print the source path substitution rule
8793 which would rewrite that path, if any.
8795 If no path is specified, then print all existing source path substitution
8800 If your source path is cluttered with directories that are no longer of
8801 interest, @value{GDBN} may sometimes cause confusion by finding the wrong
8802 versions of source. You can correct the situation as follows:
8806 Use @code{directory} with no argument to reset the source path to its default value.
8809 Use @code{directory} with suitable arguments to reinstall the
8810 directories you want in the source path. You can add all the
8811 directories in one command.
8815 @section Source and Machine Code
8816 @cindex source line and its code address
8818 You can use the command @code{info line} to map source lines to program
8819 addresses (and vice versa), and the command @code{disassemble} to display
8820 a range of addresses as machine instructions. You can use the command
8821 @code{set disassemble-next-line} to set whether to disassemble next
8822 source line when execution stops. When run under @sc{gnu} Emacs
8823 mode, the @code{info line} command causes the arrow to point to the
8824 line specified. Also, @code{info line} prints addresses in symbolic form as
8830 @itemx info line @var{location}
8831 Print the starting and ending addresses of the compiled code for
8832 source line @var{location}. You can specify source lines in any of
8833 the ways documented in @ref{Specify Location}. With no @var{location}
8834 information about the current source line is printed.
8837 For example, we can use @code{info line} to discover the location of
8838 the object code for the first line of function
8839 @code{m4_changequote}:
8842 (@value{GDBP}) info line m4_changequote
8843 Line 895 of "builtin.c" starts at pc 0x634c <m4_changequote> and \
8844 ends at 0x6350 <m4_changequote+4>.
8848 @cindex code address and its source line
8849 We can also inquire (using @code{*@var{addr}} as the form for
8850 @var{location}) what source line covers a particular address:
8852 (@value{GDBP}) info line *0x63ff
8853 Line 926 of "builtin.c" starts at pc 0x63e4 <m4_changequote+152> and \
8854 ends at 0x6404 <m4_changequote+184>.
8857 @cindex @code{$_} and @code{info line}
8858 @cindex @code{x} command, default address
8859 @kindex x@r{(examine), and} info line
8860 After @code{info line}, the default address for the @code{x} command
8861 is changed to the starting address of the line, so that @samp{x/i} is
8862 sufficient to begin examining the machine code (@pxref{Memory,
8863 ,Examining Memory}). Also, this address is saved as the value of the
8864 convenience variable @code{$_} (@pxref{Convenience Vars, ,Convenience
8867 @cindex info line, repeated calls
8868 After @code{info line}, using @code{info line} again without
8869 specifying a location will display information about the next source
8874 @cindex assembly instructions
8875 @cindex instructions, assembly
8876 @cindex machine instructions
8877 @cindex listing machine instructions
8879 @itemx disassemble /m
8880 @itemx disassemble /s
8881 @itemx disassemble /r
8882 This specialized command dumps a range of memory as machine
8883 instructions. It can also print mixed source+disassembly by specifying
8884 the @code{/m} or @code{/s} modifier and print the raw instructions in hex
8885 as well as in symbolic form by specifying the @code{/r} modifier.
8886 The default memory range is the function surrounding the
8887 program counter of the selected frame. A single argument to this
8888 command is a program counter value; @value{GDBN} dumps the function
8889 surrounding this value. When two arguments are given, they should
8890 be separated by a comma, possibly surrounded by whitespace. The
8891 arguments specify a range of addresses to dump, in one of two forms:
8894 @item @var{start},@var{end}
8895 the addresses from @var{start} (inclusive) to @var{end} (exclusive)
8896 @item @var{start},+@var{length}
8897 the addresses from @var{start} (inclusive) to
8898 @code{@var{start}+@var{length}} (exclusive).
8902 When 2 arguments are specified, the name of the function is also
8903 printed (since there could be several functions in the given range).
8905 The argument(s) can be any expression yielding a numeric value, such as
8906 @samp{0x32c4}, @samp{&main+10} or @samp{$pc - 8}.
8908 If the range of memory being disassembled contains current program counter,
8909 the instruction at that location is shown with a @code{=>} marker.
8912 The following example shows the disassembly of a range of addresses of
8913 HP PA-RISC 2.0 code:
8916 (@value{GDBP}) disas 0x32c4, 0x32e4
8917 Dump of assembler code from 0x32c4 to 0x32e4:
8918 0x32c4 <main+204>: addil 0,dp
8919 0x32c8 <main+208>: ldw 0x22c(sr0,r1),r26
8920 0x32cc <main+212>: ldil 0x3000,r31
8921 0x32d0 <main+216>: ble 0x3f8(sr4,r31)
8922 0x32d4 <main+220>: ldo 0(r31),rp
8923 0x32d8 <main+224>: addil -0x800,dp
8924 0x32dc <main+228>: ldo 0x588(r1),r26
8925 0x32e0 <main+232>: ldil 0x3000,r31
8926 End of assembler dump.
8929 Here is an example showing mixed source+assembly for Intel x86
8930 with @code{/m} or @code{/s}, when the program is stopped just after
8931 function prologue in a non-optimized function with no inline code.
8934 (@value{GDBP}) disas /m main
8935 Dump of assembler code for function main:
8937 0x08048330 <+0>: push %ebp
8938 0x08048331 <+1>: mov %esp,%ebp
8939 0x08048333 <+3>: sub $0x8,%esp
8940 0x08048336 <+6>: and $0xfffffff0,%esp
8941 0x08048339 <+9>: sub $0x10,%esp
8943 6 printf ("Hello.\n");
8944 => 0x0804833c <+12>: movl $0x8048440,(%esp)
8945 0x08048343 <+19>: call 0x8048284 <puts@@plt>
8949 0x08048348 <+24>: mov $0x0,%eax
8950 0x0804834d <+29>: leave
8951 0x0804834e <+30>: ret
8953 End of assembler dump.
8956 The @code{/m} option is deprecated as its output is not useful when
8957 there is either inlined code or re-ordered code.
8958 The @code{/s} option is the preferred choice.
8959 Here is an example for AMD x86-64 showing the difference between
8960 @code{/m} output and @code{/s} output.
8961 This example has one inline function defined in a header file,
8962 and the code is compiled with @samp{-O2} optimization.
8963 Note how the @code{/m} output is missing the disassembly of
8964 several instructions that are present in the @code{/s} output.
8994 (@value{GDBP}) disas /m main
8995 Dump of assembler code for function main:
8999 0x0000000000400400 <+0>: mov 0x200c2e(%rip),%eax # 0x601034 <y>
9000 0x0000000000400417 <+23>: mov %eax,0x200c13(%rip) # 0x601030 <x>
9004 0x000000000040041d <+29>: xor %eax,%eax
9005 0x000000000040041f <+31>: retq
9006 0x0000000000400420 <+32>: add %eax,%eax
9007 0x0000000000400422 <+34>: jmp 0x400417 <main+23>
9009 End of assembler dump.
9010 (@value{GDBP}) disas /s main
9011 Dump of assembler code for function main:
9015 0x0000000000400400 <+0>: mov 0x200c2e(%rip),%eax # 0x601034 <y>
9019 0x0000000000400406 <+6>: test %eax,%eax
9020 0x0000000000400408 <+8>: js 0x400420 <main+32>
9025 0x000000000040040a <+10>: lea 0xa(%rax),%edx
9026 0x000000000040040d <+13>: test %eax,%eax
9027 0x000000000040040f <+15>: mov $0x1,%eax
9028 0x0000000000400414 <+20>: cmovne %edx,%eax
9032 0x0000000000400417 <+23>: mov %eax,0x200c13(%rip) # 0x601030 <x>
9036 0x000000000040041d <+29>: xor %eax,%eax
9037 0x000000000040041f <+31>: retq
9041 0x0000000000400420 <+32>: add %eax,%eax
9042 0x0000000000400422 <+34>: jmp 0x400417 <main+23>
9043 End of assembler dump.
9046 Here is another example showing raw instructions in hex for AMD x86-64,
9049 (gdb) disas /r 0x400281,+10
9050 Dump of assembler code from 0x400281 to 0x40028b:
9051 0x0000000000400281: 38 36 cmp %dh,(%rsi)
9052 0x0000000000400283: 2d 36 34 2e 73 sub $0x732e3436,%eax
9053 0x0000000000400288: 6f outsl %ds:(%rsi),(%dx)
9054 0x0000000000400289: 2e 32 00 xor %cs:(%rax),%al
9055 End of assembler dump.
9058 Addresses cannot be specified as a location (@pxref{Specify Location}).
9059 So, for example, if you want to disassemble function @code{bar}
9060 in file @file{foo.c}, you must type @samp{disassemble 'foo.c'::bar}
9061 and not @samp{disassemble foo.c:bar}.
9063 Some architectures have more than one commonly-used set of instruction
9064 mnemonics or other syntax.
9066 For programs that were dynamically linked and use shared libraries,
9067 instructions that call functions or branch to locations in the shared
9068 libraries might show a seemingly bogus location---it's actually a
9069 location of the relocation table. On some architectures, @value{GDBN}
9070 might be able to resolve these to actual function names.
9073 @kindex set disassembler-options
9074 @cindex disassembler options
9075 @item set disassembler-options @var{option1}[,@var{option2}@dots{}]
9076 This command controls the passing of target specific information to
9077 the disassembler. For a list of valid options, please refer to the
9078 @code{-M}/@code{--disassembler-options} section of the @samp{objdump}
9079 manual and/or the output of @kbd{objdump --help}
9080 (@pxref{objdump,,objdump,binutils,The GNU Binary Utilities}).
9081 The default value is the empty string.
9083 If it is necessary to specify more than one disassembler option, then
9084 multiple options can be placed together into a comma separated list.
9085 Currently this command is only supported on targets ARM, MIPS, PowerPC
9088 @kindex show disassembler-options
9089 @item show disassembler-options
9090 Show the current setting of the disassembler options.
9094 @kindex set disassembly-flavor
9095 @cindex Intel disassembly flavor
9096 @cindex AT&T disassembly flavor
9097 @item set disassembly-flavor @var{instruction-set}
9098 Select the instruction set to use when disassembling the
9099 program via the @code{disassemble} or @code{x/i} commands.
9101 Currently this command is only defined for the Intel x86 family. You
9102 can set @var{instruction-set} to either @code{intel} or @code{att}.
9103 The default is @code{att}, the AT&T flavor used by default by Unix
9104 assemblers for x86-based targets.
9106 @kindex show disassembly-flavor
9107 @item show disassembly-flavor
9108 Show the current setting of the disassembly flavor.
9112 @kindex set disassemble-next-line
9113 @kindex show disassemble-next-line
9114 @item set disassemble-next-line
9115 @itemx show disassemble-next-line
9116 Control whether or not @value{GDBN} will disassemble the next source
9117 line or instruction when execution stops. If ON, @value{GDBN} will
9118 display disassembly of the next source line when execution of the
9119 program being debugged stops. This is @emph{in addition} to
9120 displaying the source line itself, which @value{GDBN} always does if
9121 possible. If the next source line cannot be displayed for some reason
9122 (e.g., if @value{GDBN} cannot find the source file, or there's no line
9123 info in the debug info), @value{GDBN} will display disassembly of the
9124 next @emph{instruction} instead of showing the next source line. If
9125 AUTO, @value{GDBN} will display disassembly of next instruction only
9126 if the source line cannot be displayed. This setting causes
9127 @value{GDBN} to display some feedback when you step through a function
9128 with no line info or whose source file is unavailable. The default is
9129 OFF, which means never display the disassembly of the next line or
9135 @chapter Examining Data
9137 @cindex printing data
9138 @cindex examining data
9141 The usual way to examine data in your program is with the @code{print}
9142 command (abbreviated @code{p}), or its synonym @code{inspect}. It
9143 evaluates and prints the value of an expression of the language your
9144 program is written in (@pxref{Languages, ,Using @value{GDBN} with
9145 Different Languages}). It may also print the expression using a
9146 Python-based pretty-printer (@pxref{Pretty Printing}).
9149 @item print @var{expr}
9150 @itemx print /@var{f} @var{expr}
9151 @var{expr} is an expression (in the source language). By default the
9152 value of @var{expr} is printed in a format appropriate to its data type;
9153 you can choose a different format by specifying @samp{/@var{f}}, where
9154 @var{f} is a letter specifying the format; see @ref{Output Formats,,Output
9158 @itemx print /@var{f}
9159 @cindex reprint the last value
9160 If you omit @var{expr}, @value{GDBN} displays the last value again (from the
9161 @dfn{value history}; @pxref{Value History, ,Value History}). This allows you to
9162 conveniently inspect the same value in an alternative format.
9165 A more low-level way of examining data is with the @code{x} command.
9166 It examines data in memory at a specified address and prints it in a
9167 specified format. @xref{Memory, ,Examining Memory}.
9169 If you are interested in information about types, or about how the
9170 fields of a struct or a class are declared, use the @code{ptype @var{exp}}
9171 command rather than @code{print}. @xref{Symbols, ,Examining the Symbol
9174 @cindex exploring hierarchical data structures
9176 Another way of examining values of expressions and type information is
9177 through the Python extension command @code{explore} (available only if
9178 the @value{GDBN} build is configured with @code{--with-python}). It
9179 offers an interactive way to start at the highest level (or, the most
9180 abstract level) of the data type of an expression (or, the data type
9181 itself) and explore all the way down to leaf scalar values/fields
9182 embedded in the higher level data types.
9185 @item explore @var{arg}
9186 @var{arg} is either an expression (in the source language), or a type
9187 visible in the current context of the program being debugged.
9190 The working of the @code{explore} command can be illustrated with an
9191 example. If a data type @code{struct ComplexStruct} is defined in your
9201 struct ComplexStruct
9203 struct SimpleStruct *ss_p;
9209 followed by variable declarations as
9212 struct SimpleStruct ss = @{ 10, 1.11 @};
9213 struct ComplexStruct cs = @{ &ss, @{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 @} @};
9217 then, the value of the variable @code{cs} can be explored using the
9218 @code{explore} command as follows.
9222 The value of `cs' is a struct/class of type `struct ComplexStruct' with
9223 the following fields:
9225 ss_p = <Enter 0 to explore this field of type `struct SimpleStruct *'>
9226 arr = <Enter 1 to explore this field of type `int [10]'>
9228 Enter the field number of choice:
9232 Since the fields of @code{cs} are not scalar values, you are being
9233 prompted to chose the field you want to explore. Let's say you choose
9234 the field @code{ss_p} by entering @code{0}. Then, since this field is a
9235 pointer, you will be asked if it is pointing to a single value. From
9236 the declaration of @code{cs} above, it is indeed pointing to a single
9237 value, hence you enter @code{y}. If you enter @code{n}, then you will
9238 be asked if it were pointing to an array of values, in which case this
9239 field will be explored as if it were an array.
9242 `cs.ss_p' is a pointer to a value of type `struct SimpleStruct'
9243 Continue exploring it as a pointer to a single value [y/n]: y
9244 The value of `*(cs.ss_p)' is a struct/class of type `struct
9245 SimpleStruct' with the following fields:
9247 i = 10 .. (Value of type `int')
9248 d = 1.1100000000000001 .. (Value of type `double')
9250 Press enter to return to parent value:
9254 If the field @code{arr} of @code{cs} was chosen for exploration by
9255 entering @code{1} earlier, then since it is as array, you will be
9256 prompted to enter the index of the element in the array that you want
9260 `cs.arr' is an array of `int'.
9261 Enter the index of the element you want to explore in `cs.arr': 5
9263 `(cs.arr)[5]' is a scalar value of type `int'.
9267 Press enter to return to parent value:
9270 In general, at any stage of exploration, you can go deeper towards the
9271 leaf values by responding to the prompts appropriately, or hit the
9272 return key to return to the enclosing data structure (the @i{higher}
9273 level data structure).
9275 Similar to exploring values, you can use the @code{explore} command to
9276 explore types. Instead of specifying a value (which is typically a
9277 variable name or an expression valid in the current context of the
9278 program being debugged), you specify a type name. If you consider the
9279 same example as above, your can explore the type
9280 @code{struct ComplexStruct} by passing the argument
9281 @code{struct ComplexStruct} to the @code{explore} command.
9284 (gdb) explore struct ComplexStruct
9288 By responding to the prompts appropriately in the subsequent interactive
9289 session, you can explore the type @code{struct ComplexStruct} in a
9290 manner similar to how the value @code{cs} was explored in the above
9293 The @code{explore} command also has two sub-commands,
9294 @code{explore value} and @code{explore type}. The former sub-command is
9295 a way to explicitly specify that value exploration of the argument is
9296 being invoked, while the latter is a way to explicitly specify that type
9297 exploration of the argument is being invoked.
9300 @item explore value @var{expr}
9301 @cindex explore value
9302 This sub-command of @code{explore} explores the value of the
9303 expression @var{expr} (if @var{expr} is an expression valid in the
9304 current context of the program being debugged). The behavior of this
9305 command is identical to that of the behavior of the @code{explore}
9306 command being passed the argument @var{expr}.
9308 @item explore type @var{arg}
9309 @cindex explore type
9310 This sub-command of @code{explore} explores the type of @var{arg} (if
9311 @var{arg} is a type visible in the current context of program being
9312 debugged), or the type of the value/expression @var{arg} (if @var{arg}
9313 is an expression valid in the current context of the program being
9314 debugged). If @var{arg} is a type, then the behavior of this command is
9315 identical to that of the @code{explore} command being passed the
9316 argument @var{arg}. If @var{arg} is an expression, then the behavior of
9317 this command will be identical to that of the @code{explore} command
9318 being passed the type of @var{arg} as the argument.
9322 * Expressions:: Expressions
9323 * Ambiguous Expressions:: Ambiguous Expressions
9324 * Variables:: Program variables
9325 * Arrays:: Artificial arrays
9326 * Output Formats:: Output formats
9327 * Memory:: Examining memory
9328 * Auto Display:: Automatic display
9329 * Print Settings:: Print settings
9330 * Pretty Printing:: Python pretty printing
9331 * Value History:: Value history
9332 * Convenience Vars:: Convenience variables
9333 * Convenience Funs:: Convenience functions
9334 * Registers:: Registers
9335 * Floating Point Hardware:: Floating point hardware
9336 * Vector Unit:: Vector Unit
9337 * OS Information:: Auxiliary data provided by operating system
9338 * Memory Region Attributes:: Memory region attributes
9339 * Dump/Restore Files:: Copy between memory and a file
9340 * Core File Generation:: Cause a program dump its core
9341 * Character Sets:: Debugging programs that use a different
9342 character set than GDB does
9343 * Caching Target Data:: Data caching for targets
9344 * Searching Memory:: Searching memory for a sequence of bytes
9345 * Value Sizes:: Managing memory allocated for values
9349 @section Expressions
9352 @code{print} and many other @value{GDBN} commands accept an expression and
9353 compute its value. Any kind of constant, variable or operator defined
9354 by the programming language you are using is valid in an expression in
9355 @value{GDBN}. This includes conditional expressions, function calls,
9356 casts, and string constants. It also includes preprocessor macros, if
9357 you compiled your program to include this information; see
9360 @cindex arrays in expressions
9361 @value{GDBN} supports array constants in expressions input by
9362 the user. The syntax is @{@var{element}, @var{element}@dots{}@}. For example,
9363 you can use the command @code{print @{1, 2, 3@}} to create an array
9364 of three integers. If you pass an array to a function or assign it
9365 to a program variable, @value{GDBN} copies the array to memory that
9366 is @code{malloc}ed in the target program.
9368 Because C is so widespread, most of the expressions shown in examples in
9369 this manual are in C. @xref{Languages, , Using @value{GDBN} with Different
9370 Languages}, for information on how to use expressions in other
9373 In this section, we discuss operators that you can use in @value{GDBN}
9374 expressions regardless of your programming language.
9376 @cindex casts, in expressions
9377 Casts are supported in all languages, not just in C, because it is so
9378 useful to cast a number into a pointer in order to examine a structure
9379 at that address in memory.
9380 @c FIXME: casts supported---Mod2 true?
9382 @value{GDBN} supports these operators, in addition to those common
9383 to programming languages:
9387 @samp{@@} is a binary operator for treating parts of memory as arrays.
9388 @xref{Arrays, ,Artificial Arrays}, for more information.
9391 @samp{::} allows you to specify a variable in terms of the file or
9392 function where it is defined. @xref{Variables, ,Program Variables}.
9394 @cindex @{@var{type}@}
9395 @cindex type casting memory
9396 @cindex memory, viewing as typed object
9397 @cindex casts, to view memory
9398 @item @{@var{type}@} @var{addr}
9399 Refers to an object of type @var{type} stored at address @var{addr} in
9400 memory. The address @var{addr} may be any expression whose value is
9401 an integer or pointer (but parentheses are required around binary
9402 operators, just as in a cast). This construct is allowed regardless
9403 of what kind of data is normally supposed to reside at @var{addr}.
9406 @node Ambiguous Expressions
9407 @section Ambiguous Expressions
9408 @cindex ambiguous expressions
9410 Expressions can sometimes contain some ambiguous elements. For instance,
9411 some programming languages (notably Ada, C@t{++} and Objective-C) permit
9412 a single function name to be defined several times, for application in
9413 different contexts. This is called @dfn{overloading}. Another example
9414 involving Ada is generics. A @dfn{generic package} is similar to C@t{++}
9415 templates and is typically instantiated several times, resulting in
9416 the same function name being defined in different contexts.
9418 In some cases and depending on the language, it is possible to adjust
9419 the expression to remove the ambiguity. For instance in C@t{++}, you
9420 can specify the signature of the function you want to break on, as in
9421 @kbd{break @var{function}(@var{types})}. In Ada, using the fully
9422 qualified name of your function often makes the expression unambiguous
9425 When an ambiguity that needs to be resolved is detected, the debugger
9426 has the capability to display a menu of numbered choices for each
9427 possibility, and then waits for the selection with the prompt @samp{>}.
9428 The first option is always @samp{[0] cancel}, and typing @kbd{0 @key{RET}}
9429 aborts the current command. If the command in which the expression was
9430 used allows more than one choice to be selected, the next option in the
9431 menu is @samp{[1] all}, and typing @kbd{1 @key{RET}} selects all possible
9434 For example, the following session excerpt shows an attempt to set a
9435 breakpoint at the overloaded symbol @code{String::after}.
9436 We choose three particular definitions of that function name:
9438 @c FIXME! This is likely to change to show arg type lists, at least
9441 (@value{GDBP}) b String::after
9444 [2] file:String.cc; line number:867
9445 [3] file:String.cc; line number:860
9446 [4] file:String.cc; line number:875
9447 [5] file:String.cc; line number:853
9448 [6] file:String.cc; line number:846
9449 [7] file:String.cc; line number:735
9451 Breakpoint 1 at 0xb26c: file String.cc, line 867.
9452 Breakpoint 2 at 0xb344: file String.cc, line 875.
9453 Breakpoint 3 at 0xafcc: file String.cc, line 846.
9454 Multiple breakpoints were set.
9455 Use the "delete" command to delete unwanted
9462 @kindex set multiple-symbols
9463 @item set multiple-symbols @var{mode}
9464 @cindex multiple-symbols menu
9466 This option allows you to adjust the debugger behavior when an expression
9469 By default, @var{mode} is set to @code{all}. If the command with which
9470 the expression is used allows more than one choice, then @value{GDBN}
9471 automatically selects all possible choices. For instance, inserting
9472 a breakpoint on a function using an ambiguous name results in a breakpoint
9473 inserted on each possible match. However, if a unique choice must be made,
9474 then @value{GDBN} uses the menu to help you disambiguate the expression.
9475 For instance, printing the address of an overloaded function will result
9476 in the use of the menu.
9478 When @var{mode} is set to @code{ask}, the debugger always uses the menu
9479 when an ambiguity is detected.
9481 Finally, when @var{mode} is set to @code{cancel}, the debugger reports
9482 an error due to the ambiguity and the command is aborted.
9484 @kindex show multiple-symbols
9485 @item show multiple-symbols
9486 Show the current value of the @code{multiple-symbols} setting.
9490 @section Program Variables
9492 The most common kind of expression to use is the name of a variable
9495 Variables in expressions are understood in the selected stack frame
9496 (@pxref{Selection, ,Selecting a Frame}); they must be either:
9500 global (or file-static)
9507 visible according to the scope rules of the
9508 programming language from the point of execution in that frame
9511 @noindent This means that in the function
9526 you can examine and use the variable @code{a} whenever your program is
9527 executing within the function @code{foo}, but you can only use or
9528 examine the variable @code{b} while your program is executing inside
9529 the block where @code{b} is declared.
9531 @cindex variable name conflict
9532 There is an exception: you can refer to a variable or function whose
9533 scope is a single source file even if the current execution point is not
9534 in this file. But it is possible to have more than one such variable or
9535 function with the same name (in different source files). If that
9536 happens, referring to that name has unpredictable effects. If you wish,
9537 you can specify a static variable in a particular function or file by
9538 using the colon-colon (@code{::}) notation:
9540 @cindex colon-colon, context for variables/functions
9542 @c info cannot cope with a :: index entry, but why deprive hard copy readers?
9543 @cindex @code{::}, context for variables/functions
9546 @var{file}::@var{variable}
9547 @var{function}::@var{variable}
9551 Here @var{file} or @var{function} is the name of the context for the
9552 static @var{variable}. In the case of file names, you can use quotes to
9553 make sure @value{GDBN} parses the file name as a single word---for example,
9554 to print a global value of @code{x} defined in @file{f2.c}:
9557 (@value{GDBP}) p 'f2.c'::x
9560 The @code{::} notation is normally used for referring to
9561 static variables, since you typically disambiguate uses of local variables
9562 in functions by selecting the appropriate frame and using the
9563 simple name of the variable. However, you may also use this notation
9564 to refer to local variables in frames enclosing the selected frame:
9573 process (a); /* Stop here */
9584 For example, if there is a breakpoint at the commented line,
9585 here is what you might see
9586 when the program stops after executing the call @code{bar(0)}:
9591 (@value{GDBP}) p bar::a
9594 #2 0x080483d0 in foo (a=5) at foobar.c:12
9597 (@value{GDBP}) p bar::a
9601 @cindex C@t{++} scope resolution
9602 These uses of @samp{::} are very rarely in conflict with the very
9603 similar use of the same notation in C@t{++}. When they are in
9604 conflict, the C@t{++} meaning takes precedence; however, this can be
9605 overridden by quoting the file or function name with single quotes.
9607 For example, suppose the program is stopped in a method of a class
9608 that has a field named @code{includefile}, and there is also an
9609 include file named @file{includefile} that defines a variable,
9613 (@value{GDBP}) p includefile
9615 (@value{GDBP}) p includefile::some_global
9616 A syntax error in expression, near `'.
9617 (@value{GDBP}) p 'includefile'::some_global
9621 @cindex wrong values
9622 @cindex variable values, wrong
9623 @cindex function entry/exit, wrong values of variables
9624 @cindex optimized code, wrong values of variables
9626 @emph{Warning:} Occasionally, a local variable may appear to have the
9627 wrong value at certain points in a function---just after entry to a new
9628 scope, and just before exit.
9630 You may see this problem when you are stepping by machine instructions.
9631 This is because, on most machines, it takes more than one instruction to
9632 set up a stack frame (including local variable definitions); if you are
9633 stepping by machine instructions, variables may appear to have the wrong
9634 values until the stack frame is completely built. On exit, it usually
9635 also takes more than one machine instruction to destroy a stack frame;
9636 after you begin stepping through that group of instructions, local
9637 variable definitions may be gone.
9639 This may also happen when the compiler does significant optimizations.
9640 To be sure of always seeing accurate values, turn off all optimization
9643 @cindex ``No symbol "foo" in current context''
9644 Another possible effect of compiler optimizations is to optimize
9645 unused variables out of existence, or assign variables to registers (as
9646 opposed to memory addresses). Depending on the support for such cases
9647 offered by the debug info format used by the compiler, @value{GDBN}
9648 might not be able to display values for such local variables. If that
9649 happens, @value{GDBN} will print a message like this:
9652 No symbol "foo" in current context.
9655 To solve such problems, either recompile without optimizations, or use a
9656 different debug info format, if the compiler supports several such
9657 formats. @xref{Compilation}, for more information on choosing compiler
9658 options. @xref{C, ,C and C@t{++}}, for more information about debug
9659 info formats that are best suited to C@t{++} programs.
9661 If you ask to print an object whose contents are unknown to
9662 @value{GDBN}, e.g., because its data type is not completely specified
9663 by the debug information, @value{GDBN} will say @samp{<incomplete
9664 type>}. @xref{Symbols, incomplete type}, for more about this.
9666 @cindex no debug info variables
9667 If you try to examine or use the value of a (global) variable for
9668 which @value{GDBN} has no type information, e.g., because the program
9669 includes no debug information, @value{GDBN} displays an error message.
9670 @xref{Symbols, unknown type}, for more about unknown types. If you
9671 cast the variable to its declared type, @value{GDBN} gets the
9672 variable's value using the cast-to type as the variable's type. For
9673 example, in a C program:
9676 (@value{GDBP}) p var
9677 'var' has unknown type; cast it to its declared type
9678 (@value{GDBP}) p (float) var
9682 If you append @kbd{@@entry} string to a function parameter name you get its
9683 value at the time the function got called. If the value is not available an
9684 error message is printed. Entry values are available only with some compilers.
9685 Entry values are normally also printed at the function parameter list according
9686 to @ref{set print entry-values}.
9689 Breakpoint 1, d (i=30) at gdb.base/entry-value.c:29
9695 (gdb) print i@@entry
9699 Strings are identified as arrays of @code{char} values without specified
9700 signedness. Arrays of either @code{signed char} or @code{unsigned char} get
9701 printed as arrays of 1 byte sized integers. @code{-fsigned-char} or
9702 @code{-funsigned-char} @value{NGCC} options have no effect as @value{GDBN}
9703 defines literal string type @code{"char"} as @code{char} without a sign.
9708 signed char var1[] = "A";
9711 You get during debugging
9716 $2 = @{65 'A', 0 '\0'@}
9720 @section Artificial Arrays
9722 @cindex artificial array
9724 @kindex @@@r{, referencing memory as an array}
9725 It is often useful to print out several successive objects of the
9726 same type in memory; a section of an array, or an array of
9727 dynamically determined size for which only a pointer exists in the
9730 You can do this by referring to a contiguous span of memory as an
9731 @dfn{artificial array}, using the binary operator @samp{@@}. The left
9732 operand of @samp{@@} should be the first element of the desired array
9733 and be an individual object. The right operand should be the desired length
9734 of the array. The result is an array value whose elements are all of
9735 the type of the left argument. The first element is actually the left
9736 argument; the second element comes from bytes of memory immediately
9737 following those that hold the first element, and so on. Here is an
9738 example. If a program says
9741 int *array = (int *) malloc (len * sizeof (int));
9745 you can print the contents of @code{array} with
9751 The left operand of @samp{@@} must reside in memory. Array values made
9752 with @samp{@@} in this way behave just like other arrays in terms of
9753 subscripting, and are coerced to pointers when used in expressions.
9754 Artificial arrays most often appear in expressions via the value history
9755 (@pxref{Value History, ,Value History}), after printing one out.
9757 Another way to create an artificial array is to use a cast.
9758 This re-interprets a value as if it were an array.
9759 The value need not be in memory:
9761 (@value{GDBP}) p/x (short[2])0x12345678
9762 $1 = @{0x1234, 0x5678@}
9765 As a convenience, if you leave the array length out (as in
9766 @samp{(@var{type}[])@var{value}}) @value{GDBN} calculates the size to fill
9767 the value (as @samp{sizeof(@var{value})/sizeof(@var{type})}:
9769 (@value{GDBP}) p/x (short[])0x12345678
9770 $2 = @{0x1234, 0x5678@}
9773 Sometimes the artificial array mechanism is not quite enough; in
9774 moderately complex data structures, the elements of interest may not
9775 actually be adjacent---for example, if you are interested in the values
9776 of pointers in an array. One useful work-around in this situation is
9777 to use a convenience variable (@pxref{Convenience Vars, ,Convenience
9778 Variables}) as a counter in an expression that prints the first
9779 interesting value, and then repeat that expression via @key{RET}. For
9780 instance, suppose you have an array @code{dtab} of pointers to
9781 structures, and you are interested in the values of a field @code{fv}
9782 in each structure. Here is an example of what you might type:
9792 @node Output Formats
9793 @section Output Formats
9795 @cindex formatted output
9796 @cindex output formats
9797 By default, @value{GDBN} prints a value according to its data type. Sometimes
9798 this is not what you want. For example, you might want to print a number
9799 in hex, or a pointer in decimal. Or you might want to view data in memory
9800 at a certain address as a character string or as an instruction. To do
9801 these things, specify an @dfn{output format} when you print a value.
9803 The simplest use of output formats is to say how to print a value
9804 already computed. This is done by starting the arguments of the
9805 @code{print} command with a slash and a format letter. The format
9806 letters supported are:
9810 Regard the bits of the value as an integer, and print the integer in
9814 Print as integer in signed decimal.
9817 Print as integer in unsigned decimal.
9820 Print as integer in octal.
9823 Print as integer in binary. The letter @samp{t} stands for ``two''.
9824 @footnote{@samp{b} cannot be used because these format letters are also
9825 used with the @code{x} command, where @samp{b} stands for ``byte'';
9826 see @ref{Memory,,Examining Memory}.}
9829 @cindex unknown address, locating
9830 @cindex locate address
9831 Print as an address, both absolute in hexadecimal and as an offset from
9832 the nearest preceding symbol. You can use this format used to discover
9833 where (in what function) an unknown address is located:
9836 (@value{GDBP}) p/a 0x54320
9837 $3 = 0x54320 <_initialize_vx+396>
9841 The command @code{info symbol 0x54320} yields similar results.
9842 @xref{Symbols, info symbol}.
9845 Regard as an integer and print it as a character constant. This
9846 prints both the numerical value and its character representation. The
9847 character representation is replaced with the octal escape @samp{\nnn}
9848 for characters outside the 7-bit @sc{ascii} range.
9850 Without this format, @value{GDBN} displays @code{char},
9851 @w{@code{unsigned char}}, and @w{@code{signed char}} data as character
9852 constants. Single-byte members of vectors are displayed as integer
9856 Regard the bits of the value as a floating point number and print
9857 using typical floating point syntax.
9860 @cindex printing strings
9861 @cindex printing byte arrays
9862 Regard as a string, if possible. With this format, pointers to single-byte
9863 data are displayed as null-terminated strings and arrays of single-byte data
9864 are displayed as fixed-length strings. Other values are displayed in their
9867 Without this format, @value{GDBN} displays pointers to and arrays of
9868 @code{char}, @w{@code{unsigned char}}, and @w{@code{signed char}} as
9869 strings. Single-byte members of a vector are displayed as an integer
9873 Like @samp{x} formatting, the value is treated as an integer and
9874 printed as hexadecimal, but leading zeros are printed to pad the value
9875 to the size of the integer type.
9878 @cindex raw printing
9879 Print using the @samp{raw} formatting. By default, @value{GDBN} will
9880 use a Python-based pretty-printer, if one is available (@pxref{Pretty
9881 Printing}). This typically results in a higher-level display of the
9882 value's contents. The @samp{r} format bypasses any Python
9883 pretty-printer which might exist.
9886 For example, to print the program counter in hex (@pxref{Registers}), type
9893 Note that no space is required before the slash; this is because command
9894 names in @value{GDBN} cannot contain a slash.
9896 To reprint the last value in the value history with a different format,
9897 you can use the @code{print} command with just a format and no
9898 expression. For example, @samp{p/x} reprints the last value in hex.
9901 @section Examining Memory
9903 You can use the command @code{x} (for ``examine'') to examine memory in
9904 any of several formats, independently of your program's data types.
9906 @cindex examining memory
9908 @kindex x @r{(examine memory)}
9909 @item x/@var{nfu} @var{addr}
9912 Use the @code{x} command to examine memory.
9915 @var{n}, @var{f}, and @var{u} are all optional parameters that specify how
9916 much memory to display and how to format it; @var{addr} is an
9917 expression giving the address where you want to start displaying memory.
9918 If you use defaults for @var{nfu}, you need not type the slash @samp{/}.
9919 Several commands set convenient defaults for @var{addr}.
9922 @item @var{n}, the repeat count
9923 The repeat count is a decimal integer; the default is 1. It specifies
9924 how much memory (counting by units @var{u}) to display. If a negative
9925 number is specified, memory is examined backward from @var{addr}.
9926 @c This really is **decimal**; unaffected by 'set radix' as of GDB
9929 @item @var{f}, the display format
9930 The display format is one of the formats used by @code{print}
9931 (@samp{x}, @samp{d}, @samp{u}, @samp{o}, @samp{t}, @samp{a}, @samp{c},
9932 @samp{f}, @samp{s}), and in addition @samp{i} (for machine instructions).
9933 The default is @samp{x} (hexadecimal) initially. The default changes
9934 each time you use either @code{x} or @code{print}.
9936 @item @var{u}, the unit size
9937 The unit size is any of
9943 Halfwords (two bytes).
9945 Words (four bytes). This is the initial default.
9947 Giant words (eight bytes).
9950 Each time you specify a unit size with @code{x}, that size becomes the
9951 default unit the next time you use @code{x}. For the @samp{i} format,
9952 the unit size is ignored and is normally not written. For the @samp{s} format,
9953 the unit size defaults to @samp{b}, unless it is explicitly given.
9954 Use @kbd{x /hs} to display 16-bit char strings and @kbd{x /ws} to display
9955 32-bit strings. The next use of @kbd{x /s} will again display 8-bit strings.
9956 Note that the results depend on the programming language of the
9957 current compilation unit. If the language is C, the @samp{s}
9958 modifier will use the UTF-16 encoding while @samp{w} will use
9959 UTF-32. The encoding is set by the programming language and cannot
9962 @item @var{addr}, starting display address
9963 @var{addr} is the address where you want @value{GDBN} to begin displaying
9964 memory. The expression need not have a pointer value (though it may);
9965 it is always interpreted as an integer address of a byte of memory.
9966 @xref{Expressions, ,Expressions}, for more information on expressions. The default for
9967 @var{addr} is usually just after the last address examined---but several
9968 other commands also set the default address: @code{info breakpoints} (to
9969 the address of the last breakpoint listed), @code{info line} (to the
9970 starting address of a line), and @code{print} (if you use it to display
9971 a value from memory).
9974 For example, @samp{x/3uh 0x54320} is a request to display three halfwords
9975 (@code{h}) of memory, formatted as unsigned decimal integers (@samp{u}),
9976 starting at address @code{0x54320}. @samp{x/4xw $sp} prints the four
9977 words (@samp{w}) of memory above the stack pointer (here, @samp{$sp};
9978 @pxref{Registers, ,Registers}) in hexadecimal (@samp{x}).
9980 You can also specify a negative repeat count to examine memory backward
9981 from the given address. For example, @samp{x/-3uh 0x54320} prints three
9982 halfwords (@code{h}) at @code{0x54314}, @code{0x54328}, and @code{0x5431c}.
9984 Since the letters indicating unit sizes are all distinct from the
9985 letters specifying output formats, you do not have to remember whether
9986 unit size or format comes first; either order works. The output
9987 specifications @samp{4xw} and @samp{4wx} mean exactly the same thing.
9988 (However, the count @var{n} must come first; @samp{wx4} does not work.)
9990 Even though the unit size @var{u} is ignored for the formats @samp{s}
9991 and @samp{i}, you might still want to use a count @var{n}; for example,
9992 @samp{3i} specifies that you want to see three machine instructions,
9993 including any operands. For convenience, especially when used with
9994 the @code{display} command, the @samp{i} format also prints branch delay
9995 slot instructions, if any, beyond the count specified, which immediately
9996 follow the last instruction that is within the count. The command
9997 @code{disassemble} gives an alternative way of inspecting machine
9998 instructions; see @ref{Machine Code,,Source and Machine Code}.
10000 If a negative repeat count is specified for the formats @samp{s} or @samp{i},
10001 the command displays null-terminated strings or instructions before the given
10002 address as many as the absolute value of the given number. For the @samp{i}
10003 format, we use line number information in the debug info to accurately locate
10004 instruction boundaries while disassembling backward. If line info is not
10005 available, the command stops examining memory with an error message.
10007 All the defaults for the arguments to @code{x} are designed to make it
10008 easy to continue scanning memory with minimal specifications each time
10009 you use @code{x}. For example, after you have inspected three machine
10010 instructions with @samp{x/3i @var{addr}}, you can inspect the next seven
10011 with just @samp{x/7}. If you use @key{RET} to repeat the @code{x} command,
10012 the repeat count @var{n} is used again; the other arguments default as
10013 for successive uses of @code{x}.
10015 When examining machine instructions, the instruction at current program
10016 counter is shown with a @code{=>} marker. For example:
10019 (@value{GDBP}) x/5i $pc-6
10020 0x804837f <main+11>: mov %esp,%ebp
10021 0x8048381 <main+13>: push %ecx
10022 0x8048382 <main+14>: sub $0x4,%esp
10023 => 0x8048385 <main+17>: movl $0x8048460,(%esp)
10024 0x804838c <main+24>: call 0x80482d4 <puts@@plt>
10027 @cindex @code{$_}, @code{$__}, and value history
10028 The addresses and contents printed by the @code{x} command are not saved
10029 in the value history because there is often too much of them and they
10030 would get in the way. Instead, @value{GDBN} makes these values available for
10031 subsequent use in expressions as values of the convenience variables
10032 @code{$_} and @code{$__}. After an @code{x} command, the last address
10033 examined is available for use in expressions in the convenience variable
10034 @code{$_}. The contents of that address, as examined, are available in
10035 the convenience variable @code{$__}.
10037 If the @code{x} command has a repeat count, the address and contents saved
10038 are from the last memory unit printed; this is not the same as the last
10039 address printed if several units were printed on the last line of output.
10041 @anchor{addressable memory unit}
10042 @cindex addressable memory unit
10043 Most targets have an addressable memory unit size of 8 bits. This means
10044 that to each memory address are associated 8 bits of data. Some
10045 targets, however, have other addressable memory unit sizes.
10046 Within @value{GDBN} and this document, the term
10047 @dfn{addressable memory unit} (or @dfn{memory unit} for short) is used
10048 when explicitly referring to a chunk of data of that size. The word
10049 @dfn{byte} is used to refer to a chunk of data of 8 bits, regardless of
10050 the addressable memory unit size of the target. For most systems,
10051 addressable memory unit is a synonym of byte.
10053 @cindex remote memory comparison
10054 @cindex target memory comparison
10055 @cindex verify remote memory image
10056 @cindex verify target memory image
10057 When you are debugging a program running on a remote target machine
10058 (@pxref{Remote Debugging}), you may wish to verify the program's image
10059 in the remote machine's memory against the executable file you
10060 downloaded to the target. Or, on any target, you may want to check
10061 whether the program has corrupted its own read-only sections. The
10062 @code{compare-sections} command is provided for such situations.
10065 @kindex compare-sections
10066 @item compare-sections @r{[}@var{section-name}@r{|}@code{-r}@r{]}
10067 Compare the data of a loadable section @var{section-name} in the
10068 executable file of the program being debugged with the same section in
10069 the target machine's memory, and report any mismatches. With no
10070 arguments, compares all loadable sections. With an argument of
10071 @code{-r}, compares all loadable read-only sections.
10073 Note: for remote targets, this command can be accelerated if the
10074 target supports computing the CRC checksum of a block of memory
10075 (@pxref{qCRC packet}).
10079 @section Automatic Display
10080 @cindex automatic display
10081 @cindex display of expressions
10083 If you find that you want to print the value of an expression frequently
10084 (to see how it changes), you might want to add it to the @dfn{automatic
10085 display list} so that @value{GDBN} prints its value each time your program stops.
10086 Each expression added to the list is given a number to identify it;
10087 to remove an expression from the list, you specify that number.
10088 The automatic display looks like this:
10092 3: bar[5] = (struct hack *) 0x3804
10096 This display shows item numbers, expressions and their current values. As with
10097 displays you request manually using @code{x} or @code{print}, you can
10098 specify the output format you prefer; in fact, @code{display} decides
10099 whether to use @code{print} or @code{x} depending your format
10100 specification---it uses @code{x} if you specify either the @samp{i}
10101 or @samp{s} format, or a unit size; otherwise it uses @code{print}.
10105 @item display @var{expr}
10106 Add the expression @var{expr} to the list of expressions to display
10107 each time your program stops. @xref{Expressions, ,Expressions}.
10109 @code{display} does not repeat if you press @key{RET} again after using it.
10111 @item display/@var{fmt} @var{expr}
10112 For @var{fmt} specifying only a display format and not a size or
10113 count, add the expression @var{expr} to the auto-display list but
10114 arrange to display it each time in the specified format @var{fmt}.
10115 @xref{Output Formats,,Output Formats}.
10117 @item display/@var{fmt} @var{addr}
10118 For @var{fmt} @samp{i} or @samp{s}, or including a unit-size or a
10119 number of units, add the expression @var{addr} as a memory address to
10120 be examined each time your program stops. Examining means in effect
10121 doing @samp{x/@var{fmt} @var{addr}}. @xref{Memory, ,Examining Memory}.
10124 For example, @samp{display/i $pc} can be helpful, to see the machine
10125 instruction about to be executed each time execution stops (@samp{$pc}
10126 is a common name for the program counter; @pxref{Registers, ,Registers}).
10129 @kindex delete display
10131 @item undisplay @var{dnums}@dots{}
10132 @itemx delete display @var{dnums}@dots{}
10133 Remove items from the list of expressions to display. Specify the
10134 numbers of the displays that you want affected with the command
10135 argument @var{dnums}. It can be a single display number, one of the
10136 numbers shown in the first field of the @samp{info display} display;
10137 or it could be a range of display numbers, as in @code{2-4}.
10139 @code{undisplay} does not repeat if you press @key{RET} after using it.
10140 (Otherwise you would just get the error @samp{No display number @dots{}}.)
10142 @kindex disable display
10143 @item disable display @var{dnums}@dots{}
10144 Disable the display of item numbers @var{dnums}. A disabled display
10145 item is not printed automatically, but is not forgotten. It may be
10146 enabled again later. Specify the numbers of the displays that you
10147 want affected with the command argument @var{dnums}. It can be a
10148 single display number, one of the numbers shown in the first field of
10149 the @samp{info display} display; or it could be a range of display
10150 numbers, as in @code{2-4}.
10152 @kindex enable display
10153 @item enable display @var{dnums}@dots{}
10154 Enable display of item numbers @var{dnums}. It becomes effective once
10155 again in auto display of its expression, until you specify otherwise.
10156 Specify the numbers of the displays that you want affected with the
10157 command argument @var{dnums}. It can be a single display number, one
10158 of the numbers shown in the first field of the @samp{info display}
10159 display; or it could be a range of display numbers, as in @code{2-4}.
10162 Display the current values of the expressions on the list, just as is
10163 done when your program stops.
10165 @kindex info display
10167 Print the list of expressions previously set up to display
10168 automatically, each one with its item number, but without showing the
10169 values. This includes disabled expressions, which are marked as such.
10170 It also includes expressions which would not be displayed right now
10171 because they refer to automatic variables not currently available.
10174 @cindex display disabled out of scope
10175 If a display expression refers to local variables, then it does not make
10176 sense outside the lexical context for which it was set up. Such an
10177 expression is disabled when execution enters a context where one of its
10178 variables is not defined. For example, if you give the command
10179 @code{display last_char} while inside a function with an argument
10180 @code{last_char}, @value{GDBN} displays this argument while your program
10181 continues to stop inside that function. When it stops elsewhere---where
10182 there is no variable @code{last_char}---the display is disabled
10183 automatically. The next time your program stops where @code{last_char}
10184 is meaningful, you can enable the display expression once again.
10186 @node Print Settings
10187 @section Print Settings
10189 @cindex format options
10190 @cindex print settings
10191 @value{GDBN} provides the following ways to control how arrays, structures,
10192 and symbols are printed.
10195 These settings are useful for debugging programs in any language:
10199 @item set print address
10200 @itemx set print address on
10201 @cindex print/don't print memory addresses
10202 @value{GDBN} prints memory addresses showing the location of stack
10203 traces, structure values, pointer values, breakpoints, and so forth,
10204 even when it also displays the contents of those addresses. The default
10205 is @code{on}. For example, this is what a stack frame display looks like with
10206 @code{set print address on}:
10211 #0 set_quotes (lq=0x34c78 "<<", rq=0x34c88 ">>")
10213 530 if (lquote != def_lquote)
10217 @item set print address off
10218 Do not print addresses when displaying their contents. For example,
10219 this is the same stack frame displayed with @code{set print address off}:
10223 (@value{GDBP}) set print addr off
10225 #0 set_quotes (lq="<<", rq=">>") at input.c:530
10226 530 if (lquote != def_lquote)
10230 You can use @samp{set print address off} to eliminate all machine
10231 dependent displays from the @value{GDBN} interface. For example, with
10232 @code{print address off}, you should get the same text for backtraces on
10233 all machines---whether or not they involve pointer arguments.
10236 @item show print address
10237 Show whether or not addresses are to be printed.
10240 When @value{GDBN} prints a symbolic address, it normally prints the
10241 closest earlier symbol plus an offset. If that symbol does not uniquely
10242 identify the address (for example, it is a name whose scope is a single
10243 source file), you may need to clarify. One way to do this is with
10244 @code{info line}, for example @samp{info line *0x4537}. Alternately,
10245 you can set @value{GDBN} to print the source file and line number when
10246 it prints a symbolic address:
10249 @item set print symbol-filename on
10250 @cindex source file and line of a symbol
10251 @cindex symbol, source file and line
10252 Tell @value{GDBN} to print the source file name and line number of a
10253 symbol in the symbolic form of an address.
10255 @item set print symbol-filename off
10256 Do not print source file name and line number of a symbol. This is the
10259 @item show print symbol-filename
10260 Show whether or not @value{GDBN} will print the source file name and
10261 line number of a symbol in the symbolic form of an address.
10264 Another situation where it is helpful to show symbol filenames and line
10265 numbers is when disassembling code; @value{GDBN} shows you the line
10266 number and source file that corresponds to each instruction.
10268 Also, you may wish to see the symbolic form only if the address being
10269 printed is reasonably close to the closest earlier symbol:
10272 @item set print max-symbolic-offset @var{max-offset}
10273 @itemx set print max-symbolic-offset unlimited
10274 @cindex maximum value for offset of closest symbol
10275 Tell @value{GDBN} to only display the symbolic form of an address if the
10276 offset between the closest earlier symbol and the address is less than
10277 @var{max-offset}. The default is @code{unlimited}, which tells @value{GDBN}
10278 to always print the symbolic form of an address if any symbol precedes
10279 it. Zero is equivalent to @code{unlimited}.
10281 @item show print max-symbolic-offset
10282 Ask how large the maximum offset is that @value{GDBN} prints in a
10286 @cindex wild pointer, interpreting
10287 @cindex pointer, finding referent
10288 If you have a pointer and you are not sure where it points, try
10289 @samp{set print symbol-filename on}. Then you can determine the name
10290 and source file location of the variable where it points, using
10291 @samp{p/a @var{pointer}}. This interprets the address in symbolic form.
10292 For example, here @value{GDBN} shows that a variable @code{ptt} points
10293 at another variable @code{t}, defined in @file{hi2.c}:
10296 (@value{GDBP}) set print symbol-filename on
10297 (@value{GDBP}) p/a ptt
10298 $4 = 0xe008 <t in hi2.c>
10302 @emph{Warning:} For pointers that point to a local variable, @samp{p/a}
10303 does not show the symbol name and filename of the referent, even with
10304 the appropriate @code{set print} options turned on.
10307 You can also enable @samp{/a}-like formatting all the time using
10308 @samp{set print symbol on}:
10311 @item set print symbol on
10312 Tell @value{GDBN} to print the symbol corresponding to an address, if
10315 @item set print symbol off
10316 Tell @value{GDBN} not to print the symbol corresponding to an
10317 address. In this mode, @value{GDBN} will still print the symbol
10318 corresponding to pointers to functions. This is the default.
10320 @item show print symbol
10321 Show whether @value{GDBN} will display the symbol corresponding to an
10325 Other settings control how different kinds of objects are printed:
10328 @item set print array
10329 @itemx set print array on
10330 @cindex pretty print arrays
10331 Pretty print arrays. This format is more convenient to read,
10332 but uses more space. The default is off.
10334 @item set print array off
10335 Return to compressed format for arrays.
10337 @item show print array
10338 Show whether compressed or pretty format is selected for displaying
10341 @cindex print array indexes
10342 @item set print array-indexes
10343 @itemx set print array-indexes on
10344 Print the index of each element when displaying arrays. May be more
10345 convenient to locate a given element in the array or quickly find the
10346 index of a given element in that printed array. The default is off.
10348 @item set print array-indexes off
10349 Stop printing element indexes when displaying arrays.
10351 @item show print array-indexes
10352 Show whether the index of each element is printed when displaying
10355 @item set print elements @var{number-of-elements}
10356 @itemx set print elements unlimited
10357 @cindex number of array elements to print
10358 @cindex limit on number of printed array elements
10359 Set a limit on how many elements of an array @value{GDBN} will print.
10360 If @value{GDBN} is printing a large array, it stops printing after it has
10361 printed the number of elements set by the @code{set print elements} command.
10362 This limit also applies to the display of strings.
10363 When @value{GDBN} starts, this limit is set to 200.
10364 Setting @var{number-of-elements} to @code{unlimited} or zero means
10365 that the number of elements to print is unlimited.
10367 @item show print elements
10368 Display the number of elements of a large array that @value{GDBN} will print.
10369 If the number is 0, then the printing is unlimited.
10371 @item set print frame-arguments @var{value}
10372 @kindex set print frame-arguments
10373 @cindex printing frame argument values
10374 @cindex print all frame argument values
10375 @cindex print frame argument values for scalars only
10376 @cindex do not print frame argument values
10377 This command allows to control how the values of arguments are printed
10378 when the debugger prints a frame (@pxref{Frames}). The possible
10383 The values of all arguments are printed.
10386 Print the value of an argument only if it is a scalar. The value of more
10387 complex arguments such as arrays, structures, unions, etc, is replaced
10388 by @code{@dots{}}. This is the default. Here is an example where
10389 only scalar arguments are shown:
10392 #1 0x08048361 in call_me (i=3, s=@dots{}, ss=0xbf8d508c, u=@dots{}, e=green)
10397 None of the argument values are printed. Instead, the value of each argument
10398 is replaced by @code{@dots{}}. In this case, the example above now becomes:
10401 #1 0x08048361 in call_me (i=@dots{}, s=@dots{}, ss=@dots{}, u=@dots{}, e=@dots{})
10406 By default, only scalar arguments are printed. This command can be used
10407 to configure the debugger to print the value of all arguments, regardless
10408 of their type. However, it is often advantageous to not print the value
10409 of more complex parameters. For instance, it reduces the amount of
10410 information printed in each frame, making the backtrace more readable.
10411 Also, it improves performance when displaying Ada frames, because
10412 the computation of large arguments can sometimes be CPU-intensive,
10413 especially in large applications. Setting @code{print frame-arguments}
10414 to @code{scalars} (the default) or @code{none} avoids this computation,
10415 thus speeding up the display of each Ada frame.
10417 @item show print frame-arguments
10418 Show how the value of arguments should be displayed when printing a frame.
10420 @item set print raw frame-arguments on
10421 Print frame arguments in raw, non pretty-printed, form.
10423 @item set print raw frame-arguments off
10424 Print frame arguments in pretty-printed form, if there is a pretty-printer
10425 for the value (@pxref{Pretty Printing}),
10426 otherwise print the value in raw form.
10427 This is the default.
10429 @item show print raw frame-arguments
10430 Show whether to print frame arguments in raw form.
10432 @anchor{set print entry-values}
10433 @item set print entry-values @var{value}
10434 @kindex set print entry-values
10435 Set printing of frame argument values at function entry. In some cases
10436 @value{GDBN} can determine the value of function argument which was passed by
10437 the function caller, even if the value was modified inside the called function
10438 and therefore is different. With optimized code, the current value could be
10439 unavailable, but the entry value may still be known.
10441 The default value is @code{default} (see below for its description). Older
10442 @value{GDBN} behaved as with the setting @code{no}. Compilers not supporting
10443 this feature will behave in the @code{default} setting the same way as with the
10446 This functionality is currently supported only by DWARF 2 debugging format and
10447 the compiler has to produce @samp{DW_TAG_call_site} tags. With
10448 @value{NGCC}, you need to specify @option{-O -g} during compilation, to get
10451 The @var{value} parameter can be one of the following:
10455 Print only actual parameter values, never print values from function entry
10459 #0 different (val=6)
10460 #0 lost (val=<optimized out>)
10462 #0 invalid (val=<optimized out>)
10466 Print only parameter values from function entry point. The actual parameter
10467 values are never printed.
10469 #0 equal (val@@entry=5)
10470 #0 different (val@@entry=5)
10471 #0 lost (val@@entry=5)
10472 #0 born (val@@entry=<optimized out>)
10473 #0 invalid (val@@entry=<optimized out>)
10477 Print only parameter values from function entry point. If value from function
10478 entry point is not known while the actual value is known, print the actual
10479 value for such parameter.
10481 #0 equal (val@@entry=5)
10482 #0 different (val@@entry=5)
10483 #0 lost (val@@entry=5)
10485 #0 invalid (val@@entry=<optimized out>)
10489 Print actual parameter values. If actual parameter value is not known while
10490 value from function entry point is known, print the entry point value for such
10494 #0 different (val=6)
10495 #0 lost (val@@entry=5)
10497 #0 invalid (val=<optimized out>)
10501 Always print both the actual parameter value and its value from function entry
10502 point, even if values of one or both are not available due to compiler
10505 #0 equal (val=5, val@@entry=5)
10506 #0 different (val=6, val@@entry=5)
10507 #0 lost (val=<optimized out>, val@@entry=5)
10508 #0 born (val=10, val@@entry=<optimized out>)
10509 #0 invalid (val=<optimized out>, val@@entry=<optimized out>)
10513 Print the actual parameter value if it is known and also its value from
10514 function entry point if it is known. If neither is known, print for the actual
10515 value @code{<optimized out>}. If not in MI mode (@pxref{GDB/MI}) and if both
10516 values are known and identical, print the shortened
10517 @code{param=param@@entry=VALUE} notation.
10519 #0 equal (val=val@@entry=5)
10520 #0 different (val=6, val@@entry=5)
10521 #0 lost (val@@entry=5)
10523 #0 invalid (val=<optimized out>)
10527 Always print the actual parameter value. Print also its value from function
10528 entry point, but only if it is known. If not in MI mode (@pxref{GDB/MI}) and
10529 if both values are known and identical, print the shortened
10530 @code{param=param@@entry=VALUE} notation.
10532 #0 equal (val=val@@entry=5)
10533 #0 different (val=6, val@@entry=5)
10534 #0 lost (val=<optimized out>, val@@entry=5)
10536 #0 invalid (val=<optimized out>)
10540 For analysis messages on possible failures of frame argument values at function
10541 entry resolution see @ref{set debug entry-values}.
10543 @item show print entry-values
10544 Show the method being used for printing of frame argument values at function
10547 @item set print repeats @var{number-of-repeats}
10548 @itemx set print repeats unlimited
10549 @cindex repeated array elements
10550 Set the threshold for suppressing display of repeated array
10551 elements. When the number of consecutive identical elements of an
10552 array exceeds the threshold, @value{GDBN} prints the string
10553 @code{"<repeats @var{n} times>"}, where @var{n} is the number of
10554 identical repetitions, instead of displaying the identical elements
10555 themselves. Setting the threshold to @code{unlimited} or zero will
10556 cause all elements to be individually printed. The default threshold
10559 @item show print repeats
10560 Display the current threshold for printing repeated identical
10563 @item set print null-stop
10564 @cindex @sc{null} elements in arrays
10565 Cause @value{GDBN} to stop printing the characters of an array when the first
10566 @sc{null} is encountered. This is useful when large arrays actually
10567 contain only short strings.
10568 The default is off.
10570 @item show print null-stop
10571 Show whether @value{GDBN} stops printing an array on the first
10572 @sc{null} character.
10574 @item set print pretty on
10575 @cindex print structures in indented form
10576 @cindex indentation in structure display
10577 Cause @value{GDBN} to print structures in an indented format with one member
10578 per line, like this:
10593 @item set print pretty off
10594 Cause @value{GDBN} to print structures in a compact format, like this:
10598 $1 = @{next = 0x0, flags = @{sweet = 1, sour = 1@}, \
10599 meat = 0x54 "Pork"@}
10604 This is the default format.
10606 @item show print pretty
10607 Show which format @value{GDBN} is using to print structures.
10609 @item set print sevenbit-strings on
10610 @cindex eight-bit characters in strings
10611 @cindex octal escapes in strings
10612 Print using only seven-bit characters; if this option is set,
10613 @value{GDBN} displays any eight-bit characters (in strings or
10614 character values) using the notation @code{\}@var{nnn}. This setting is
10615 best if you are working in English (@sc{ascii}) and you use the
10616 high-order bit of characters as a marker or ``meta'' bit.
10618 @item set print sevenbit-strings off
10619 Print full eight-bit characters. This allows the use of more
10620 international character sets, and is the default.
10622 @item show print sevenbit-strings
10623 Show whether or not @value{GDBN} is printing only seven-bit characters.
10625 @item set print union on
10626 @cindex unions in structures, printing
10627 Tell @value{GDBN} to print unions which are contained in structures
10628 and other unions. This is the default setting.
10630 @item set print union off
10631 Tell @value{GDBN} not to print unions which are contained in
10632 structures and other unions. @value{GDBN} will print @code{"@{...@}"}
10635 @item show print union
10636 Ask @value{GDBN} whether or not it will print unions which are contained in
10637 structures and other unions.
10639 For example, given the declarations
10642 typedef enum @{Tree, Bug@} Species;
10643 typedef enum @{Big_tree, Acorn, Seedling@} Tree_forms;
10644 typedef enum @{Caterpillar, Cocoon, Butterfly@}
10655 struct thing foo = @{Tree, @{Acorn@}@};
10659 with @code{set print union on} in effect @samp{p foo} would print
10662 $1 = @{it = Tree, form = @{tree = Acorn, bug = Cocoon@}@}
10666 and with @code{set print union off} in effect it would print
10669 $1 = @{it = Tree, form = @{...@}@}
10673 @code{set print union} affects programs written in C-like languages
10679 These settings are of interest when debugging C@t{++} programs:
10682 @cindex demangling C@t{++} names
10683 @item set print demangle
10684 @itemx set print demangle on
10685 Print C@t{++} names in their source form rather than in the encoded
10686 (``mangled'') form passed to the assembler and linker for type-safe
10687 linkage. The default is on.
10689 @item show print demangle
10690 Show whether C@t{++} names are printed in mangled or demangled form.
10692 @item set print asm-demangle
10693 @itemx set print asm-demangle on
10694 Print C@t{++} names in their source form rather than their mangled form, even
10695 in assembler code printouts such as instruction disassemblies.
10696 The default is off.
10698 @item show print asm-demangle
10699 Show whether C@t{++} names in assembly listings are printed in mangled
10702 @cindex C@t{++} symbol decoding style
10703 @cindex symbol decoding style, C@t{++}
10704 @kindex set demangle-style
10705 @item set demangle-style @var{style}
10706 Choose among several encoding schemes used by different compilers to represent
10707 C@t{++} names. If you omit @var{style}, you will see a list of possible
10708 formats. The default value is @var{auto}, which lets @value{GDBN} choose a
10709 decoding style by inspecting your program.
10711 @item show demangle-style
10712 Display the encoding style currently in use for decoding C@t{++} symbols.
10714 @item set print object
10715 @itemx set print object on
10716 @cindex derived type of an object, printing
10717 @cindex display derived types
10718 When displaying a pointer to an object, identify the @emph{actual}
10719 (derived) type of the object rather than the @emph{declared} type, using
10720 the virtual function table. Note that the virtual function table is
10721 required---this feature can only work for objects that have run-time
10722 type identification; a single virtual method in the object's declared
10723 type is sufficient. Note that this setting is also taken into account when
10724 working with variable objects via MI (@pxref{GDB/MI}).
10726 @item set print object off
10727 Display only the declared type of objects, without reference to the
10728 virtual function table. This is the default setting.
10730 @item show print object
10731 Show whether actual, or declared, object types are displayed.
10733 @item set print static-members
10734 @itemx set print static-members on
10735 @cindex static members of C@t{++} objects
10736 Print static members when displaying a C@t{++} object. The default is on.
10738 @item set print static-members off
10739 Do not print static members when displaying a C@t{++} object.
10741 @item show print static-members
10742 Show whether C@t{++} static members are printed or not.
10744 @item set print pascal_static-members
10745 @itemx set print pascal_static-members on
10746 @cindex static members of Pascal objects
10747 @cindex Pascal objects, static members display
10748 Print static members when displaying a Pascal object. The default is on.
10750 @item set print pascal_static-members off
10751 Do not print static members when displaying a Pascal object.
10753 @item show print pascal_static-members
10754 Show whether Pascal static members are printed or not.
10756 @c These don't work with HP ANSI C++ yet.
10757 @item set print vtbl
10758 @itemx set print vtbl on
10759 @cindex pretty print C@t{++} virtual function tables
10760 @cindex virtual functions (C@t{++}) display
10761 @cindex VTBL display
10762 Pretty print C@t{++} virtual function tables. The default is off.
10763 (The @code{vtbl} commands do not work on programs compiled with the HP
10764 ANSI C@t{++} compiler (@code{aCC}).)
10766 @item set print vtbl off
10767 Do not pretty print C@t{++} virtual function tables.
10769 @item show print vtbl
10770 Show whether C@t{++} virtual function tables are pretty printed, or not.
10773 @node Pretty Printing
10774 @section Pretty Printing
10776 @value{GDBN} provides a mechanism to allow pretty-printing of values using
10777 Python code. It greatly simplifies the display of complex objects. This
10778 mechanism works for both MI and the CLI.
10781 * Pretty-Printer Introduction:: Introduction to pretty-printers
10782 * Pretty-Printer Example:: An example pretty-printer
10783 * Pretty-Printer Commands:: Pretty-printer commands
10786 @node Pretty-Printer Introduction
10787 @subsection Pretty-Printer Introduction
10789 When @value{GDBN} prints a value, it first sees if there is a pretty-printer
10790 registered for the value. If there is then @value{GDBN} invokes the
10791 pretty-printer to print the value. Otherwise the value is printed normally.
10793 Pretty-printers are normally named. This makes them easy to manage.
10794 The @samp{info pretty-printer} command will list all the installed
10795 pretty-printers with their names.
10796 If a pretty-printer can handle multiple data types, then its
10797 @dfn{subprinters} are the printers for the individual data types.
10798 Each such subprinter has its own name.
10799 The format of the name is @var{printer-name};@var{subprinter-name}.
10801 Pretty-printers are installed by @dfn{registering} them with @value{GDBN}.
10802 Typically they are automatically loaded and registered when the corresponding
10803 debug information is loaded, thus making them available without having to
10804 do anything special.
10806 There are three places where a pretty-printer can be registered.
10810 Pretty-printers registered globally are available when debugging
10814 Pretty-printers registered with a program space are available only
10815 when debugging that program.
10816 @xref{Progspaces In Python}, for more details on program spaces in Python.
10819 Pretty-printers registered with an objfile are loaded and unloaded
10820 with the corresponding objfile (e.g., shared library).
10821 @xref{Objfiles In Python}, for more details on objfiles in Python.
10824 @xref{Selecting Pretty-Printers}, for further information on how
10825 pretty-printers are selected,
10827 @xref{Writing a Pretty-Printer}, for implementing pretty printers
10830 @node Pretty-Printer Example
10831 @subsection Pretty-Printer Example
10833 Here is how a C@t{++} @code{std::string} looks without a pretty-printer:
10836 (@value{GDBP}) print s
10838 static npos = 4294967295,
10840 <std::allocator<char>> = @{
10841 <__gnu_cxx::new_allocator<char>> = @{
10842 <No data fields>@}, <No data fields>
10844 members of std::basic_string<char, std::char_traits<char>,
10845 std::allocator<char> >::_Alloc_hider:
10846 _M_p = 0x804a014 "abcd"
10851 With a pretty-printer for @code{std::string} only the contents are printed:
10854 (@value{GDBP}) print s
10858 @node Pretty-Printer Commands
10859 @subsection Pretty-Printer Commands
10860 @cindex pretty-printer commands
10863 @kindex info pretty-printer
10864 @item info pretty-printer [@var{object-regexp} [@var{name-regexp}]]
10865 Print the list of installed pretty-printers.
10866 This includes disabled pretty-printers, which are marked as such.
10868 @var{object-regexp} is a regular expression matching the objects
10869 whose pretty-printers to list.
10870 Objects can be @code{global}, the program space's file
10871 (@pxref{Progspaces In Python}),
10872 and the object files within that program space (@pxref{Objfiles In Python}).
10873 @xref{Selecting Pretty-Printers}, for details on how @value{GDBN}
10874 looks up a printer from these three objects.
10876 @var{name-regexp} is a regular expression matching the name of the printers
10879 @kindex disable pretty-printer
10880 @item disable pretty-printer [@var{object-regexp} [@var{name-regexp}]]
10881 Disable pretty-printers matching @var{object-regexp} and @var{name-regexp}.
10882 A disabled pretty-printer is not forgotten, it may be enabled again later.
10884 @kindex enable pretty-printer
10885 @item enable pretty-printer [@var{object-regexp} [@var{name-regexp}]]
10886 Enable pretty-printers matching @var{object-regexp} and @var{name-regexp}.
10891 Suppose we have three pretty-printers installed: one from library1.so
10892 named @code{foo} that prints objects of type @code{foo}, and
10893 another from library2.so named @code{bar} that prints two types of objects,
10894 @code{bar1} and @code{bar2}.
10897 (gdb) info pretty-printer
10904 (gdb) info pretty-printer library2
10909 (gdb) disable pretty-printer library1
10911 2 of 3 printers enabled
10912 (gdb) info pretty-printer
10919 (gdb) disable pretty-printer library2 bar;bar1
10921 1 of 3 printers enabled
10922 (gdb) info pretty-printer library2
10929 (gdb) disable pretty-printer library2 bar
10931 0 of 3 printers enabled
10932 (gdb) info pretty-printer library2
10941 Note that for @code{bar} the entire printer can be disabled,
10942 as can each individual subprinter.
10944 @node Value History
10945 @section Value History
10947 @cindex value history
10948 @cindex history of values printed by @value{GDBN}
10949 Values printed by the @code{print} command are saved in the @value{GDBN}
10950 @dfn{value history}. This allows you to refer to them in other expressions.
10951 Values are kept until the symbol table is re-read or discarded
10952 (for example with the @code{file} or @code{symbol-file} commands).
10953 When the symbol table changes, the value history is discarded,
10954 since the values may contain pointers back to the types defined in the
10959 @cindex history number
10960 The values printed are given @dfn{history numbers} by which you can
10961 refer to them. These are successive integers starting with one.
10962 @code{print} shows you the history number assigned to a value by
10963 printing @samp{$@var{num} = } before the value; here @var{num} is the
10966 To refer to any previous value, use @samp{$} followed by the value's
10967 history number. The way @code{print} labels its output is designed to
10968 remind you of this. Just @code{$} refers to the most recent value in
10969 the history, and @code{$$} refers to the value before that.
10970 @code{$$@var{n}} refers to the @var{n}th value from the end; @code{$$2}
10971 is the value just prior to @code{$$}, @code{$$1} is equivalent to
10972 @code{$$}, and @code{$$0} is equivalent to @code{$}.
10974 For example, suppose you have just printed a pointer to a structure and
10975 want to see the contents of the structure. It suffices to type
10981 If you have a chain of structures where the component @code{next} points
10982 to the next one, you can print the contents of the next one with this:
10989 You can print successive links in the chain by repeating this
10990 command---which you can do by just typing @key{RET}.
10992 Note that the history records values, not expressions. If the value of
10993 @code{x} is 4 and you type these commands:
11001 then the value recorded in the value history by the @code{print} command
11002 remains 4 even though the value of @code{x} has changed.
11005 @kindex show values
11007 Print the last ten values in the value history, with their item numbers.
11008 This is like @samp{p@ $$9} repeated ten times, except that @code{show
11009 values} does not change the history.
11011 @item show values @var{n}
11012 Print ten history values centered on history item number @var{n}.
11014 @item show values +
11015 Print ten history values just after the values last printed. If no more
11016 values are available, @code{show values +} produces no display.
11019 Pressing @key{RET} to repeat @code{show values @var{n}} has exactly the
11020 same effect as @samp{show values +}.
11022 @node Convenience Vars
11023 @section Convenience Variables
11025 @cindex convenience variables
11026 @cindex user-defined variables
11027 @value{GDBN} provides @dfn{convenience variables} that you can use within
11028 @value{GDBN} to hold on to a value and refer to it later. These variables
11029 exist entirely within @value{GDBN}; they are not part of your program, and
11030 setting a convenience variable has no direct effect on further execution
11031 of your program. That is why you can use them freely.
11033 Convenience variables are prefixed with @samp{$}. Any name preceded by
11034 @samp{$} can be used for a convenience variable, unless it is one of
11035 the predefined machine-specific register names (@pxref{Registers, ,Registers}).
11036 (Value history references, in contrast, are @emph{numbers} preceded
11037 by @samp{$}. @xref{Value History, ,Value History}.)
11039 You can save a value in a convenience variable with an assignment
11040 expression, just as you would set a variable in your program.
11044 set $foo = *object_ptr
11048 would save in @code{$foo} the value contained in the object pointed to by
11051 Using a convenience variable for the first time creates it, but its
11052 value is @code{void} until you assign a new value. You can alter the
11053 value with another assignment at any time.
11055 Convenience variables have no fixed types. You can assign a convenience
11056 variable any type of value, including structures and arrays, even if
11057 that variable already has a value of a different type. The convenience
11058 variable, when used as an expression, has the type of its current value.
11061 @kindex show convenience
11062 @cindex show all user variables and functions
11063 @item show convenience
11064 Print a list of convenience variables used so far, and their values,
11065 as well as a list of the convenience functions.
11066 Abbreviated @code{show conv}.
11068 @kindex init-if-undefined
11069 @cindex convenience variables, initializing
11070 @item init-if-undefined $@var{variable} = @var{expression}
11071 Set a convenience variable if it has not already been set. This is useful
11072 for user-defined commands that keep some state. It is similar, in concept,
11073 to using local static variables with initializers in C (except that
11074 convenience variables are global). It can also be used to allow users to
11075 override default values used in a command script.
11077 If the variable is already defined then the expression is not evaluated so
11078 any side-effects do not occur.
11081 One of the ways to use a convenience variable is as a counter to be
11082 incremented or a pointer to be advanced. For example, to print
11083 a field from successive elements of an array of structures:
11087 print bar[$i++]->contents
11091 Repeat that command by typing @key{RET}.
11093 Some convenience variables are created automatically by @value{GDBN} and given
11094 values likely to be useful.
11097 @vindex $_@r{, convenience variable}
11099 The variable @code{$_} is automatically set by the @code{x} command to
11100 the last address examined (@pxref{Memory, ,Examining Memory}). Other
11101 commands which provide a default address for @code{x} to examine also
11102 set @code{$_} to that address; these commands include @code{info line}
11103 and @code{info breakpoint}. The type of @code{$_} is @code{void *}
11104 except when set by the @code{x} command, in which case it is a pointer
11105 to the type of @code{$__}.
11107 @vindex $__@r{, convenience variable}
11109 The variable @code{$__} is automatically set by the @code{x} command
11110 to the value found in the last address examined. Its type is chosen
11111 to match the format in which the data was printed.
11114 @vindex $_exitcode@r{, convenience variable}
11115 When the program being debugged terminates normally, @value{GDBN}
11116 automatically sets this variable to the exit code of the program, and
11117 resets @code{$_exitsignal} to @code{void}.
11120 @vindex $_exitsignal@r{, convenience variable}
11121 When the program being debugged dies due to an uncaught signal,
11122 @value{GDBN} automatically sets this variable to that signal's number,
11123 and resets @code{$_exitcode} to @code{void}.
11125 To distinguish between whether the program being debugged has exited
11126 (i.e., @code{$_exitcode} is not @code{void}) or signalled (i.e.,
11127 @code{$_exitsignal} is not @code{void}), the convenience function
11128 @code{$_isvoid} can be used (@pxref{Convenience Funs,, Convenience
11129 Functions}). For example, considering the following source code:
11132 #include <signal.h>
11135 main (int argc, char *argv[])
11142 A valid way of telling whether the program being debugged has exited
11143 or signalled would be:
11146 (@value{GDBP}) define has_exited_or_signalled
11147 Type commands for definition of ``has_exited_or_signalled''.
11148 End with a line saying just ``end''.
11149 >if $_isvoid ($_exitsignal)
11150 >echo The program has exited\n
11152 >echo The program has signalled\n
11158 Program terminated with signal SIGALRM, Alarm clock.
11159 The program no longer exists.
11160 (@value{GDBP}) has_exited_or_signalled
11161 The program has signalled
11164 As can be seen, @value{GDBN} correctly informs that the program being
11165 debugged has signalled, since it calls @code{raise} and raises a
11166 @code{SIGALRM} signal. If the program being debugged had not called
11167 @code{raise}, then @value{GDBN} would report a normal exit:
11170 (@value{GDBP}) has_exited_or_signalled
11171 The program has exited
11175 The variable @code{$_exception} is set to the exception object being
11176 thrown at an exception-related catchpoint. @xref{Set Catchpoints}.
11179 @itemx $_probe_arg0@dots{}$_probe_arg11
11180 Arguments to a static probe. @xref{Static Probe Points}.
11183 @vindex $_sdata@r{, inspect, convenience variable}
11184 The variable @code{$_sdata} contains extra collected static tracepoint
11185 data. @xref{Tracepoint Actions,,Tracepoint Action Lists}. Note that
11186 @code{$_sdata} could be empty, if not inspecting a trace buffer, or
11187 if extra static tracepoint data has not been collected.
11190 @vindex $_siginfo@r{, convenience variable}
11191 The variable @code{$_siginfo} contains extra signal information
11192 (@pxref{extra signal information}). Note that @code{$_siginfo}
11193 could be empty, if the application has not yet received any signals.
11194 For example, it will be empty before you execute the @code{run} command.
11197 @vindex $_tlb@r{, convenience variable}
11198 The variable @code{$_tlb} is automatically set when debugging
11199 applications running on MS-Windows in native mode or connected to
11200 gdbserver that supports the @code{qGetTIBAddr} request.
11201 @xref{General Query Packets}.
11202 This variable contains the address of the thread information block.
11205 The number of the current inferior. @xref{Inferiors and
11206 Programs, ,Debugging Multiple Inferiors and Programs}.
11209 The thread number of the current thread. @xref{thread numbers}.
11212 The global number of the current thread. @xref{global thread numbers}.
11216 @node Convenience Funs
11217 @section Convenience Functions
11219 @cindex convenience functions
11220 @value{GDBN} also supplies some @dfn{convenience functions}. These
11221 have a syntax similar to convenience variables. A convenience
11222 function can be used in an expression just like an ordinary function;
11223 however, a convenience function is implemented internally to
11226 These functions do not require @value{GDBN} to be configured with
11227 @code{Python} support, which means that they are always available.
11231 @item $_isvoid (@var{expr})
11232 @findex $_isvoid@r{, convenience function}
11233 Return one if the expression @var{expr} is @code{void}. Otherwise it
11236 A @code{void} expression is an expression where the type of the result
11237 is @code{void}. For example, you can examine a convenience variable
11238 (see @ref{Convenience Vars,, Convenience Variables}) to check whether
11242 (@value{GDBP}) print $_exitcode
11244 (@value{GDBP}) print $_isvoid ($_exitcode)
11247 Starting program: ./a.out
11248 [Inferior 1 (process 29572) exited normally]
11249 (@value{GDBP}) print $_exitcode
11251 (@value{GDBP}) print $_isvoid ($_exitcode)
11255 In the example above, we used @code{$_isvoid} to check whether
11256 @code{$_exitcode} is @code{void} before and after the execution of the
11257 program being debugged. Before the execution there is no exit code to
11258 be examined, therefore @code{$_exitcode} is @code{void}. After the
11259 execution the program being debugged returned zero, therefore
11260 @code{$_exitcode} is zero, which means that it is not @code{void}
11263 The @code{void} expression can also be a call of a function from the
11264 program being debugged. For example, given the following function:
11273 The result of calling it inside @value{GDBN} is @code{void}:
11276 (@value{GDBP}) print foo ()
11278 (@value{GDBP}) print $_isvoid (foo ())
11280 (@value{GDBP}) set $v = foo ()
11281 (@value{GDBP}) print $v
11283 (@value{GDBP}) print $_isvoid ($v)
11289 These functions require @value{GDBN} to be configured with
11290 @code{Python} support.
11294 @item $_memeq(@var{buf1}, @var{buf2}, @var{length})
11295 @findex $_memeq@r{, convenience function}
11296 Returns one if the @var{length} bytes at the addresses given by
11297 @var{buf1} and @var{buf2} are equal.
11298 Otherwise it returns zero.
11300 @item $_regex(@var{str}, @var{regex})
11301 @findex $_regex@r{, convenience function}
11302 Returns one if the string @var{str} matches the regular expression
11303 @var{regex}. Otherwise it returns zero.
11304 The syntax of the regular expression is that specified by @code{Python}'s
11305 regular expression support.
11307 @item $_streq(@var{str1}, @var{str2})
11308 @findex $_streq@r{, convenience function}
11309 Returns one if the strings @var{str1} and @var{str2} are equal.
11310 Otherwise it returns zero.
11312 @item $_strlen(@var{str})
11313 @findex $_strlen@r{, convenience function}
11314 Returns the length of string @var{str}.
11316 @item $_caller_is(@var{name}@r{[}, @var{number_of_frames}@r{]})
11317 @findex $_caller_is@r{, convenience function}
11318 Returns one if the calling function's name is equal to @var{name}.
11319 Otherwise it returns zero.
11321 If the optional argument @var{number_of_frames} is provided,
11322 it is the number of frames up in the stack to look.
11330 at testsuite/gdb.python/py-caller-is.c:21
11331 #1 0x00000000004005a0 in middle_func ()
11332 at testsuite/gdb.python/py-caller-is.c:27
11333 #2 0x00000000004005ab in top_func ()
11334 at testsuite/gdb.python/py-caller-is.c:33
11335 #3 0x00000000004005b6 in main ()
11336 at testsuite/gdb.python/py-caller-is.c:39
11337 (gdb) print $_caller_is ("middle_func")
11339 (gdb) print $_caller_is ("top_func", 2)
11343 @item $_caller_matches(@var{regexp}@r{[}, @var{number_of_frames}@r{]})
11344 @findex $_caller_matches@r{, convenience function}
11345 Returns one if the calling function's name matches the regular expression
11346 @var{regexp}. Otherwise it returns zero.
11348 If the optional argument @var{number_of_frames} is provided,
11349 it is the number of frames up in the stack to look.
11352 @item $_any_caller_is(@var{name}@r{[}, @var{number_of_frames}@r{]})
11353 @findex $_any_caller_is@r{, convenience function}
11354 Returns one if any calling function's name is equal to @var{name}.
11355 Otherwise it returns zero.
11357 If the optional argument @var{number_of_frames} is provided,
11358 it is the number of frames up in the stack to look.
11361 This function differs from @code{$_caller_is} in that this function
11362 checks all stack frames from the immediate caller to the frame specified
11363 by @var{number_of_frames}, whereas @code{$_caller_is} only checks the
11364 frame specified by @var{number_of_frames}.
11366 @item $_any_caller_matches(@var{regexp}@r{[}, @var{number_of_frames}@r{]})
11367 @findex $_any_caller_matches@r{, convenience function}
11368 Returns one if any calling function's name matches the regular expression
11369 @var{regexp}. Otherwise it returns zero.
11371 If the optional argument @var{number_of_frames} is provided,
11372 it is the number of frames up in the stack to look.
11375 This function differs from @code{$_caller_matches} in that this function
11376 checks all stack frames from the immediate caller to the frame specified
11377 by @var{number_of_frames}, whereas @code{$_caller_matches} only checks the
11378 frame specified by @var{number_of_frames}.
11380 @item $_as_string(@var{value})
11381 @findex $_as_string@r{, convenience function}
11382 Return the string representation of @var{value}.
11384 This function is useful to obtain the textual label (enumerator) of an
11385 enumeration value. For example, assuming the variable @var{node} is of
11386 an enumerated type:
11389 (gdb) printf "Visiting node of type %s\n", $_as_string(node)
11390 Visiting node of type NODE_INTEGER
11395 @value{GDBN} provides the ability to list and get help on
11396 convenience functions.
11399 @item help function
11400 @kindex help function
11401 @cindex show all convenience functions
11402 Print a list of all convenience functions.
11409 You can refer to machine register contents, in expressions, as variables
11410 with names starting with @samp{$}. The names of registers are different
11411 for each machine; use @code{info registers} to see the names used on
11415 @kindex info registers
11416 @item info registers
11417 Print the names and values of all registers except floating-point
11418 and vector registers (in the selected stack frame).
11420 @kindex info all-registers
11421 @cindex floating point registers
11422 @item info all-registers
11423 Print the names and values of all registers, including floating-point
11424 and vector registers (in the selected stack frame).
11426 @item info registers @var{reggroup} @dots{}
11427 Print the name and value of the registers in each of the specified
11428 @var{reggroup}s. The @var{reggoup} can be any of those returned by
11429 @code{maint print reggroups} (@pxref{Maintenance Commands}).
11431 @item info registers @var{regname} @dots{}
11432 Print the @dfn{relativized} value of each specified register @var{regname}.
11433 As discussed in detail below, register values are normally relative to
11434 the selected stack frame. The @var{regname} may be any register name valid on
11435 the machine you are using, with or without the initial @samp{$}.
11438 @anchor{standard registers}
11439 @cindex stack pointer register
11440 @cindex program counter register
11441 @cindex process status register
11442 @cindex frame pointer register
11443 @cindex standard registers
11444 @value{GDBN} has four ``standard'' register names that are available (in
11445 expressions) on most machines---whenever they do not conflict with an
11446 architecture's canonical mnemonics for registers. The register names
11447 @code{$pc} and @code{$sp} are used for the program counter register and
11448 the stack pointer. @code{$fp} is used for a register that contains a
11449 pointer to the current stack frame, and @code{$ps} is used for a
11450 register that contains the processor status. For example,
11451 you could print the program counter in hex with
11458 or print the instruction to be executed next with
11465 or add four to the stack pointer@footnote{This is a way of removing
11466 one word from the stack, on machines where stacks grow downward in
11467 memory (most machines, nowadays). This assumes that the innermost
11468 stack frame is selected; setting @code{$sp} is not allowed when other
11469 stack frames are selected. To pop entire frames off the stack,
11470 regardless of machine architecture, use @code{return};
11471 see @ref{Returning, ,Returning from a Function}.} with
11477 Whenever possible, these four standard register names are available on
11478 your machine even though the machine has different canonical mnemonics,
11479 so long as there is no conflict. The @code{info registers} command
11480 shows the canonical names. For example, on the SPARC, @code{info
11481 registers} displays the processor status register as @code{$psr} but you
11482 can also refer to it as @code{$ps}; and on x86-based machines @code{$ps}
11483 is an alias for the @sc{eflags} register.
11485 @value{GDBN} always considers the contents of an ordinary register as an
11486 integer when the register is examined in this way. Some machines have
11487 special registers which can hold nothing but floating point; these
11488 registers are considered to have floating point values. There is no way
11489 to refer to the contents of an ordinary register as floating point value
11490 (although you can @emph{print} it as a floating point value with
11491 @samp{print/f $@var{regname}}).
11493 Some registers have distinct ``raw'' and ``virtual'' data formats. This
11494 means that the data format in which the register contents are saved by
11495 the operating system is not the same one that your program normally
11496 sees. For example, the registers of the 68881 floating point
11497 coprocessor are always saved in ``extended'' (raw) format, but all C
11498 programs expect to work with ``double'' (virtual) format. In such
11499 cases, @value{GDBN} normally works with the virtual format only (the format
11500 that makes sense for your program), but the @code{info registers} command
11501 prints the data in both formats.
11503 @cindex SSE registers (x86)
11504 @cindex MMX registers (x86)
11505 Some machines have special registers whose contents can be interpreted
11506 in several different ways. For example, modern x86-based machines
11507 have SSE and MMX registers that can hold several values packed
11508 together in several different formats. @value{GDBN} refers to such
11509 registers in @code{struct} notation:
11512 (@value{GDBP}) print $xmm1
11514 v4_float = @{0, 3.43859137e-038, 1.54142831e-044, 1.821688e-044@},
11515 v2_double = @{9.92129282474342e-303, 2.7585945287983262e-313@},
11516 v16_int8 = "\000\000\000\000\3706;\001\v\000\000\000\r\000\000",
11517 v8_int16 = @{0, 0, 14072, 315, 11, 0, 13, 0@},
11518 v4_int32 = @{0, 20657912, 11, 13@},
11519 v2_int64 = @{88725056443645952, 55834574859@},
11520 uint128 = 0x0000000d0000000b013b36f800000000
11525 To set values of such registers, you need to tell @value{GDBN} which
11526 view of the register you wish to change, as if you were assigning
11527 value to a @code{struct} member:
11530 (@value{GDBP}) set $xmm1.uint128 = 0x000000000000000000000000FFFFFFFF
11533 Normally, register values are relative to the selected stack frame
11534 (@pxref{Selection, ,Selecting a Frame}). This means that you get the
11535 value that the register would contain if all stack frames farther in
11536 were exited and their saved registers restored. In order to see the
11537 true contents of hardware registers, you must select the innermost
11538 frame (with @samp{frame 0}).
11540 @cindex caller-saved registers
11541 @cindex call-clobbered registers
11542 @cindex volatile registers
11543 @cindex <not saved> values
11544 Usually ABIs reserve some registers as not needed to be saved by the
11545 callee (a.k.a.: ``caller-saved'', ``call-clobbered'' or ``volatile''
11546 registers). It may therefore not be possible for @value{GDBN} to know
11547 the value a register had before the call (in other words, in the outer
11548 frame), if the register value has since been changed by the callee.
11549 @value{GDBN} tries to deduce where the inner frame saved
11550 (``callee-saved'') registers, from the debug info, unwind info, or the
11551 machine code generated by your compiler. If some register is not
11552 saved, and @value{GDBN} knows the register is ``caller-saved'' (via
11553 its own knowledge of the ABI, or because the debug/unwind info
11554 explicitly says the register's value is undefined), @value{GDBN}
11555 displays @w{@samp{<not saved>}} as the register's value. With targets
11556 that @value{GDBN} has no knowledge of the register saving convention,
11557 if a register was not saved by the callee, then its value and location
11558 in the outer frame are assumed to be the same of the inner frame.
11559 This is usually harmless, because if the register is call-clobbered,
11560 the caller either does not care what is in the register after the
11561 call, or has code to restore the value that it does care about. Note,
11562 however, that if you change such a register in the outer frame, you
11563 may also be affecting the inner frame. Also, the more ``outer'' the
11564 frame is you're looking at, the more likely a call-clobbered
11565 register's value is to be wrong, in the sense that it doesn't actually
11566 represent the value the register had just before the call.
11568 @node Floating Point Hardware
11569 @section Floating Point Hardware
11570 @cindex floating point
11572 Depending on the configuration, @value{GDBN} may be able to give
11573 you more information about the status of the floating point hardware.
11578 Display hardware-dependent information about the floating
11579 point unit. The exact contents and layout vary depending on the
11580 floating point chip. Currently, @samp{info float} is supported on
11581 the ARM and x86 machines.
11585 @section Vector Unit
11586 @cindex vector unit
11588 Depending on the configuration, @value{GDBN} may be able to give you
11589 more information about the status of the vector unit.
11592 @kindex info vector
11594 Display information about the vector unit. The exact contents and
11595 layout vary depending on the hardware.
11598 @node OS Information
11599 @section Operating System Auxiliary Information
11600 @cindex OS information
11602 @value{GDBN} provides interfaces to useful OS facilities that can help
11603 you debug your program.
11605 @cindex auxiliary vector
11606 @cindex vector, auxiliary
11607 Some operating systems supply an @dfn{auxiliary vector} to programs at
11608 startup. This is akin to the arguments and environment that you
11609 specify for a program, but contains a system-dependent variety of
11610 binary values that tell system libraries important details about the
11611 hardware, operating system, and process. Each value's purpose is
11612 identified by an integer tag; the meanings are well-known but system-specific.
11613 Depending on the configuration and operating system facilities,
11614 @value{GDBN} may be able to show you this information. For remote
11615 targets, this functionality may further depend on the remote stub's
11616 support of the @samp{qXfer:auxv:read} packet, see
11617 @ref{qXfer auxiliary vector read}.
11622 Display the auxiliary vector of the inferior, which can be either a
11623 live process or a core dump file. @value{GDBN} prints each tag value
11624 numerically, and also shows names and text descriptions for recognized
11625 tags. Some values in the vector are numbers, some bit masks, and some
11626 pointers to strings or other data. @value{GDBN} displays each value in the
11627 most appropriate form for a recognized tag, and in hexadecimal for
11628 an unrecognized tag.
11631 On some targets, @value{GDBN} can access operating system-specific
11632 information and show it to you. The types of information available
11633 will differ depending on the type of operating system running on the
11634 target. The mechanism used to fetch the data is described in
11635 @ref{Operating System Information}. For remote targets, this
11636 functionality depends on the remote stub's support of the
11637 @samp{qXfer:osdata:read} packet, see @ref{qXfer osdata read}.
11641 @item info os @var{infotype}
11643 Display OS information of the requested type.
11645 On @sc{gnu}/Linux, the following values of @var{infotype} are valid:
11647 @anchor{linux info os infotypes}
11649 @kindex info os cpus
11651 Display the list of all CPUs/cores. For each CPU/core, @value{GDBN} prints
11652 the available fields from /proc/cpuinfo. For each supported architecture
11653 different fields are available. Two common entries are processor which gives
11654 CPU number and bogomips; a system constant that is calculated during
11655 kernel initialization.
11657 @kindex info os files
11659 Display the list of open file descriptors on the target. For each
11660 file descriptor, @value{GDBN} prints the identifier of the process
11661 owning the descriptor, the command of the owning process, the value
11662 of the descriptor, and the target of the descriptor.
11664 @kindex info os modules
11666 Display the list of all loaded kernel modules on the target. For each
11667 module, @value{GDBN} prints the module name, the size of the module in
11668 bytes, the number of times the module is used, the dependencies of the
11669 module, the status of the module, and the address of the loaded module
11672 @kindex info os msg
11674 Display the list of all System V message queues on the target. For each
11675 message queue, @value{GDBN} prints the message queue key, the message
11676 queue identifier, the access permissions, the current number of bytes
11677 on the queue, the current number of messages on the queue, the processes
11678 that last sent and received a message on the queue, the user and group
11679 of the owner and creator of the message queue, the times at which a
11680 message was last sent and received on the queue, and the time at which
11681 the message queue was last changed.
11683 @kindex info os processes
11685 Display the list of processes on the target. For each process,
11686 @value{GDBN} prints the process identifier, the name of the user, the
11687 command corresponding to the process, and the list of processor cores
11688 that the process is currently running on. (To understand what these
11689 properties mean, for this and the following info types, please consult
11690 the general @sc{gnu}/Linux documentation.)
11692 @kindex info os procgroups
11694 Display the list of process groups on the target. For each process,
11695 @value{GDBN} prints the identifier of the process group that it belongs
11696 to, the command corresponding to the process group leader, the process
11697 identifier, and the command line of the process. The list is sorted
11698 first by the process group identifier, then by the process identifier,
11699 so that processes belonging to the same process group are grouped together
11700 and the process group leader is listed first.
11702 @kindex info os semaphores
11704 Display the list of all System V semaphore sets on the target. For each
11705 semaphore set, @value{GDBN} prints the semaphore set key, the semaphore
11706 set identifier, the access permissions, the number of semaphores in the
11707 set, the user and group of the owner and creator of the semaphore set,
11708 and the times at which the semaphore set was operated upon and changed.
11710 @kindex info os shm
11712 Display the list of all System V shared-memory regions on the target.
11713 For each shared-memory region, @value{GDBN} prints the region key,
11714 the shared-memory identifier, the access permissions, the size of the
11715 region, the process that created the region, the process that last
11716 attached to or detached from the region, the current number of live
11717 attaches to the region, and the times at which the region was last
11718 attached to, detach from, and changed.
11720 @kindex info os sockets
11722 Display the list of Internet-domain sockets on the target. For each
11723 socket, @value{GDBN} prints the address and port of the local and
11724 remote endpoints, the current state of the connection, the creator of
11725 the socket, the IP address family of the socket, and the type of the
11728 @kindex info os threads
11730 Display the list of threads running on the target. For each thread,
11731 @value{GDBN} prints the identifier of the process that the thread
11732 belongs to, the command of the process, the thread identifier, and the
11733 processor core that it is currently running on. The main thread of a
11734 process is not listed.
11738 If @var{infotype} is omitted, then list the possible values for
11739 @var{infotype} and the kind of OS information available for each
11740 @var{infotype}. If the target does not return a list of possible
11741 types, this command will report an error.
11744 @node Memory Region Attributes
11745 @section Memory Region Attributes
11746 @cindex memory region attributes
11748 @dfn{Memory region attributes} allow you to describe special handling
11749 required by regions of your target's memory. @value{GDBN} uses
11750 attributes to determine whether to allow certain types of memory
11751 accesses; whether to use specific width accesses; and whether to cache
11752 target memory. By default the description of memory regions is
11753 fetched from the target (if the current target supports this), but the
11754 user can override the fetched regions.
11756 Defined memory regions can be individually enabled and disabled. When a
11757 memory region is disabled, @value{GDBN} uses the default attributes when
11758 accessing memory in that region. Similarly, if no memory regions have
11759 been defined, @value{GDBN} uses the default attributes when accessing
11762 When a memory region is defined, it is given a number to identify it;
11763 to enable, disable, or remove a memory region, you specify that number.
11767 @item mem @var{lower} @var{upper} @var{attributes}@dots{}
11768 Define a memory region bounded by @var{lower} and @var{upper} with
11769 attributes @var{attributes}@dots{}, and add it to the list of regions
11770 monitored by @value{GDBN}. Note that @var{upper} == 0 is a special
11771 case: it is treated as the target's maximum memory address.
11772 (0xffff on 16 bit targets, 0xffffffff on 32 bit targets, etc.)
11775 Discard any user changes to the memory regions and use target-supplied
11776 regions, if available, or no regions if the target does not support.
11779 @item delete mem @var{nums}@dots{}
11780 Remove memory regions @var{nums}@dots{} from the list of regions
11781 monitored by @value{GDBN}.
11783 @kindex disable mem
11784 @item disable mem @var{nums}@dots{}
11785 Disable monitoring of memory regions @var{nums}@dots{}.
11786 A disabled memory region is not forgotten.
11787 It may be enabled again later.
11790 @item enable mem @var{nums}@dots{}
11791 Enable monitoring of memory regions @var{nums}@dots{}.
11795 Print a table of all defined memory regions, with the following columns
11799 @item Memory Region Number
11800 @item Enabled or Disabled.
11801 Enabled memory regions are marked with @samp{y}.
11802 Disabled memory regions are marked with @samp{n}.
11805 The address defining the inclusive lower bound of the memory region.
11808 The address defining the exclusive upper bound of the memory region.
11811 The list of attributes set for this memory region.
11816 @subsection Attributes
11818 @subsubsection Memory Access Mode
11819 The access mode attributes set whether @value{GDBN} may make read or
11820 write accesses to a memory region.
11822 While these attributes prevent @value{GDBN} from performing invalid
11823 memory accesses, they do nothing to prevent the target system, I/O DMA,
11824 etc.@: from accessing memory.
11828 Memory is read only.
11830 Memory is write only.
11832 Memory is read/write. This is the default.
11835 @subsubsection Memory Access Size
11836 The access size attribute tells @value{GDBN} to use specific sized
11837 accesses in the memory region. Often memory mapped device registers
11838 require specific sized accesses. If no access size attribute is
11839 specified, @value{GDBN} may use accesses of any size.
11843 Use 8 bit memory accesses.
11845 Use 16 bit memory accesses.
11847 Use 32 bit memory accesses.
11849 Use 64 bit memory accesses.
11852 @c @subsubsection Hardware/Software Breakpoints
11853 @c The hardware/software breakpoint attributes set whether @value{GDBN}
11854 @c will use hardware or software breakpoints for the internal breakpoints
11855 @c used by the step, next, finish, until, etc. commands.
11859 @c Always use hardware breakpoints
11860 @c @item swbreak (default)
11863 @subsubsection Data Cache
11864 The data cache attributes set whether @value{GDBN} will cache target
11865 memory. While this generally improves performance by reducing debug
11866 protocol overhead, it can lead to incorrect results because @value{GDBN}
11867 does not know about volatile variables or memory mapped device
11872 Enable @value{GDBN} to cache target memory.
11874 Disable @value{GDBN} from caching target memory. This is the default.
11877 @subsection Memory Access Checking
11878 @value{GDBN} can be instructed to refuse accesses to memory that is
11879 not explicitly described. This can be useful if accessing such
11880 regions has undesired effects for a specific target, or to provide
11881 better error checking. The following commands control this behaviour.
11884 @kindex set mem inaccessible-by-default
11885 @item set mem inaccessible-by-default [on|off]
11886 If @code{on} is specified, make @value{GDBN} treat memory not
11887 explicitly described by the memory ranges as non-existent and refuse accesses
11888 to such memory. The checks are only performed if there's at least one
11889 memory range defined. If @code{off} is specified, make @value{GDBN}
11890 treat the memory not explicitly described by the memory ranges as RAM.
11891 The default value is @code{on}.
11892 @kindex show mem inaccessible-by-default
11893 @item show mem inaccessible-by-default
11894 Show the current handling of accesses to unknown memory.
11898 @c @subsubsection Memory Write Verification
11899 @c The memory write verification attributes set whether @value{GDBN}
11900 @c will re-reads data after each write to verify the write was successful.
11904 @c @item noverify (default)
11907 @node Dump/Restore Files
11908 @section Copy Between Memory and a File
11909 @cindex dump/restore files
11910 @cindex append data to a file
11911 @cindex dump data to a file
11912 @cindex restore data from a file
11914 You can use the commands @code{dump}, @code{append}, and
11915 @code{restore} to copy data between target memory and a file. The
11916 @code{dump} and @code{append} commands write data to a file, and the
11917 @code{restore} command reads data from a file back into the inferior's
11918 memory. Files may be in binary, Motorola S-record, Intel hex,
11919 Tektronix Hex, or Verilog Hex format; however, @value{GDBN} can only
11920 append to binary files, and cannot read from Verilog Hex files.
11925 @item dump @r{[}@var{format}@r{]} memory @var{filename} @var{start_addr} @var{end_addr}
11926 @itemx dump @r{[}@var{format}@r{]} value @var{filename} @var{expr}
11927 Dump the contents of memory from @var{start_addr} to @var{end_addr},
11928 or the value of @var{expr}, to @var{filename} in the given format.
11930 The @var{format} parameter may be any one of:
11937 Motorola S-record format.
11939 Tektronix Hex format.
11941 Verilog Hex format.
11944 @value{GDBN} uses the same definitions of these formats as the
11945 @sc{gnu} binary utilities, like @samp{objdump} and @samp{objcopy}. If
11946 @var{format} is omitted, @value{GDBN} dumps the data in raw binary
11950 @item append @r{[}binary@r{]} memory @var{filename} @var{start_addr} @var{end_addr}
11951 @itemx append @r{[}binary@r{]} value @var{filename} @var{expr}
11952 Append the contents of memory from @var{start_addr} to @var{end_addr},
11953 or the value of @var{expr}, to the file @var{filename}, in raw binary form.
11954 (@value{GDBN} can only append data to files in raw binary form.)
11957 @item restore @var{filename} @r{[}binary@r{]} @var{bias} @var{start} @var{end}
11958 Restore the contents of file @var{filename} into memory. The
11959 @code{restore} command can automatically recognize any known @sc{bfd}
11960 file format, except for raw binary. To restore a raw binary file you
11961 must specify the optional keyword @code{binary} after the filename.
11963 If @var{bias} is non-zero, its value will be added to the addresses
11964 contained in the file. Binary files always start at address zero, so
11965 they will be restored at address @var{bias}. Other bfd files have
11966 a built-in location; they will be restored at offset @var{bias}
11967 from that location.
11969 If @var{start} and/or @var{end} are non-zero, then only data between
11970 file offset @var{start} and file offset @var{end} will be restored.
11971 These offsets are relative to the addresses in the file, before
11972 the @var{bias} argument is applied.
11976 @node Core File Generation
11977 @section How to Produce a Core File from Your Program
11978 @cindex dump core from inferior
11980 A @dfn{core file} or @dfn{core dump} is a file that records the memory
11981 image of a running process and its process status (register values
11982 etc.). Its primary use is post-mortem debugging of a program that
11983 crashed while it ran outside a debugger. A program that crashes
11984 automatically produces a core file, unless this feature is disabled by
11985 the user. @xref{Files}, for information on invoking @value{GDBN} in
11986 the post-mortem debugging mode.
11988 Occasionally, you may wish to produce a core file of the program you
11989 are debugging in order to preserve a snapshot of its state.
11990 @value{GDBN} has a special command for that.
11994 @kindex generate-core-file
11995 @item generate-core-file [@var{file}]
11996 @itemx gcore [@var{file}]
11997 Produce a core dump of the inferior process. The optional argument
11998 @var{file} specifies the file name where to put the core dump. If not
11999 specified, the file name defaults to @file{core.@var{pid}}, where
12000 @var{pid} is the inferior process ID.
12002 Note that this command is implemented only for some systems (as of
12003 this writing, @sc{gnu}/Linux, FreeBSD, Solaris, and S390).
12005 On @sc{gnu}/Linux, this command can take into account the value of the
12006 file @file{/proc/@var{pid}/coredump_filter} when generating the core
12007 dump (@pxref{set use-coredump-filter}), and by default honors the
12008 @code{VM_DONTDUMP} flag for mappings where it is present in the file
12009 @file{/proc/@var{pid}/smaps} (@pxref{set dump-excluded-mappings}).
12011 @kindex set use-coredump-filter
12012 @anchor{set use-coredump-filter}
12013 @item set use-coredump-filter on
12014 @itemx set use-coredump-filter off
12015 Enable or disable the use of the file
12016 @file{/proc/@var{pid}/coredump_filter} when generating core dump
12017 files. This file is used by the Linux kernel to decide what types of
12018 memory mappings will be dumped or ignored when generating a core dump
12019 file. @var{pid} is the process ID of a currently running process.
12021 To make use of this feature, you have to write in the
12022 @file{/proc/@var{pid}/coredump_filter} file a value, in hexadecimal,
12023 which is a bit mask representing the memory mapping types. If a bit
12024 is set in the bit mask, then the memory mappings of the corresponding
12025 types will be dumped; otherwise, they will be ignored. This
12026 configuration is inherited by child processes. For more information
12027 about the bits that can be set in the
12028 @file{/proc/@var{pid}/coredump_filter} file, please refer to the
12029 manpage of @code{core(5)}.
12031 By default, this option is @code{on}. If this option is turned
12032 @code{off}, @value{GDBN} does not read the @file{coredump_filter} file
12033 and instead uses the same default value as the Linux kernel in order
12034 to decide which pages will be dumped in the core dump file. This
12035 value is currently @code{0x33}, which means that bits @code{0}
12036 (anonymous private mappings), @code{1} (anonymous shared mappings),
12037 @code{4} (ELF headers) and @code{5} (private huge pages) are active.
12038 This will cause these memory mappings to be dumped automatically.
12040 @kindex set dump-excluded-mappings
12041 @anchor{set dump-excluded-mappings}
12042 @item set dump-excluded-mappings on
12043 @itemx set dump-excluded-mappings off
12044 If @code{on} is specified, @value{GDBN} will dump memory mappings
12045 marked with the @code{VM_DONTDUMP} flag. This flag is represented in
12046 the file @file{/proc/@var{pid}/smaps} with the acronym @code{dd}.
12048 The default value is @code{off}.
12051 @node Character Sets
12052 @section Character Sets
12053 @cindex character sets
12055 @cindex translating between character sets
12056 @cindex host character set
12057 @cindex target character set
12059 If the program you are debugging uses a different character set to
12060 represent characters and strings than the one @value{GDBN} uses itself,
12061 @value{GDBN} can automatically translate between the character sets for
12062 you. The character set @value{GDBN} uses we call the @dfn{host
12063 character set}; the one the inferior program uses we call the
12064 @dfn{target character set}.
12066 For example, if you are running @value{GDBN} on a @sc{gnu}/Linux system, which
12067 uses the ISO Latin 1 character set, but you are using @value{GDBN}'s
12068 remote protocol (@pxref{Remote Debugging}) to debug a program
12069 running on an IBM mainframe, which uses the @sc{ebcdic} character set,
12070 then the host character set is Latin-1, and the target character set is
12071 @sc{ebcdic}. If you give @value{GDBN} the command @code{set
12072 target-charset EBCDIC-US}, then @value{GDBN} translates between
12073 @sc{ebcdic} and Latin 1 as you print character or string values, or use
12074 character and string literals in expressions.
12076 @value{GDBN} has no way to automatically recognize which character set
12077 the inferior program uses; you must tell it, using the @code{set
12078 target-charset} command, described below.
12080 Here are the commands for controlling @value{GDBN}'s character set
12084 @item set target-charset @var{charset}
12085 @kindex set target-charset
12086 Set the current target character set to @var{charset}. To display the
12087 list of supported target character sets, type
12088 @kbd{@w{set target-charset @key{TAB}@key{TAB}}}.
12090 @item set host-charset @var{charset}
12091 @kindex set host-charset
12092 Set the current host character set to @var{charset}.
12094 By default, @value{GDBN} uses a host character set appropriate to the
12095 system it is running on; you can override that default using the
12096 @code{set host-charset} command. On some systems, @value{GDBN} cannot
12097 automatically determine the appropriate host character set. In this
12098 case, @value{GDBN} uses @samp{UTF-8}.
12100 @value{GDBN} can only use certain character sets as its host character
12101 set. If you type @kbd{@w{set host-charset @key{TAB}@key{TAB}}},
12102 @value{GDBN} will list the host character sets it supports.
12104 @item set charset @var{charset}
12105 @kindex set charset
12106 Set the current host and target character sets to @var{charset}. As
12107 above, if you type @kbd{@w{set charset @key{TAB}@key{TAB}}},
12108 @value{GDBN} will list the names of the character sets that can be used
12109 for both host and target.
12112 @kindex show charset
12113 Show the names of the current host and target character sets.
12115 @item show host-charset
12116 @kindex show host-charset
12117 Show the name of the current host character set.
12119 @item show target-charset
12120 @kindex show target-charset
12121 Show the name of the current target character set.
12123 @item set target-wide-charset @var{charset}
12124 @kindex set target-wide-charset
12125 Set the current target's wide character set to @var{charset}. This is
12126 the character set used by the target's @code{wchar_t} type. To
12127 display the list of supported wide character sets, type
12128 @kbd{@w{set target-wide-charset @key{TAB}@key{TAB}}}.
12130 @item show target-wide-charset
12131 @kindex show target-wide-charset
12132 Show the name of the current target's wide character set.
12135 Here is an example of @value{GDBN}'s character set support in action.
12136 Assume that the following source code has been placed in the file
12137 @file{charset-test.c}:
12143 = @{72, 101, 108, 108, 111, 44, 32, 119,
12144 111, 114, 108, 100, 33, 10, 0@};
12145 char ibm1047_hello[]
12146 = @{200, 133, 147, 147, 150, 107, 64, 166,
12147 150, 153, 147, 132, 90, 37, 0@};
12151 printf ("Hello, world!\n");
12155 In this program, @code{ascii_hello} and @code{ibm1047_hello} are arrays
12156 containing the string @samp{Hello, world!} followed by a newline,
12157 encoded in the @sc{ascii} and @sc{ibm1047} character sets.
12159 We compile the program, and invoke the debugger on it:
12162 $ gcc -g charset-test.c -o charset-test
12163 $ gdb -nw charset-test
12164 GNU gdb 2001-12-19-cvs
12165 Copyright 2001 Free Software Foundation, Inc.
12170 We can use the @code{show charset} command to see what character sets
12171 @value{GDBN} is currently using to interpret and display characters and
12175 (@value{GDBP}) show charset
12176 The current host and target character set is `ISO-8859-1'.
12180 For the sake of printing this manual, let's use @sc{ascii} as our
12181 initial character set:
12183 (@value{GDBP}) set charset ASCII
12184 (@value{GDBP}) show charset
12185 The current host and target character set is `ASCII'.
12189 Let's assume that @sc{ascii} is indeed the correct character set for our
12190 host system --- in other words, let's assume that if @value{GDBN} prints
12191 characters using the @sc{ascii} character set, our terminal will display
12192 them properly. Since our current target character set is also
12193 @sc{ascii}, the contents of @code{ascii_hello} print legibly:
12196 (@value{GDBP}) print ascii_hello
12197 $1 = 0x401698 "Hello, world!\n"
12198 (@value{GDBP}) print ascii_hello[0]
12203 @value{GDBN} uses the target character set for character and string
12204 literals you use in expressions:
12207 (@value{GDBP}) print '+'
12212 The @sc{ascii} character set uses the number 43 to encode the @samp{+}
12215 @value{GDBN} relies on the user to tell it which character set the
12216 target program uses. If we print @code{ibm1047_hello} while our target
12217 character set is still @sc{ascii}, we get jibberish:
12220 (@value{GDBP}) print ibm1047_hello
12221 $4 = 0x4016a8 "\310\205\223\223\226k@@\246\226\231\223\204Z%"
12222 (@value{GDBP}) print ibm1047_hello[0]
12227 If we invoke the @code{set target-charset} followed by @key{TAB}@key{TAB},
12228 @value{GDBN} tells us the character sets it supports:
12231 (@value{GDBP}) set target-charset
12232 ASCII EBCDIC-US IBM1047 ISO-8859-1
12233 (@value{GDBP}) set target-charset
12236 We can select @sc{ibm1047} as our target character set, and examine the
12237 program's strings again. Now the @sc{ascii} string is wrong, but
12238 @value{GDBN} translates the contents of @code{ibm1047_hello} from the
12239 target character set, @sc{ibm1047}, to the host character set,
12240 @sc{ascii}, and they display correctly:
12243 (@value{GDBP}) set target-charset IBM1047
12244 (@value{GDBP}) show charset
12245 The current host character set is `ASCII'.
12246 The current target character set is `IBM1047'.
12247 (@value{GDBP}) print ascii_hello
12248 $6 = 0x401698 "\110\145%%?\054\040\167?\162%\144\041\012"
12249 (@value{GDBP}) print ascii_hello[0]
12251 (@value{GDBP}) print ibm1047_hello
12252 $8 = 0x4016a8 "Hello, world!\n"
12253 (@value{GDBP}) print ibm1047_hello[0]
12258 As above, @value{GDBN} uses the target character set for character and
12259 string literals you use in expressions:
12262 (@value{GDBP}) print '+'
12267 The @sc{ibm1047} character set uses the number 78 to encode the @samp{+}
12270 @node Caching Target Data
12271 @section Caching Data of Targets
12272 @cindex caching data of targets
12274 @value{GDBN} caches data exchanged between the debugger and a target.
12275 Each cache is associated with the address space of the inferior.
12276 @xref{Inferiors and Programs}, about inferior and address space.
12277 Such caching generally improves performance in remote debugging
12278 (@pxref{Remote Debugging}), because it reduces the overhead of the
12279 remote protocol by bundling memory reads and writes into large chunks.
12280 Unfortunately, simply caching everything would lead to incorrect results,
12281 since @value{GDBN} does not necessarily know anything about volatile
12282 values, memory-mapped I/O addresses, etc. Furthermore, in non-stop mode
12283 (@pxref{Non-Stop Mode}) memory can be changed @emph{while} a gdb command
12285 Therefore, by default, @value{GDBN} only caches data
12286 known to be on the stack@footnote{In non-stop mode, it is moderately
12287 rare for a running thread to modify the stack of a stopped thread
12288 in a way that would interfere with a backtrace, and caching of
12289 stack reads provides a significant speed up of remote backtraces.} or
12290 in the code segment.
12291 Other regions of memory can be explicitly marked as
12292 cacheable; @pxref{Memory Region Attributes}.
12295 @kindex set remotecache
12296 @item set remotecache on
12297 @itemx set remotecache off
12298 This option no longer does anything; it exists for compatibility
12301 @kindex show remotecache
12302 @item show remotecache
12303 Show the current state of the obsolete remotecache flag.
12305 @kindex set stack-cache
12306 @item set stack-cache on
12307 @itemx set stack-cache off
12308 Enable or disable caching of stack accesses. When @code{on}, use
12309 caching. By default, this option is @code{on}.
12311 @kindex show stack-cache
12312 @item show stack-cache
12313 Show the current state of data caching for memory accesses.
12315 @kindex set code-cache
12316 @item set code-cache on
12317 @itemx set code-cache off
12318 Enable or disable caching of code segment accesses. When @code{on},
12319 use caching. By default, this option is @code{on}. This improves
12320 performance of disassembly in remote debugging.
12322 @kindex show code-cache
12323 @item show code-cache
12324 Show the current state of target memory cache for code segment
12327 @kindex info dcache
12328 @item info dcache @r{[}line@r{]}
12329 Print the information about the performance of data cache of the
12330 current inferior's address space. The information displayed
12331 includes the dcache width and depth, and for each cache line, its
12332 number, address, and how many times it was referenced. This
12333 command is useful for debugging the data cache operation.
12335 If a line number is specified, the contents of that line will be
12338 @item set dcache size @var{size}
12339 @cindex dcache size
12340 @kindex set dcache size
12341 Set maximum number of entries in dcache (dcache depth above).
12343 @item set dcache line-size @var{line-size}
12344 @cindex dcache line-size
12345 @kindex set dcache line-size
12346 Set number of bytes each dcache entry caches (dcache width above).
12347 Must be a power of 2.
12349 @item show dcache size
12350 @kindex show dcache size
12351 Show maximum number of dcache entries. @xref{Caching Target Data, info dcache}.
12353 @item show dcache line-size
12354 @kindex show dcache line-size
12355 Show default size of dcache lines.
12359 @node Searching Memory
12360 @section Search Memory
12361 @cindex searching memory
12363 Memory can be searched for a particular sequence of bytes with the
12364 @code{find} command.
12368 @item find @r{[}/@var{sn}@r{]} @var{start_addr}, +@var{len}, @var{val1} @r{[}, @var{val2}, @dots{}@r{]}
12369 @itemx find @r{[}/@var{sn}@r{]} @var{start_addr}, @var{end_addr}, @var{val1} @r{[}, @var{val2}, @dots{}@r{]}
12370 Search memory for the sequence of bytes specified by @var{val1}, @var{val2},
12371 etc. The search begins at address @var{start_addr} and continues for either
12372 @var{len} bytes or through to @var{end_addr} inclusive.
12375 @var{s} and @var{n} are optional parameters.
12376 They may be specified in either order, apart or together.
12379 @item @var{s}, search query size
12380 The size of each search query value.
12386 halfwords (two bytes)
12390 giant words (eight bytes)
12393 All values are interpreted in the current language.
12394 This means, for example, that if the current source language is C/C@t{++}
12395 then searching for the string ``hello'' includes the trailing '\0'.
12396 The null terminator can be removed from searching by using casts,
12397 e.g.: @samp{@{char[5]@}"hello"}.
12399 If the value size is not specified, it is taken from the
12400 value's type in the current language.
12401 This is useful when one wants to specify the search
12402 pattern as a mixture of types.
12403 Note that this means, for example, that in the case of C-like languages
12404 a search for an untyped 0x42 will search for @samp{(int) 0x42}
12405 which is typically four bytes.
12407 @item @var{n}, maximum number of finds
12408 The maximum number of matches to print. The default is to print all finds.
12411 You can use strings as search values. Quote them with double-quotes
12413 The string value is copied into the search pattern byte by byte,
12414 regardless of the endianness of the target and the size specification.
12416 The address of each match found is printed as well as a count of the
12417 number of matches found.
12419 The address of the last value found is stored in convenience variable
12421 A count of the number of matches is stored in @samp{$numfound}.
12423 For example, if stopped at the @code{printf} in this function:
12429 static char hello[] = "hello-hello";
12430 static struct @{ char c; short s; int i; @}
12431 __attribute__ ((packed)) mixed
12432 = @{ 'c', 0x1234, 0x87654321 @};
12433 printf ("%s\n", hello);
12438 you get during debugging:
12441 (gdb) find &hello[0], +sizeof(hello), "hello"
12442 0x804956d <hello.1620+6>
12444 (gdb) find &hello[0], +sizeof(hello), 'h', 'e', 'l', 'l', 'o'
12445 0x8049567 <hello.1620>
12446 0x804956d <hello.1620+6>
12448 (gdb) find &hello[0], +sizeof(hello), @{char[5]@}"hello"
12449 0x8049567 <hello.1620>
12450 0x804956d <hello.1620+6>
12452 (gdb) find /b1 &hello[0], +sizeof(hello), 'h', 0x65, 'l'
12453 0x8049567 <hello.1620>
12455 (gdb) find &mixed, +sizeof(mixed), (char) 'c', (short) 0x1234, (int) 0x87654321
12456 0x8049560 <mixed.1625>
12458 (gdb) print $numfound
12461 $2 = (void *) 0x8049560
12465 @section Value Sizes
12467 Whenever @value{GDBN} prints a value memory will be allocated within
12468 @value{GDBN} to hold the contents of the value. It is possible in
12469 some languages with dynamic typing systems, that an invalid program
12470 may indicate a value that is incorrectly large, this in turn may cause
12471 @value{GDBN} to try and allocate an overly large ammount of memory.
12474 @kindex set max-value-size
12475 @item set max-value-size @var{bytes}
12476 @itemx set max-value-size unlimited
12477 Set the maximum size of memory that @value{GDBN} will allocate for the
12478 contents of a value to @var{bytes}, trying to display a value that
12479 requires more memory than that will result in an error.
12481 Setting this variable does not effect values that have already been
12482 allocated within @value{GDBN}, only future allocations.
12484 There's a minimum size that @code{max-value-size} can be set to in
12485 order that @value{GDBN} can still operate correctly, this minimum is
12486 currently 16 bytes.
12488 The limit applies to the results of some subexpressions as well as to
12489 complete expressions. For example, an expression denoting a simple
12490 integer component, such as @code{x.y.z}, may fail if the size of
12491 @var{x.y} is dynamic and exceeds @var{bytes}. On the other hand,
12492 @value{GDBN} is sometimes clever; the expression @code{A[i]}, where
12493 @var{A} is an array variable with non-constant size, will generally
12494 succeed regardless of the bounds on @var{A}, as long as the component
12495 size is less than @var{bytes}.
12497 The default value of @code{max-value-size} is currently 64k.
12499 @kindex show max-value-size
12500 @item show max-value-size
12501 Show the maximum size of memory, in bytes, that @value{GDBN} will
12502 allocate for the contents of a value.
12505 @node Optimized Code
12506 @chapter Debugging Optimized Code
12507 @cindex optimized code, debugging
12508 @cindex debugging optimized code
12510 Almost all compilers support optimization. With optimization
12511 disabled, the compiler generates assembly code that corresponds
12512 directly to your source code, in a simplistic way. As the compiler
12513 applies more powerful optimizations, the generated assembly code
12514 diverges from your original source code. With help from debugging
12515 information generated by the compiler, @value{GDBN} can map from
12516 the running program back to constructs from your original source.
12518 @value{GDBN} is more accurate with optimization disabled. If you
12519 can recompile without optimization, it is easier to follow the
12520 progress of your program during debugging. But, there are many cases
12521 where you may need to debug an optimized version.
12523 When you debug a program compiled with @samp{-g -O}, remember that the
12524 optimizer has rearranged your code; the debugger shows you what is
12525 really there. Do not be too surprised when the execution path does not
12526 exactly match your source file! An extreme example: if you define a
12527 variable, but never use it, @value{GDBN} never sees that
12528 variable---because the compiler optimizes it out of existence.
12530 Some things do not work as well with @samp{-g -O} as with just
12531 @samp{-g}, particularly on machines with instruction scheduling. If in
12532 doubt, recompile with @samp{-g} alone, and if this fixes the problem,
12533 please report it to us as a bug (including a test case!).
12534 @xref{Variables}, for more information about debugging optimized code.
12537 * Inline Functions:: How @value{GDBN} presents inlining
12538 * Tail Call Frames:: @value{GDBN} analysis of jumps to functions
12541 @node Inline Functions
12542 @section Inline Functions
12543 @cindex inline functions, debugging
12545 @dfn{Inlining} is an optimization that inserts a copy of the function
12546 body directly at each call site, instead of jumping to a shared
12547 routine. @value{GDBN} displays inlined functions just like
12548 non-inlined functions. They appear in backtraces. You can view their
12549 arguments and local variables, step into them with @code{step}, skip
12550 them with @code{next}, and escape from them with @code{finish}.
12551 You can check whether a function was inlined by using the
12552 @code{info frame} command.
12554 For @value{GDBN} to support inlined functions, the compiler must
12555 record information about inlining in the debug information ---
12556 @value{NGCC} using the @sc{dwarf 2} format does this, and several
12557 other compilers do also. @value{GDBN} only supports inlined functions
12558 when using @sc{dwarf 2}. Versions of @value{NGCC} before 4.1
12559 do not emit two required attributes (@samp{DW_AT_call_file} and
12560 @samp{DW_AT_call_line}); @value{GDBN} does not display inlined
12561 function calls with earlier versions of @value{NGCC}. It instead
12562 displays the arguments and local variables of inlined functions as
12563 local variables in the caller.
12565 The body of an inlined function is directly included at its call site;
12566 unlike a non-inlined function, there are no instructions devoted to
12567 the call. @value{GDBN} still pretends that the call site and the
12568 start of the inlined function are different instructions. Stepping to
12569 the call site shows the call site, and then stepping again shows
12570 the first line of the inlined function, even though no additional
12571 instructions are executed.
12573 This makes source-level debugging much clearer; you can see both the
12574 context of the call and then the effect of the call. Only stepping by
12575 a single instruction using @code{stepi} or @code{nexti} does not do
12576 this; single instruction steps always show the inlined body.
12578 There are some ways that @value{GDBN} does not pretend that inlined
12579 function calls are the same as normal calls:
12583 Setting breakpoints at the call site of an inlined function may not
12584 work, because the call site does not contain any code. @value{GDBN}
12585 may incorrectly move the breakpoint to the next line of the enclosing
12586 function, after the call. This limitation will be removed in a future
12587 version of @value{GDBN}; until then, set a breakpoint on an earlier line
12588 or inside the inlined function instead.
12591 @value{GDBN} cannot locate the return value of inlined calls after
12592 using the @code{finish} command. This is a limitation of compiler-generated
12593 debugging information; after @code{finish}, you can step to the next line
12594 and print a variable where your program stored the return value.
12598 @node Tail Call Frames
12599 @section Tail Call Frames
12600 @cindex tail call frames, debugging
12602 Function @code{B} can call function @code{C} in its very last statement. In
12603 unoptimized compilation the call of @code{C} is immediately followed by return
12604 instruction at the end of @code{B} code. Optimizing compiler may replace the
12605 call and return in function @code{B} into one jump to function @code{C}
12606 instead. Such use of a jump instruction is called @dfn{tail call}.
12608 During execution of function @code{C}, there will be no indication in the
12609 function call stack frames that it was tail-called from @code{B}. If function
12610 @code{A} regularly calls function @code{B} which tail-calls function @code{C},
12611 then @value{GDBN} will see @code{A} as the caller of @code{C}. However, in
12612 some cases @value{GDBN} can determine that @code{C} was tail-called from
12613 @code{B}, and it will then create fictitious call frame for that, with the
12614 return address set up as if @code{B} called @code{C} normally.
12616 This functionality is currently supported only by DWARF 2 debugging format and
12617 the compiler has to produce @samp{DW_TAG_call_site} tags. With
12618 @value{NGCC}, you need to specify @option{-O -g} during compilation, to get
12621 @kbd{info frame} command (@pxref{Frame Info}) will indicate the tail call frame
12622 kind by text @code{tail call frame} such as in this sample @value{GDBN} output:
12626 0x40066b <b(int, double)+11>: jmp 0x400640 <c(int, double)>
12628 Stack level 1, frame at 0x7fffffffda30:
12629 rip = 0x40066d in b (amd64-entry-value.cc:59); saved rip 0x4004c5
12630 tail call frame, caller of frame at 0x7fffffffda30
12631 source language c++.
12632 Arglist at unknown address.
12633 Locals at unknown address, Previous frame's sp is 0x7fffffffda30
12636 The detection of all the possible code path executions can find them ambiguous.
12637 There is no execution history stored (possible @ref{Reverse Execution} is never
12638 used for this purpose) and the last known caller could have reached the known
12639 callee by multiple different jump sequences. In such case @value{GDBN} still
12640 tries to show at least all the unambiguous top tail callers and all the
12641 unambiguous bottom tail calees, if any.
12644 @anchor{set debug entry-values}
12645 @item set debug entry-values
12646 @kindex set debug entry-values
12647 When set to on, enables printing of analysis messages for both frame argument
12648 values at function entry and tail calls. It will show all the possible valid
12649 tail calls code paths it has considered. It will also print the intersection
12650 of them with the final unambiguous (possibly partial or even empty) code path
12653 @item show debug entry-values
12654 @kindex show debug entry-values
12655 Show the current state of analysis messages printing for both frame argument
12656 values at function entry and tail calls.
12659 The analysis messages for tail calls can for example show why the virtual tail
12660 call frame for function @code{c} has not been recognized (due to the indirect
12661 reference by variable @code{x}):
12664 static void __attribute__((noinline, noclone)) c (void);
12665 void (*x) (void) = c;
12666 static void __attribute__((noinline, noclone)) a (void) @{ x++; @}
12667 static void __attribute__((noinline, noclone)) c (void) @{ a (); @}
12668 int main (void) @{ x (); return 0; @}
12670 Breakpoint 1, DW_OP_entry_value resolving cannot find
12671 DW_TAG_call_site 0x40039a in main
12673 3 static void __attribute__((noinline, noclone)) a (void) @{ x++; @}
12676 #1 0x000000000040039a in main () at t.c:5
12679 Another possibility is an ambiguous virtual tail call frames resolution:
12683 static void __attribute__((noinline, noclone)) f (void) @{ i++; @}
12684 static void __attribute__((noinline, noclone)) e (void) @{ f (); @}
12685 static void __attribute__((noinline, noclone)) d (void) @{ f (); @}
12686 static void __attribute__((noinline, noclone)) c (void) @{ d (); @}
12687 static void __attribute__((noinline, noclone)) b (void)
12688 @{ if (i) c (); else e (); @}
12689 static void __attribute__((noinline, noclone)) a (void) @{ b (); @}
12690 int main (void) @{ a (); return 0; @}
12692 tailcall: initial: 0x4004d2(a) 0x4004ce(b) 0x4004b2(c) 0x4004a2(d)
12693 tailcall: compare: 0x4004d2(a) 0x4004cc(b) 0x400492(e)
12694 tailcall: reduced: 0x4004d2(a) |
12697 #1 0x00000000004004d2 in a () at t.c:8
12698 #2 0x0000000000400395 in main () at t.c:9
12701 @set CALLSEQ1A @code{main@value{ARROW}a@value{ARROW}b@value{ARROW}c@value{ARROW}d@value{ARROW}f}
12702 @set CALLSEQ2A @code{main@value{ARROW}a@value{ARROW}b@value{ARROW}e@value{ARROW}f}
12704 @c Convert CALLSEQ#A to CALLSEQ#B depending on HAVE_MAKEINFO_CLICK.
12705 @ifset HAVE_MAKEINFO_CLICK
12706 @set ARROW @click{}
12707 @set CALLSEQ1B @clicksequence{@value{CALLSEQ1A}}
12708 @set CALLSEQ2B @clicksequence{@value{CALLSEQ2A}}
12710 @ifclear HAVE_MAKEINFO_CLICK
12712 @set CALLSEQ1B @value{CALLSEQ1A}
12713 @set CALLSEQ2B @value{CALLSEQ2A}
12716 Frames #0 and #2 are real, #1 is a virtual tail call frame.
12717 The code can have possible execution paths @value{CALLSEQ1B} or
12718 @value{CALLSEQ2B}, @value{GDBN} cannot find which one from the inferior state.
12720 @code{initial:} state shows some random possible calling sequence @value{GDBN}
12721 has found. It then finds another possible calling sequcen - that one is
12722 prefixed by @code{compare:}. The non-ambiguous intersection of these two is
12723 printed as the @code{reduced:} calling sequence. That one could have many
12724 futher @code{compare:} and @code{reduced:} statements as long as there remain
12725 any non-ambiguous sequence entries.
12727 For the frame of function @code{b} in both cases there are different possible
12728 @code{$pc} values (@code{0x4004cc} or @code{0x4004ce}), therefore this frame is
12729 also ambigous. The only non-ambiguous frame is the one for function @code{a},
12730 therefore this one is displayed to the user while the ambiguous frames are
12733 There can be also reasons why printing of frame argument values at function
12738 static void __attribute__((noinline, noclone)) c (int i) @{ v++; @}
12739 static void __attribute__((noinline, noclone)) a (int i);
12740 static void __attribute__((noinline, noclone)) b (int i) @{ a (i); @}
12741 static void __attribute__((noinline, noclone)) a (int i)
12742 @{ if (i) b (i - 1); else c (0); @}
12743 int main (void) @{ a (5); return 0; @}
12746 #0 c (i=i@@entry=0) at t.c:2
12747 #1 0x0000000000400428 in a (DW_OP_entry_value resolving has found
12748 function "a" at 0x400420 can call itself via tail calls
12749 i=<optimized out>) at t.c:6
12750 #2 0x000000000040036e in main () at t.c:7
12753 @value{GDBN} cannot find out from the inferior state if and how many times did
12754 function @code{a} call itself (via function @code{b}) as these calls would be
12755 tail calls. Such tail calls would modify thue @code{i} variable, therefore
12756 @value{GDBN} cannot be sure the value it knows would be right - @value{GDBN}
12757 prints @code{<optimized out>} instead.
12760 @chapter C Preprocessor Macros
12762 Some languages, such as C and C@t{++}, provide a way to define and invoke
12763 ``preprocessor macros'' which expand into strings of tokens.
12764 @value{GDBN} can evaluate expressions containing macro invocations, show
12765 the result of macro expansion, and show a macro's definition, including
12766 where it was defined.
12768 You may need to compile your program specially to provide @value{GDBN}
12769 with information about preprocessor macros. Most compilers do not
12770 include macros in their debugging information, even when you compile
12771 with the @option{-g} flag. @xref{Compilation}.
12773 A program may define a macro at one point, remove that definition later,
12774 and then provide a different definition after that. Thus, at different
12775 points in the program, a macro may have different definitions, or have
12776 no definition at all. If there is a current stack frame, @value{GDBN}
12777 uses the macros in scope at that frame's source code line. Otherwise,
12778 @value{GDBN} uses the macros in scope at the current listing location;
12781 Whenever @value{GDBN} evaluates an expression, it always expands any
12782 macro invocations present in the expression. @value{GDBN} also provides
12783 the following commands for working with macros explicitly.
12787 @kindex macro expand
12788 @cindex macro expansion, showing the results of preprocessor
12789 @cindex preprocessor macro expansion, showing the results of
12790 @cindex expanding preprocessor macros
12791 @item macro expand @var{expression}
12792 @itemx macro exp @var{expression}
12793 Show the results of expanding all preprocessor macro invocations in
12794 @var{expression}. Since @value{GDBN} simply expands macros, but does
12795 not parse the result, @var{expression} need not be a valid expression;
12796 it can be any string of tokens.
12799 @item macro expand-once @var{expression}
12800 @itemx macro exp1 @var{expression}
12801 @cindex expand macro once
12802 @i{(This command is not yet implemented.)} Show the results of
12803 expanding those preprocessor macro invocations that appear explicitly in
12804 @var{expression}. Macro invocations appearing in that expansion are
12805 left unchanged. This command allows you to see the effect of a
12806 particular macro more clearly, without being confused by further
12807 expansions. Since @value{GDBN} simply expands macros, but does not
12808 parse the result, @var{expression} need not be a valid expression; it
12809 can be any string of tokens.
12812 @cindex macro definition, showing
12813 @cindex definition of a macro, showing
12814 @cindex macros, from debug info
12815 @item info macro [-a|-all] [--] @var{macro}
12816 Show the current definition or all definitions of the named @var{macro},
12817 and describe the source location or compiler command-line where that
12818 definition was established. The optional double dash is to signify the end of
12819 argument processing and the beginning of @var{macro} for non C-like macros where
12820 the macro may begin with a hyphen.
12822 @kindex info macros
12823 @item info macros @var{location}
12824 Show all macro definitions that are in effect at the location specified
12825 by @var{location}, and describe the source location or compiler
12826 command-line where those definitions were established.
12828 @kindex macro define
12829 @cindex user-defined macros
12830 @cindex defining macros interactively
12831 @cindex macros, user-defined
12832 @item macro define @var{macro} @var{replacement-list}
12833 @itemx macro define @var{macro}(@var{arglist}) @var{replacement-list}
12834 Introduce a definition for a preprocessor macro named @var{macro},
12835 invocations of which are replaced by the tokens given in
12836 @var{replacement-list}. The first form of this command defines an
12837 ``object-like'' macro, which takes no arguments; the second form
12838 defines a ``function-like'' macro, which takes the arguments given in
12841 A definition introduced by this command is in scope in every
12842 expression evaluated in @value{GDBN}, until it is removed with the
12843 @code{macro undef} command, described below. The definition overrides
12844 all definitions for @var{macro} present in the program being debugged,
12845 as well as any previous user-supplied definition.
12847 @kindex macro undef
12848 @item macro undef @var{macro}
12849 Remove any user-supplied definition for the macro named @var{macro}.
12850 This command only affects definitions provided with the @code{macro
12851 define} command, described above; it cannot remove definitions present
12852 in the program being debugged.
12856 List all the macros defined using the @code{macro define} command.
12859 @cindex macros, example of debugging with
12860 Here is a transcript showing the above commands in action. First, we
12861 show our source files:
12866 #include "sample.h"
12869 #define ADD(x) (M + x)
12874 printf ("Hello, world!\n");
12876 printf ("We're so creative.\n");
12878 printf ("Goodbye, world!\n");
12885 Now, we compile the program using the @sc{gnu} C compiler,
12886 @value{NGCC}. We pass the @option{-gdwarf-2}@footnote{This is the
12887 minimum. Recent versions of @value{NGCC} support @option{-gdwarf-3}
12888 and @option{-gdwarf-4}; we recommend always choosing the most recent
12889 version of DWARF.} @emph{and} @option{-g3} flags to ensure the compiler
12890 includes information about preprocessor macros in the debugging
12894 $ gcc -gdwarf-2 -g3 sample.c -o sample
12898 Now, we start @value{GDBN} on our sample program:
12902 GNU gdb 2002-05-06-cvs
12903 Copyright 2002 Free Software Foundation, Inc.
12904 GDB is free software, @dots{}
12908 We can expand macros and examine their definitions, even when the
12909 program is not running. @value{GDBN} uses the current listing position
12910 to decide which macro definitions are in scope:
12913 (@value{GDBP}) list main
12916 5 #define ADD(x) (M + x)
12921 10 printf ("Hello, world!\n");
12923 12 printf ("We're so creative.\n");
12924 (@value{GDBP}) info macro ADD
12925 Defined at /home/jimb/gdb/macros/play/sample.c:5
12926 #define ADD(x) (M + x)
12927 (@value{GDBP}) info macro Q
12928 Defined at /home/jimb/gdb/macros/play/sample.h:1
12929 included at /home/jimb/gdb/macros/play/sample.c:2
12931 (@value{GDBP}) macro expand ADD(1)
12932 expands to: (42 + 1)
12933 (@value{GDBP}) macro expand-once ADD(1)
12934 expands to: once (M + 1)
12938 In the example above, note that @code{macro expand-once} expands only
12939 the macro invocation explicit in the original text --- the invocation of
12940 @code{ADD} --- but does not expand the invocation of the macro @code{M},
12941 which was introduced by @code{ADD}.
12943 Once the program is running, @value{GDBN} uses the macro definitions in
12944 force at the source line of the current stack frame:
12947 (@value{GDBP}) break main
12948 Breakpoint 1 at 0x8048370: file sample.c, line 10.
12950 Starting program: /home/jimb/gdb/macros/play/sample
12952 Breakpoint 1, main () at sample.c:10
12953 10 printf ("Hello, world!\n");
12957 At line 10, the definition of the macro @code{N} at line 9 is in force:
12960 (@value{GDBP}) info macro N
12961 Defined at /home/jimb/gdb/macros/play/sample.c:9
12963 (@value{GDBP}) macro expand N Q M
12964 expands to: 28 < 42
12965 (@value{GDBP}) print N Q M
12970 As we step over directives that remove @code{N}'s definition, and then
12971 give it a new definition, @value{GDBN} finds the definition (or lack
12972 thereof) in force at each point:
12975 (@value{GDBP}) next
12977 12 printf ("We're so creative.\n");
12978 (@value{GDBP}) info macro N
12979 The symbol `N' has no definition as a C/C++ preprocessor macro
12980 at /home/jimb/gdb/macros/play/sample.c:12
12981 (@value{GDBP}) next
12983 14 printf ("Goodbye, world!\n");
12984 (@value{GDBP}) info macro N
12985 Defined at /home/jimb/gdb/macros/play/sample.c:13
12987 (@value{GDBP}) macro expand N Q M
12988 expands to: 1729 < 42
12989 (@value{GDBP}) print N Q M
12994 In addition to source files, macros can be defined on the compilation command
12995 line using the @option{-D@var{name}=@var{value}} syntax. For macros defined in
12996 such a way, @value{GDBN} displays the location of their definition as line zero
12997 of the source file submitted to the compiler.
13000 (@value{GDBP}) info macro __STDC__
13001 Defined at /home/jimb/gdb/macros/play/sample.c:0
13008 @chapter Tracepoints
13009 @c This chapter is based on the documentation written by Michael
13010 @c Snyder, David Taylor, Jim Blandy, and Elena Zannoni.
13012 @cindex tracepoints
13013 In some applications, it is not feasible for the debugger to interrupt
13014 the program's execution long enough for the developer to learn
13015 anything helpful about its behavior. If the program's correctness
13016 depends on its real-time behavior, delays introduced by a debugger
13017 might cause the program to change its behavior drastically, or perhaps
13018 fail, even when the code itself is correct. It is useful to be able
13019 to observe the program's behavior without interrupting it.
13021 Using @value{GDBN}'s @code{trace} and @code{collect} commands, you can
13022 specify locations in the program, called @dfn{tracepoints}, and
13023 arbitrary expressions to evaluate when those tracepoints are reached.
13024 Later, using the @code{tfind} command, you can examine the values
13025 those expressions had when the program hit the tracepoints. The
13026 expressions may also denote objects in memory---structures or arrays,
13027 for example---whose values @value{GDBN} should record; while visiting
13028 a particular tracepoint, you may inspect those objects as if they were
13029 in memory at that moment. However, because @value{GDBN} records these
13030 values without interacting with you, it can do so quickly and
13031 unobtrusively, hopefully not disturbing the program's behavior.
13033 The tracepoint facility is currently available only for remote
13034 targets. @xref{Targets}. In addition, your remote target must know
13035 how to collect trace data. This functionality is implemented in the
13036 remote stub; however, none of the stubs distributed with @value{GDBN}
13037 support tracepoints as of this writing. The format of the remote
13038 packets used to implement tracepoints are described in @ref{Tracepoint
13041 It is also possible to get trace data from a file, in a manner reminiscent
13042 of corefiles; you specify the filename, and use @code{tfind} to search
13043 through the file. @xref{Trace Files}, for more details.
13045 This chapter describes the tracepoint commands and features.
13048 * Set Tracepoints::
13049 * Analyze Collected Data::
13050 * Tracepoint Variables::
13054 @node Set Tracepoints
13055 @section Commands to Set Tracepoints
13057 Before running such a @dfn{trace experiment}, an arbitrary number of
13058 tracepoints can be set. A tracepoint is actually a special type of
13059 breakpoint (@pxref{Set Breaks}), so you can manipulate it using
13060 standard breakpoint commands. For instance, as with breakpoints,
13061 tracepoint numbers are successive integers starting from one, and many
13062 of the commands associated with tracepoints take the tracepoint number
13063 as their argument, to identify which tracepoint to work on.
13065 For each tracepoint, you can specify, in advance, some arbitrary set
13066 of data that you want the target to collect in the trace buffer when
13067 it hits that tracepoint. The collected data can include registers,
13068 local variables, or global data. Later, you can use @value{GDBN}
13069 commands to examine the values these data had at the time the
13070 tracepoint was hit.
13072 Tracepoints do not support every breakpoint feature. Ignore counts on
13073 tracepoints have no effect, and tracepoints cannot run @value{GDBN}
13074 commands when they are hit. Tracepoints may not be thread-specific
13077 @cindex fast tracepoints
13078 Some targets may support @dfn{fast tracepoints}, which are inserted in
13079 a different way (such as with a jump instead of a trap), that is
13080 faster but possibly restricted in where they may be installed.
13082 @cindex static tracepoints
13083 @cindex markers, static tracepoints
13084 @cindex probing markers, static tracepoints
13085 Regular and fast tracepoints are dynamic tracing facilities, meaning
13086 that they can be used to insert tracepoints at (almost) any location
13087 in the target. Some targets may also support controlling @dfn{static
13088 tracepoints} from @value{GDBN}. With static tracing, a set of
13089 instrumentation points, also known as @dfn{markers}, are embedded in
13090 the target program, and can be activated or deactivated by name or
13091 address. These are usually placed at locations which facilitate
13092 investigating what the target is actually doing. @value{GDBN}'s
13093 support for static tracing includes being able to list instrumentation
13094 points, and attach them with @value{GDBN} defined high level
13095 tracepoints that expose the whole range of convenience of
13096 @value{GDBN}'s tracepoints support. Namely, support for collecting
13097 registers values and values of global or local (to the instrumentation
13098 point) variables; tracepoint conditions and trace state variables.
13099 The act of installing a @value{GDBN} static tracepoint on an
13100 instrumentation point, or marker, is referred to as @dfn{probing} a
13101 static tracepoint marker.
13103 @code{gdbserver} supports tracepoints on some target systems.
13104 @xref{Server,,Tracepoints support in @code{gdbserver}}.
13106 This section describes commands to set tracepoints and associated
13107 conditions and actions.
13110 * Create and Delete Tracepoints::
13111 * Enable and Disable Tracepoints::
13112 * Tracepoint Passcounts::
13113 * Tracepoint Conditions::
13114 * Trace State Variables::
13115 * Tracepoint Actions::
13116 * Listing Tracepoints::
13117 * Listing Static Tracepoint Markers::
13118 * Starting and Stopping Trace Experiments::
13119 * Tracepoint Restrictions::
13122 @node Create and Delete Tracepoints
13123 @subsection Create and Delete Tracepoints
13126 @cindex set tracepoint
13128 @item trace @var{location}
13129 The @code{trace} command is very similar to the @code{break} command.
13130 Its argument @var{location} can be any valid location.
13131 @xref{Specify Location}. The @code{trace} command defines a tracepoint,
13132 which is a point in the target program where the debugger will briefly stop,
13133 collect some data, and then allow the program to continue. Setting a tracepoint
13134 or changing its actions takes effect immediately if the remote stub
13135 supports the @samp{InstallInTrace} feature (@pxref{install tracepoint
13137 If remote stub doesn't support the @samp{InstallInTrace} feature, all
13138 these changes don't take effect until the next @code{tstart}
13139 command, and once a trace experiment is running, further changes will
13140 not have any effect until the next trace experiment starts. In addition,
13141 @value{GDBN} supports @dfn{pending tracepoints}---tracepoints whose
13142 address is not yet resolved. (This is similar to pending breakpoints.)
13143 Pending tracepoints are not downloaded to the target and not installed
13144 until they are resolved. The resolution of pending tracepoints requires
13145 @value{GDBN} support---when debugging with the remote target, and
13146 @value{GDBN} disconnects from the remote stub (@pxref{disconnected
13147 tracing}), pending tracepoints can not be resolved (and downloaded to
13148 the remote stub) while @value{GDBN} is disconnected.
13150 Here are some examples of using the @code{trace} command:
13153 (@value{GDBP}) @b{trace foo.c:121} // a source file and line number
13155 (@value{GDBP}) @b{trace +2} // 2 lines forward
13157 (@value{GDBP}) @b{trace my_function} // first source line of function
13159 (@value{GDBP}) @b{trace *my_function} // EXACT start address of function
13161 (@value{GDBP}) @b{trace *0x2117c4} // an address
13165 You can abbreviate @code{trace} as @code{tr}.
13167 @item trace @var{location} if @var{cond}
13168 Set a tracepoint with condition @var{cond}; evaluate the expression
13169 @var{cond} each time the tracepoint is reached, and collect data only
13170 if the value is nonzero---that is, if @var{cond} evaluates as true.
13171 @xref{Tracepoint Conditions, ,Tracepoint Conditions}, for more
13172 information on tracepoint conditions.
13174 @item ftrace @var{location} [ if @var{cond} ]
13175 @cindex set fast tracepoint
13176 @cindex fast tracepoints, setting
13178 The @code{ftrace} command sets a fast tracepoint. For targets that
13179 support them, fast tracepoints will use a more efficient but possibly
13180 less general technique to trigger data collection, such as a jump
13181 instruction instead of a trap, or some sort of hardware support. It
13182 may not be possible to create a fast tracepoint at the desired
13183 location, in which case the command will exit with an explanatory
13186 @value{GDBN} handles arguments to @code{ftrace} exactly as for
13189 On 32-bit x86-architecture systems, fast tracepoints normally need to
13190 be placed at an instruction that is 5 bytes or longer, but can be
13191 placed at 4-byte instructions if the low 64K of memory of the target
13192 program is available to install trampolines. Some Unix-type systems,
13193 such as @sc{gnu}/Linux, exclude low addresses from the program's
13194 address space; but for instance with the Linux kernel it is possible
13195 to let @value{GDBN} use this area by doing a @command{sysctl} command
13196 to set the @code{mmap_min_addr} kernel parameter, as in
13199 sudo sysctl -w vm.mmap_min_addr=32768
13203 which sets the low address to 32K, which leaves plenty of room for
13204 trampolines. The minimum address should be set to a page boundary.
13206 @item strace @var{location} [ if @var{cond} ]
13207 @cindex set static tracepoint
13208 @cindex static tracepoints, setting
13209 @cindex probe static tracepoint marker
13211 The @code{strace} command sets a static tracepoint. For targets that
13212 support it, setting a static tracepoint probes a static
13213 instrumentation point, or marker, found at @var{location}. It may not
13214 be possible to set a static tracepoint at the desired location, in
13215 which case the command will exit with an explanatory message.
13217 @value{GDBN} handles arguments to @code{strace} exactly as for
13218 @code{trace}, with the addition that the user can also specify
13219 @code{-m @var{marker}} as @var{location}. This probes the marker
13220 identified by the @var{marker} string identifier. This identifier
13221 depends on the static tracepoint backend library your program is
13222 using. You can find all the marker identifiers in the @samp{ID} field
13223 of the @code{info static-tracepoint-markers} command output.
13224 @xref{Listing Static Tracepoint Markers,,Listing Static Tracepoint
13225 Markers}. For example, in the following small program using the UST
13231 trace_mark(ust, bar33, "str %s", "FOOBAZ");
13236 the marker id is composed of joining the first two arguments to the
13237 @code{trace_mark} call with a slash, which translates to:
13240 (@value{GDBP}) info static-tracepoint-markers
13241 Cnt Enb ID Address What
13242 1 n ust/bar33 0x0000000000400ddc in main at stexample.c:22
13248 so you may probe the marker above with:
13251 (@value{GDBP}) strace -m ust/bar33
13254 Static tracepoints accept an extra collect action --- @code{collect
13255 $_sdata}. This collects arbitrary user data passed in the probe point
13256 call to the tracing library. In the UST example above, you'll see
13257 that the third argument to @code{trace_mark} is a printf-like format
13258 string. The user data is then the result of running that formating
13259 string against the following arguments. Note that @code{info
13260 static-tracepoint-markers} command output lists that format string in
13261 the @samp{Data:} field.
13263 You can inspect this data when analyzing the trace buffer, by printing
13264 the $_sdata variable like any other variable available to
13265 @value{GDBN}. @xref{Tracepoint Actions,,Tracepoint Action Lists}.
13268 @cindex last tracepoint number
13269 @cindex recent tracepoint number
13270 @cindex tracepoint number
13271 The convenience variable @code{$tpnum} records the tracepoint number
13272 of the most recently set tracepoint.
13274 @kindex delete tracepoint
13275 @cindex tracepoint deletion
13276 @item delete tracepoint @r{[}@var{num}@r{]}
13277 Permanently delete one or more tracepoints. With no argument, the
13278 default is to delete all tracepoints. Note that the regular
13279 @code{delete} command can remove tracepoints also.
13284 (@value{GDBP}) @b{delete trace 1 2 3} // remove three tracepoints
13286 (@value{GDBP}) @b{delete trace} // remove all tracepoints
13290 You can abbreviate this command as @code{del tr}.
13293 @node Enable and Disable Tracepoints
13294 @subsection Enable and Disable Tracepoints
13296 These commands are deprecated; they are equivalent to plain @code{disable} and @code{enable}.
13299 @kindex disable tracepoint
13300 @item disable tracepoint @r{[}@var{num}@r{]}
13301 Disable tracepoint @var{num}, or all tracepoints if no argument
13302 @var{num} is given. A disabled tracepoint will have no effect during
13303 a trace experiment, but it is not forgotten. You can re-enable
13304 a disabled tracepoint using the @code{enable tracepoint} command.
13305 If the command is issued during a trace experiment and the debug target
13306 has support for disabling tracepoints during a trace experiment, then the
13307 change will be effective immediately. Otherwise, it will be applied to the
13308 next trace experiment.
13310 @kindex enable tracepoint
13311 @item enable tracepoint @r{[}@var{num}@r{]}
13312 Enable tracepoint @var{num}, or all tracepoints. If this command is
13313 issued during a trace experiment and the debug target supports enabling
13314 tracepoints during a trace experiment, then the enabled tracepoints will
13315 become effective immediately. Otherwise, they will become effective the
13316 next time a trace experiment is run.
13319 @node Tracepoint Passcounts
13320 @subsection Tracepoint Passcounts
13324 @cindex tracepoint pass count
13325 @item passcount @r{[}@var{n} @r{[}@var{num}@r{]]}
13326 Set the @dfn{passcount} of a tracepoint. The passcount is a way to
13327 automatically stop a trace experiment. If a tracepoint's passcount is
13328 @var{n}, then the trace experiment will be automatically stopped on
13329 the @var{n}'th time that tracepoint is hit. If the tracepoint number
13330 @var{num} is not specified, the @code{passcount} command sets the
13331 passcount of the most recently defined tracepoint. If no passcount is
13332 given, the trace experiment will run until stopped explicitly by the
13338 (@value{GDBP}) @b{passcount 5 2} // Stop on the 5th execution of
13339 @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// tracepoint 2}
13341 (@value{GDBP}) @b{passcount 12} // Stop on the 12th execution of the
13342 @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// most recently defined tracepoint.}
13343 (@value{GDBP}) @b{trace foo}
13344 (@value{GDBP}) @b{pass 3}
13345 (@value{GDBP}) @b{trace bar}
13346 (@value{GDBP}) @b{pass 2}
13347 (@value{GDBP}) @b{trace baz}
13348 (@value{GDBP}) @b{pass 1} // Stop tracing when foo has been
13349 @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// executed 3 times OR when bar has}
13350 @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// been executed 2 times}
13351 @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// OR when baz has been executed 1 time.}
13355 @node Tracepoint Conditions
13356 @subsection Tracepoint Conditions
13357 @cindex conditional tracepoints
13358 @cindex tracepoint conditions
13360 The simplest sort of tracepoint collects data every time your program
13361 reaches a specified place. You can also specify a @dfn{condition} for
13362 a tracepoint. A condition is just a Boolean expression in your
13363 programming language (@pxref{Expressions, ,Expressions}). A
13364 tracepoint with a condition evaluates the expression each time your
13365 program reaches it, and data collection happens only if the condition
13368 Tracepoint conditions can be specified when a tracepoint is set, by
13369 using @samp{if} in the arguments to the @code{trace} command.
13370 @xref{Create and Delete Tracepoints, ,Setting Tracepoints}. They can
13371 also be set or changed at any time with the @code{condition} command,
13372 just as with breakpoints.
13374 Unlike breakpoint conditions, @value{GDBN} does not actually evaluate
13375 the conditional expression itself. Instead, @value{GDBN} encodes the
13376 expression into an agent expression (@pxref{Agent Expressions})
13377 suitable for execution on the target, independently of @value{GDBN}.
13378 Global variables become raw memory locations, locals become stack
13379 accesses, and so forth.
13381 For instance, suppose you have a function that is usually called
13382 frequently, but should not be called after an error has occurred. You
13383 could use the following tracepoint command to collect data about calls
13384 of that function that happen while the error code is propagating
13385 through the program; an unconditional tracepoint could end up
13386 collecting thousands of useless trace frames that you would have to
13390 (@value{GDBP}) @kbd{trace normal_operation if errcode > 0}
13393 @node Trace State Variables
13394 @subsection Trace State Variables
13395 @cindex trace state variables
13397 A @dfn{trace state variable} is a special type of variable that is
13398 created and managed by target-side code. The syntax is the same as
13399 that for GDB's convenience variables (a string prefixed with ``$''),
13400 but they are stored on the target. They must be created explicitly,
13401 using a @code{tvariable} command. They are always 64-bit signed
13404 Trace state variables are remembered by @value{GDBN}, and downloaded
13405 to the target along with tracepoint information when the trace
13406 experiment starts. There are no intrinsic limits on the number of
13407 trace state variables, beyond memory limitations of the target.
13409 @cindex convenience variables, and trace state variables
13410 Although trace state variables are managed by the target, you can use
13411 them in print commands and expressions as if they were convenience
13412 variables; @value{GDBN} will get the current value from the target
13413 while the trace experiment is running. Trace state variables share
13414 the same namespace as other ``$'' variables, which means that you
13415 cannot have trace state variables with names like @code{$23} or
13416 @code{$pc}, nor can you have a trace state variable and a convenience
13417 variable with the same name.
13421 @item tvariable $@var{name} [ = @var{expression} ]
13423 The @code{tvariable} command creates a new trace state variable named
13424 @code{$@var{name}}, and optionally gives it an initial value of
13425 @var{expression}. The @var{expression} is evaluated when this command is
13426 entered; the result will be converted to an integer if possible,
13427 otherwise @value{GDBN} will report an error. A subsequent
13428 @code{tvariable} command specifying the same name does not create a
13429 variable, but instead assigns the supplied initial value to the
13430 existing variable of that name, overwriting any previous initial
13431 value. The default initial value is 0.
13433 @item info tvariables
13434 @kindex info tvariables
13435 List all the trace state variables along with their initial values.
13436 Their current values may also be displayed, if the trace experiment is
13439 @item delete tvariable @r{[} $@var{name} @dots{} @r{]}
13440 @kindex delete tvariable
13441 Delete the given trace state variables, or all of them if no arguments
13446 @node Tracepoint Actions
13447 @subsection Tracepoint Action Lists
13451 @cindex tracepoint actions
13452 @item actions @r{[}@var{num}@r{]}
13453 This command will prompt for a list of actions to be taken when the
13454 tracepoint is hit. If the tracepoint number @var{num} is not
13455 specified, this command sets the actions for the one that was most
13456 recently defined (so that you can define a tracepoint and then say
13457 @code{actions} without bothering about its number). You specify the
13458 actions themselves on the following lines, one action at a time, and
13459 terminate the actions list with a line containing just @code{end}. So
13460 far, the only defined actions are @code{collect}, @code{teval}, and
13461 @code{while-stepping}.
13463 @code{actions} is actually equivalent to @code{commands} (@pxref{Break
13464 Commands, ,Breakpoint Command Lists}), except that only the defined
13465 actions are allowed; any other @value{GDBN} command is rejected.
13467 @cindex remove actions from a tracepoint
13468 To remove all actions from a tracepoint, type @samp{actions @var{num}}
13469 and follow it immediately with @samp{end}.
13472 (@value{GDBP}) @b{collect @var{data}} // collect some data
13474 (@value{GDBP}) @b{while-stepping 5} // single-step 5 times, collect data
13476 (@value{GDBP}) @b{end} // signals the end of actions.
13479 In the following example, the action list begins with @code{collect}
13480 commands indicating the things to be collected when the tracepoint is
13481 hit. Then, in order to single-step and collect additional data
13482 following the tracepoint, a @code{while-stepping} command is used,
13483 followed by the list of things to be collected after each step in a
13484 sequence of single steps. The @code{while-stepping} command is
13485 terminated by its own separate @code{end} command. Lastly, the action
13486 list is terminated by an @code{end} command.
13489 (@value{GDBP}) @b{trace foo}
13490 (@value{GDBP}) @b{actions}
13491 Enter actions for tracepoint 1, one per line:
13494 > while-stepping 12
13495 > collect $pc, arr[i]
13500 @kindex collect @r{(tracepoints)}
13501 @item collect@r{[}/@var{mods}@r{]} @var{expr1}, @var{expr2}, @dots{}
13502 Collect values of the given expressions when the tracepoint is hit.
13503 This command accepts a comma-separated list of any valid expressions.
13504 In addition to global, static, or local variables, the following
13505 special arguments are supported:
13509 Collect all registers.
13512 Collect all function arguments.
13515 Collect all local variables.
13518 Collect the return address. This is helpful if you want to see more
13521 @emph{Note:} The return address location can not always be reliably
13522 determined up front, and the wrong address / registers may end up
13523 collected instead. On some architectures the reliability is higher
13524 for tracepoints at function entry, while on others it's the opposite.
13525 When this happens, backtracing will stop because the return address is
13526 found unavailable (unless another collect rule happened to match it).
13529 Collects the number of arguments from the static probe at which the
13530 tracepoint is located.
13531 @xref{Static Probe Points}.
13533 @item $_probe_arg@var{n}
13534 @var{n} is an integer between 0 and 11. Collects the @var{n}th argument
13535 from the static probe at which the tracepoint is located.
13536 @xref{Static Probe Points}.
13539 @vindex $_sdata@r{, collect}
13540 Collect static tracepoint marker specific data. Only available for
13541 static tracepoints. @xref{Tracepoint Actions,,Tracepoint Action
13542 Lists}. On the UST static tracepoints library backend, an
13543 instrumentation point resembles a @code{printf} function call. The
13544 tracing library is able to collect user specified data formatted to a
13545 character string using the format provided by the programmer that
13546 instrumented the program. Other backends have similar mechanisms.
13547 Here's an example of a UST marker call:
13550 const char master_name[] = "$your_name";
13551 trace_mark(channel1, marker1, "hello %s", master_name)
13554 In this case, collecting @code{$_sdata} collects the string
13555 @samp{hello $yourname}. When analyzing the trace buffer, you can
13556 inspect @samp{$_sdata} like any other variable available to
13560 You can give several consecutive @code{collect} commands, each one
13561 with a single argument, or one @code{collect} command with several
13562 arguments separated by commas; the effect is the same.
13564 The optional @var{mods} changes the usual handling of the arguments.
13565 @code{s} requests that pointers to chars be handled as strings, in
13566 particular collecting the contents of the memory being pointed at, up
13567 to the first zero. The upper bound is by default the value of the
13568 @code{print elements} variable; if @code{s} is followed by a decimal
13569 number, that is the upper bound instead. So for instance
13570 @samp{collect/s25 mystr} collects as many as 25 characters at
13573 The command @code{info scope} (@pxref{Symbols, info scope}) is
13574 particularly useful for figuring out what data to collect.
13576 @kindex teval @r{(tracepoints)}
13577 @item teval @var{expr1}, @var{expr2}, @dots{}
13578 Evaluate the given expressions when the tracepoint is hit. This
13579 command accepts a comma-separated list of expressions. The results
13580 are discarded, so this is mainly useful for assigning values to trace
13581 state variables (@pxref{Trace State Variables}) without adding those
13582 values to the trace buffer, as would be the case if the @code{collect}
13585 @kindex while-stepping @r{(tracepoints)}
13586 @item while-stepping @var{n}
13587 Perform @var{n} single-step instruction traces after the tracepoint,
13588 collecting new data after each step. The @code{while-stepping}
13589 command is followed by the list of what to collect while stepping
13590 (followed by its own @code{end} command):
13593 > while-stepping 12
13594 > collect $regs, myglobal
13600 Note that @code{$pc} is not automatically collected by
13601 @code{while-stepping}; you need to explicitly collect that register if
13602 you need it. You may abbreviate @code{while-stepping} as @code{ws} or
13605 @item set default-collect @var{expr1}, @var{expr2}, @dots{}
13606 @kindex set default-collect
13607 @cindex default collection action
13608 This variable is a list of expressions to collect at each tracepoint
13609 hit. It is effectively an additional @code{collect} action prepended
13610 to every tracepoint action list. The expressions are parsed
13611 individually for each tracepoint, so for instance a variable named
13612 @code{xyz} may be interpreted as a global for one tracepoint, and a
13613 local for another, as appropriate to the tracepoint's location.
13615 @item show default-collect
13616 @kindex show default-collect
13617 Show the list of expressions that are collected by default at each
13622 @node Listing Tracepoints
13623 @subsection Listing Tracepoints
13626 @kindex info tracepoints @r{[}@var{n}@dots{}@r{]}
13627 @kindex info tp @r{[}@var{n}@dots{}@r{]}
13628 @cindex information about tracepoints
13629 @item info tracepoints @r{[}@var{num}@dots{}@r{]}
13630 Display information about the tracepoint @var{num}. If you don't
13631 specify a tracepoint number, displays information about all the
13632 tracepoints defined so far. The format is similar to that used for
13633 @code{info breakpoints}; in fact, @code{info tracepoints} is the same
13634 command, simply restricting itself to tracepoints.
13636 A tracepoint's listing may include additional information specific to
13641 its passcount as given by the @code{passcount @var{n}} command
13644 the state about installed on target of each location
13648 (@value{GDBP}) @b{info trace}
13649 Num Type Disp Enb Address What
13650 1 tracepoint keep y 0x0804ab57 in foo() at main.cxx:7
13652 collect globfoo, $regs
13657 2 tracepoint keep y <MULTIPLE>
13659 2.1 y 0x0804859c in func4 at change-loc.h:35
13660 installed on target
13661 2.2 y 0xb7ffc480 in func4 at change-loc.h:35
13662 installed on target
13663 2.3 y <PENDING> set_tracepoint
13664 3 tracepoint keep y 0x080485b1 in foo at change-loc.c:29
13665 not installed on target
13670 This command can be abbreviated @code{info tp}.
13673 @node Listing Static Tracepoint Markers
13674 @subsection Listing Static Tracepoint Markers
13677 @kindex info static-tracepoint-markers
13678 @cindex information about static tracepoint markers
13679 @item info static-tracepoint-markers
13680 Display information about all static tracepoint markers defined in the
13683 For each marker, the following columns are printed:
13687 An incrementing counter, output to help readability. This is not a
13690 The marker ID, as reported by the target.
13691 @item Enabled or Disabled
13692 Probed markers are tagged with @samp{y}. @samp{n} identifies marks
13693 that are not enabled.
13695 Where the marker is in your program, as a memory address.
13697 Where the marker is in the source for your program, as a file and line
13698 number. If the debug information included in the program does not
13699 allow @value{GDBN} to locate the source of the marker, this column
13700 will be left blank.
13704 In addition, the following information may be printed for each marker:
13708 User data passed to the tracing library by the marker call. In the
13709 UST backend, this is the format string passed as argument to the
13711 @item Static tracepoints probing the marker
13712 The list of static tracepoints attached to the marker.
13716 (@value{GDBP}) info static-tracepoint-markers
13717 Cnt ID Enb Address What
13718 1 ust/bar2 y 0x0000000000400e1a in main at stexample.c:25
13719 Data: number1 %d number2 %d
13720 Probed by static tracepoints: #2
13721 2 ust/bar33 n 0x0000000000400c87 in main at stexample.c:24
13727 @node Starting and Stopping Trace Experiments
13728 @subsection Starting and Stopping Trace Experiments
13731 @kindex tstart [ @var{notes} ]
13732 @cindex start a new trace experiment
13733 @cindex collected data discarded
13735 This command starts the trace experiment, and begins collecting data.
13736 It has the side effect of discarding all the data collected in the
13737 trace buffer during the previous trace experiment. If any arguments
13738 are supplied, they are taken as a note and stored with the trace
13739 experiment's state. The notes may be arbitrary text, and are
13740 especially useful with disconnected tracing in a multi-user context;
13741 the notes can explain what the trace is doing, supply user contact
13742 information, and so forth.
13744 @kindex tstop [ @var{notes} ]
13745 @cindex stop a running trace experiment
13747 This command stops the trace experiment. If any arguments are
13748 supplied, they are recorded with the experiment as a note. This is
13749 useful if you are stopping a trace started by someone else, for
13750 instance if the trace is interfering with the system's behavior and
13751 needs to be stopped quickly.
13753 @strong{Note}: a trace experiment and data collection may stop
13754 automatically if any tracepoint's passcount is reached
13755 (@pxref{Tracepoint Passcounts}), or if the trace buffer becomes full.
13758 @cindex status of trace data collection
13759 @cindex trace experiment, status of
13761 This command displays the status of the current trace data
13765 Here is an example of the commands we described so far:
13768 (@value{GDBP}) @b{trace gdb_c_test}
13769 (@value{GDBP}) @b{actions}
13770 Enter actions for tracepoint #1, one per line.
13771 > collect $regs,$locals,$args
13772 > while-stepping 11
13776 (@value{GDBP}) @b{tstart}
13777 [time passes @dots{}]
13778 (@value{GDBP}) @b{tstop}
13781 @anchor{disconnected tracing}
13782 @cindex disconnected tracing
13783 You can choose to continue running the trace experiment even if
13784 @value{GDBN} disconnects from the target, voluntarily or
13785 involuntarily. For commands such as @code{detach}, the debugger will
13786 ask what you want to do with the trace. But for unexpected
13787 terminations (@value{GDBN} crash, network outage), it would be
13788 unfortunate to lose hard-won trace data, so the variable
13789 @code{disconnected-tracing} lets you decide whether the trace should
13790 continue running without @value{GDBN}.
13793 @item set disconnected-tracing on
13794 @itemx set disconnected-tracing off
13795 @kindex set disconnected-tracing
13796 Choose whether a tracing run should continue to run if @value{GDBN}
13797 has disconnected from the target. Note that @code{detach} or
13798 @code{quit} will ask you directly what to do about a running trace no
13799 matter what this variable's setting, so the variable is mainly useful
13800 for handling unexpected situations, such as loss of the network.
13802 @item show disconnected-tracing
13803 @kindex show disconnected-tracing
13804 Show the current choice for disconnected tracing.
13808 When you reconnect to the target, the trace experiment may or may not
13809 still be running; it might have filled the trace buffer in the
13810 meantime, or stopped for one of the other reasons. If it is running,
13811 it will continue after reconnection.
13813 Upon reconnection, the target will upload information about the
13814 tracepoints in effect. @value{GDBN} will then compare that
13815 information to the set of tracepoints currently defined, and attempt
13816 to match them up, allowing for the possibility that the numbers may
13817 have changed due to creation and deletion in the meantime. If one of
13818 the target's tracepoints does not match any in @value{GDBN}, the
13819 debugger will create a new tracepoint, so that you have a number with
13820 which to specify that tracepoint. This matching-up process is
13821 necessarily heuristic, and it may result in useless tracepoints being
13822 created; you may simply delete them if they are of no use.
13824 @cindex circular trace buffer
13825 If your target agent supports a @dfn{circular trace buffer}, then you
13826 can run a trace experiment indefinitely without filling the trace
13827 buffer; when space runs out, the agent deletes already-collected trace
13828 frames, oldest first, until there is enough room to continue
13829 collecting. This is especially useful if your tracepoints are being
13830 hit too often, and your trace gets terminated prematurely because the
13831 buffer is full. To ask for a circular trace buffer, simply set
13832 @samp{circular-trace-buffer} to on. You can set this at any time,
13833 including during tracing; if the agent can do it, it will change
13834 buffer handling on the fly, otherwise it will not take effect until
13838 @item set circular-trace-buffer on
13839 @itemx set circular-trace-buffer off
13840 @kindex set circular-trace-buffer
13841 Choose whether a tracing run should use a linear or circular buffer
13842 for trace data. A linear buffer will not lose any trace data, but may
13843 fill up prematurely, while a circular buffer will discard old trace
13844 data, but it will have always room for the latest tracepoint hits.
13846 @item show circular-trace-buffer
13847 @kindex show circular-trace-buffer
13848 Show the current choice for the trace buffer. Note that this may not
13849 match the agent's current buffer handling, nor is it guaranteed to
13850 match the setting that might have been in effect during a past run,
13851 for instance if you are looking at frames from a trace file.
13856 @item set trace-buffer-size @var{n}
13857 @itemx set trace-buffer-size unlimited
13858 @kindex set trace-buffer-size
13859 Request that the target use a trace buffer of @var{n} bytes. Not all
13860 targets will honor the request; they may have a compiled-in size for
13861 the trace buffer, or some other limitation. Set to a value of
13862 @code{unlimited} or @code{-1} to let the target use whatever size it
13863 likes. This is also the default.
13865 @item show trace-buffer-size
13866 @kindex show trace-buffer-size
13867 Show the current requested size for the trace buffer. Note that this
13868 will only match the actual size if the target supports size-setting,
13869 and was able to handle the requested size. For instance, if the
13870 target can only change buffer size between runs, this variable will
13871 not reflect the change until the next run starts. Use @code{tstatus}
13872 to get a report of the actual buffer size.
13876 @item set trace-user @var{text}
13877 @kindex set trace-user
13879 @item show trace-user
13880 @kindex show trace-user
13882 @item set trace-notes @var{text}
13883 @kindex set trace-notes
13884 Set the trace run's notes.
13886 @item show trace-notes
13887 @kindex show trace-notes
13888 Show the trace run's notes.
13890 @item set trace-stop-notes @var{text}
13891 @kindex set trace-stop-notes
13892 Set the trace run's stop notes. The handling of the note is as for
13893 @code{tstop} arguments; the set command is convenient way to fix a
13894 stop note that is mistaken or incomplete.
13896 @item show trace-stop-notes
13897 @kindex show trace-stop-notes
13898 Show the trace run's stop notes.
13902 @node Tracepoint Restrictions
13903 @subsection Tracepoint Restrictions
13905 @cindex tracepoint restrictions
13906 There are a number of restrictions on the use of tracepoints. As
13907 described above, tracepoint data gathering occurs on the target
13908 without interaction from @value{GDBN}. Thus the full capabilities of
13909 the debugger are not available during data gathering, and then at data
13910 examination time, you will be limited by only having what was
13911 collected. The following items describe some common problems, but it
13912 is not exhaustive, and you may run into additional difficulties not
13918 Tracepoint expressions are intended to gather objects (lvalues). Thus
13919 the full flexibility of GDB's expression evaluator is not available.
13920 You cannot call functions, cast objects to aggregate types, access
13921 convenience variables or modify values (except by assignment to trace
13922 state variables). Some language features may implicitly call
13923 functions (for instance Objective-C fields with accessors), and therefore
13924 cannot be collected either.
13927 Collection of local variables, either individually or in bulk with
13928 @code{$locals} or @code{$args}, during @code{while-stepping} may
13929 behave erratically. The stepping action may enter a new scope (for
13930 instance by stepping into a function), or the location of the variable
13931 may change (for instance it is loaded into a register). The
13932 tracepoint data recorded uses the location information for the
13933 variables that is correct for the tracepoint location. When the
13934 tracepoint is created, it is not possible, in general, to determine
13935 where the steps of a @code{while-stepping} sequence will advance the
13936 program---particularly if a conditional branch is stepped.
13939 Collection of an incompletely-initialized or partially-destroyed object
13940 may result in something that @value{GDBN} cannot display, or displays
13941 in a misleading way.
13944 When @value{GDBN} displays a pointer to character it automatically
13945 dereferences the pointer to also display characters of the string
13946 being pointed to. However, collecting the pointer during tracing does
13947 not automatically collect the string. You need to explicitly
13948 dereference the pointer and provide size information if you want to
13949 collect not only the pointer, but the memory pointed to. For example,
13950 @code{*ptr@@50} can be used to collect the 50 element array pointed to
13954 It is not possible to collect a complete stack backtrace at a
13955 tracepoint. Instead, you may collect the registers and a few hundred
13956 bytes from the stack pointer with something like @code{*(unsigned char *)$esp@@300}
13957 (adjust to use the name of the actual stack pointer register on your
13958 target architecture, and the amount of stack you wish to capture).
13959 Then the @code{backtrace} command will show a partial backtrace when
13960 using a trace frame. The number of stack frames that can be examined
13961 depends on the sizes of the frames in the collected stack. Note that
13962 if you ask for a block so large that it goes past the bottom of the
13963 stack, the target agent may report an error trying to read from an
13967 If you do not collect registers at a tracepoint, @value{GDBN} can
13968 infer that the value of @code{$pc} must be the same as the address of
13969 the tracepoint and use that when you are looking at a trace frame
13970 for that tracepoint. However, this cannot work if the tracepoint has
13971 multiple locations (for instance if it was set in a function that was
13972 inlined), or if it has a @code{while-stepping} loop. In those cases
13973 @value{GDBN} will warn you that it can't infer @code{$pc}, and default
13978 @node Analyze Collected Data
13979 @section Using the Collected Data
13981 After the tracepoint experiment ends, you use @value{GDBN} commands
13982 for examining the trace data. The basic idea is that each tracepoint
13983 collects a trace @dfn{snapshot} every time it is hit and another
13984 snapshot every time it single-steps. All these snapshots are
13985 consecutively numbered from zero and go into a buffer, and you can
13986 examine them later. The way you examine them is to @dfn{focus} on a
13987 specific trace snapshot. When the remote stub is focused on a trace
13988 snapshot, it will respond to all @value{GDBN} requests for memory and
13989 registers by reading from the buffer which belongs to that snapshot,
13990 rather than from @emph{real} memory or registers of the program being
13991 debugged. This means that @strong{all} @value{GDBN} commands
13992 (@code{print}, @code{info registers}, @code{backtrace}, etc.) will
13993 behave as if we were currently debugging the program state as it was
13994 when the tracepoint occurred. Any requests for data that are not in
13995 the buffer will fail.
13998 * tfind:: How to select a trace snapshot
13999 * tdump:: How to display all data for a snapshot
14000 * save tracepoints:: How to save tracepoints for a future run
14004 @subsection @code{tfind @var{n}}
14007 @cindex select trace snapshot
14008 @cindex find trace snapshot
14009 The basic command for selecting a trace snapshot from the buffer is
14010 @code{tfind @var{n}}, which finds trace snapshot number @var{n},
14011 counting from zero. If no argument @var{n} is given, the next
14012 snapshot is selected.
14014 Here are the various forms of using the @code{tfind} command.
14018 Find the first snapshot in the buffer. This is a synonym for
14019 @code{tfind 0} (since 0 is the number of the first snapshot).
14022 Stop debugging trace snapshots, resume @emph{live} debugging.
14025 Same as @samp{tfind none}.
14028 No argument means find the next trace snapshot or find the first
14029 one if no trace snapshot is selected.
14032 Find the previous trace snapshot before the current one. This permits
14033 retracing earlier steps.
14035 @item tfind tracepoint @var{num}
14036 Find the next snapshot associated with tracepoint @var{num}. Search
14037 proceeds forward from the last examined trace snapshot. If no
14038 argument @var{num} is given, it means find the next snapshot collected
14039 for the same tracepoint as the current snapshot.
14041 @item tfind pc @var{addr}
14042 Find the next snapshot associated with the value @var{addr} of the
14043 program counter. Search proceeds forward from the last examined trace
14044 snapshot. If no argument @var{addr} is given, it means find the next
14045 snapshot with the same value of PC as the current snapshot.
14047 @item tfind outside @var{addr1}, @var{addr2}
14048 Find the next snapshot whose PC is outside the given range of
14049 addresses (exclusive).
14051 @item tfind range @var{addr1}, @var{addr2}
14052 Find the next snapshot whose PC is between @var{addr1} and
14053 @var{addr2} (inclusive).
14055 @item tfind line @r{[}@var{file}:@r{]}@var{n}
14056 Find the next snapshot associated with the source line @var{n}. If
14057 the optional argument @var{file} is given, refer to line @var{n} in
14058 that source file. Search proceeds forward from the last examined
14059 trace snapshot. If no argument @var{n} is given, it means find the
14060 next line other than the one currently being examined; thus saying
14061 @code{tfind line} repeatedly can appear to have the same effect as
14062 stepping from line to line in a @emph{live} debugging session.
14065 The default arguments for the @code{tfind} commands are specifically
14066 designed to make it easy to scan through the trace buffer. For
14067 instance, @code{tfind} with no argument selects the next trace
14068 snapshot, and @code{tfind -} with no argument selects the previous
14069 trace snapshot. So, by giving one @code{tfind} command, and then
14070 simply hitting @key{RET} repeatedly you can examine all the trace
14071 snapshots in order. Or, by saying @code{tfind -} and then hitting
14072 @key{RET} repeatedly you can examine the snapshots in reverse order.
14073 The @code{tfind line} command with no argument selects the snapshot
14074 for the next source line executed. The @code{tfind pc} command with
14075 no argument selects the next snapshot with the same program counter
14076 (PC) as the current frame. The @code{tfind tracepoint} command with
14077 no argument selects the next trace snapshot collected by the same
14078 tracepoint as the current one.
14080 In addition to letting you scan through the trace buffer manually,
14081 these commands make it easy to construct @value{GDBN} scripts that
14082 scan through the trace buffer and print out whatever collected data
14083 you are interested in. Thus, if we want to examine the PC, FP, and SP
14084 registers from each trace frame in the buffer, we can say this:
14087 (@value{GDBP}) @b{tfind start}
14088 (@value{GDBP}) @b{while ($trace_frame != -1)}
14089 > printf "Frame %d, PC = %08X, SP = %08X, FP = %08X\n", \
14090 $trace_frame, $pc, $sp, $fp
14094 Frame 0, PC = 0020DC64, SP = 0030BF3C, FP = 0030BF44
14095 Frame 1, PC = 0020DC6C, SP = 0030BF38, FP = 0030BF44
14096 Frame 2, PC = 0020DC70, SP = 0030BF34, FP = 0030BF44
14097 Frame 3, PC = 0020DC74, SP = 0030BF30, FP = 0030BF44
14098 Frame 4, PC = 0020DC78, SP = 0030BF2C, FP = 0030BF44
14099 Frame 5, PC = 0020DC7C, SP = 0030BF28, FP = 0030BF44
14100 Frame 6, PC = 0020DC80, SP = 0030BF24, FP = 0030BF44
14101 Frame 7, PC = 0020DC84, SP = 0030BF20, FP = 0030BF44
14102 Frame 8, PC = 0020DC88, SP = 0030BF1C, FP = 0030BF44
14103 Frame 9, PC = 0020DC8E, SP = 0030BF18, FP = 0030BF44
14104 Frame 10, PC = 00203F6C, SP = 0030BE3C, FP = 0030BF14
14107 Or, if we want to examine the variable @code{X} at each source line in
14111 (@value{GDBP}) @b{tfind start}
14112 (@value{GDBP}) @b{while ($trace_frame != -1)}
14113 > printf "Frame %d, X == %d\n", $trace_frame, X
14123 @subsection @code{tdump}
14125 @cindex dump all data collected at tracepoint
14126 @cindex tracepoint data, display
14128 This command takes no arguments. It prints all the data collected at
14129 the current trace snapshot.
14132 (@value{GDBP}) @b{trace 444}
14133 (@value{GDBP}) @b{actions}
14134 Enter actions for tracepoint #2, one per line:
14135 > collect $regs, $locals, $args, gdb_long_test
14138 (@value{GDBP}) @b{tstart}
14140 (@value{GDBP}) @b{tfind line 444}
14141 #0 gdb_test (p1=0x11, p2=0x22, p3=0x33, p4=0x44, p5=0x55, p6=0x66)
14143 444 printp( "%s: arguments = 0x%X 0x%X 0x%X 0x%X 0x%X 0x%X\n", )
14145 (@value{GDBP}) @b{tdump}
14146 Data collected at tracepoint 2, trace frame 1:
14147 d0 0xc4aa0085 -995491707
14151 d4 0x71aea3d 119204413
14154 d7 0x380035 3670069
14155 a0 0x19e24a 1696330
14156 a1 0x3000668 50333288
14158 a3 0x322000 3284992
14159 a4 0x3000698 50333336
14160 a5 0x1ad3cc 1758156
14161 fp 0x30bf3c 0x30bf3c
14162 sp 0x30bf34 0x30bf34
14164 pc 0x20b2c8 0x20b2c8
14168 p = 0x20e5b4 "gdb-test"
14175 gdb_long_test = 17 '\021'
14180 @code{tdump} works by scanning the tracepoint's current collection
14181 actions and printing the value of each expression listed. So
14182 @code{tdump} can fail, if after a run, you change the tracepoint's
14183 actions to mention variables that were not collected during the run.
14185 Also, for tracepoints with @code{while-stepping} loops, @code{tdump}
14186 uses the collected value of @code{$pc} to distinguish between trace
14187 frames that were collected at the tracepoint hit, and frames that were
14188 collected while stepping. This allows it to correctly choose whether
14189 to display the basic list of collections, or the collections from the
14190 body of the while-stepping loop. However, if @code{$pc} was not collected,
14191 then @code{tdump} will always attempt to dump using the basic collection
14192 list, and may fail if a while-stepping frame does not include all the
14193 same data that is collected at the tracepoint hit.
14194 @c This is getting pretty arcane, example would be good.
14196 @node save tracepoints
14197 @subsection @code{save tracepoints @var{filename}}
14198 @kindex save tracepoints
14199 @kindex save-tracepoints
14200 @cindex save tracepoints for future sessions
14202 This command saves all current tracepoint definitions together with
14203 their actions and passcounts, into a file @file{@var{filename}}
14204 suitable for use in a later debugging session. To read the saved
14205 tracepoint definitions, use the @code{source} command (@pxref{Command
14206 Files}). The @w{@code{save-tracepoints}} command is a deprecated
14207 alias for @w{@code{save tracepoints}}
14209 @node Tracepoint Variables
14210 @section Convenience Variables for Tracepoints
14211 @cindex tracepoint variables
14212 @cindex convenience variables for tracepoints
14215 @vindex $trace_frame
14216 @item (int) $trace_frame
14217 The current trace snapshot (a.k.a.@: @dfn{frame}) number, or -1 if no
14218 snapshot is selected.
14220 @vindex $tracepoint
14221 @item (int) $tracepoint
14222 The tracepoint for the current trace snapshot.
14224 @vindex $trace_line
14225 @item (int) $trace_line
14226 The line number for the current trace snapshot.
14228 @vindex $trace_file
14229 @item (char []) $trace_file
14230 The source file for the current trace snapshot.
14232 @vindex $trace_func
14233 @item (char []) $trace_func
14234 The name of the function containing @code{$tracepoint}.
14237 Note: @code{$trace_file} is not suitable for use in @code{printf},
14238 use @code{output} instead.
14240 Here's a simple example of using these convenience variables for
14241 stepping through all the trace snapshots and printing some of their
14242 data. Note that these are not the same as trace state variables,
14243 which are managed by the target.
14246 (@value{GDBP}) @b{tfind start}
14248 (@value{GDBP}) @b{while $trace_frame != -1}
14249 > output $trace_file
14250 > printf ", line %d (tracepoint #%d)\n", $trace_line, $tracepoint
14256 @section Using Trace Files
14257 @cindex trace files
14259 In some situations, the target running a trace experiment may no
14260 longer be available; perhaps it crashed, or the hardware was needed
14261 for a different activity. To handle these cases, you can arrange to
14262 dump the trace data into a file, and later use that file as a source
14263 of trace data, via the @code{target tfile} command.
14268 @item tsave [ -r ] @var{filename}
14269 @itemx tsave [-ctf] @var{dirname}
14270 Save the trace data to @var{filename}. By default, this command
14271 assumes that @var{filename} refers to the host filesystem, so if
14272 necessary @value{GDBN} will copy raw trace data up from the target and
14273 then save it. If the target supports it, you can also supply the
14274 optional argument @code{-r} (``remote'') to direct the target to save
14275 the data directly into @var{filename} in its own filesystem, which may be
14276 more efficient if the trace buffer is very large. (Note, however, that
14277 @code{target tfile} can only read from files accessible to the host.)
14278 By default, this command will save trace frame in tfile format.
14279 You can supply the optional argument @code{-ctf} to save data in CTF
14280 format. The @dfn{Common Trace Format} (CTF) is proposed as a trace format
14281 that can be shared by multiple debugging and tracing tools. Please go to
14282 @indicateurl{http://www.efficios.com/ctf} to get more information.
14284 @kindex target tfile
14288 @item target tfile @var{filename}
14289 @itemx target ctf @var{dirname}
14290 Use the file named @var{filename} or directory named @var{dirname} as
14291 a source of trace data. Commands that examine data work as they do with
14292 a live target, but it is not possible to run any new trace experiments.
14293 @code{tstatus} will report the state of the trace run at the moment
14294 the data was saved, as well as the current trace frame you are examining.
14295 Both @var{filename} and @var{dirname} must be on a filesystem accessible to
14299 (@value{GDBP}) target ctf ctf.ctf
14300 (@value{GDBP}) tfind
14301 Found trace frame 0, tracepoint 2
14302 39 ++a; /* set tracepoint 1 here */
14303 (@value{GDBP}) tdump
14304 Data collected at tracepoint 2, trace frame 0:
14308 c = @{"123", "456", "789", "123", "456", "789"@}
14309 d = @{@{@{a = 1, b = 2@}, @{a = 3, b = 4@}@}, @{@{a = 5, b = 6@}, @{a = 7, b = 8@}@}@}
14317 @chapter Debugging Programs That Use Overlays
14320 If your program is too large to fit completely in your target system's
14321 memory, you can sometimes use @dfn{overlays} to work around this
14322 problem. @value{GDBN} provides some support for debugging programs that
14326 * How Overlays Work:: A general explanation of overlays.
14327 * Overlay Commands:: Managing overlays in @value{GDBN}.
14328 * Automatic Overlay Debugging:: @value{GDBN} can find out which overlays are
14329 mapped by asking the inferior.
14330 * Overlay Sample Program:: A sample program using overlays.
14333 @node How Overlays Work
14334 @section How Overlays Work
14335 @cindex mapped overlays
14336 @cindex unmapped overlays
14337 @cindex load address, overlay's
14338 @cindex mapped address
14339 @cindex overlay area
14341 Suppose you have a computer whose instruction address space is only 64
14342 kilobytes long, but which has much more memory which can be accessed by
14343 other means: special instructions, segment registers, or memory
14344 management hardware, for example. Suppose further that you want to
14345 adapt a program which is larger than 64 kilobytes to run on this system.
14347 One solution is to identify modules of your program which are relatively
14348 independent, and need not call each other directly; call these modules
14349 @dfn{overlays}. Separate the overlays from the main program, and place
14350 their machine code in the larger memory. Place your main program in
14351 instruction memory, but leave at least enough space there to hold the
14352 largest overlay as well.
14354 Now, to call a function located in an overlay, you must first copy that
14355 overlay's machine code from the large memory into the space set aside
14356 for it in the instruction memory, and then jump to its entry point
14359 @c NB: In the below the mapped area's size is greater or equal to the
14360 @c size of all overlays. This is intentional to remind the developer
14361 @c that overlays don't necessarily need to be the same size.
14365 Data Instruction Larger
14366 Address Space Address Space Address Space
14367 +-----------+ +-----------+ +-----------+
14369 +-----------+ +-----------+ +-----------+<-- overlay 1
14370 | program | | main | .----| overlay 1 | load address
14371 | variables | | program | | +-----------+
14372 | and heap | | | | | |
14373 +-----------+ | | | +-----------+<-- overlay 2
14374 | | +-----------+ | | | load address
14375 +-----------+ | | | .-| overlay 2 |
14377 mapped --->+-----------+ | | +-----------+
14378 address | | | | | |
14379 | overlay | <-' | | |
14380 | area | <---' +-----------+<-- overlay 3
14381 | | <---. | | load address
14382 +-----------+ `--| overlay 3 |
14389 @anchor{A code overlay}A code overlay
14393 The diagram (@pxref{A code overlay}) shows a system with separate data
14394 and instruction address spaces. To map an overlay, the program copies
14395 its code from the larger address space to the instruction address space.
14396 Since the overlays shown here all use the same mapped address, only one
14397 may be mapped at a time. For a system with a single address space for
14398 data and instructions, the diagram would be similar, except that the
14399 program variables and heap would share an address space with the main
14400 program and the overlay area.
14402 An overlay loaded into instruction memory and ready for use is called a
14403 @dfn{mapped} overlay; its @dfn{mapped address} is its address in the
14404 instruction memory. An overlay not present (or only partially present)
14405 in instruction memory is called @dfn{unmapped}; its @dfn{load address}
14406 is its address in the larger memory. The mapped address is also called
14407 the @dfn{virtual memory address}, or @dfn{VMA}; the load address is also
14408 called the @dfn{load memory address}, or @dfn{LMA}.
14410 Unfortunately, overlays are not a completely transparent way to adapt a
14411 program to limited instruction memory. They introduce a new set of
14412 global constraints you must keep in mind as you design your program:
14417 Before calling or returning to a function in an overlay, your program
14418 must make sure that overlay is actually mapped. Otherwise, the call or
14419 return will transfer control to the right address, but in the wrong
14420 overlay, and your program will probably crash.
14423 If the process of mapping an overlay is expensive on your system, you
14424 will need to choose your overlays carefully to minimize their effect on
14425 your program's performance.
14428 The executable file you load onto your system must contain each
14429 overlay's instructions, appearing at the overlay's load address, not its
14430 mapped address. However, each overlay's instructions must be relocated
14431 and its symbols defined as if the overlay were at its mapped address.
14432 You can use GNU linker scripts to specify different load and relocation
14433 addresses for pieces of your program; see @ref{Overlay Description,,,
14434 ld.info, Using ld: the GNU linker}.
14437 The procedure for loading executable files onto your system must be able
14438 to load their contents into the larger address space as well as the
14439 instruction and data spaces.
14443 The overlay system described above is rather simple, and could be
14444 improved in many ways:
14449 If your system has suitable bank switch registers or memory management
14450 hardware, you could use those facilities to make an overlay's load area
14451 contents simply appear at their mapped address in instruction space.
14452 This would probably be faster than copying the overlay to its mapped
14453 area in the usual way.
14456 If your overlays are small enough, you could set aside more than one
14457 overlay area, and have more than one overlay mapped at a time.
14460 You can use overlays to manage data, as well as instructions. In
14461 general, data overlays are even less transparent to your design than
14462 code overlays: whereas code overlays only require care when you call or
14463 return to functions, data overlays require care every time you access
14464 the data. Also, if you change the contents of a data overlay, you
14465 must copy its contents back out to its load address before you can copy a
14466 different data overlay into the same mapped area.
14471 @node Overlay Commands
14472 @section Overlay Commands
14474 To use @value{GDBN}'s overlay support, each overlay in your program must
14475 correspond to a separate section of the executable file. The section's
14476 virtual memory address and load memory address must be the overlay's
14477 mapped and load addresses. Identifying overlays with sections allows
14478 @value{GDBN} to determine the appropriate address of a function or
14479 variable, depending on whether the overlay is mapped or not.
14481 @value{GDBN}'s overlay commands all start with the word @code{overlay};
14482 you can abbreviate this as @code{ov} or @code{ovly}. The commands are:
14487 Disable @value{GDBN}'s overlay support. When overlay support is
14488 disabled, @value{GDBN} assumes that all functions and variables are
14489 always present at their mapped addresses. By default, @value{GDBN}'s
14490 overlay support is disabled.
14492 @item overlay manual
14493 @cindex manual overlay debugging
14494 Enable @dfn{manual} overlay debugging. In this mode, @value{GDBN}
14495 relies on you to tell it which overlays are mapped, and which are not,
14496 using the @code{overlay map-overlay} and @code{overlay unmap-overlay}
14497 commands described below.
14499 @item overlay map-overlay @var{overlay}
14500 @itemx overlay map @var{overlay}
14501 @cindex map an overlay
14502 Tell @value{GDBN} that @var{overlay} is now mapped; @var{overlay} must
14503 be the name of the object file section containing the overlay. When an
14504 overlay is mapped, @value{GDBN} assumes it can find the overlay's
14505 functions and variables at their mapped addresses. @value{GDBN} assumes
14506 that any other overlays whose mapped ranges overlap that of
14507 @var{overlay} are now unmapped.
14509 @item overlay unmap-overlay @var{overlay}
14510 @itemx overlay unmap @var{overlay}
14511 @cindex unmap an overlay
14512 Tell @value{GDBN} that @var{overlay} is no longer mapped; @var{overlay}
14513 must be the name of the object file section containing the overlay.
14514 When an overlay is unmapped, @value{GDBN} assumes it can find the
14515 overlay's functions and variables at their load addresses.
14518 Enable @dfn{automatic} overlay debugging. In this mode, @value{GDBN}
14519 consults a data structure the overlay manager maintains in the inferior
14520 to see which overlays are mapped. For details, see @ref{Automatic
14521 Overlay Debugging}.
14523 @item overlay load-target
14524 @itemx overlay load
14525 @cindex reloading the overlay table
14526 Re-read the overlay table from the inferior. Normally, @value{GDBN}
14527 re-reads the table @value{GDBN} automatically each time the inferior
14528 stops, so this command should only be necessary if you have changed the
14529 overlay mapping yourself using @value{GDBN}. This command is only
14530 useful when using automatic overlay debugging.
14532 @item overlay list-overlays
14533 @itemx overlay list
14534 @cindex listing mapped overlays
14535 Display a list of the overlays currently mapped, along with their mapped
14536 addresses, load addresses, and sizes.
14540 Normally, when @value{GDBN} prints a code address, it includes the name
14541 of the function the address falls in:
14544 (@value{GDBP}) print main
14545 $3 = @{int ()@} 0x11a0 <main>
14548 When overlay debugging is enabled, @value{GDBN} recognizes code in
14549 unmapped overlays, and prints the names of unmapped functions with
14550 asterisks around them. For example, if @code{foo} is a function in an
14551 unmapped overlay, @value{GDBN} prints it this way:
14554 (@value{GDBP}) overlay list
14555 No sections are mapped.
14556 (@value{GDBP}) print foo
14557 $5 = @{int (int)@} 0x100000 <*foo*>
14560 When @code{foo}'s overlay is mapped, @value{GDBN} prints the function's
14564 (@value{GDBP}) overlay list
14565 Section .ov.foo.text, loaded at 0x100000 - 0x100034,
14566 mapped at 0x1016 - 0x104a
14567 (@value{GDBP}) print foo
14568 $6 = @{int (int)@} 0x1016 <foo>
14571 When overlay debugging is enabled, @value{GDBN} can find the correct
14572 address for functions and variables in an overlay, whether or not the
14573 overlay is mapped. This allows most @value{GDBN} commands, like
14574 @code{break} and @code{disassemble}, to work normally, even on unmapped
14575 code. However, @value{GDBN}'s breakpoint support has some limitations:
14579 @cindex breakpoints in overlays
14580 @cindex overlays, setting breakpoints in
14581 You can set breakpoints in functions in unmapped overlays, as long as
14582 @value{GDBN} can write to the overlay at its load address.
14584 @value{GDBN} can not set hardware or simulator-based breakpoints in
14585 unmapped overlays. However, if you set a breakpoint at the end of your
14586 overlay manager (and tell @value{GDBN} which overlays are now mapped, if
14587 you are using manual overlay management), @value{GDBN} will re-set its
14588 breakpoints properly.
14592 @node Automatic Overlay Debugging
14593 @section Automatic Overlay Debugging
14594 @cindex automatic overlay debugging
14596 @value{GDBN} can automatically track which overlays are mapped and which
14597 are not, given some simple co-operation from the overlay manager in the
14598 inferior. If you enable automatic overlay debugging with the
14599 @code{overlay auto} command (@pxref{Overlay Commands}), @value{GDBN}
14600 looks in the inferior's memory for certain variables describing the
14601 current state of the overlays.
14603 Here are the variables your overlay manager must define to support
14604 @value{GDBN}'s automatic overlay debugging:
14608 @item @code{_ovly_table}:
14609 This variable must be an array of the following structures:
14614 /* The overlay's mapped address. */
14617 /* The size of the overlay, in bytes. */
14618 unsigned long size;
14620 /* The overlay's load address. */
14623 /* Non-zero if the overlay is currently mapped;
14625 unsigned long mapped;
14629 @item @code{_novlys}:
14630 This variable must be a four-byte signed integer, holding the total
14631 number of elements in @code{_ovly_table}.
14635 To decide whether a particular overlay is mapped or not, @value{GDBN}
14636 looks for an entry in @w{@code{_ovly_table}} whose @code{vma} and
14637 @code{lma} members equal the VMA and LMA of the overlay's section in the
14638 executable file. When @value{GDBN} finds a matching entry, it consults
14639 the entry's @code{mapped} member to determine whether the overlay is
14642 In addition, your overlay manager may define a function called
14643 @code{_ovly_debug_event}. If this function is defined, @value{GDBN}
14644 will silently set a breakpoint there. If the overlay manager then
14645 calls this function whenever it has changed the overlay table, this
14646 will enable @value{GDBN} to accurately keep track of which overlays
14647 are in program memory, and update any breakpoints that may be set
14648 in overlays. This will allow breakpoints to work even if the
14649 overlays are kept in ROM or other non-writable memory while they
14650 are not being executed.
14652 @node Overlay Sample Program
14653 @section Overlay Sample Program
14654 @cindex overlay example program
14656 When linking a program which uses overlays, you must place the overlays
14657 at their load addresses, while relocating them to run at their mapped
14658 addresses. To do this, you must write a linker script (@pxref{Overlay
14659 Description,,, ld.info, Using ld: the GNU linker}). Unfortunately,
14660 since linker scripts are specific to a particular host system, target
14661 architecture, and target memory layout, this manual cannot provide
14662 portable sample code demonstrating @value{GDBN}'s overlay support.
14664 However, the @value{GDBN} source distribution does contain an overlaid
14665 program, with linker scripts for a few systems, as part of its test
14666 suite. The program consists of the following files from
14667 @file{gdb/testsuite/gdb.base}:
14671 The main program file.
14673 A simple overlay manager, used by @file{overlays.c}.
14678 Overlay modules, loaded and used by @file{overlays.c}.
14681 Linker scripts for linking the test program on the @code{d10v-elf}
14682 and @code{m32r-elf} targets.
14685 You can build the test program using the @code{d10v-elf} GCC
14686 cross-compiler like this:
14689 $ d10v-elf-gcc -g -c overlays.c
14690 $ d10v-elf-gcc -g -c ovlymgr.c
14691 $ d10v-elf-gcc -g -c foo.c
14692 $ d10v-elf-gcc -g -c bar.c
14693 $ d10v-elf-gcc -g -c baz.c
14694 $ d10v-elf-gcc -g -c grbx.c
14695 $ d10v-elf-gcc -g overlays.o ovlymgr.o foo.o bar.o \
14696 baz.o grbx.o -Wl,-Td10v.ld -o overlays
14699 The build process is identical for any other architecture, except that
14700 you must substitute the appropriate compiler and linker script for the
14701 target system for @code{d10v-elf-gcc} and @code{d10v.ld}.
14705 @chapter Using @value{GDBN} with Different Languages
14708 Although programming languages generally have common aspects, they are
14709 rarely expressed in the same manner. For instance, in ANSI C,
14710 dereferencing a pointer @code{p} is accomplished by @code{*p}, but in
14711 Modula-2, it is accomplished by @code{p^}. Values can also be
14712 represented (and displayed) differently. Hex numbers in C appear as
14713 @samp{0x1ae}, while in Modula-2 they appear as @samp{1AEH}.
14715 @cindex working language
14716 Language-specific information is built into @value{GDBN} for some languages,
14717 allowing you to express operations like the above in your program's
14718 native language, and allowing @value{GDBN} to output values in a manner
14719 consistent with the syntax of your program's native language. The
14720 language you use to build expressions is called the @dfn{working
14724 * Setting:: Switching between source languages
14725 * Show:: Displaying the language
14726 * Checks:: Type and range checks
14727 * Supported Languages:: Supported languages
14728 * Unsupported Languages:: Unsupported languages
14732 @section Switching Between Source Languages
14734 There are two ways to control the working language---either have @value{GDBN}
14735 set it automatically, or select it manually yourself. You can use the
14736 @code{set language} command for either purpose. On startup, @value{GDBN}
14737 defaults to setting the language automatically. The working language is
14738 used to determine how expressions you type are interpreted, how values
14741 In addition to the working language, every source file that
14742 @value{GDBN} knows about has its own working language. For some object
14743 file formats, the compiler might indicate which language a particular
14744 source file is in. However, most of the time @value{GDBN} infers the
14745 language from the name of the file. The language of a source file
14746 controls whether C@t{++} names are demangled---this way @code{backtrace} can
14747 show each frame appropriately for its own language. There is no way to
14748 set the language of a source file from within @value{GDBN}, but you can
14749 set the language associated with a filename extension. @xref{Show, ,
14750 Displaying the Language}.
14752 This is most commonly a problem when you use a program, such
14753 as @code{cfront} or @code{f2c}, that generates C but is written in
14754 another language. In that case, make the
14755 program use @code{#line} directives in its C output; that way
14756 @value{GDBN} will know the correct language of the source code of the original
14757 program, and will display that source code, not the generated C code.
14760 * Filenames:: Filename extensions and languages.
14761 * Manually:: Setting the working language manually
14762 * Automatically:: Having @value{GDBN} infer the source language
14766 @subsection List of Filename Extensions and Languages
14768 If a source file name ends in one of the following extensions, then
14769 @value{GDBN} infers that its language is the one indicated.
14787 C@t{++} source file
14793 Objective-C source file
14797 Fortran source file
14800 Modula-2 source file
14804 Assembler source file. This actually behaves almost like C, but
14805 @value{GDBN} does not skip over function prologues when stepping.
14808 In addition, you may set the language associated with a filename
14809 extension. @xref{Show, , Displaying the Language}.
14812 @subsection Setting the Working Language
14814 If you allow @value{GDBN} to set the language automatically,
14815 expressions are interpreted the same way in your debugging session and
14818 @kindex set language
14819 If you wish, you may set the language manually. To do this, issue the
14820 command @samp{set language @var{lang}}, where @var{lang} is the name of
14821 a language, such as
14822 @code{c} or @code{modula-2}.
14823 For a list of the supported languages, type @samp{set language}.
14825 Setting the language manually prevents @value{GDBN} from updating the working
14826 language automatically. This can lead to confusion if you try
14827 to debug a program when the working language is not the same as the
14828 source language, when an expression is acceptable to both
14829 languages---but means different things. For instance, if the current
14830 source file were written in C, and @value{GDBN} was parsing Modula-2, a
14838 might not have the effect you intended. In C, this means to add
14839 @code{b} and @code{c} and place the result in @code{a}. The result
14840 printed would be the value of @code{a}. In Modula-2, this means to compare
14841 @code{a} to the result of @code{b+c}, yielding a @code{BOOLEAN} value.
14843 @node Automatically
14844 @subsection Having @value{GDBN} Infer the Source Language
14846 To have @value{GDBN} set the working language automatically, use
14847 @samp{set language local} or @samp{set language auto}. @value{GDBN}
14848 then infers the working language. That is, when your program stops in a
14849 frame (usually by encountering a breakpoint), @value{GDBN} sets the
14850 working language to the language recorded for the function in that
14851 frame. If the language for a frame is unknown (that is, if the function
14852 or block corresponding to the frame was defined in a source file that
14853 does not have a recognized extension), the current working language is
14854 not changed, and @value{GDBN} issues a warning.
14856 This may not seem necessary for most programs, which are written
14857 entirely in one source language. However, program modules and libraries
14858 written in one source language can be used by a main program written in
14859 a different source language. Using @samp{set language auto} in this
14860 case frees you from having to set the working language manually.
14863 @section Displaying the Language
14865 The following commands help you find out which language is the
14866 working language, and also what language source files were written in.
14869 @item show language
14870 @anchor{show language}
14871 @kindex show language
14872 Display the current working language. This is the
14873 language you can use with commands such as @code{print} to
14874 build and compute expressions that may involve variables in your program.
14877 @kindex info frame@r{, show the source language}
14878 Display the source language for this frame. This language becomes the
14879 working language if you use an identifier from this frame.
14880 @xref{Frame Info, ,Information about a Frame}, to identify the other
14881 information listed here.
14884 @kindex info source@r{, show the source language}
14885 Display the source language of this source file.
14886 @xref{Symbols, ,Examining the Symbol Table}, to identify the other
14887 information listed here.
14890 In unusual circumstances, you may have source files with extensions
14891 not in the standard list. You can then set the extension associated
14892 with a language explicitly:
14895 @item set extension-language @var{ext} @var{language}
14896 @kindex set extension-language
14897 Tell @value{GDBN} that source files with extension @var{ext} are to be
14898 assumed as written in the source language @var{language}.
14900 @item info extensions
14901 @kindex info extensions
14902 List all the filename extensions and the associated languages.
14906 @section Type and Range Checking
14908 Some languages are designed to guard you against making seemingly common
14909 errors through a series of compile- and run-time checks. These include
14910 checking the type of arguments to functions and operators and making
14911 sure mathematical overflows are caught at run time. Checks such as
14912 these help to ensure a program's correctness once it has been compiled
14913 by eliminating type mismatches and providing active checks for range
14914 errors when your program is running.
14916 By default @value{GDBN} checks for these errors according to the
14917 rules of the current source language. Although @value{GDBN} does not check
14918 the statements in your program, it can check expressions entered directly
14919 into @value{GDBN} for evaluation via the @code{print} command, for example.
14922 * Type Checking:: An overview of type checking
14923 * Range Checking:: An overview of range checking
14926 @cindex type checking
14927 @cindex checks, type
14928 @node Type Checking
14929 @subsection An Overview of Type Checking
14931 Some languages, such as C and C@t{++}, are strongly typed, meaning that the
14932 arguments to operators and functions have to be of the correct type,
14933 otherwise an error occurs. These checks prevent type mismatch
14934 errors from ever causing any run-time problems. For example,
14937 int klass::my_method(char *b) @{ return b ? 1 : 2; @}
14939 (@value{GDBP}) print obj.my_method (0)
14942 (@value{GDBP}) print obj.my_method (0x1234)
14943 Cannot resolve method klass::my_method to any overloaded instance
14946 The second example fails because in C@t{++} the integer constant
14947 @samp{0x1234} is not type-compatible with the pointer parameter type.
14949 For the expressions you use in @value{GDBN} commands, you can tell
14950 @value{GDBN} to not enforce strict type checking or
14951 to treat any mismatches as errors and abandon the expression;
14952 When type checking is disabled, @value{GDBN} successfully evaluates
14953 expressions like the second example above.
14955 Even if type checking is off, there may be other reasons
14956 related to type that prevent @value{GDBN} from evaluating an expression.
14957 For instance, @value{GDBN} does not know how to add an @code{int} and
14958 a @code{struct foo}. These particular type errors have nothing to do
14959 with the language in use and usually arise from expressions which make
14960 little sense to evaluate anyway.
14962 @value{GDBN} provides some additional commands for controlling type checking:
14964 @kindex set check type
14965 @kindex show check type
14967 @item set check type on
14968 @itemx set check type off
14969 Set strict type checking on or off. If any type mismatches occur in
14970 evaluating an expression while type checking is on, @value{GDBN} prints a
14971 message and aborts evaluation of the expression.
14973 @item show check type
14974 Show the current setting of type checking and whether @value{GDBN}
14975 is enforcing strict type checking rules.
14978 @cindex range checking
14979 @cindex checks, range
14980 @node Range Checking
14981 @subsection An Overview of Range Checking
14983 In some languages (such as Modula-2), it is an error to exceed the
14984 bounds of a type; this is enforced with run-time checks. Such range
14985 checking is meant to ensure program correctness by making sure
14986 computations do not overflow, or indices on an array element access do
14987 not exceed the bounds of the array.
14989 For expressions you use in @value{GDBN} commands, you can tell
14990 @value{GDBN} to treat range errors in one of three ways: ignore them,
14991 always treat them as errors and abandon the expression, or issue
14992 warnings but evaluate the expression anyway.
14994 A range error can result from numerical overflow, from exceeding an
14995 array index bound, or when you type a constant that is not a member
14996 of any type. Some languages, however, do not treat overflows as an
14997 error. In many implementations of C, mathematical overflow causes the
14998 result to ``wrap around'' to lower values---for example, if @var{m} is
14999 the largest integer value, and @var{s} is the smallest, then
15002 @var{m} + 1 @result{} @var{s}
15005 This, too, is specific to individual languages, and in some cases
15006 specific to individual compilers or machines. @xref{Supported Languages, ,
15007 Supported Languages}, for further details on specific languages.
15009 @value{GDBN} provides some additional commands for controlling the range checker:
15011 @kindex set check range
15012 @kindex show check range
15014 @item set check range auto
15015 Set range checking on or off based on the current working language.
15016 @xref{Supported Languages, ,Supported Languages}, for the default settings for
15019 @item set check range on
15020 @itemx set check range off
15021 Set range checking on or off, overriding the default setting for the
15022 current working language. A warning is issued if the setting does not
15023 match the language default. If a range error occurs and range checking is on,
15024 then a message is printed and evaluation of the expression is aborted.
15026 @item set check range warn
15027 Output messages when the @value{GDBN} range checker detects a range error,
15028 but attempt to evaluate the expression anyway. Evaluating the
15029 expression may still be impossible for other reasons, such as accessing
15030 memory that the process does not own (a typical example from many Unix
15034 Show the current setting of the range checker, and whether or not it is
15035 being set automatically by @value{GDBN}.
15038 @node Supported Languages
15039 @section Supported Languages
15041 @value{GDBN} supports C, C@t{++}, D, Go, Objective-C, Fortran,
15042 OpenCL C, Pascal, Rust, assembly, Modula-2, and Ada.
15043 @c This is false ...
15044 Some @value{GDBN} features may be used in expressions regardless of the
15045 language you use: the @value{GDBN} @code{@@} and @code{::} operators,
15046 and the @samp{@{type@}addr} construct (@pxref{Expressions,
15047 ,Expressions}) can be used with the constructs of any supported
15050 The following sections detail to what degree each source language is
15051 supported by @value{GDBN}. These sections are not meant to be language
15052 tutorials or references, but serve only as a reference guide to what the
15053 @value{GDBN} expression parser accepts, and what input and output
15054 formats should look like for different languages. There are many good
15055 books written on each of these languages; please look to these for a
15056 language reference or tutorial.
15059 * C:: C and C@t{++}
15062 * Objective-C:: Objective-C
15063 * OpenCL C:: OpenCL C
15064 * Fortran:: Fortran
15067 * Modula-2:: Modula-2
15072 @subsection C and C@t{++}
15074 @cindex C and C@t{++}
15075 @cindex expressions in C or C@t{++}
15077 Since C and C@t{++} are so closely related, many features of @value{GDBN} apply
15078 to both languages. Whenever this is the case, we discuss those languages
15082 @cindex @code{g++}, @sc{gnu} C@t{++} compiler
15083 @cindex @sc{gnu} C@t{++}
15084 The C@t{++} debugging facilities are jointly implemented by the C@t{++}
15085 compiler and @value{GDBN}. Therefore, to debug your C@t{++} code
15086 effectively, you must compile your C@t{++} programs with a supported
15087 C@t{++} compiler, such as @sc{gnu} @code{g++}, or the HP ANSI C@t{++}
15088 compiler (@code{aCC}).
15091 * C Operators:: C and C@t{++} operators
15092 * C Constants:: C and C@t{++} constants
15093 * C Plus Plus Expressions:: C@t{++} expressions
15094 * C Defaults:: Default settings for C and C@t{++}
15095 * C Checks:: C and C@t{++} type and range checks
15096 * Debugging C:: @value{GDBN} and C
15097 * Debugging C Plus Plus:: @value{GDBN} features for C@t{++}
15098 * Decimal Floating Point:: Numbers in Decimal Floating Point format
15102 @subsubsection C and C@t{++} Operators
15104 @cindex C and C@t{++} operators
15106 Operators must be defined on values of specific types. For instance,
15107 @code{+} is defined on numbers, but not on structures. Operators are
15108 often defined on groups of types.
15110 For the purposes of C and C@t{++}, the following definitions hold:
15115 @emph{Integral types} include @code{int} with any of its storage-class
15116 specifiers; @code{char}; @code{enum}; and, for C@t{++}, @code{bool}.
15119 @emph{Floating-point types} include @code{float}, @code{double}, and
15120 @code{long double} (if supported by the target platform).
15123 @emph{Pointer types} include all types defined as @code{(@var{type} *)}.
15126 @emph{Scalar types} include all of the above.
15131 The following operators are supported. They are listed here
15132 in order of increasing precedence:
15136 The comma or sequencing operator. Expressions in a comma-separated list
15137 are evaluated from left to right, with the result of the entire
15138 expression being the last expression evaluated.
15141 Assignment. The value of an assignment expression is the value
15142 assigned. Defined on scalar types.
15145 Used in an expression of the form @w{@code{@var{a} @var{op}= @var{b}}},
15146 and translated to @w{@code{@var{a} = @var{a op b}}}.
15147 @w{@code{@var{op}=}} and @code{=} have the same precedence. The operator
15148 @var{op} is any one of the operators @code{|}, @code{^}, @code{&},
15149 @code{<<}, @code{>>}, @code{+}, @code{-}, @code{*}, @code{/}, @code{%}.
15152 The ternary operator. @code{@var{a} ? @var{b} : @var{c}} can be thought
15153 of as: if @var{a} then @var{b} else @var{c}. The argument @var{a}
15154 should be of an integral type.
15157 Logical @sc{or}. Defined on integral types.
15160 Logical @sc{and}. Defined on integral types.
15163 Bitwise @sc{or}. Defined on integral types.
15166 Bitwise exclusive-@sc{or}. Defined on integral types.
15169 Bitwise @sc{and}. Defined on integral types.
15172 Equality and inequality. Defined on scalar types. The value of these
15173 expressions is 0 for false and non-zero for true.
15175 @item <@r{, }>@r{, }<=@r{, }>=
15176 Less than, greater than, less than or equal, greater than or equal.
15177 Defined on scalar types. The value of these expressions is 0 for false
15178 and non-zero for true.
15181 left shift, and right shift. Defined on integral types.
15184 The @value{GDBN} ``artificial array'' operator (@pxref{Expressions, ,Expressions}).
15187 Addition and subtraction. Defined on integral types, floating-point types and
15190 @item *@r{, }/@r{, }%
15191 Multiplication, division, and modulus. Multiplication and division are
15192 defined on integral and floating-point types. Modulus is defined on
15196 Increment and decrement. When appearing before a variable, the
15197 operation is performed before the variable is used in an expression;
15198 when appearing after it, the variable's value is used before the
15199 operation takes place.
15202 Pointer dereferencing. Defined on pointer types. Same precedence as
15206 Address operator. Defined on variables. Same precedence as @code{++}.
15208 For debugging C@t{++}, @value{GDBN} implements a use of @samp{&} beyond what is
15209 allowed in the C@t{++} language itself: you can use @samp{&(&@var{ref})}
15210 to examine the address
15211 where a C@t{++} reference variable (declared with @samp{&@var{ref}}) is
15215 Negative. Defined on integral and floating-point types. Same
15216 precedence as @code{++}.
15219 Logical negation. Defined on integral types. Same precedence as
15223 Bitwise complement operator. Defined on integral types. Same precedence as
15228 Structure member, and pointer-to-structure member. For convenience,
15229 @value{GDBN} regards the two as equivalent, choosing whether to dereference a
15230 pointer based on the stored type information.
15231 Defined on @code{struct} and @code{union} data.
15234 Dereferences of pointers to members.
15237 Array indexing. @code{@var{a}[@var{i}]} is defined as
15238 @code{*(@var{a}+@var{i})}. Same precedence as @code{->}.
15241 Function parameter list. Same precedence as @code{->}.
15244 C@t{++} scope resolution operator. Defined on @code{struct}, @code{union},
15245 and @code{class} types.
15248 Doubled colons also represent the @value{GDBN} scope operator
15249 (@pxref{Expressions, ,Expressions}). Same precedence as @code{::},
15253 If an operator is redefined in the user code, @value{GDBN} usually
15254 attempts to invoke the redefined version instead of using the operator's
15255 predefined meaning.
15258 @subsubsection C and C@t{++} Constants
15260 @cindex C and C@t{++} constants
15262 @value{GDBN} allows you to express the constants of C and C@t{++} in the
15267 Integer constants are a sequence of digits. Octal constants are
15268 specified by a leading @samp{0} (i.e.@: zero), and hexadecimal constants
15269 by a leading @samp{0x} or @samp{0X}. Constants may also end with a letter
15270 @samp{l}, specifying that the constant should be treated as a
15274 Floating point constants are a sequence of digits, followed by a decimal
15275 point, followed by a sequence of digits, and optionally followed by an
15276 exponent. An exponent is of the form:
15277 @samp{@w{e@r{[[}+@r{]|}-@r{]}@var{nnn}}}, where @var{nnn} is another
15278 sequence of digits. The @samp{+} is optional for positive exponents.
15279 A floating-point constant may also end with a letter @samp{f} or
15280 @samp{F}, specifying that the constant should be treated as being of
15281 the @code{float} (as opposed to the default @code{double}) type; or with
15282 a letter @samp{l} or @samp{L}, which specifies a @code{long double}
15286 Enumerated constants consist of enumerated identifiers, or their
15287 integral equivalents.
15290 Character constants are a single character surrounded by single quotes
15291 (@code{'}), or a number---the ordinal value of the corresponding character
15292 (usually its @sc{ascii} value). Within quotes, the single character may
15293 be represented by a letter or by @dfn{escape sequences}, which are of
15294 the form @samp{\@var{nnn}}, where @var{nnn} is the octal representation
15295 of the character's ordinal value; or of the form @samp{\@var{x}}, where
15296 @samp{@var{x}} is a predefined special character---for example,
15297 @samp{\n} for newline.
15299 Wide character constants can be written by prefixing a character
15300 constant with @samp{L}, as in C. For example, @samp{L'x'} is the wide
15301 form of @samp{x}. The target wide character set is used when
15302 computing the value of this constant (@pxref{Character Sets}).
15305 String constants are a sequence of character constants surrounded by
15306 double quotes (@code{"}). Any valid character constant (as described
15307 above) may appear. Double quotes within the string must be preceded by
15308 a backslash, so for instance @samp{"a\"b'c"} is a string of five
15311 Wide string constants can be written by prefixing a string constant
15312 with @samp{L}, as in C. The target wide character set is used when
15313 computing the value of this constant (@pxref{Character Sets}).
15316 Pointer constants are an integral value. You can also write pointers
15317 to constants using the C operator @samp{&}.
15320 Array constants are comma-separated lists surrounded by braces @samp{@{}
15321 and @samp{@}}; for example, @samp{@{1,2,3@}} is a three-element array of
15322 integers, @samp{@{@{1,2@}, @{3,4@}, @{5,6@}@}} is a three-by-two array,
15323 and @samp{@{&"hi", &"there", &"fred"@}} is a three-element array of pointers.
15326 @node C Plus Plus Expressions
15327 @subsubsection C@t{++} Expressions
15329 @cindex expressions in C@t{++}
15330 @value{GDBN} expression handling can interpret most C@t{++} expressions.
15332 @cindex debugging C@t{++} programs
15333 @cindex C@t{++} compilers
15334 @cindex debug formats and C@t{++}
15335 @cindex @value{NGCC} and C@t{++}
15337 @emph{Warning:} @value{GDBN} can only debug C@t{++} code if you use
15338 the proper compiler and the proper debug format. Currently,
15339 @value{GDBN} works best when debugging C@t{++} code that is compiled
15340 with the most recent version of @value{NGCC} possible. The DWARF
15341 debugging format is preferred; @value{NGCC} defaults to this on most
15342 popular platforms. Other compilers and/or debug formats are likely to
15343 work badly or not at all when using @value{GDBN} to debug C@t{++}
15344 code. @xref{Compilation}.
15349 @cindex member functions
15351 Member function calls are allowed; you can use expressions like
15354 count = aml->GetOriginal(x, y)
15357 @vindex this@r{, inside C@t{++} member functions}
15358 @cindex namespace in C@t{++}
15360 While a member function is active (in the selected stack frame), your
15361 expressions have the same namespace available as the member function;
15362 that is, @value{GDBN} allows implicit references to the class instance
15363 pointer @code{this} following the same rules as C@t{++}. @code{using}
15364 declarations in the current scope are also respected by @value{GDBN}.
15366 @cindex call overloaded functions
15367 @cindex overloaded functions, calling
15368 @cindex type conversions in C@t{++}
15370 You can call overloaded functions; @value{GDBN} resolves the function
15371 call to the right definition, with some restrictions. @value{GDBN} does not
15372 perform overload resolution involving user-defined type conversions,
15373 calls to constructors, or instantiations of templates that do not exist
15374 in the program. It also cannot handle ellipsis argument lists or
15377 It does perform integral conversions and promotions, floating-point
15378 promotions, arithmetic conversions, pointer conversions, conversions of
15379 class objects to base classes, and standard conversions such as those of
15380 functions or arrays to pointers; it requires an exact match on the
15381 number of function arguments.
15383 Overload resolution is always performed, unless you have specified
15384 @code{set overload-resolution off}. @xref{Debugging C Plus Plus,
15385 ,@value{GDBN} Features for C@t{++}}.
15387 You must specify @code{set overload-resolution off} in order to use an
15388 explicit function signature to call an overloaded function, as in
15390 p 'foo(char,int)'('x', 13)
15393 The @value{GDBN} command-completion facility can simplify this;
15394 see @ref{Completion, ,Command Completion}.
15396 @cindex reference declarations
15398 @value{GDBN} understands variables declared as C@t{++} lvalue or rvalue
15399 references; you can use them in expressions just as you do in C@t{++}
15400 source---they are automatically dereferenced.
15402 In the parameter list shown when @value{GDBN} displays a frame, the values of
15403 reference variables are not displayed (unlike other variables); this
15404 avoids clutter, since references are often used for large structures.
15405 The @emph{address} of a reference variable is always shown, unless
15406 you have specified @samp{set print address off}.
15409 @value{GDBN} supports the C@t{++} name resolution operator @code{::}---your
15410 expressions can use it just as expressions in your program do. Since
15411 one scope may be defined in another, you can use @code{::} repeatedly if
15412 necessary, for example in an expression like
15413 @samp{@var{scope1}::@var{scope2}::@var{name}}. @value{GDBN} also allows
15414 resolving name scope by reference to source files, in both C and C@t{++}
15415 debugging (@pxref{Variables, ,Program Variables}).
15418 @value{GDBN} performs argument-dependent lookup, following the C@t{++}
15423 @subsubsection C and C@t{++} Defaults
15425 @cindex C and C@t{++} defaults
15427 If you allow @value{GDBN} to set range checking automatically, it
15428 defaults to @code{off} whenever the working language changes to
15429 C or C@t{++}. This happens regardless of whether you or @value{GDBN}
15430 selects the working language.
15432 If you allow @value{GDBN} to set the language automatically, it
15433 recognizes source files whose names end with @file{.c}, @file{.C}, or
15434 @file{.cc}, etc, and when @value{GDBN} enters code compiled from one of
15435 these files, it sets the working language to C or C@t{++}.
15436 @xref{Automatically, ,Having @value{GDBN} Infer the Source Language},
15437 for further details.
15440 @subsubsection C and C@t{++} Type and Range Checks
15442 @cindex C and C@t{++} checks
15444 By default, when @value{GDBN} parses C or C@t{++} expressions, strict type
15445 checking is used. However, if you turn type checking off, @value{GDBN}
15446 will allow certain non-standard conversions, such as promoting integer
15447 constants to pointers.
15449 Range checking, if turned on, is done on mathematical operations. Array
15450 indices are not checked, since they are often used to index a pointer
15451 that is not itself an array.
15454 @subsubsection @value{GDBN} and C
15456 The @code{set print union} and @code{show print union} commands apply to
15457 the @code{union} type. When set to @samp{on}, any @code{union} that is
15458 inside a @code{struct} or @code{class} is also printed. Otherwise, it
15459 appears as @samp{@{...@}}.
15461 The @code{@@} operator aids in the debugging of dynamic arrays, formed
15462 with pointers and a memory allocation function. @xref{Expressions,
15465 @node Debugging C Plus Plus
15466 @subsubsection @value{GDBN} Features for C@t{++}
15468 @cindex commands for C@t{++}
15470 Some @value{GDBN} commands are particularly useful with C@t{++}, and some are
15471 designed specifically for use with C@t{++}. Here is a summary:
15474 @cindex break in overloaded functions
15475 @item @r{breakpoint menus}
15476 When you want a breakpoint in a function whose name is overloaded,
15477 @value{GDBN} has the capability to display a menu of possible breakpoint
15478 locations to help you specify which function definition you want.
15479 @xref{Ambiguous Expressions,,Ambiguous Expressions}.
15481 @cindex overloading in C@t{++}
15482 @item rbreak @var{regex}
15483 Setting breakpoints using regular expressions is helpful for setting
15484 breakpoints on overloaded functions that are not members of any special
15486 @xref{Set Breaks, ,Setting Breakpoints}.
15488 @cindex C@t{++} exception handling
15490 @itemx catch rethrow
15492 Debug C@t{++} exception handling using these commands. @xref{Set
15493 Catchpoints, , Setting Catchpoints}.
15495 @cindex inheritance
15496 @item ptype @var{typename}
15497 Print inheritance relationships as well as other information for type
15499 @xref{Symbols, ,Examining the Symbol Table}.
15501 @item info vtbl @var{expression}.
15502 The @code{info vtbl} command can be used to display the virtual
15503 method tables of the object computed by @var{expression}. This shows
15504 one entry per virtual table; there may be multiple virtual tables when
15505 multiple inheritance is in use.
15507 @cindex C@t{++} demangling
15508 @item demangle @var{name}
15509 Demangle @var{name}.
15510 @xref{Symbols}, for a more complete description of the @code{demangle} command.
15512 @cindex C@t{++} symbol display
15513 @item set print demangle
15514 @itemx show print demangle
15515 @itemx set print asm-demangle
15516 @itemx show print asm-demangle
15517 Control whether C@t{++} symbols display in their source form, both when
15518 displaying code as C@t{++} source and when displaying disassemblies.
15519 @xref{Print Settings, ,Print Settings}.
15521 @item set print object
15522 @itemx show print object
15523 Choose whether to print derived (actual) or declared types of objects.
15524 @xref{Print Settings, ,Print Settings}.
15526 @item set print vtbl
15527 @itemx show print vtbl
15528 Control the format for printing virtual function tables.
15529 @xref{Print Settings, ,Print Settings}.
15530 (The @code{vtbl} commands do not work on programs compiled with the HP
15531 ANSI C@t{++} compiler (@code{aCC}).)
15533 @kindex set overload-resolution
15534 @cindex overloaded functions, overload resolution
15535 @item set overload-resolution on
15536 Enable overload resolution for C@t{++} expression evaluation. The default
15537 is on. For overloaded functions, @value{GDBN} evaluates the arguments
15538 and searches for a function whose signature matches the argument types,
15539 using the standard C@t{++} conversion rules (see @ref{C Plus Plus
15540 Expressions, ,C@t{++} Expressions}, for details).
15541 If it cannot find a match, it emits a message.
15543 @item set overload-resolution off
15544 Disable overload resolution for C@t{++} expression evaluation. For
15545 overloaded functions that are not class member functions, @value{GDBN}
15546 chooses the first function of the specified name that it finds in the
15547 symbol table, whether or not its arguments are of the correct type. For
15548 overloaded functions that are class member functions, @value{GDBN}
15549 searches for a function whose signature @emph{exactly} matches the
15552 @kindex show overload-resolution
15553 @item show overload-resolution
15554 Show the current setting of overload resolution.
15556 @item @r{Overloaded symbol names}
15557 You can specify a particular definition of an overloaded symbol, using
15558 the same notation that is used to declare such symbols in C@t{++}: type
15559 @code{@var{symbol}(@var{types})} rather than just @var{symbol}. You can
15560 also use the @value{GDBN} command-line word completion facilities to list the
15561 available choices, or to finish the type list for you.
15562 @xref{Completion,, Command Completion}, for details on how to do this.
15564 @item @r{Breakpoints in functions with ABI tags}
15566 The GNU C@t{++} compiler introduced the notion of ABI ``tags'', which
15567 correspond to changes in the ABI of a type, function, or variable that
15568 would not otherwise be reflected in a mangled name. See
15569 @url{https://developers.redhat.com/blog/2015/02/05/gcc5-and-the-c11-abi/}
15572 The ABI tags are visible in C@t{++} demangled names. For example, a
15573 function that returns a std::string:
15576 std::string function(int);
15580 when compiled for the C++11 ABI is marked with the @code{cxx11} ABI
15581 tag, and @value{GDBN} displays the symbol like this:
15584 function[abi:cxx11](int)
15587 You can set a breakpoint on such functions simply as if they had no
15591 (gdb) b function(int)
15592 Breakpoint 2 at 0x40060d: file main.cc, line 10.
15593 (gdb) info breakpoints
15594 Num Type Disp Enb Address What
15595 1 breakpoint keep y 0x0040060d in function[abi:cxx11](int)
15599 On the rare occasion you need to disambiguate between different ABI
15600 tags, you can do so by simply including the ABI tag in the function
15604 (@value{GDBP}) b ambiguous[abi:other_tag](int)
15608 @node Decimal Floating Point
15609 @subsubsection Decimal Floating Point format
15610 @cindex decimal floating point format
15612 @value{GDBN} can examine, set and perform computations with numbers in
15613 decimal floating point format, which in the C language correspond to the
15614 @code{_Decimal32}, @code{_Decimal64} and @code{_Decimal128} types as
15615 specified by the extension to support decimal floating-point arithmetic.
15617 There are two encodings in use, depending on the architecture: BID (Binary
15618 Integer Decimal) for x86 and x86-64, and DPD (Densely Packed Decimal) for
15619 PowerPC and S/390. @value{GDBN} will use the appropriate encoding for the
15622 Because of a limitation in @file{libdecnumber}, the library used by @value{GDBN}
15623 to manipulate decimal floating point numbers, it is not possible to convert
15624 (using a cast, for example) integers wider than 32-bit to decimal float.
15626 In addition, in order to imitate @value{GDBN}'s behaviour with binary floating
15627 point computations, error checking in decimal float operations ignores
15628 underflow, overflow and divide by zero exceptions.
15630 In the PowerPC architecture, @value{GDBN} provides a set of pseudo-registers
15631 to inspect @code{_Decimal128} values stored in floating point registers.
15632 See @ref{PowerPC,,PowerPC} for more details.
15638 @value{GDBN} can be used to debug programs written in D and compiled with
15639 GDC, LDC or DMD compilers. Currently @value{GDBN} supports only one D
15640 specific feature --- dynamic arrays.
15645 @cindex Go (programming language)
15646 @value{GDBN} can be used to debug programs written in Go and compiled with
15647 @file{gccgo} or @file{6g} compilers.
15649 Here is a summary of the Go-specific features and restrictions:
15652 @cindex current Go package
15653 @item The current Go package
15654 The name of the current package does not need to be specified when
15655 specifying global variables and functions.
15657 For example, given the program:
15661 var myglob = "Shall we?"
15667 When stopped inside @code{main} either of these work:
15671 (gdb) p main.myglob
15674 @cindex builtin Go types
15675 @item Builtin Go types
15676 The @code{string} type is recognized by @value{GDBN} and is printed
15679 @cindex builtin Go functions
15680 @item Builtin Go functions
15681 The @value{GDBN} expression parser recognizes the @code{unsafe.Sizeof}
15682 function and handles it internally.
15684 @cindex restrictions on Go expressions
15685 @item Restrictions on Go expressions
15686 All Go operators are supported except @code{&^}.
15687 The Go @code{_} ``blank identifier'' is not supported.
15688 Automatic dereferencing of pointers is not supported.
15692 @subsection Objective-C
15694 @cindex Objective-C
15695 This section provides information about some commands and command
15696 options that are useful for debugging Objective-C code. See also
15697 @ref{Symbols, info classes}, and @ref{Symbols, info selectors}, for a
15698 few more commands specific to Objective-C support.
15701 * Method Names in Commands::
15702 * The Print Command with Objective-C::
15705 @node Method Names in Commands
15706 @subsubsection Method Names in Commands
15708 The following commands have been extended to accept Objective-C method
15709 names as line specifications:
15711 @kindex clear@r{, and Objective-C}
15712 @kindex break@r{, and Objective-C}
15713 @kindex info line@r{, and Objective-C}
15714 @kindex jump@r{, and Objective-C}
15715 @kindex list@r{, and Objective-C}
15719 @item @code{info line}
15724 A fully qualified Objective-C method name is specified as
15727 -[@var{Class} @var{methodName}]
15730 where the minus sign is used to indicate an instance method and a
15731 plus sign (not shown) is used to indicate a class method. The class
15732 name @var{Class} and method name @var{methodName} are enclosed in
15733 brackets, similar to the way messages are specified in Objective-C
15734 source code. For example, to set a breakpoint at the @code{create}
15735 instance method of class @code{Fruit} in the program currently being
15739 break -[Fruit create]
15742 To list ten program lines around the @code{initialize} class method,
15746 list +[NSText initialize]
15749 In the current version of @value{GDBN}, the plus or minus sign is
15750 required. In future versions of @value{GDBN}, the plus or minus
15751 sign will be optional, but you can use it to narrow the search. It
15752 is also possible to specify just a method name:
15758 You must specify the complete method name, including any colons. If
15759 your program's source files contain more than one @code{create} method,
15760 you'll be presented with a numbered list of classes that implement that
15761 method. Indicate your choice by number, or type @samp{0} to exit if
15764 As another example, to clear a breakpoint established at the
15765 @code{makeKeyAndOrderFront:} method of the @code{NSWindow} class, enter:
15768 clear -[NSWindow makeKeyAndOrderFront:]
15771 @node The Print Command with Objective-C
15772 @subsubsection The Print Command With Objective-C
15773 @cindex Objective-C, print objects
15774 @kindex print-object
15775 @kindex po @r{(@code{print-object})}
15777 The print command has also been extended to accept methods. For example:
15780 print -[@var{object} hash]
15783 @cindex print an Objective-C object description
15784 @cindex @code{_NSPrintForDebugger}, and printing Objective-C objects
15786 will tell @value{GDBN} to send the @code{hash} message to @var{object}
15787 and print the result. Also, an additional command has been added,
15788 @code{print-object} or @code{po} for short, which is meant to print
15789 the description of an object. However, this command may only work
15790 with certain Objective-C libraries that have a particular hook
15791 function, @code{_NSPrintForDebugger}, defined.
15794 @subsection OpenCL C
15797 This section provides information about @value{GDBN}s OpenCL C support.
15800 * OpenCL C Datatypes::
15801 * OpenCL C Expressions::
15802 * OpenCL C Operators::
15805 @node OpenCL C Datatypes
15806 @subsubsection OpenCL C Datatypes
15808 @cindex OpenCL C Datatypes
15809 @value{GDBN} supports the builtin scalar and vector datatypes specified
15810 by OpenCL 1.1. In addition the half- and double-precision floating point
15811 data types of the @code{cl_khr_fp16} and @code{cl_khr_fp64} OpenCL
15812 extensions are also known to @value{GDBN}.
15814 @node OpenCL C Expressions
15815 @subsubsection OpenCL C Expressions
15817 @cindex OpenCL C Expressions
15818 @value{GDBN} supports accesses to vector components including the access as
15819 lvalue where possible. Since OpenCL C is based on C99 most C expressions
15820 supported by @value{GDBN} can be used as well.
15822 @node OpenCL C Operators
15823 @subsubsection OpenCL C Operators
15825 @cindex OpenCL C Operators
15826 @value{GDBN} supports the operators specified by OpenCL 1.1 for scalar and
15830 @subsection Fortran
15831 @cindex Fortran-specific support in @value{GDBN}
15833 @value{GDBN} can be used to debug programs written in Fortran, but it
15834 currently supports only the features of Fortran 77 language.
15836 @cindex trailing underscore, in Fortran symbols
15837 Some Fortran compilers (@sc{gnu} Fortran 77 and Fortran 95 compilers
15838 among them) append an underscore to the names of variables and
15839 functions. When you debug programs compiled by those compilers, you
15840 will need to refer to variables and functions with a trailing
15844 * Fortran Operators:: Fortran operators and expressions
15845 * Fortran Defaults:: Default settings for Fortran
15846 * Special Fortran Commands:: Special @value{GDBN} commands for Fortran
15849 @node Fortran Operators
15850 @subsubsection Fortran Operators and Expressions
15852 @cindex Fortran operators and expressions
15854 Operators must be defined on values of specific types. For instance,
15855 @code{+} is defined on numbers, but not on characters or other non-
15856 arithmetic types. Operators are often defined on groups of types.
15860 The exponentiation operator. It raises the first operand to the power
15864 The range operator. Normally used in the form of array(low:high) to
15865 represent a section of array.
15868 The access component operator. Normally used to access elements in derived
15869 types. Also suitable for unions. As unions aren't part of regular Fortran,
15870 this can only happen when accessing a register that uses a gdbarch-defined
15874 @node Fortran Defaults
15875 @subsubsection Fortran Defaults
15877 @cindex Fortran Defaults
15879 Fortran symbols are usually case-insensitive, so @value{GDBN} by
15880 default uses case-insensitive matches for Fortran symbols. You can
15881 change that with the @samp{set case-insensitive} command, see
15882 @ref{Symbols}, for the details.
15884 @node Special Fortran Commands
15885 @subsubsection Special Fortran Commands
15887 @cindex Special Fortran commands
15889 @value{GDBN} has some commands to support Fortran-specific features,
15890 such as displaying common blocks.
15893 @cindex @code{COMMON} blocks, Fortran
15894 @kindex info common
15895 @item info common @r{[}@var{common-name}@r{]}
15896 This command prints the values contained in the Fortran @code{COMMON}
15897 block whose name is @var{common-name}. With no argument, the names of
15898 all @code{COMMON} blocks visible at the current program location are
15905 @cindex Pascal support in @value{GDBN}, limitations
15906 Debugging Pascal programs which use sets, subranges, file variables, or
15907 nested functions does not currently work. @value{GDBN} does not support
15908 entering expressions, printing values, or similar features using Pascal
15911 The Pascal-specific command @code{set print pascal_static-members}
15912 controls whether static members of Pascal objects are displayed.
15913 @xref{Print Settings, pascal_static-members}.
15918 @value{GDBN} supports the @url{https://www.rust-lang.org/, Rust
15919 Programming Language}. Type- and value-printing, and expression
15920 parsing, are reasonably complete. However, there are a few
15921 peculiarities and holes to be aware of.
15925 Linespecs (@pxref{Specify Location}) are never relative to the current
15926 crate. Instead, they act as if there were a global namespace of
15927 crates, somewhat similar to the way @code{extern crate} behaves.
15929 That is, if @value{GDBN} is stopped at a breakpoint in a function in
15930 crate @samp{A}, module @samp{B}, then @code{break B::f} will attempt
15931 to set a breakpoint in a function named @samp{f} in a crate named
15934 As a consequence of this approach, linespecs also cannot refer to
15935 items using @samp{self::} or @samp{super::}.
15938 Because @value{GDBN} implements Rust name-lookup semantics in
15939 expressions, it will sometimes prepend the current crate to a name.
15940 For example, if @value{GDBN} is stopped at a breakpoint in the crate
15941 @samp{K}, then @code{print ::x::y} will try to find the symbol
15944 However, since it is useful to be able to refer to other crates when
15945 debugging, @value{GDBN} provides the @code{extern} extension to
15946 circumvent this. To use the extension, just put @code{extern} before
15947 a path expression to refer to the otherwise unavailable ``global''
15950 In the above example, if you wanted to refer to the symbol @samp{y} in
15951 the crate @samp{x}, you would use @code{print extern x::y}.
15954 The Rust expression evaluator does not support ``statement-like''
15955 expressions such as @code{if} or @code{match}, or lambda expressions.
15958 Tuple expressions are not implemented.
15961 The Rust expression evaluator does not currently implement the
15962 @code{Drop} trait. Objects that may be created by the evaluator will
15963 never be destroyed.
15966 @value{GDBN} does not implement type inference for generics. In order
15967 to call generic functions or otherwise refer to generic items, you
15968 will have to specify the type parameters manually.
15971 @value{GDBN} currently uses the C@t{++} demangler for Rust. In most
15972 cases this does not cause any problems. However, in an expression
15973 context, completing a generic function name will give syntactically
15974 invalid results. This happens because Rust requires the @samp{::}
15975 operator between the function name and its generic arguments. For
15976 example, @value{GDBN} might provide a completion like
15977 @code{crate::f<u32>}, where the parser would require
15978 @code{crate::f::<u32>}.
15981 As of this writing, the Rust compiler (version 1.8) has a few holes in
15982 the debugging information it generates. These holes prevent certain
15983 features from being implemented by @value{GDBN}:
15987 Method calls cannot be made via traits.
15990 Operator overloading is not implemented.
15993 When debugging in a monomorphized function, you cannot use the generic
15997 The type @code{Self} is not available.
16000 @code{use} statements are not available, so some names may not be
16001 available in the crate.
16006 @subsection Modula-2
16008 @cindex Modula-2, @value{GDBN} support
16010 The extensions made to @value{GDBN} to support Modula-2 only support
16011 output from the @sc{gnu} Modula-2 compiler (which is currently being
16012 developed). Other Modula-2 compilers are not currently supported, and
16013 attempting to debug executables produced by them is most likely
16014 to give an error as @value{GDBN} reads in the executable's symbol
16017 @cindex expressions in Modula-2
16019 * M2 Operators:: Built-in operators
16020 * Built-In Func/Proc:: Built-in functions and procedures
16021 * M2 Constants:: Modula-2 constants
16022 * M2 Types:: Modula-2 types
16023 * M2 Defaults:: Default settings for Modula-2
16024 * Deviations:: Deviations from standard Modula-2
16025 * M2 Checks:: Modula-2 type and range checks
16026 * M2 Scope:: The scope operators @code{::} and @code{.}
16027 * GDB/M2:: @value{GDBN} and Modula-2
16031 @subsubsection Operators
16032 @cindex Modula-2 operators
16034 Operators must be defined on values of specific types. For instance,
16035 @code{+} is defined on numbers, but not on structures. Operators are
16036 often defined on groups of types. For the purposes of Modula-2, the
16037 following definitions hold:
16042 @emph{Integral types} consist of @code{INTEGER}, @code{CARDINAL}, and
16046 @emph{Character types} consist of @code{CHAR} and its subranges.
16049 @emph{Floating-point types} consist of @code{REAL}.
16052 @emph{Pointer types} consist of anything declared as @code{POINTER TO
16056 @emph{Scalar types} consist of all of the above.
16059 @emph{Set types} consist of @code{SET} and @code{BITSET} types.
16062 @emph{Boolean types} consist of @code{BOOLEAN}.
16066 The following operators are supported, and appear in order of
16067 increasing precedence:
16071 Function argument or array index separator.
16074 Assignment. The value of @var{var} @code{:=} @var{value} is
16078 Less than, greater than on integral, floating-point, or enumerated
16082 Less than or equal to, greater than or equal to
16083 on integral, floating-point and enumerated types, or set inclusion on
16084 set types. Same precedence as @code{<}.
16086 @item =@r{, }<>@r{, }#
16087 Equality and two ways of expressing inequality, valid on scalar types.
16088 Same precedence as @code{<}. In @value{GDBN} scripts, only @code{<>} is
16089 available for inequality, since @code{#} conflicts with the script
16093 Set membership. Defined on set types and the types of their members.
16094 Same precedence as @code{<}.
16097 Boolean disjunction. Defined on boolean types.
16100 Boolean conjunction. Defined on boolean types.
16103 The @value{GDBN} ``artificial array'' operator (@pxref{Expressions, ,Expressions}).
16106 Addition and subtraction on integral and floating-point types, or union
16107 and difference on set types.
16110 Multiplication on integral and floating-point types, or set intersection
16114 Division on floating-point types, or symmetric set difference on set
16115 types. Same precedence as @code{*}.
16118 Integer division and remainder. Defined on integral types. Same
16119 precedence as @code{*}.
16122 Negative. Defined on @code{INTEGER} and @code{REAL} data.
16125 Pointer dereferencing. Defined on pointer types.
16128 Boolean negation. Defined on boolean types. Same precedence as
16132 @code{RECORD} field selector. Defined on @code{RECORD} data. Same
16133 precedence as @code{^}.
16136 Array indexing. Defined on @code{ARRAY} data. Same precedence as @code{^}.
16139 Procedure argument list. Defined on @code{PROCEDURE} objects. Same precedence
16143 @value{GDBN} and Modula-2 scope operators.
16147 @emph{Warning:} Set expressions and their operations are not yet supported, so @value{GDBN}
16148 treats the use of the operator @code{IN}, or the use of operators
16149 @code{+}, @code{-}, @code{*}, @code{/}, @code{=}, , @code{<>}, @code{#},
16150 @code{<=}, and @code{>=} on sets as an error.
16154 @node Built-In Func/Proc
16155 @subsubsection Built-in Functions and Procedures
16156 @cindex Modula-2 built-ins
16158 Modula-2 also makes available several built-in procedures and functions.
16159 In describing these, the following metavariables are used:
16164 represents an @code{ARRAY} variable.
16167 represents a @code{CHAR} constant or variable.
16170 represents a variable or constant of integral type.
16173 represents an identifier that belongs to a set. Generally used in the
16174 same function with the metavariable @var{s}. The type of @var{s} should
16175 be @code{SET OF @var{mtype}} (where @var{mtype} is the type of @var{m}).
16178 represents a variable or constant of integral or floating-point type.
16181 represents a variable or constant of floating-point type.
16187 represents a variable.
16190 represents a variable or constant of one of many types. See the
16191 explanation of the function for details.
16194 All Modula-2 built-in procedures also return a result, described below.
16198 Returns the absolute value of @var{n}.
16201 If @var{c} is a lower case letter, it returns its upper case
16202 equivalent, otherwise it returns its argument.
16205 Returns the character whose ordinal value is @var{i}.
16208 Decrements the value in the variable @var{v} by one. Returns the new value.
16210 @item DEC(@var{v},@var{i})
16211 Decrements the value in the variable @var{v} by @var{i}. Returns the
16214 @item EXCL(@var{m},@var{s})
16215 Removes the element @var{m} from the set @var{s}. Returns the new
16218 @item FLOAT(@var{i})
16219 Returns the floating point equivalent of the integer @var{i}.
16221 @item HIGH(@var{a})
16222 Returns the index of the last member of @var{a}.
16225 Increments the value in the variable @var{v} by one. Returns the new value.
16227 @item INC(@var{v},@var{i})
16228 Increments the value in the variable @var{v} by @var{i}. Returns the
16231 @item INCL(@var{m},@var{s})
16232 Adds the element @var{m} to the set @var{s} if it is not already
16233 there. Returns the new set.
16236 Returns the maximum value of the type @var{t}.
16239 Returns the minimum value of the type @var{t}.
16242 Returns boolean TRUE if @var{i} is an odd number.
16245 Returns the ordinal value of its argument. For example, the ordinal
16246 value of a character is its @sc{ascii} value (on machines supporting
16247 the @sc{ascii} character set). The argument @var{x} must be of an
16248 ordered type, which include integral, character and enumerated types.
16250 @item SIZE(@var{x})
16251 Returns the size of its argument. The argument @var{x} can be a
16252 variable or a type.
16254 @item TRUNC(@var{r})
16255 Returns the integral part of @var{r}.
16257 @item TSIZE(@var{x})
16258 Returns the size of its argument. The argument @var{x} can be a
16259 variable or a type.
16261 @item VAL(@var{t},@var{i})
16262 Returns the member of the type @var{t} whose ordinal value is @var{i}.
16266 @emph{Warning:} Sets and their operations are not yet supported, so
16267 @value{GDBN} treats the use of procedures @code{INCL} and @code{EXCL} as
16271 @cindex Modula-2 constants
16273 @subsubsection Constants
16275 @value{GDBN} allows you to express the constants of Modula-2 in the following
16281 Integer constants are simply a sequence of digits. When used in an
16282 expression, a constant is interpreted to be type-compatible with the
16283 rest of the expression. Hexadecimal integers are specified by a
16284 trailing @samp{H}, and octal integers by a trailing @samp{B}.
16287 Floating point constants appear as a sequence of digits, followed by a
16288 decimal point and another sequence of digits. An optional exponent can
16289 then be specified, in the form @samp{E@r{[}+@r{|}-@r{]}@var{nnn}}, where
16290 @samp{@r{[}+@r{|}-@r{]}@var{nnn}} is the desired exponent. All of the
16291 digits of the floating point constant must be valid decimal (base 10)
16295 Character constants consist of a single character enclosed by a pair of
16296 like quotes, either single (@code{'}) or double (@code{"}). They may
16297 also be expressed by their ordinal value (their @sc{ascii} value, usually)
16298 followed by a @samp{C}.
16301 String constants consist of a sequence of characters enclosed by a
16302 pair of like quotes, either single (@code{'}) or double (@code{"}).
16303 Escape sequences in the style of C are also allowed. @xref{C
16304 Constants, ,C and C@t{++} Constants}, for a brief explanation of escape
16308 Enumerated constants consist of an enumerated identifier.
16311 Boolean constants consist of the identifiers @code{TRUE} and
16315 Pointer constants consist of integral values only.
16318 Set constants are not yet supported.
16322 @subsubsection Modula-2 Types
16323 @cindex Modula-2 types
16325 Currently @value{GDBN} can print the following data types in Modula-2
16326 syntax: array types, record types, set types, pointer types, procedure
16327 types, enumerated types, subrange types and base types. You can also
16328 print the contents of variables declared using these type.
16329 This section gives a number of simple source code examples together with
16330 sample @value{GDBN} sessions.
16332 The first example contains the following section of code:
16341 and you can request @value{GDBN} to interrogate the type and value of
16342 @code{r} and @code{s}.
16345 (@value{GDBP}) print s
16347 (@value{GDBP}) ptype s
16349 (@value{GDBP}) print r
16351 (@value{GDBP}) ptype r
16356 Likewise if your source code declares @code{s} as:
16360 s: SET ['A'..'Z'] ;
16364 then you may query the type of @code{s} by:
16367 (@value{GDBP}) ptype s
16368 type = SET ['A'..'Z']
16372 Note that at present you cannot interactively manipulate set
16373 expressions using the debugger.
16375 The following example shows how you might declare an array in Modula-2
16376 and how you can interact with @value{GDBN} to print its type and contents:
16380 s: ARRAY [-10..10] OF CHAR ;
16384 (@value{GDBP}) ptype s
16385 ARRAY [-10..10] OF CHAR
16388 Note that the array handling is not yet complete and although the type
16389 is printed correctly, expression handling still assumes that all
16390 arrays have a lower bound of zero and not @code{-10} as in the example
16393 Here are some more type related Modula-2 examples:
16397 colour = (blue, red, yellow, green) ;
16398 t = [blue..yellow] ;
16406 The @value{GDBN} interaction shows how you can query the data type
16407 and value of a variable.
16410 (@value{GDBP}) print s
16412 (@value{GDBP}) ptype t
16413 type = [blue..yellow]
16417 In this example a Modula-2 array is declared and its contents
16418 displayed. Observe that the contents are written in the same way as
16419 their @code{C} counterparts.
16423 s: ARRAY [1..5] OF CARDINAL ;
16429 (@value{GDBP}) print s
16430 $1 = @{1, 0, 0, 0, 0@}
16431 (@value{GDBP}) ptype s
16432 type = ARRAY [1..5] OF CARDINAL
16435 The Modula-2 language interface to @value{GDBN} also understands
16436 pointer types as shown in this example:
16440 s: POINTER TO ARRAY [1..5] OF CARDINAL ;
16447 and you can request that @value{GDBN} describes the type of @code{s}.
16450 (@value{GDBP}) ptype s
16451 type = POINTER TO ARRAY [1..5] OF CARDINAL
16454 @value{GDBN} handles compound types as we can see in this example.
16455 Here we combine array types, record types, pointer types and subrange
16466 myarray = ARRAY myrange OF CARDINAL ;
16467 myrange = [-2..2] ;
16469 s: POINTER TO ARRAY myrange OF foo ;
16473 and you can ask @value{GDBN} to describe the type of @code{s} as shown
16477 (@value{GDBP}) ptype s
16478 type = POINTER TO ARRAY [-2..2] OF foo = RECORD
16481 f3 : ARRAY [-2..2] OF CARDINAL;
16486 @subsubsection Modula-2 Defaults
16487 @cindex Modula-2 defaults
16489 If type and range checking are set automatically by @value{GDBN}, they
16490 both default to @code{on} whenever the working language changes to
16491 Modula-2. This happens regardless of whether you or @value{GDBN}
16492 selected the working language.
16494 If you allow @value{GDBN} to set the language automatically, then entering
16495 code compiled from a file whose name ends with @file{.mod} sets the
16496 working language to Modula-2. @xref{Automatically, ,Having @value{GDBN}
16497 Infer the Source Language}, for further details.
16500 @subsubsection Deviations from Standard Modula-2
16501 @cindex Modula-2, deviations from
16503 A few changes have been made to make Modula-2 programs easier to debug.
16504 This is done primarily via loosening its type strictness:
16508 Unlike in standard Modula-2, pointer constants can be formed by
16509 integers. This allows you to modify pointer variables during
16510 debugging. (In standard Modula-2, the actual address contained in a
16511 pointer variable is hidden from you; it can only be modified
16512 through direct assignment to another pointer variable or expression that
16513 returned a pointer.)
16516 C escape sequences can be used in strings and characters to represent
16517 non-printable characters. @value{GDBN} prints out strings with these
16518 escape sequences embedded. Single non-printable characters are
16519 printed using the @samp{CHR(@var{nnn})} format.
16522 The assignment operator (@code{:=}) returns the value of its right-hand
16526 All built-in procedures both modify @emph{and} return their argument.
16530 @subsubsection Modula-2 Type and Range Checks
16531 @cindex Modula-2 checks
16534 @emph{Warning:} in this release, @value{GDBN} does not yet perform type or
16537 @c FIXME remove warning when type/range checks added
16539 @value{GDBN} considers two Modula-2 variables type equivalent if:
16543 They are of types that have been declared equivalent via a @code{TYPE
16544 @var{t1} = @var{t2}} statement
16547 They have been declared on the same line. (Note: This is true of the
16548 @sc{gnu} Modula-2 compiler, but it may not be true of other compilers.)
16551 As long as type checking is enabled, any attempt to combine variables
16552 whose types are not equivalent is an error.
16554 Range checking is done on all mathematical operations, assignment, array
16555 index bounds, and all built-in functions and procedures.
16558 @subsubsection The Scope Operators @code{::} and @code{.}
16560 @cindex @code{.}, Modula-2 scope operator
16561 @cindex colon, doubled as scope operator
16563 @vindex colon-colon@r{, in Modula-2}
16564 @c Info cannot handle :: but TeX can.
16567 @vindex ::@r{, in Modula-2}
16570 There are a few subtle differences between the Modula-2 scope operator
16571 (@code{.}) and the @value{GDBN} scope operator (@code{::}). The two have
16576 @var{module} . @var{id}
16577 @var{scope} :: @var{id}
16581 where @var{scope} is the name of a module or a procedure,
16582 @var{module} the name of a module, and @var{id} is any declared
16583 identifier within your program, except another module.
16585 Using the @code{::} operator makes @value{GDBN} search the scope
16586 specified by @var{scope} for the identifier @var{id}. If it is not
16587 found in the specified scope, then @value{GDBN} searches all scopes
16588 enclosing the one specified by @var{scope}.
16590 Using the @code{.} operator makes @value{GDBN} search the current scope for
16591 the identifier specified by @var{id} that was imported from the
16592 definition module specified by @var{module}. With this operator, it is
16593 an error if the identifier @var{id} was not imported from definition
16594 module @var{module}, or if @var{id} is not an identifier in
16598 @subsubsection @value{GDBN} and Modula-2
16600 Some @value{GDBN} commands have little use when debugging Modula-2 programs.
16601 Five subcommands of @code{set print} and @code{show print} apply
16602 specifically to C and C@t{++}: @samp{vtbl}, @samp{demangle},
16603 @samp{asm-demangle}, @samp{object}, and @samp{union}. The first four
16604 apply to C@t{++}, and the last to the C @code{union} type, which has no direct
16605 analogue in Modula-2.
16607 The @code{@@} operator (@pxref{Expressions, ,Expressions}), while available
16608 with any language, is not useful with Modula-2. Its
16609 intent is to aid the debugging of @dfn{dynamic arrays}, which cannot be
16610 created in Modula-2 as they can in C or C@t{++}. However, because an
16611 address can be specified by an integral constant, the construct
16612 @samp{@{@var{type}@}@var{adrexp}} is still useful.
16614 @cindex @code{#} in Modula-2
16615 In @value{GDBN} scripts, the Modula-2 inequality operator @code{#} is
16616 interpreted as the beginning of a comment. Use @code{<>} instead.
16622 The extensions made to @value{GDBN} for Ada only support
16623 output from the @sc{gnu} Ada (GNAT) compiler.
16624 Other Ada compilers are not currently supported, and
16625 attempting to debug executables produced by them is most likely
16629 @cindex expressions in Ada
16631 * Ada Mode Intro:: General remarks on the Ada syntax
16632 and semantics supported by Ada mode
16634 * Omissions from Ada:: Restrictions on the Ada expression syntax.
16635 * Additions to Ada:: Extensions of the Ada expression syntax.
16636 * Overloading support for Ada:: Support for expressions involving overloaded
16638 * Stopping Before Main Program:: Debugging the program during elaboration.
16639 * Ada Exceptions:: Ada Exceptions
16640 * Ada Tasks:: Listing and setting breakpoints in tasks.
16641 * Ada Tasks and Core Files:: Tasking Support when Debugging Core Files
16642 * Ravenscar Profile:: Tasking Support when using the Ravenscar
16644 * Ada Settings:: New settable GDB parameters for Ada.
16645 * Ada Glitches:: Known peculiarities of Ada mode.
16648 @node Ada Mode Intro
16649 @subsubsection Introduction
16650 @cindex Ada mode, general
16652 The Ada mode of @value{GDBN} supports a fairly large subset of Ada expression
16653 syntax, with some extensions.
16654 The philosophy behind the design of this subset is
16658 That @value{GDBN} should provide basic literals and access to operations for
16659 arithmetic, dereferencing, field selection, indexing, and subprogram calls,
16660 leaving more sophisticated computations to subprograms written into the
16661 program (which therefore may be called from @value{GDBN}).
16664 That type safety and strict adherence to Ada language restrictions
16665 are not particularly important to the @value{GDBN} user.
16668 That brevity is important to the @value{GDBN} user.
16671 Thus, for brevity, the debugger acts as if all names declared in
16672 user-written packages are directly visible, even if they are not visible
16673 according to Ada rules, thus making it unnecessary to fully qualify most
16674 names with their packages, regardless of context. Where this causes
16675 ambiguity, @value{GDBN} asks the user's intent.
16677 The debugger will start in Ada mode if it detects an Ada main program.
16678 As for other languages, it will enter Ada mode when stopped in a program that
16679 was translated from an Ada source file.
16681 While in Ada mode, you may use `@t{--}' for comments. This is useful
16682 mostly for documenting command files. The standard @value{GDBN} comment
16683 (@samp{#}) still works at the beginning of a line in Ada mode, but not in the
16684 middle (to allow based literals).
16686 @node Omissions from Ada
16687 @subsubsection Omissions from Ada
16688 @cindex Ada, omissions from
16690 Here are the notable omissions from the subset:
16694 Only a subset of the attributes are supported:
16698 @t{'First}, @t{'Last}, and @t{'Length}
16699 on array objects (not on types and subtypes).
16702 @t{'Min} and @t{'Max}.
16705 @t{'Pos} and @t{'Val}.
16711 @t{'Range} on array objects (not subtypes), but only as the right
16712 operand of the membership (@code{in}) operator.
16715 @t{'Access}, @t{'Unchecked_Access}, and
16716 @t{'Unrestricted_Access} (a GNAT extension).
16724 @code{Characters.Latin_1} are not available and
16725 concatenation is not implemented. Thus, escape characters in strings are
16726 not currently available.
16729 Equality tests (@samp{=} and @samp{/=}) on arrays test for bitwise
16730 equality of representations. They will generally work correctly
16731 for strings and arrays whose elements have integer or enumeration types.
16732 They may not work correctly for arrays whose element
16733 types have user-defined equality, for arrays of real values
16734 (in particular, IEEE-conformant floating point, because of negative
16735 zeroes and NaNs), and for arrays whose elements contain unused bits with
16736 indeterminate values.
16739 The other component-by-component array operations (@code{and}, @code{or},
16740 @code{xor}, @code{not}, and relational tests other than equality)
16741 are not implemented.
16744 @cindex array aggregates (Ada)
16745 @cindex record aggregates (Ada)
16746 @cindex aggregates (Ada)
16747 There is limited support for array and record aggregates. They are
16748 permitted only on the right sides of assignments, as in these examples:
16751 (@value{GDBP}) set An_Array := (1, 2, 3, 4, 5, 6)
16752 (@value{GDBP}) set An_Array := (1, others => 0)
16753 (@value{GDBP}) set An_Array := (0|4 => 1, 1..3 => 2, 5 => 6)
16754 (@value{GDBP}) set A_2D_Array := ((1, 2, 3), (4, 5, 6), (7, 8, 9))
16755 (@value{GDBP}) set A_Record := (1, "Peter", True);
16756 (@value{GDBP}) set A_Record := (Name => "Peter", Id => 1, Alive => True)
16760 discriminant's value by assigning an aggregate has an
16761 undefined effect if that discriminant is used within the record.
16762 However, you can first modify discriminants by directly assigning to
16763 them (which normally would not be allowed in Ada), and then performing an
16764 aggregate assignment. For example, given a variable @code{A_Rec}
16765 declared to have a type such as:
16768 type Rec (Len : Small_Integer := 0) is record
16770 Vals : IntArray (1 .. Len);
16774 you can assign a value with a different size of @code{Vals} with two
16778 (@value{GDBP}) set A_Rec.Len := 4
16779 (@value{GDBP}) set A_Rec := (Id => 42, Vals => (1, 2, 3, 4))
16782 As this example also illustrates, @value{GDBN} is very loose about the usual
16783 rules concerning aggregates. You may leave out some of the
16784 components of an array or record aggregate (such as the @code{Len}
16785 component in the assignment to @code{A_Rec} above); they will retain their
16786 original values upon assignment. You may freely use dynamic values as
16787 indices in component associations. You may even use overlapping or
16788 redundant component associations, although which component values are
16789 assigned in such cases is not defined.
16792 Calls to dispatching subprograms are not implemented.
16795 The overloading algorithm is much more limited (i.e., less selective)
16796 than that of real Ada. It makes only limited use of the context in
16797 which a subexpression appears to resolve its meaning, and it is much
16798 looser in its rules for allowing type matches. As a result, some
16799 function calls will be ambiguous, and the user will be asked to choose
16800 the proper resolution.
16803 The @code{new} operator is not implemented.
16806 Entry calls are not implemented.
16809 Aside from printing, arithmetic operations on the native VAX floating-point
16810 formats are not supported.
16813 It is not possible to slice a packed array.
16816 The names @code{True} and @code{False}, when not part of a qualified name,
16817 are interpreted as if implicitly prefixed by @code{Standard}, regardless of
16819 Should your program
16820 redefine these names in a package or procedure (at best a dubious practice),
16821 you will have to use fully qualified names to access their new definitions.
16824 @node Additions to Ada
16825 @subsubsection Additions to Ada
16826 @cindex Ada, deviations from
16828 As it does for other languages, @value{GDBN} makes certain generic
16829 extensions to Ada (@pxref{Expressions}):
16833 If the expression @var{E} is a variable residing in memory (typically
16834 a local variable or array element) and @var{N} is a positive integer,
16835 then @code{@var{E}@@@var{N}} displays the values of @var{E} and the
16836 @var{N}-1 adjacent variables following it in memory as an array. In
16837 Ada, this operator is generally not necessary, since its prime use is
16838 in displaying parts of an array, and slicing will usually do this in
16839 Ada. However, there are occasional uses when debugging programs in
16840 which certain debugging information has been optimized away.
16843 @code{@var{B}::@var{var}} means ``the variable named @var{var} that
16844 appears in function or file @var{B}.'' When @var{B} is a file name,
16845 you must typically surround it in single quotes.
16848 The expression @code{@{@var{type}@} @var{addr}} means ``the variable of type
16849 @var{type} that appears at address @var{addr}.''
16852 A name starting with @samp{$} is a convenience variable
16853 (@pxref{Convenience Vars}) or a machine register (@pxref{Registers}).
16856 In addition, @value{GDBN} provides a few other shortcuts and outright
16857 additions specific to Ada:
16861 The assignment statement is allowed as an expression, returning
16862 its right-hand operand as its value. Thus, you may enter
16865 (@value{GDBP}) set x := y + 3
16866 (@value{GDBP}) print A(tmp := y + 1)
16870 The semicolon is allowed as an ``operator,'' returning as its value
16871 the value of its right-hand operand.
16872 This allows, for example,
16873 complex conditional breaks:
16876 (@value{GDBP}) break f
16877 (@value{GDBP}) condition 1 (report(i); k += 1; A(k) > 100)
16881 Rather than use catenation and symbolic character names to introduce special
16882 characters into strings, one may instead use a special bracket notation,
16883 which is also used to print strings. A sequence of characters of the form
16884 @samp{["@var{XX}"]} within a string or character literal denotes the
16885 (single) character whose numeric encoding is @var{XX} in hexadecimal. The
16886 sequence of characters @samp{["""]} also denotes a single quotation mark
16887 in strings. For example,
16889 "One line.["0a"]Next line.["0a"]"
16892 contains an ASCII newline character (@code{Ada.Characters.Latin_1.LF})
16896 The subtype used as a prefix for the attributes @t{'Pos}, @t{'Min}, and
16897 @t{'Max} is optional (and is ignored in any case). For example, it is valid
16901 (@value{GDBP}) print 'max(x, y)
16905 When printing arrays, @value{GDBN} uses positional notation when the
16906 array has a lower bound of 1, and uses a modified named notation otherwise.
16907 For example, a one-dimensional array of three integers with a lower bound
16908 of 3 might print as
16915 That is, in contrast to valid Ada, only the first component has a @code{=>}
16919 You may abbreviate attributes in expressions with any unique,
16920 multi-character subsequence of
16921 their names (an exact match gets preference).
16922 For example, you may use @t{a'len}, @t{a'gth}, or @t{a'lh}
16923 in place of @t{a'length}.
16926 @cindex quoting Ada internal identifiers
16927 Since Ada is case-insensitive, the debugger normally maps identifiers you type
16928 to lower case. The GNAT compiler uses upper-case characters for
16929 some of its internal identifiers, which are normally of no interest to users.
16930 For the rare occasions when you actually have to look at them,
16931 enclose them in angle brackets to avoid the lower-case mapping.
16934 (@value{GDBP}) print <JMPBUF_SAVE>[0]
16938 Printing an object of class-wide type or dereferencing an
16939 access-to-class-wide value will display all the components of the object's
16940 specific type (as indicated by its run-time tag). Likewise, component
16941 selection on such a value will operate on the specific type of the
16946 @node Overloading support for Ada
16947 @subsubsection Overloading support for Ada
16948 @cindex overloading, Ada
16950 The debugger supports limited overloading. Given a subprogram call in which
16951 the function symbol has multiple definitions, it will use the number of
16952 actual parameters and some information about their types to attempt to narrow
16953 the set of definitions. It also makes very limited use of context, preferring
16954 procedures to functions in the context of the @code{call} command, and
16955 functions to procedures elsewhere.
16957 If, after narrowing, the set of matching definitions still contains more than
16958 one definition, @value{GDBN} will display a menu to query which one it should
16962 (@value{GDBP}) print f(1)
16963 Multiple matches for f
16965 [1] foo.f (integer) return boolean at foo.adb:23
16966 [2] foo.f (foo.new_integer) return boolean at foo.adb:28
16970 In this case, just select one menu entry either to cancel expression evaluation
16971 (type @kbd{0} and press @key{RET}) or to continue evaluation with a specific
16972 instance (type the corresponding number and press @key{RET}).
16974 Here are a couple of commands to customize @value{GDBN}'s behavior in this
16979 @kindex set ada print-signatures
16980 @item set ada print-signatures
16981 Control whether parameter types and return types are displayed in overloads
16982 selection menus. It is @code{on} by default.
16983 @xref{Overloading support for Ada}.
16985 @kindex show ada print-signatures
16986 @item show ada print-signatures
16987 Show the current setting for displaying parameter types and return types in
16988 overloads selection menu.
16989 @xref{Overloading support for Ada}.
16993 @node Stopping Before Main Program
16994 @subsubsection Stopping at the Very Beginning
16996 @cindex breakpointing Ada elaboration code
16997 It is sometimes necessary to debug the program during elaboration, and
16998 before reaching the main procedure.
16999 As defined in the Ada Reference
17000 Manual, the elaboration code is invoked from a procedure called
17001 @code{adainit}. To run your program up to the beginning of
17002 elaboration, simply use the following two commands:
17003 @code{tbreak adainit} and @code{run}.
17005 @node Ada Exceptions
17006 @subsubsection Ada Exceptions
17008 A command is provided to list all Ada exceptions:
17011 @kindex info exceptions
17012 @item info exceptions
17013 @itemx info exceptions @var{regexp}
17014 The @code{info exceptions} command allows you to list all Ada exceptions
17015 defined within the program being debugged, as well as their addresses.
17016 With a regular expression, @var{regexp}, as argument, only those exceptions
17017 whose names match @var{regexp} are listed.
17020 Below is a small example, showing how the command can be used, first
17021 without argument, and next with a regular expression passed as an
17025 (@value{GDBP}) info exceptions
17026 All defined Ada exceptions:
17027 constraint_error: 0x613da0
17028 program_error: 0x613d20
17029 storage_error: 0x613ce0
17030 tasking_error: 0x613ca0
17031 const.aint_global_e: 0x613b00
17032 (@value{GDBP}) info exceptions const.aint
17033 All Ada exceptions matching regular expression "const.aint":
17034 constraint_error: 0x613da0
17035 const.aint_global_e: 0x613b00
17038 It is also possible to ask @value{GDBN} to stop your program's execution
17039 when an exception is raised. For more details, see @ref{Set Catchpoints}.
17042 @subsubsection Extensions for Ada Tasks
17043 @cindex Ada, tasking
17045 Support for Ada tasks is analogous to that for threads (@pxref{Threads}).
17046 @value{GDBN} provides the following task-related commands:
17051 This command shows a list of current Ada tasks, as in the following example:
17058 (@value{GDBP}) info tasks
17059 ID TID P-ID Pri State Name
17060 1 8088000 0 15 Child Activation Wait main_task
17061 2 80a4000 1 15 Accept Statement b
17062 3 809a800 1 15 Child Activation Wait a
17063 * 4 80ae800 3 15 Runnable c
17068 In this listing, the asterisk before the last task indicates it to be the
17069 task currently being inspected.
17073 Represents @value{GDBN}'s internal task number.
17079 The parent's task ID (@value{GDBN}'s internal task number).
17082 The base priority of the task.
17085 Current state of the task.
17089 The task has been created but has not been activated. It cannot be
17093 The task is not blocked for any reason known to Ada. (It may be waiting
17094 for a mutex, though.) It is conceptually "executing" in normal mode.
17097 The task is terminated, in the sense of ARM 9.3 (5). Any dependents
17098 that were waiting on terminate alternatives have been awakened and have
17099 terminated themselves.
17101 @item Child Activation Wait
17102 The task is waiting for created tasks to complete activation.
17104 @item Accept Statement
17105 The task is waiting on an accept or selective wait statement.
17107 @item Waiting on entry call
17108 The task is waiting on an entry call.
17110 @item Async Select Wait
17111 The task is waiting to start the abortable part of an asynchronous
17115 The task is waiting on a select statement with only a delay
17118 @item Child Termination Wait
17119 The task is sleeping having completed a master within itself, and is
17120 waiting for the tasks dependent on that master to become terminated or
17121 waiting on a terminate Phase.
17123 @item Wait Child in Term Alt
17124 The task is sleeping waiting for tasks on terminate alternatives to
17125 finish terminating.
17127 @item Accepting RV with @var{taskno}
17128 The task is accepting a rendez-vous with the task @var{taskno}.
17132 Name of the task in the program.
17136 @kindex info task @var{taskno}
17137 @item info task @var{taskno}
17138 This command shows detailled informations on the specified task, as in
17139 the following example:
17144 (@value{GDBP}) info tasks
17145 ID TID P-ID Pri State Name
17146 1 8077880 0 15 Child Activation Wait main_task
17147 * 2 807c468 1 15 Runnable task_1
17148 (@value{GDBP}) info task 2
17149 Ada Task: 0x807c468
17153 Parent: 1 (main_task)
17159 @kindex task@r{ (Ada)}
17160 @cindex current Ada task ID
17161 This command prints the ID of the current task.
17167 (@value{GDBP}) info tasks
17168 ID TID P-ID Pri State Name
17169 1 8077870 0 15 Child Activation Wait main_task
17170 * 2 807c458 1 15 Runnable t
17171 (@value{GDBP}) task
17172 [Current task is 2]
17175 @item task @var{taskno}
17176 @cindex Ada task switching
17177 This command is like the @code{thread @var{thread-id}}
17178 command (@pxref{Threads}). It switches the context of debugging
17179 from the current task to the given task.
17185 (@value{GDBP}) info tasks
17186 ID TID P-ID Pri State Name
17187 1 8077870 0 15 Child Activation Wait main_task
17188 * 2 807c458 1 15 Runnable t
17189 (@value{GDBP}) task 1
17190 [Switching to task 1]
17191 #0 0x8067726 in pthread_cond_wait ()
17193 #0 0x8067726 in pthread_cond_wait ()
17194 #1 0x8056714 in system.os_interface.pthread_cond_wait ()
17195 #2 0x805cb63 in system.task_primitives.operations.sleep ()
17196 #3 0x806153e in system.tasking.stages.activate_tasks ()
17197 #4 0x804aacc in un () at un.adb:5
17200 @item break @var{location} task @var{taskno}
17201 @itemx break @var{location} task @var{taskno} if @dots{}
17202 @cindex breakpoints and tasks, in Ada
17203 @cindex task breakpoints, in Ada
17204 @kindex break @dots{} task @var{taskno}@r{ (Ada)}
17205 These commands are like the @code{break @dots{} thread @dots{}}
17206 command (@pxref{Thread Stops}). The
17207 @var{location} argument specifies source lines, as described
17208 in @ref{Specify Location}.
17210 Use the qualifier @samp{task @var{taskno}} with a breakpoint command
17211 to specify that you only want @value{GDBN} to stop the program when a
17212 particular Ada task reaches this breakpoint. The @var{taskno} is one of the
17213 numeric task identifiers assigned by @value{GDBN}, shown in the first
17214 column of the @samp{info tasks} display.
17216 If you do not specify @samp{task @var{taskno}} when you set a
17217 breakpoint, the breakpoint applies to @emph{all} tasks of your
17220 You can use the @code{task} qualifier on conditional breakpoints as
17221 well; in this case, place @samp{task @var{taskno}} before the
17222 breakpoint condition (before the @code{if}).
17230 (@value{GDBP}) info tasks
17231 ID TID P-ID Pri State Name
17232 1 140022020 0 15 Child Activation Wait main_task
17233 2 140045060 1 15 Accept/Select Wait t2
17234 3 140044840 1 15 Runnable t1
17235 * 4 140056040 1 15 Runnable t3
17236 (@value{GDBP}) b 15 task 2
17237 Breakpoint 5 at 0x120044cb0: file test_task_debug.adb, line 15.
17238 (@value{GDBP}) cont
17243 Breakpoint 5, test_task_debug () at test_task_debug.adb:15
17245 (@value{GDBP}) info tasks
17246 ID TID P-ID Pri State Name
17247 1 140022020 0 15 Child Activation Wait main_task
17248 * 2 140045060 1 15 Runnable t2
17249 3 140044840 1 15 Runnable t1
17250 4 140056040 1 15 Delay Sleep t3
17254 @node Ada Tasks and Core Files
17255 @subsubsection Tasking Support when Debugging Core Files
17256 @cindex Ada tasking and core file debugging
17258 When inspecting a core file, as opposed to debugging a live program,
17259 tasking support may be limited or even unavailable, depending on
17260 the platform being used.
17261 For instance, on x86-linux, the list of tasks is available, but task
17262 switching is not supported.
17264 On certain platforms, the debugger needs to perform some
17265 memory writes in order to provide Ada tasking support. When inspecting
17266 a core file, this means that the core file must be opened with read-write
17267 privileges, using the command @samp{"set write on"} (@pxref{Patching}).
17268 Under these circumstances, you should make a backup copy of the core
17269 file before inspecting it with @value{GDBN}.
17271 @node Ravenscar Profile
17272 @subsubsection Tasking Support when using the Ravenscar Profile
17273 @cindex Ravenscar Profile
17275 The @dfn{Ravenscar Profile} is a subset of the Ada tasking features,
17276 specifically designed for systems with safety-critical real-time
17280 @kindex set ravenscar task-switching on
17281 @cindex task switching with program using Ravenscar Profile
17282 @item set ravenscar task-switching on
17283 Allows task switching when debugging a program that uses the Ravenscar
17284 Profile. This is the default.
17286 @kindex set ravenscar task-switching off
17287 @item set ravenscar task-switching off
17288 Turn off task switching when debugging a program that uses the Ravenscar
17289 Profile. This is mostly intended to disable the code that adds support
17290 for the Ravenscar Profile, in case a bug in either @value{GDBN} or in
17291 the Ravenscar runtime is preventing @value{GDBN} from working properly.
17292 To be effective, this command should be run before the program is started.
17294 @kindex show ravenscar task-switching
17295 @item show ravenscar task-switching
17296 Show whether it is possible to switch from task to task in a program
17297 using the Ravenscar Profile.
17302 @subsubsection Ada Settings
17303 @cindex Ada settings
17306 @kindex set varsize-limit
17307 @item set varsize-limit @var{size}
17308 Prevent @value{GDBN} from attempting to evaluate objects whose size
17309 is above the given limit (@var{size}) when those sizes are computed
17310 from run-time quantities. This is typically the case when the object
17311 has a variable size, such as an array whose bounds are not known at
17312 compile time for example. Setting @var{size} to @code{unlimited}
17313 removes the size limitation. By default, the limit is about 65KB.
17315 The purpose of having such a limit is to prevent @value{GDBN} from
17316 trying to grab enormous chunks of virtual memory when asked to evaluate
17317 a quantity whose bounds have been corrupted or have not yet been fully
17318 initialized. The limit applies to the results of some subexpressions
17319 as well as to complete expressions. For example, an expression denoting
17320 a simple integer component, such as @code{x.y.z}, may fail if the size of
17321 @code{x.y} is variable and exceeds @code{size}. On the other hand,
17322 @value{GDBN} is sometimes clever; the expression @code{A(i)}, where
17323 @code{A} is an array variable with non-constant size, will generally
17324 succeed regardless of the bounds on @code{A}, as long as the component
17325 size is less than @var{size}.
17327 @kindex show varsize-limit
17328 @item show varsize-limit
17329 Show the limit on types whose size is determined by run-time quantities.
17333 @subsubsection Known Peculiarities of Ada Mode
17334 @cindex Ada, problems
17336 Besides the omissions listed previously (@pxref{Omissions from Ada}),
17337 we know of several problems with and limitations of Ada mode in
17339 some of which will be fixed with planned future releases of the debugger
17340 and the GNU Ada compiler.
17344 Static constants that the compiler chooses not to materialize as objects in
17345 storage are invisible to the debugger.
17348 Named parameter associations in function argument lists are ignored (the
17349 argument lists are treated as positional).
17352 Many useful library packages are currently invisible to the debugger.
17355 Fixed-point arithmetic, conversions, input, and output is carried out using
17356 floating-point arithmetic, and may give results that only approximate those on
17360 The GNAT compiler never generates the prefix @code{Standard} for any of
17361 the standard symbols defined by the Ada language. @value{GDBN} knows about
17362 this: it will strip the prefix from names when you use it, and will never
17363 look for a name you have so qualified among local symbols, nor match against
17364 symbols in other packages or subprograms. If you have
17365 defined entities anywhere in your program other than parameters and
17366 local variables whose simple names match names in @code{Standard},
17367 GNAT's lack of qualification here can cause confusion. When this happens,
17368 you can usually resolve the confusion
17369 by qualifying the problematic names with package
17370 @code{Standard} explicitly.
17373 Older versions of the compiler sometimes generate erroneous debugging
17374 information, resulting in the debugger incorrectly printing the value
17375 of affected entities. In some cases, the debugger is able to work
17376 around an issue automatically. In other cases, the debugger is able
17377 to work around the issue, but the work-around has to be specifically
17380 @kindex set ada trust-PAD-over-XVS
17381 @kindex show ada trust-PAD-over-XVS
17384 @item set ada trust-PAD-over-XVS on
17385 Configure GDB to strictly follow the GNAT encoding when computing the
17386 value of Ada entities, particularly when @code{PAD} and @code{PAD___XVS}
17387 types are involved (see @code{ada/exp_dbug.ads} in the GCC sources for
17388 a complete description of the encoding used by the GNAT compiler).
17389 This is the default.
17391 @item set ada trust-PAD-over-XVS off
17392 This is related to the encoding using by the GNAT compiler. If @value{GDBN}
17393 sometimes prints the wrong value for certain entities, changing @code{ada
17394 trust-PAD-over-XVS} to @code{off} activates a work-around which may fix
17395 the issue. It is always safe to set @code{ada trust-PAD-over-XVS} to
17396 @code{off}, but this incurs a slight performance penalty, so it is
17397 recommended to leave this setting to @code{on} unless necessary.
17401 @cindex GNAT descriptive types
17402 @cindex GNAT encoding
17403 Internally, the debugger also relies on the compiler following a number
17404 of conventions known as the @samp{GNAT Encoding}, all documented in
17405 @file{gcc/ada/exp_dbug.ads} in the GCC sources. This encoding describes
17406 how the debugging information should be generated for certain types.
17407 In particular, this convention makes use of @dfn{descriptive types},
17408 which are artificial types generated purely to help the debugger.
17410 These encodings were defined at a time when the debugging information
17411 format used was not powerful enough to describe some of the more complex
17412 types available in Ada. Since DWARF allows us to express nearly all
17413 Ada features, the long-term goal is to slowly replace these descriptive
17414 types by their pure DWARF equivalent. To facilitate that transition,
17415 a new maintenance option is available to force the debugger to ignore
17416 those descriptive types. It allows the user to quickly evaluate how
17417 well @value{GDBN} works without them.
17421 @kindex maint ada set ignore-descriptive-types
17422 @item maintenance ada set ignore-descriptive-types [on|off]
17423 Control whether the debugger should ignore descriptive types.
17424 The default is not to ignore descriptives types (@code{off}).
17426 @kindex maint ada show ignore-descriptive-types
17427 @item maintenance ada show ignore-descriptive-types
17428 Show if descriptive types are ignored by @value{GDBN}.
17432 @node Unsupported Languages
17433 @section Unsupported Languages
17435 @cindex unsupported languages
17436 @cindex minimal language
17437 In addition to the other fully-supported programming languages,
17438 @value{GDBN} also provides a pseudo-language, called @code{minimal}.
17439 It does not represent a real programming language, but provides a set
17440 of capabilities close to what the C or assembly languages provide.
17441 This should allow most simple operations to be performed while debugging
17442 an application that uses a language currently not supported by @value{GDBN}.
17444 If the language is set to @code{auto}, @value{GDBN} will automatically
17445 select this language if the current frame corresponds to an unsupported
17449 @chapter Examining the Symbol Table
17451 The commands described in this chapter allow you to inquire about the
17452 symbols (names of variables, functions and types) defined in your
17453 program. This information is inherent in the text of your program and
17454 does not change as your program executes. @value{GDBN} finds it in your
17455 program's symbol table, in the file indicated when you started @value{GDBN}
17456 (@pxref{File Options, ,Choosing Files}), or by one of the
17457 file-management commands (@pxref{Files, ,Commands to Specify Files}).
17459 @cindex symbol names
17460 @cindex names of symbols
17461 @cindex quoting names
17462 @anchor{quoting names}
17463 Occasionally, you may need to refer to symbols that contain unusual
17464 characters, which @value{GDBN} ordinarily treats as word delimiters. The
17465 most frequent case is in referring to static variables in other
17466 source files (@pxref{Variables,,Program Variables}). File names
17467 are recorded in object files as debugging symbols, but @value{GDBN} would
17468 ordinarily parse a typical file name, like @file{foo.c}, as the three words
17469 @samp{foo} @samp{.} @samp{c}. To allow @value{GDBN} to recognize
17470 @samp{foo.c} as a single symbol, enclose it in single quotes; for example,
17477 looks up the value of @code{x} in the scope of the file @file{foo.c}.
17480 @cindex case-insensitive symbol names
17481 @cindex case sensitivity in symbol names
17482 @kindex set case-sensitive
17483 @item set case-sensitive on
17484 @itemx set case-sensitive off
17485 @itemx set case-sensitive auto
17486 Normally, when @value{GDBN} looks up symbols, it matches their names
17487 with case sensitivity determined by the current source language.
17488 Occasionally, you may wish to control that. The command @code{set
17489 case-sensitive} lets you do that by specifying @code{on} for
17490 case-sensitive matches or @code{off} for case-insensitive ones. If
17491 you specify @code{auto}, case sensitivity is reset to the default
17492 suitable for the source language. The default is case-sensitive
17493 matches for all languages except for Fortran, for which the default is
17494 case-insensitive matches.
17496 @kindex show case-sensitive
17497 @item show case-sensitive
17498 This command shows the current setting of case sensitivity for symbols
17501 @kindex set print type methods
17502 @item set print type methods
17503 @itemx set print type methods on
17504 @itemx set print type methods off
17505 Normally, when @value{GDBN} prints a class, it displays any methods
17506 declared in that class. You can control this behavior either by
17507 passing the appropriate flag to @code{ptype}, or using @command{set
17508 print type methods}. Specifying @code{on} will cause @value{GDBN} to
17509 display the methods; this is the default. Specifying @code{off} will
17510 cause @value{GDBN} to omit the methods.
17512 @kindex show print type methods
17513 @item show print type methods
17514 This command shows the current setting of method display when printing
17517 @kindex set print type nested-type-limit
17518 @item set print type nested-type-limit @var{limit}
17519 @itemx set print type nested-type-limit unlimited
17520 Set the limit of displayed nested types that the type printer will
17521 show. A @var{limit} of @code{unlimited} or @code{-1} will show all
17522 nested definitions. By default, the type printer will not show any nested
17523 types defined in classes.
17525 @kindex show print type nested-type-limit
17526 @item show print type nested-type-limit
17527 This command shows the current display limit of nested types when
17530 @kindex set print type typedefs
17531 @item set print type typedefs
17532 @itemx set print type typedefs on
17533 @itemx set print type typedefs off
17535 Normally, when @value{GDBN} prints a class, it displays any typedefs
17536 defined in that class. You can control this behavior either by
17537 passing the appropriate flag to @code{ptype}, or using @command{set
17538 print type typedefs}. Specifying @code{on} will cause @value{GDBN} to
17539 display the typedef definitions; this is the default. Specifying
17540 @code{off} will cause @value{GDBN} to omit the typedef definitions.
17541 Note that this controls whether the typedef definition itself is
17542 printed, not whether typedef names are substituted when printing other
17545 @kindex show print type typedefs
17546 @item show print type typedefs
17547 This command shows the current setting of typedef display when
17550 @kindex info address
17551 @cindex address of a symbol
17552 @item info address @var{symbol}
17553 Describe where the data for @var{symbol} is stored. For a register
17554 variable, this says which register it is kept in. For a non-register
17555 local variable, this prints the stack-frame offset at which the variable
17558 Note the contrast with @samp{print &@var{symbol}}, which does not work
17559 at all for a register variable, and for a stack local variable prints
17560 the exact address of the current instantiation of the variable.
17562 @kindex info symbol
17563 @cindex symbol from address
17564 @cindex closest symbol and offset for an address
17565 @item info symbol @var{addr}
17566 Print the name of a symbol which is stored at the address @var{addr}.
17567 If no symbol is stored exactly at @var{addr}, @value{GDBN} prints the
17568 nearest symbol and an offset from it:
17571 (@value{GDBP}) info symbol 0x54320
17572 _initialize_vx + 396 in section .text
17576 This is the opposite of the @code{info address} command. You can use
17577 it to find out the name of a variable or a function given its address.
17579 For dynamically linked executables, the name of executable or shared
17580 library containing the symbol is also printed:
17583 (@value{GDBP}) info symbol 0x400225
17584 _start + 5 in section .text of /tmp/a.out
17585 (@value{GDBP}) info symbol 0x2aaaac2811cf
17586 __read_nocancel + 6 in section .text of /usr/lib64/libc.so.6
17591 @item demangle @r{[}-l @var{language}@r{]} @r{[}@var{--}@r{]} @var{name}
17592 Demangle @var{name}.
17593 If @var{language} is provided it is the name of the language to demangle
17594 @var{name} in. Otherwise @var{name} is demangled in the current language.
17596 The @samp{--} option specifies the end of options,
17597 and is useful when @var{name} begins with a dash.
17599 The parameter @code{demangle-style} specifies how to interpret the kind
17600 of mangling used. @xref{Print Settings}.
17603 @item whatis[/@var{flags}] [@var{arg}]
17604 Print the data type of @var{arg}, which can be either an expression
17605 or a name of a data type. With no argument, print the data type of
17606 @code{$}, the last value in the value history.
17608 If @var{arg} is an expression (@pxref{Expressions, ,Expressions}), it
17609 is not actually evaluated, and any side-effecting operations (such as
17610 assignments or function calls) inside it do not take place.
17612 If @var{arg} is a variable or an expression, @code{whatis} prints its
17613 literal type as it is used in the source code. If the type was
17614 defined using a @code{typedef}, @code{whatis} will @emph{not} print
17615 the data type underlying the @code{typedef}. If the type of the
17616 variable or the expression is a compound data type, such as
17617 @code{struct} or @code{class}, @code{whatis} never prints their
17618 fields or methods. It just prints the @code{struct}/@code{class}
17619 name (a.k.a.@: its @dfn{tag}). If you want to see the members of
17620 such a compound data type, use @code{ptype}.
17622 If @var{arg} is a type name that was defined using @code{typedef},
17623 @code{whatis} @dfn{unrolls} only one level of that @code{typedef}.
17624 Unrolling means that @code{whatis} will show the underlying type used
17625 in the @code{typedef} declaration of @var{arg}. However, if that
17626 underlying type is also a @code{typedef}, @code{whatis} will not
17629 For C code, the type names may also have the form @samp{class
17630 @var{class-name}}, @samp{struct @var{struct-tag}}, @samp{union
17631 @var{union-tag}} or @samp{enum @var{enum-tag}}.
17633 @var{flags} can be used to modify how the type is displayed.
17634 Available flags are:
17638 Display in ``raw'' form. Normally, @value{GDBN} substitutes template
17639 parameters and typedefs defined in a class when printing the class'
17640 members. The @code{/r} flag disables this.
17643 Do not print methods defined in the class.
17646 Print methods defined in the class. This is the default, but the flag
17647 exists in case you change the default with @command{set print type methods}.
17650 Do not print typedefs defined in the class. Note that this controls
17651 whether the typedef definition itself is printed, not whether typedef
17652 names are substituted when printing other types.
17655 Print typedefs defined in the class. This is the default, but the flag
17656 exists in case you change the default with @command{set print type typedefs}.
17659 Print the offsets and sizes of fields in a struct, similar to what the
17660 @command{pahole} tool does. This option implies the @code{/tm} flags.
17662 For example, given the following declarations:
17698 Issuing a @kbd{ptype /o struct tuv} command would print:
17701 (@value{GDBP}) ptype /o struct tuv
17702 /* offset | size */ type = struct tuv @{
17703 /* 0 | 4 */ int a1;
17704 /* XXX 4-byte hole */
17705 /* 8 | 8 */ char *a2;
17706 /* 16 | 4 */ int a3;
17708 /* total size (bytes): 24 */
17712 Notice the format of the first column of comments. There, you can
17713 find two parts separated by the @samp{|} character: the @emph{offset},
17714 which indicates where the field is located inside the struct, in
17715 bytes, and the @emph{size} of the field. Another interesting line is
17716 the marker of a @emph{hole} in the struct, indicating that it may be
17717 possible to pack the struct and make it use less space by reorganizing
17720 It is also possible to print offsets inside an union:
17723 (@value{GDBP}) ptype /o union qwe
17724 /* offset | size */ type = union qwe @{
17725 /* 24 */ struct tuv @{
17726 /* 0 | 4 */ int a1;
17727 /* XXX 4-byte hole */
17728 /* 8 | 8 */ char *a2;
17729 /* 16 | 4 */ int a3;
17731 /* total size (bytes): 24 */
17733 /* 40 */ struct xyz @{
17734 /* 0 | 4 */ int f1;
17735 /* 4 | 1 */ char f2;
17736 /* XXX 3-byte hole */
17737 /* 8 | 8 */ void *f3;
17738 /* 16 | 24 */ struct tuv @{
17739 /* 16 | 4 */ int a1;
17740 /* XXX 4-byte hole */
17741 /* 24 | 8 */ char *a2;
17742 /* 32 | 4 */ int a3;
17744 /* total size (bytes): 24 */
17747 /* total size (bytes): 40 */
17750 /* total size (bytes): 40 */
17754 In this case, since @code{struct tuv} and @code{struct xyz} occupy the
17755 same space (because we are dealing with an union), the offset is not
17756 printed for them. However, you can still examine the offset of each
17757 of these structures' fields.
17759 Another useful scenario is printing the offsets of a struct containing
17763 (@value{GDBP}) ptype /o struct tyu
17764 /* offset | size */ type = struct tyu @{
17765 /* 0:31 | 4 */ int a1 : 1;
17766 /* 0:28 | 4 */ int a2 : 3;
17767 /* 0: 5 | 4 */ int a3 : 23;
17768 /* 3: 3 | 1 */ signed char a4 : 2;
17769 /* XXX 3-bit hole */
17770 /* XXX 4-byte hole */
17771 /* 8 | 8 */ int64_t a5;
17772 /* 16:27 | 4 */ int a6 : 5;
17773 /* 16:56 | 8 */ int64_t a7 : 3;
17775 /* total size (bytes): 24 */
17779 Note how the offset information is now extended to also include how
17780 many bits are left to be used in each bitfield.
17784 @item ptype[/@var{flags}] [@var{arg}]
17785 @code{ptype} accepts the same arguments as @code{whatis}, but prints a
17786 detailed description of the type, instead of just the name of the type.
17787 @xref{Expressions, ,Expressions}.
17789 Contrary to @code{whatis}, @code{ptype} always unrolls any
17790 @code{typedef}s in its argument declaration, whether the argument is
17791 a variable, expression, or a data type. This means that @code{ptype}
17792 of a variable or an expression will not print literally its type as
17793 present in the source code---use @code{whatis} for that. @code{typedef}s at
17794 the pointer or reference targets are also unrolled. Only @code{typedef}s of
17795 fields, methods and inner @code{class typedef}s of @code{struct}s,
17796 @code{class}es and @code{union}s are not unrolled even with @code{ptype}.
17798 For example, for this variable declaration:
17801 typedef double real_t;
17802 struct complex @{ real_t real; double imag; @};
17803 typedef struct complex complex_t;
17805 real_t *real_pointer_var;
17809 the two commands give this output:
17813 (@value{GDBP}) whatis var
17815 (@value{GDBP}) ptype var
17816 type = struct complex @{
17820 (@value{GDBP}) whatis complex_t
17821 type = struct complex
17822 (@value{GDBP}) whatis struct complex
17823 type = struct complex
17824 (@value{GDBP}) ptype struct complex
17825 type = struct complex @{
17829 (@value{GDBP}) whatis real_pointer_var
17831 (@value{GDBP}) ptype real_pointer_var
17837 As with @code{whatis}, using @code{ptype} without an argument refers to
17838 the type of @code{$}, the last value in the value history.
17840 @cindex incomplete type
17841 Sometimes, programs use opaque data types or incomplete specifications
17842 of complex data structure. If the debug information included in the
17843 program does not allow @value{GDBN} to display a full declaration of
17844 the data type, it will say @samp{<incomplete type>}. For example,
17845 given these declarations:
17849 struct foo *fooptr;
17853 but no definition for @code{struct foo} itself, @value{GDBN} will say:
17856 (@value{GDBP}) ptype foo
17857 $1 = <incomplete type>
17861 ``Incomplete type'' is C terminology for data types that are not
17862 completely specified.
17864 @cindex unknown type
17865 Othertimes, information about a variable's type is completely absent
17866 from the debug information included in the program. This most often
17867 happens when the program or library where the variable is defined
17868 includes no debug information at all. @value{GDBN} knows the variable
17869 exists from inspecting the linker/loader symbol table (e.g., the ELF
17870 dynamic symbol table), but such symbols do not contain type
17871 information. Inspecting the type of a (global) variable for which
17872 @value{GDBN} has no type information shows:
17875 (@value{GDBP}) ptype var
17876 type = <data variable, no debug info>
17879 @xref{Variables, no debug info variables}, for how to print the values
17883 @item info types @var{regexp}
17885 Print a brief description of all types whose names match the regular
17886 expression @var{regexp} (or all types in your program, if you supply
17887 no argument). Each complete typename is matched as though it were a
17888 complete line; thus, @samp{i type value} gives information on all
17889 types in your program whose names include the string @code{value}, but
17890 @samp{i type ^value$} gives information only on types whose complete
17891 name is @code{value}.
17893 In programs using different languages, @value{GDBN} chooses the syntax
17894 to print the type description according to the
17895 @samp{set language} value: using @samp{set language auto}
17896 (see @ref{Automatically, ,Set Language Automatically}) means to use the
17897 language of the type, other values mean to use
17898 the manually specified language (see @ref{Manually, ,Set Language Manually}).
17900 This command differs from @code{ptype} in two ways: first, like
17901 @code{whatis}, it does not print a detailed description; second, it
17902 lists all source files and line numbers where a type is defined.
17904 @kindex info type-printers
17905 @item info type-printers
17906 Versions of @value{GDBN} that ship with Python scripting enabled may
17907 have ``type printers'' available. When using @command{ptype} or
17908 @command{whatis}, these printers are consulted when the name of a type
17909 is needed. @xref{Type Printing API}, for more information on writing
17912 @code{info type-printers} displays all the available type printers.
17914 @kindex enable type-printer
17915 @kindex disable type-printer
17916 @item enable type-printer @var{name}@dots{}
17917 @item disable type-printer @var{name}@dots{}
17918 These commands can be used to enable or disable type printers.
17921 @cindex local variables
17922 @item info scope @var{location}
17923 List all the variables local to a particular scope. This command
17924 accepts a @var{location} argument---a function name, a source line, or
17925 an address preceded by a @samp{*}, and prints all the variables local
17926 to the scope defined by that location. (@xref{Specify Location}, for
17927 details about supported forms of @var{location}.) For example:
17930 (@value{GDBP}) @b{info scope command_line_handler}
17931 Scope for command_line_handler:
17932 Symbol rl is an argument at stack/frame offset 8, length 4.
17933 Symbol linebuffer is in static storage at address 0x150a18, length 4.
17934 Symbol linelength is in static storage at address 0x150a1c, length 4.
17935 Symbol p is a local variable in register $esi, length 4.
17936 Symbol p1 is a local variable in register $ebx, length 4.
17937 Symbol nline is a local variable in register $edx, length 4.
17938 Symbol repeat is a local variable at frame offset -8, length 4.
17942 This command is especially useful for determining what data to collect
17943 during a @dfn{trace experiment}, see @ref{Tracepoint Actions,
17946 @kindex info source
17948 Show information about the current source file---that is, the source file for
17949 the function containing the current point of execution:
17952 the name of the source file, and the directory containing it,
17954 the directory it was compiled in,
17956 its length, in lines,
17958 which programming language it is written in,
17960 if the debug information provides it, the program that compiled the file
17961 (which may include, e.g., the compiler version and command line arguments),
17963 whether the executable includes debugging information for that file, and
17964 if so, what format the information is in (e.g., STABS, Dwarf 2, etc.), and
17966 whether the debugging information includes information about
17967 preprocessor macros.
17971 @kindex info sources
17973 Print the names of all source files in your program for which there is
17974 debugging information, organized into two lists: files whose symbols
17975 have already been read, and files whose symbols will be read when needed.
17977 @kindex info functions
17978 @item info functions [-q]
17979 Print the names and data types of all defined functions.
17980 Similarly to @samp{info types}, this command groups its output by source
17981 files and annotates each function definition with its source line
17984 In programs using different languages, @value{GDBN} chooses the syntax
17985 to print the function name and type according to the
17986 @samp{set language} value: using @samp{set language auto}
17987 (see @ref{Automatically, ,Set Language Automatically}) means to use the
17988 language of the function, other values mean to use
17989 the manually specified language (see @ref{Manually, ,Set Language Manually}).
17991 The optional flag @samp{-q}, which stands for @samp{quiet}, disables
17992 printing header information and messages explaining why no functions
17995 @item info functions [-q] [-t @var{type_regexp}] [@var{regexp}]
17996 Like @samp{info functions}, but only print the names and data types
17997 of the functions selected with the provided regexp(s).
17999 If @var{regexp} is provided, print only the functions whose names
18000 match the regular expression @var{regexp}.
18001 Thus, @samp{info fun step} finds all functions whose
18002 names include @code{step}; @samp{info fun ^step} finds those whose names
18003 start with @code{step}. If a function name contains characters that
18004 conflict with the regular expression language (e.g.@:
18005 @samp{operator*()}), they may be quoted with a backslash.
18007 If @var{type_regexp} is provided, print only the functions whose
18008 types, as printed by the @code{whatis} command, match
18009 the regular expression @var{type_regexp}.
18010 If @var{type_regexp} contains space(s), it should be enclosed in
18011 quote characters. If needed, use backslash to escape the meaning
18012 of special characters or quotes.
18013 Thus, @samp{info fun -t '^int ('} finds the functions that return
18014 an integer; @samp{info fun -t '(.*int.*'} finds the functions that
18015 have an argument type containing int; @samp{info fun -t '^int (' ^step}
18016 finds the functions whose names start with @code{step} and that return
18019 If both @var{regexp} and @var{type_regexp} are provided, a function
18020 is printed only if its name matches @var{regexp} and its type matches
18024 @kindex info variables
18025 @item info variables [-q]
18026 Print the names and data types of all variables that are defined
18027 outside of functions (i.e.@: excluding local variables).
18028 The printed variables are grouped by source files and annotated with
18029 their respective source line numbers.
18031 In programs using different languages, @value{GDBN} chooses the syntax
18032 to print the variable name and type according to the
18033 @samp{set language} value: using @samp{set language auto}
18034 (see @ref{Automatically, ,Set Language Automatically}) means to use the
18035 language of the variable, other values mean to use
18036 the manually specified language (see @ref{Manually, ,Set Language Manually}).
18038 The optional flag @samp{-q}, which stands for @samp{quiet}, disables
18039 printing header information and messages explaining why no variables
18042 @item info variables [-q] [-t @var{type_regexp}] [@var{regexp}]
18043 Like @kbd{info variables}, but only print the variables selected
18044 with the provided regexp(s).
18046 If @var{regexp} is provided, print only the variables whose names
18047 match the regular expression @var{regexp}.
18049 If @var{type_regexp} is provided, print only the variables whose
18050 types, as printed by the @code{whatis} command, match
18051 the regular expression @var{type_regexp}.
18052 If @var{type_regexp} contains space(s), it should be enclosed in
18053 quote characters. If needed, use backslash to escape the meaning
18054 of special characters or quotes.
18056 If both @var{regexp} and @var{type_regexp} are provided, an argument
18057 is printed only if its name matches @var{regexp} and its type matches
18060 @kindex info classes
18061 @cindex Objective-C, classes and selectors
18063 @itemx info classes @var{regexp}
18064 Display all Objective-C classes in your program, or
18065 (with the @var{regexp} argument) all those matching a particular regular
18068 @kindex info selectors
18069 @item info selectors
18070 @itemx info selectors @var{regexp}
18071 Display all Objective-C selectors in your program, or
18072 (with the @var{regexp} argument) all those matching a particular regular
18076 This was never implemented.
18077 @kindex info methods
18079 @itemx info methods @var{regexp}
18080 The @code{info methods} command permits the user to examine all defined
18081 methods within C@t{++} program, or (with the @var{regexp} argument) a
18082 specific set of methods found in the various C@t{++} classes. Many
18083 C@t{++} classes provide a large number of methods. Thus, the output
18084 from the @code{ptype} command can be overwhelming and hard to use. The
18085 @code{info-methods} command filters the methods, printing only those
18086 which match the regular-expression @var{regexp}.
18089 @cindex opaque data types
18090 @kindex set opaque-type-resolution
18091 @item set opaque-type-resolution on
18092 Tell @value{GDBN} to resolve opaque types. An opaque type is a type
18093 declared as a pointer to a @code{struct}, @code{class}, or
18094 @code{union}---for example, @code{struct MyType *}---that is used in one
18095 source file although the full declaration of @code{struct MyType} is in
18096 another source file. The default is on.
18098 A change in the setting of this subcommand will not take effect until
18099 the next time symbols for a file are loaded.
18101 @item set opaque-type-resolution off
18102 Tell @value{GDBN} not to resolve opaque types. In this case, the type
18103 is printed as follows:
18105 @{<no data fields>@}
18108 @kindex show opaque-type-resolution
18109 @item show opaque-type-resolution
18110 Show whether opaque types are resolved or not.
18112 @kindex set print symbol-loading
18113 @cindex print messages when symbols are loaded
18114 @item set print symbol-loading
18115 @itemx set print symbol-loading full
18116 @itemx set print symbol-loading brief
18117 @itemx set print symbol-loading off
18118 The @code{set print symbol-loading} command allows you to control the
18119 printing of messages when @value{GDBN} loads symbol information.
18120 By default a message is printed for the executable and one for each
18121 shared library, and normally this is what you want. However, when
18122 debugging apps with large numbers of shared libraries these messages
18124 When set to @code{brief} a message is printed for each executable,
18125 and when @value{GDBN} loads a collection of shared libraries at once
18126 it will only print one message regardless of the number of shared
18127 libraries. When set to @code{off} no messages are printed.
18129 @kindex show print symbol-loading
18130 @item show print symbol-loading
18131 Show whether messages will be printed when a @value{GDBN} command
18132 entered from the keyboard causes symbol information to be loaded.
18134 @kindex maint print symbols
18135 @cindex symbol dump
18136 @kindex maint print psymbols
18137 @cindex partial symbol dump
18138 @kindex maint print msymbols
18139 @cindex minimal symbol dump
18140 @item maint print symbols @r{[}-pc @var{address}@r{]} @r{[}@var{filename}@r{]}
18141 @itemx maint print symbols @r{[}-objfile @var{objfile}@r{]} @r{[}-source @var{source}@r{]} @r{[}--@r{]} @r{[}@var{filename}@r{]}
18142 @itemx maint print psymbols @r{[}-objfile @var{objfile}@r{]} @r{[}-pc @var{address}@r{]} @r{[}--@r{]} @r{[}@var{filename}@r{]}
18143 @itemx maint print psymbols @r{[}-objfile @var{objfile}@r{]} @r{[}-source @var{source}@r{]} @r{[}--@r{]} @r{[}@var{filename}@r{]}
18144 @itemx maint print msymbols @r{[}-objfile @var{objfile}@r{]} @r{[}--@r{]} @r{[}@var{filename}@r{]}
18145 Write a dump of debugging symbol data into the file @var{filename} or
18146 the terminal if @var{filename} is unspecified.
18147 If @code{-objfile @var{objfile}} is specified, only dump symbols for
18149 If @code{-pc @var{address}} is specified, only dump symbols for the file
18150 with code at that address. Note that @var{address} may be a symbol like
18152 If @code{-source @var{source}} is specified, only dump symbols for that
18155 These commands are used to debug the @value{GDBN} symbol-reading code.
18156 These commands do not modify internal @value{GDBN} state, therefore
18157 @samp{maint print symbols} will only print symbols for already expanded symbol
18159 You can use the command @code{info sources} to find out which files these are.
18160 If you use @samp{maint print psymbols} instead, the dump shows information
18161 about symbols that @value{GDBN} only knows partially---that is, symbols
18162 defined in files that @value{GDBN} has skimmed, but not yet read completely.
18163 Finally, @samp{maint print msymbols} just dumps ``minimal symbols'', e.g.,
18166 @xref{Files, ,Commands to Specify Files}, for a discussion of how
18167 @value{GDBN} reads symbols (in the description of @code{symbol-file}).
18169 @kindex maint info symtabs
18170 @kindex maint info psymtabs
18171 @cindex listing @value{GDBN}'s internal symbol tables
18172 @cindex symbol tables, listing @value{GDBN}'s internal
18173 @cindex full symbol tables, listing @value{GDBN}'s internal
18174 @cindex partial symbol tables, listing @value{GDBN}'s internal
18175 @item maint info symtabs @r{[} @var{regexp} @r{]}
18176 @itemx maint info psymtabs @r{[} @var{regexp} @r{]}
18178 List the @code{struct symtab} or @code{struct partial_symtab}
18179 structures whose names match @var{regexp}. If @var{regexp} is not
18180 given, list them all. The output includes expressions which you can
18181 copy into a @value{GDBN} debugging this one to examine a particular
18182 structure in more detail. For example:
18185 (@value{GDBP}) maint info psymtabs dwarf2read
18186 @{ objfile /home/gnu/build/gdb/gdb
18187 ((struct objfile *) 0x82e69d0)
18188 @{ psymtab /home/gnu/src/gdb/dwarf2read.c
18189 ((struct partial_symtab *) 0x8474b10)
18192 text addresses 0x814d3c8 -- 0x8158074
18193 globals (* (struct partial_symbol **) 0x8507a08 @@ 9)
18194 statics (* (struct partial_symbol **) 0x40e95b78 @@ 2882)
18195 dependencies (none)
18198 (@value{GDBP}) maint info symtabs
18202 We see that there is one partial symbol table whose filename contains
18203 the string @samp{dwarf2read}, belonging to the @samp{gdb} executable;
18204 and we see that @value{GDBN} has not read in any symtabs yet at all.
18205 If we set a breakpoint on a function, that will cause @value{GDBN} to
18206 read the symtab for the compilation unit containing that function:
18209 (@value{GDBP}) break dwarf2_psymtab_to_symtab
18210 Breakpoint 1 at 0x814e5da: file /home/gnu/src/gdb/dwarf2read.c,
18212 (@value{GDBP}) maint info symtabs
18213 @{ objfile /home/gnu/build/gdb/gdb
18214 ((struct objfile *) 0x82e69d0)
18215 @{ symtab /home/gnu/src/gdb/dwarf2read.c
18216 ((struct symtab *) 0x86c1f38)
18219 blockvector ((struct blockvector *) 0x86c1bd0) (primary)
18220 linetable ((struct linetable *) 0x8370fa0)
18221 debugformat DWARF 2
18227 @kindex maint info line-table
18228 @cindex listing @value{GDBN}'s internal line tables
18229 @cindex line tables, listing @value{GDBN}'s internal
18230 @item maint info line-table @r{[} @var{regexp} @r{]}
18232 List the @code{struct linetable} from all @code{struct symtab}
18233 instances whose name matches @var{regexp}. If @var{regexp} is not
18234 given, list the @code{struct linetable} from all @code{struct symtab}.
18236 @kindex maint set symbol-cache-size
18237 @cindex symbol cache size
18238 @item maint set symbol-cache-size @var{size}
18239 Set the size of the symbol cache to @var{size}.
18240 The default size is intended to be good enough for debugging
18241 most applications. This option exists to allow for experimenting
18242 with different sizes.
18244 @kindex maint show symbol-cache-size
18245 @item maint show symbol-cache-size
18246 Show the size of the symbol cache.
18248 @kindex maint print symbol-cache
18249 @cindex symbol cache, printing its contents
18250 @item maint print symbol-cache
18251 Print the contents of the symbol cache.
18252 This is useful when debugging symbol cache issues.
18254 @kindex maint print symbol-cache-statistics
18255 @cindex symbol cache, printing usage statistics
18256 @item maint print symbol-cache-statistics
18257 Print symbol cache usage statistics.
18258 This helps determine how well the cache is being utilized.
18260 @kindex maint flush-symbol-cache
18261 @cindex symbol cache, flushing
18262 @item maint flush-symbol-cache
18263 Flush the contents of the symbol cache, all entries are removed.
18264 This command is useful when debugging the symbol cache.
18265 It is also useful when collecting performance data.
18270 @chapter Altering Execution
18272 Once you think you have found an error in your program, you might want to
18273 find out for certain whether correcting the apparent error would lead to
18274 correct results in the rest of the run. You can find the answer by
18275 experiment, using the @value{GDBN} features for altering execution of the
18278 For example, you can store new values into variables or memory
18279 locations, give your program a signal, restart it at a different
18280 address, or even return prematurely from a function.
18283 * Assignment:: Assignment to variables
18284 * Jumping:: Continuing at a different address
18285 * Signaling:: Giving your program a signal
18286 * Returning:: Returning from a function
18287 * Calling:: Calling your program's functions
18288 * Patching:: Patching your program
18289 * Compiling and Injecting Code:: Compiling and injecting code in @value{GDBN}
18293 @section Assignment to Variables
18296 @cindex setting variables
18297 To alter the value of a variable, evaluate an assignment expression.
18298 @xref{Expressions, ,Expressions}. For example,
18305 stores the value 4 into the variable @code{x}, and then prints the
18306 value of the assignment expression (which is 4).
18307 @xref{Languages, ,Using @value{GDBN} with Different Languages}, for more
18308 information on operators in supported languages.
18310 @kindex set variable
18311 @cindex variables, setting
18312 If you are not interested in seeing the value of the assignment, use the
18313 @code{set} command instead of the @code{print} command. @code{set} is
18314 really the same as @code{print} except that the expression's value is
18315 not printed and is not put in the value history (@pxref{Value History,
18316 ,Value History}). The expression is evaluated only for its effects.
18318 If the beginning of the argument string of the @code{set} command
18319 appears identical to a @code{set} subcommand, use the @code{set
18320 variable} command instead of just @code{set}. This command is identical
18321 to @code{set} except for its lack of subcommands. For example, if your
18322 program has a variable @code{width}, you get an error if you try to set
18323 a new value with just @samp{set width=13}, because @value{GDBN} has the
18324 command @code{set width}:
18327 (@value{GDBP}) whatis width
18329 (@value{GDBP}) p width
18331 (@value{GDBP}) set width=47
18332 Invalid syntax in expression.
18336 The invalid expression, of course, is @samp{=47}. In
18337 order to actually set the program's variable @code{width}, use
18340 (@value{GDBP}) set var width=47
18343 Because the @code{set} command has many subcommands that can conflict
18344 with the names of program variables, it is a good idea to use the
18345 @code{set variable} command instead of just @code{set}. For example, if
18346 your program has a variable @code{g}, you run into problems if you try
18347 to set a new value with just @samp{set g=4}, because @value{GDBN} has
18348 the command @code{set gnutarget}, abbreviated @code{set g}:
18352 (@value{GDBP}) whatis g
18356 (@value{GDBP}) set g=4
18360 The program being debugged has been started already.
18361 Start it from the beginning? (y or n) y
18362 Starting program: /home/smith/cc_progs/a.out
18363 "/home/smith/cc_progs/a.out": can't open to read symbols:
18364 Invalid bfd target.
18365 (@value{GDBP}) show g
18366 The current BFD target is "=4".
18371 The program variable @code{g} did not change, and you silently set the
18372 @code{gnutarget} to an invalid value. In order to set the variable
18376 (@value{GDBP}) set var g=4
18379 @value{GDBN} allows more implicit conversions in assignments than C; you can
18380 freely store an integer value into a pointer variable or vice versa,
18381 and you can convert any structure to any other structure that is the
18382 same length or shorter.
18383 @comment FIXME: how do structs align/pad in these conversions?
18384 @comment /doc@cygnus.com 18dec1990
18386 To store values into arbitrary places in memory, use the @samp{@{@dots{}@}}
18387 construct to generate a value of specified type at a specified address
18388 (@pxref{Expressions, ,Expressions}). For example, @code{@{int@}0x83040} refers
18389 to memory location @code{0x83040} as an integer (which implies a certain size
18390 and representation in memory), and
18393 set @{int@}0x83040 = 4
18397 stores the value 4 into that memory location.
18400 @section Continuing at a Different Address
18402 Ordinarily, when you continue your program, you do so at the place where
18403 it stopped, with the @code{continue} command. You can instead continue at
18404 an address of your own choosing, with the following commands:
18408 @kindex j @r{(@code{jump})}
18409 @item jump @var{location}
18410 @itemx j @var{location}
18411 Resume execution at @var{location}. Execution stops again immediately
18412 if there is a breakpoint there. @xref{Specify Location}, for a description
18413 of the different forms of @var{location}. It is common
18414 practice to use the @code{tbreak} command in conjunction with
18415 @code{jump}. @xref{Set Breaks, ,Setting Breakpoints}.
18417 The @code{jump} command does not change the current stack frame, or
18418 the stack pointer, or the contents of any memory location or any
18419 register other than the program counter. If @var{location} is in
18420 a different function from the one currently executing, the results may
18421 be bizarre if the two functions expect different patterns of arguments or
18422 of local variables. For this reason, the @code{jump} command requests
18423 confirmation if the specified line is not in the function currently
18424 executing. However, even bizarre results are predictable if you are
18425 well acquainted with the machine-language code of your program.
18428 On many systems, you can get much the same effect as the @code{jump}
18429 command by storing a new value into the register @code{$pc}. The
18430 difference is that this does not start your program running; it only
18431 changes the address of where it @emph{will} run when you continue. For
18439 makes the next @code{continue} command or stepping command execute at
18440 address @code{0x485}, rather than at the address where your program stopped.
18441 @xref{Continuing and Stepping, ,Continuing and Stepping}.
18443 The most common occasion to use the @code{jump} command is to back
18444 up---perhaps with more breakpoints set---over a portion of a program
18445 that has already executed, in order to examine its execution in more
18450 @section Giving your Program a Signal
18451 @cindex deliver a signal to a program
18455 @item signal @var{signal}
18456 Resume execution where your program is stopped, but immediately give it the
18457 signal @var{signal}. The @var{signal} can be the name or the number of a
18458 signal. For example, on many systems @code{signal 2} and @code{signal
18459 SIGINT} are both ways of sending an interrupt signal.
18461 Alternatively, if @var{signal} is zero, continue execution without
18462 giving a signal. This is useful when your program stopped on account of
18463 a signal and would ordinarily see the signal when resumed with the
18464 @code{continue} command; @samp{signal 0} causes it to resume without a
18467 @emph{Note:} When resuming a multi-threaded program, @var{signal} is
18468 delivered to the currently selected thread, not the thread that last
18469 reported a stop. This includes the situation where a thread was
18470 stopped due to a signal. So if you want to continue execution
18471 suppressing the signal that stopped a thread, you should select that
18472 same thread before issuing the @samp{signal 0} command. If you issue
18473 the @samp{signal 0} command with another thread as the selected one,
18474 @value{GDBN} detects that and asks for confirmation.
18476 Invoking the @code{signal} command is not the same as invoking the
18477 @code{kill} utility from the shell. Sending a signal with @code{kill}
18478 causes @value{GDBN} to decide what to do with the signal depending on
18479 the signal handling tables (@pxref{Signals}). The @code{signal} command
18480 passes the signal directly to your program.
18482 @code{signal} does not repeat when you press @key{RET} a second time
18483 after executing the command.
18485 @kindex queue-signal
18486 @item queue-signal @var{signal}
18487 Queue @var{signal} to be delivered immediately to the current thread
18488 when execution of the thread resumes. The @var{signal} can be the name or
18489 the number of a signal. For example, on many systems @code{signal 2} and
18490 @code{signal SIGINT} are both ways of sending an interrupt signal.
18491 The handling of the signal must be set to pass the signal to the program,
18492 otherwise @value{GDBN} will report an error.
18493 You can control the handling of signals from @value{GDBN} with the
18494 @code{handle} command (@pxref{Signals}).
18496 Alternatively, if @var{signal} is zero, any currently queued signal
18497 for the current thread is discarded and when execution resumes no signal
18498 will be delivered. This is useful when your program stopped on account
18499 of a signal and would ordinarily see the signal when resumed with the
18500 @code{continue} command.
18502 This command differs from the @code{signal} command in that the signal
18503 is just queued, execution is not resumed. And @code{queue-signal} cannot
18504 be used to pass a signal whose handling state has been set to @code{nopass}
18509 @xref{stepping into signal handlers}, for information on how stepping
18510 commands behave when the thread has a signal queued.
18513 @section Returning from a Function
18516 @cindex returning from a function
18519 @itemx return @var{expression}
18520 You can cancel execution of a function call with the @code{return}
18521 command. If you give an
18522 @var{expression} argument, its value is used as the function's return
18526 When you use @code{return}, @value{GDBN} discards the selected stack frame
18527 (and all frames within it). You can think of this as making the
18528 discarded frame return prematurely. If you wish to specify a value to
18529 be returned, give that value as the argument to @code{return}.
18531 This pops the selected stack frame (@pxref{Selection, ,Selecting a
18532 Frame}), and any other frames inside of it, leaving its caller as the
18533 innermost remaining frame. That frame becomes selected. The
18534 specified value is stored in the registers used for returning values
18537 The @code{return} command does not resume execution; it leaves the
18538 program stopped in the state that would exist if the function had just
18539 returned. In contrast, the @code{finish} command (@pxref{Continuing
18540 and Stepping, ,Continuing and Stepping}) resumes execution until the
18541 selected stack frame returns naturally.
18543 @value{GDBN} needs to know how the @var{expression} argument should be set for
18544 the inferior. The concrete registers assignment depends on the OS ABI and the
18545 type being returned by the selected stack frame. For example it is common for
18546 OS ABI to return floating point values in FPU registers while integer values in
18547 CPU registers. Still some ABIs return even floating point values in CPU
18548 registers. Larger integer widths (such as @code{long long int}) also have
18549 specific placement rules. @value{GDBN} already knows the OS ABI from its
18550 current target so it needs to find out also the type being returned to make the
18551 assignment into the right register(s).
18553 Normally, the selected stack frame has debug info. @value{GDBN} will always
18554 use the debug info instead of the implicit type of @var{expression} when the
18555 debug info is available. For example, if you type @kbd{return -1}, and the
18556 function in the current stack frame is declared to return a @code{long long
18557 int}, @value{GDBN} transparently converts the implicit @code{int} value of -1
18558 into a @code{long long int}:
18561 Breakpoint 1, func () at gdb.base/return-nodebug.c:29
18563 (@value{GDBP}) return -1
18564 Make func return now? (y or n) y
18565 #0 0x004004f6 in main () at gdb.base/return-nodebug.c:43
18566 43 printf ("result=%lld\n", func ());
18570 However, if the selected stack frame does not have a debug info, e.g., if the
18571 function was compiled without debug info, @value{GDBN} has to find out the type
18572 to return from user. Specifying a different type by mistake may set the value
18573 in different inferior registers than the caller code expects. For example,
18574 typing @kbd{return -1} with its implicit type @code{int} would set only a part
18575 of a @code{long long int} result for a debug info less function (on 32-bit
18576 architectures). Therefore the user is required to specify the return type by
18577 an appropriate cast explicitly:
18580 Breakpoint 2, 0x0040050b in func ()
18581 (@value{GDBP}) return -1
18582 Return value type not available for selected stack frame.
18583 Please use an explicit cast of the value to return.
18584 (@value{GDBP}) return (long long int) -1
18585 Make selected stack frame return now? (y or n) y
18586 #0 0x00400526 in main ()
18591 @section Calling Program Functions
18594 @cindex calling functions
18595 @cindex inferior functions, calling
18596 @item print @var{expr}
18597 Evaluate the expression @var{expr} and display the resulting value.
18598 The expression may include calls to functions in the program being
18602 @item call @var{expr}
18603 Evaluate the expression @var{expr} without displaying @code{void}
18606 You can use this variant of the @code{print} command if you want to
18607 execute a function from your program that does not return anything
18608 (a.k.a.@: @dfn{a void function}), but without cluttering the output
18609 with @code{void} returned values that @value{GDBN} will otherwise
18610 print. If the result is not void, it is printed and saved in the
18614 It is possible for the function you call via the @code{print} or
18615 @code{call} command to generate a signal (e.g., if there's a bug in
18616 the function, or if you passed it incorrect arguments). What happens
18617 in that case is controlled by the @code{set unwindonsignal} command.
18619 Similarly, with a C@t{++} program it is possible for the function you
18620 call via the @code{print} or @code{call} command to generate an
18621 exception that is not handled due to the constraints of the dummy
18622 frame. In this case, any exception that is raised in the frame, but has
18623 an out-of-frame exception handler will not be found. GDB builds a
18624 dummy-frame for the inferior function call, and the unwinder cannot
18625 seek for exception handlers outside of this dummy-frame. What happens
18626 in that case is controlled by the
18627 @code{set unwind-on-terminating-exception} command.
18630 @item set unwindonsignal
18631 @kindex set unwindonsignal
18632 @cindex unwind stack in called functions
18633 @cindex call dummy stack unwinding
18634 Set unwinding of the stack if a signal is received while in a function
18635 that @value{GDBN} called in the program being debugged. If set to on,
18636 @value{GDBN} unwinds the stack it created for the call and restores
18637 the context to what it was before the call. If set to off (the
18638 default), @value{GDBN} stops in the frame where the signal was
18641 @item show unwindonsignal
18642 @kindex show unwindonsignal
18643 Show the current setting of stack unwinding in the functions called by
18646 @item set unwind-on-terminating-exception
18647 @kindex set unwind-on-terminating-exception
18648 @cindex unwind stack in called functions with unhandled exceptions
18649 @cindex call dummy stack unwinding on unhandled exception.
18650 Set unwinding of the stack if a C@t{++} exception is raised, but left
18651 unhandled while in a function that @value{GDBN} called in the program being
18652 debugged. If set to on (the default), @value{GDBN} unwinds the stack
18653 it created for the call and restores the context to what it was before
18654 the call. If set to off, @value{GDBN} the exception is delivered to
18655 the default C@t{++} exception handler and the inferior terminated.
18657 @item show unwind-on-terminating-exception
18658 @kindex show unwind-on-terminating-exception
18659 Show the current setting of stack unwinding in the functions called by
18664 @subsection Calling functions with no debug info
18666 @cindex no debug info functions
18667 Sometimes, a function you wish to call is missing debug information.
18668 In such case, @value{GDBN} does not know the type of the function,
18669 including the types of the function's parameters. To avoid calling
18670 the inferior function incorrectly, which could result in the called
18671 function functioning erroneously and even crash, @value{GDBN} refuses
18672 to call the function unless you tell it the type of the function.
18674 For prototyped (i.e.@: ANSI/ISO style) functions, there are two ways
18675 to do that. The simplest is to cast the call to the function's
18676 declared return type. For example:
18679 (@value{GDBP}) p getenv ("PATH")
18680 'getenv' has unknown return type; cast the call to its declared return type
18681 (@value{GDBP}) p (char *) getenv ("PATH")
18682 $1 = 0x7fffffffe7ba "/usr/local/bin:/"...
18685 Casting the return type of a no-debug function is equivalent to
18686 casting the function to a pointer to a prototyped function that has a
18687 prototype that matches the types of the passed-in arguments, and
18688 calling that. I.e., the call above is equivalent to:
18691 (@value{GDBP}) p ((char * (*) (const char *)) getenv) ("PATH")
18695 and given this prototyped C or C++ function with float parameters:
18698 float multiply (float v1, float v2) @{ return v1 * v2; @}
18702 these calls are equivalent:
18705 (@value{GDBP}) p (float) multiply (2.0f, 3.0f)
18706 (@value{GDBP}) p ((float (*) (float, float)) multiply) (2.0f, 3.0f)
18709 If the function you wish to call is declared as unprototyped (i.e.@:
18710 old K&R style), you must use the cast-to-function-pointer syntax, so
18711 that @value{GDBN} knows that it needs to apply default argument
18712 promotions (promote float arguments to double). @xref{ABI, float
18713 promotion}. For example, given this unprototyped C function with
18714 float parameters, and no debug info:
18718 multiply_noproto (v1, v2)
18726 you call it like this:
18729 (@value{GDBP}) p ((float (*) ()) multiply_noproto) (2.0f, 3.0f)
18733 @section Patching Programs
18735 @cindex patching binaries
18736 @cindex writing into executables
18737 @cindex writing into corefiles
18739 By default, @value{GDBN} opens the file containing your program's
18740 executable code (or the corefile) read-only. This prevents accidental
18741 alterations to machine code; but it also prevents you from intentionally
18742 patching your program's binary.
18744 If you'd like to be able to patch the binary, you can specify that
18745 explicitly with the @code{set write} command. For example, you might
18746 want to turn on internal debugging flags, or even to make emergency
18752 @itemx set write off
18753 If you specify @samp{set write on}, @value{GDBN} opens executable and
18754 core files for both reading and writing; if you specify @kbd{set write
18755 off} (the default), @value{GDBN} opens them read-only.
18757 If you have already loaded a file, you must load it again (using the
18758 @code{exec-file} or @code{core-file} command) after changing @code{set
18759 write}, for your new setting to take effect.
18763 Display whether executable files and core files are opened for writing
18764 as well as reading.
18767 @node Compiling and Injecting Code
18768 @section Compiling and injecting code in @value{GDBN}
18769 @cindex injecting code
18770 @cindex writing into executables
18771 @cindex compiling code
18773 @value{GDBN} supports on-demand compilation and code injection into
18774 programs running under @value{GDBN}. GCC 5.0 or higher built with
18775 @file{libcc1.so} must be installed for this functionality to be enabled.
18776 This functionality is implemented with the following commands.
18779 @kindex compile code
18780 @item compile code @var{source-code}
18781 @itemx compile code -raw @var{--} @var{source-code}
18782 Compile @var{source-code} with the compiler language found as the current
18783 language in @value{GDBN} (@pxref{Languages}). If compilation and
18784 injection is not supported with the current language specified in
18785 @value{GDBN}, or the compiler does not support this feature, an error
18786 message will be printed. If @var{source-code} compiles and links
18787 successfully, @value{GDBN} will load the object-code emitted,
18788 and execute it within the context of the currently selected inferior.
18789 It is important to note that the compiled code is executed immediately.
18790 After execution, the compiled code is removed from @value{GDBN} and any
18791 new types or variables you have defined will be deleted.
18793 The command allows you to specify @var{source-code} in two ways.
18794 The simplest method is to provide a single line of code to the command.
18798 compile code printf ("hello world\n");
18801 If you specify options on the command line as well as source code, they
18802 may conflict. The @samp{--} delimiter can be used to separate options
18803 from actual source code. E.g.:
18806 compile code -r -- printf ("hello world\n");
18809 Alternatively you can enter source code as multiple lines of text. To
18810 enter this mode, invoke the @samp{compile code} command without any text
18811 following the command. This will start the multiple-line editor and
18812 allow you to type as many lines of source code as required. When you
18813 have completed typing, enter @samp{end} on its own line to exit the
18818 >printf ("hello\n");
18819 >printf ("world\n");
18823 Specifying @samp{-raw}, prohibits @value{GDBN} from wrapping the
18824 provided @var{source-code} in a callable scope. In this case, you must
18825 specify the entry point of the code by defining a function named
18826 @code{_gdb_expr_}. The @samp{-raw} code cannot access variables of the
18827 inferior. Using @samp{-raw} option may be needed for example when
18828 @var{source-code} requires @samp{#include} lines which may conflict with
18829 inferior symbols otherwise.
18831 @kindex compile file
18832 @item compile file @var{filename}
18833 @itemx compile file -raw @var{filename}
18834 Like @code{compile code}, but take the source code from @var{filename}.
18837 compile file /home/user/example.c
18842 @item compile print @var{expr}
18843 @itemx compile print /@var{f} @var{expr}
18844 Compile and execute @var{expr} with the compiler language found as the
18845 current language in @value{GDBN} (@pxref{Languages}). By default the
18846 value of @var{expr} is printed in a format appropriate to its data type;
18847 you can choose a different format by specifying @samp{/@var{f}}, where
18848 @var{f} is a letter specifying the format; see @ref{Output Formats,,Output
18851 @item compile print
18852 @itemx compile print /@var{f}
18853 @cindex reprint the last value
18854 Alternatively you can enter the expression (source code producing it) as
18855 multiple lines of text. To enter this mode, invoke the @samp{compile print}
18856 command without any text following the command. This will start the
18857 multiple-line editor.
18861 The process of compiling and injecting the code can be inspected using:
18864 @anchor{set debug compile}
18865 @item set debug compile
18866 @cindex compile command debugging info
18867 Turns on or off display of @value{GDBN} process of compiling and
18868 injecting the code. The default is off.
18870 @item show debug compile
18871 Displays the current state of displaying @value{GDBN} process of
18872 compiling and injecting the code.
18874 @anchor{set debug compile-cplus-types}
18875 @item set debug compile-cplus-types
18876 @cindex compile C@t{++} type conversion
18877 Turns on or off the display of C@t{++} type conversion debugging information.
18878 The default is off.
18880 @item show debug compile-cplus-types
18881 Displays the current state of displaying debugging information for
18882 C@t{++} type conversion.
18885 @subsection Compilation options for the @code{compile} command
18887 @value{GDBN} needs to specify the right compilation options for the code
18888 to be injected, in part to make its ABI compatible with the inferior
18889 and in part to make the injected code compatible with @value{GDBN}'s
18893 The options used, in increasing precedence:
18896 @item target architecture and OS options (@code{gdbarch})
18897 These options depend on target processor type and target operating
18898 system, usually they specify at least 32-bit (@code{-m32}) or 64-bit
18899 (@code{-m64}) compilation option.
18901 @item compilation options recorded in the target
18902 @value{NGCC} (since version 4.7) stores the options used for compilation
18903 into @code{DW_AT_producer} part of DWARF debugging information according
18904 to the @value{NGCC} option @code{-grecord-gcc-switches}. One has to
18905 explicitly specify @code{-g} during inferior compilation otherwise
18906 @value{NGCC} produces no DWARF. This feature is only relevant for
18907 platforms where @code{-g} produces DWARF by default, otherwise one may
18908 try to enforce DWARF by using @code{-gdwarf-4}.
18910 @item compilation options set by @code{set compile-args}
18914 You can override compilation options using the following command:
18917 @item set compile-args
18918 @cindex compile command options override
18919 Set compilation options used for compiling and injecting code with the
18920 @code{compile} commands. These options override any conflicting ones
18921 from the target architecture and/or options stored during inferior
18924 @item show compile-args
18925 Displays the current state of compilation options override.
18926 This does not show all the options actually used during compilation,
18927 use @ref{set debug compile} for that.
18930 @subsection Caveats when using the @code{compile} command
18932 There are a few caveats to keep in mind when using the @code{compile}
18933 command. As the caveats are different per language, the table below
18934 highlights specific issues on a per language basis.
18937 @item C code examples and caveats
18938 When the language in @value{GDBN} is set to @samp{C}, the compiler will
18939 attempt to compile the source code with a @samp{C} compiler. The source
18940 code provided to the @code{compile} command will have much the same
18941 access to variables and types as it normally would if it were part of
18942 the program currently being debugged in @value{GDBN}.
18944 Below is a sample program that forms the basis of the examples that
18945 follow. This program has been compiled and loaded into @value{GDBN},
18946 much like any other normal debugging session.
18949 void function1 (void)
18952 printf ("function 1\n");
18955 void function2 (void)
18970 For the purposes of the examples in this section, the program above has
18971 been compiled, loaded into @value{GDBN}, stopped at the function
18972 @code{main}, and @value{GDBN} is awaiting input from the user.
18974 To access variables and types for any program in @value{GDBN}, the
18975 program must be compiled and packaged with debug information. The
18976 @code{compile} command is not an exception to this rule. Without debug
18977 information, you can still use the @code{compile} command, but you will
18978 be very limited in what variables and types you can access.
18980 So with that in mind, the example above has been compiled with debug
18981 information enabled. The @code{compile} command will have access to
18982 all variables and types (except those that may have been optimized
18983 out). Currently, as @value{GDBN} has stopped the program in the
18984 @code{main} function, the @code{compile} command would have access to
18985 the variable @code{k}. You could invoke the @code{compile} command
18986 and type some source code to set the value of @code{k}. You can also
18987 read it, or do anything with that variable you would normally do in
18988 @code{C}. Be aware that changes to inferior variables in the
18989 @code{compile} command are persistent. In the following example:
18992 compile code k = 3;
18996 the variable @code{k} is now 3. It will retain that value until
18997 something else in the example program changes it, or another
18998 @code{compile} command changes it.
19000 Normal scope and access rules apply to source code compiled and
19001 injected by the @code{compile} command. In the example, the variables
19002 @code{j} and @code{k} are not accessible yet, because the program is
19003 currently stopped in the @code{main} function, where these variables
19004 are not in scope. Therefore, the following command
19007 compile code j = 3;
19011 will result in a compilation error message.
19013 Once the program is continued, execution will bring these variables in
19014 scope, and they will become accessible; then the code you specify via
19015 the @code{compile} command will be able to access them.
19017 You can create variables and types with the @code{compile} command as
19018 part of your source code. Variables and types that are created as part
19019 of the @code{compile} command are not visible to the rest of the program for
19020 the duration of its run. This example is valid:
19023 compile code int ff = 5; printf ("ff is %d\n", ff);
19026 However, if you were to type the following into @value{GDBN} after that
19027 command has completed:
19030 compile code printf ("ff is %d\n'', ff);
19034 a compiler error would be raised as the variable @code{ff} no longer
19035 exists. Object code generated and injected by the @code{compile}
19036 command is removed when its execution ends. Caution is advised
19037 when assigning to program variables values of variables created by the
19038 code submitted to the @code{compile} command. This example is valid:
19041 compile code int ff = 5; k = ff;
19044 The value of the variable @code{ff} is assigned to @code{k}. The variable
19045 @code{k} does not require the existence of @code{ff} to maintain the value
19046 it has been assigned. However, pointers require particular care in
19047 assignment. If the source code compiled with the @code{compile} command
19048 changed the address of a pointer in the example program, perhaps to a
19049 variable created in the @code{compile} command, that pointer would point
19050 to an invalid location when the command exits. The following example
19051 would likely cause issues with your debugged program:
19054 compile code int ff = 5; p = &ff;
19057 In this example, @code{p} would point to @code{ff} when the
19058 @code{compile} command is executing the source code provided to it.
19059 However, as variables in the (example) program persist with their
19060 assigned values, the variable @code{p} would point to an invalid
19061 location when the command exists. A general rule should be followed
19062 in that you should either assign @code{NULL} to any assigned pointers,
19063 or restore a valid location to the pointer before the command exits.
19065 Similar caution must be exercised with any structs, unions, and typedefs
19066 defined in @code{compile} command. Types defined in the @code{compile}
19067 command will no longer be available in the next @code{compile} command.
19068 Therefore, if you cast a variable to a type defined in the
19069 @code{compile} command, care must be taken to ensure that any future
19070 need to resolve the type can be achieved.
19073 (gdb) compile code static struct a @{ int a; @} v = @{ 42 @}; argv = &v;
19074 (gdb) compile code printf ("%d\n", ((struct a *) argv)->a);
19075 gdb command line:1:36: error: dereferencing pointer to incomplete type ‘struct a’
19076 Compilation failed.
19077 (gdb) compile code struct a @{ int a; @}; printf ("%d\n", ((struct a *) argv)->a);
19081 Variables that have been optimized away by the compiler are not
19082 accessible to the code submitted to the @code{compile} command.
19083 Access to those variables will generate a compiler error which @value{GDBN}
19084 will print to the console.
19087 @subsection Compiler search for the @code{compile} command
19089 @value{GDBN} needs to find @value{NGCC} for the inferior being debugged
19090 which may not be obvious for remote targets of different architecture
19091 than where @value{GDBN} is running. Environment variable @code{PATH} on
19092 @value{GDBN} host is searched for @value{NGCC} binary matching the
19093 target architecture and operating system. This search can be overriden
19094 by @code{set compile-gcc} @value{GDBN} command below. @code{PATH} is
19095 taken from shell that executed @value{GDBN}, it is not the value set by
19096 @value{GDBN} command @code{set environment}). @xref{Environment}.
19099 Specifically @code{PATH} is searched for binaries matching regular expression
19100 @code{@var{arch}(-[^-]*)?-@var{os}-gcc} according to the inferior target being
19101 debugged. @var{arch} is processor name --- multiarch is supported, so for
19102 example both @code{i386} and @code{x86_64} targets look for pattern
19103 @code{(x86_64|i.86)} and both @code{s390} and @code{s390x} targets look
19104 for pattern @code{s390x?}. @var{os} is currently supported only for
19105 pattern @code{linux(-gnu)?}.
19107 On Posix hosts the compiler driver @value{GDBN} needs to find also
19108 shared library @file{libcc1.so} from the compiler. It is searched in
19109 default shared library search path (overridable with usual environment
19110 variable @code{LD_LIBRARY_PATH}), unrelated to @code{PATH} or @code{set
19111 compile-gcc} settings. Contrary to it @file{libcc1plugin.so} is found
19112 according to the installation of the found compiler --- as possibly
19113 specified by the @code{set compile-gcc} command.
19116 @item set compile-gcc
19117 @cindex compile command driver filename override
19118 Set compilation command used for compiling and injecting code with the
19119 @code{compile} commands. If this option is not set (it is set to
19120 an empty string), the search described above will occur --- that is the
19123 @item show compile-gcc
19124 Displays the current compile command @value{NGCC} driver filename.
19125 If set, it is the main command @command{gcc}, found usually for example
19126 under name @file{x86_64-linux-gnu-gcc}.
19130 @chapter @value{GDBN} Files
19132 @value{GDBN} needs to know the file name of the program to be debugged,
19133 both in order to read its symbol table and in order to start your
19134 program. To debug a core dump of a previous run, you must also tell
19135 @value{GDBN} the name of the core dump file.
19138 * Files:: Commands to specify files
19139 * File Caching:: Information about @value{GDBN}'s file caching
19140 * Separate Debug Files:: Debugging information in separate files
19141 * MiniDebugInfo:: Debugging information in a special section
19142 * Index Files:: Index files speed up GDB
19143 * Symbol Errors:: Errors reading symbol files
19144 * Data Files:: GDB data files
19148 @section Commands to Specify Files
19150 @cindex symbol table
19151 @cindex core dump file
19153 You may want to specify executable and core dump file names. The usual
19154 way to do this is at start-up time, using the arguments to
19155 @value{GDBN}'s start-up commands (@pxref{Invocation, , Getting In and
19156 Out of @value{GDBN}}).
19158 Occasionally it is necessary to change to a different file during a
19159 @value{GDBN} session. Or you may run @value{GDBN} and forget to
19160 specify a file you want to use. Or you are debugging a remote target
19161 via @code{gdbserver} (@pxref{Server, file, Using the @code{gdbserver}
19162 Program}). In these situations the @value{GDBN} commands to specify
19163 new files are useful.
19166 @cindex executable file
19168 @item file @var{filename}
19169 Use @var{filename} as the program to be debugged. It is read for its
19170 symbols and for the contents of pure memory. It is also the program
19171 executed when you use the @code{run} command. If you do not specify a
19172 directory and the file is not found in the @value{GDBN} working directory,
19173 @value{GDBN} uses the environment variable @code{PATH} as a list of
19174 directories to search, just as the shell does when looking for a program
19175 to run. You can change the value of this variable, for both @value{GDBN}
19176 and your program, using the @code{path} command.
19178 @cindex unlinked object files
19179 @cindex patching object files
19180 You can load unlinked object @file{.o} files into @value{GDBN} using
19181 the @code{file} command. You will not be able to ``run'' an object
19182 file, but you can disassemble functions and inspect variables. Also,
19183 if the underlying BFD functionality supports it, you could use
19184 @kbd{gdb -write} to patch object files using this technique. Note
19185 that @value{GDBN} can neither interpret nor modify relocations in this
19186 case, so branches and some initialized variables will appear to go to
19187 the wrong place. But this feature is still handy from time to time.
19190 @code{file} with no argument makes @value{GDBN} discard any information it
19191 has on both executable file and the symbol table.
19194 @item exec-file @r{[} @var{filename} @r{]}
19195 Specify that the program to be run (but not the symbol table) is found
19196 in @var{filename}. @value{GDBN} searches the environment variable @code{PATH}
19197 if necessary to locate your program. Omitting @var{filename} means to
19198 discard information on the executable file.
19200 @kindex symbol-file
19201 @item symbol-file @r{[} @var{filename} @r{[} -o @var{offset} @r{]]}
19202 Read symbol table information from file @var{filename}. @code{PATH} is
19203 searched when necessary. Use the @code{file} command to get both symbol
19204 table and program to run from the same file.
19206 If an optional @var{offset} is specified, it is added to the start
19207 address of each section in the symbol file. This is useful if the
19208 program is relocated at runtime, such as the Linux kernel with kASLR
19211 @code{symbol-file} with no argument clears out @value{GDBN} information on your
19212 program's symbol table.
19214 The @code{symbol-file} command causes @value{GDBN} to forget the contents of
19215 some breakpoints and auto-display expressions. This is because they may
19216 contain pointers to the internal data recording symbols and data types,
19217 which are part of the old symbol table data being discarded inside
19220 @code{symbol-file} does not repeat if you press @key{RET} again after
19223 When @value{GDBN} is configured for a particular environment, it
19224 understands debugging information in whatever format is the standard
19225 generated for that environment; you may use either a @sc{gnu} compiler, or
19226 other compilers that adhere to the local conventions.
19227 Best results are usually obtained from @sc{gnu} compilers; for example,
19228 using @code{@value{NGCC}} you can generate debugging information for
19231 For most kinds of object files, with the exception of old SVR3 systems
19232 using COFF, the @code{symbol-file} command does not normally read the
19233 symbol table in full right away. Instead, it scans the symbol table
19234 quickly to find which source files and which symbols are present. The
19235 details are read later, one source file at a time, as they are needed.
19237 The purpose of this two-stage reading strategy is to make @value{GDBN}
19238 start up faster. For the most part, it is invisible except for
19239 occasional pauses while the symbol table details for a particular source
19240 file are being read. (The @code{set verbose} command can turn these
19241 pauses into messages if desired. @xref{Messages/Warnings, ,Optional
19242 Warnings and Messages}.)
19244 We have not implemented the two-stage strategy for COFF yet. When the
19245 symbol table is stored in COFF format, @code{symbol-file} reads the
19246 symbol table data in full right away. Note that ``stabs-in-COFF''
19247 still does the two-stage strategy, since the debug info is actually
19251 @cindex reading symbols immediately
19252 @cindex symbols, reading immediately
19253 @item symbol-file @r{[} -readnow @r{]} @var{filename}
19254 @itemx file @r{[} -readnow @r{]} @var{filename}
19255 You can override the @value{GDBN} two-stage strategy for reading symbol
19256 tables by using the @samp{-readnow} option with any of the commands that
19257 load symbol table information, if you want to be sure @value{GDBN} has the
19258 entire symbol table available.
19260 @cindex @code{-readnever}, option for symbol-file command
19261 @cindex never read symbols
19262 @cindex symbols, never read
19263 @item symbol-file @r{[} -readnever @r{]} @var{filename}
19264 @itemx file @r{[} -readnever @r{]} @var{filename}
19265 You can instruct @value{GDBN} to never read the symbolic information
19266 contained in @var{filename} by using the @samp{-readnever} option.
19267 @xref{--readnever}.
19269 @c FIXME: for now no mention of directories, since this seems to be in
19270 @c flux. 13mar1992 status is that in theory GDB would look either in
19271 @c current dir or in same dir as myprog; but issues like competing
19272 @c GDB's, or clutter in system dirs, mean that in practice right now
19273 @c only current dir is used. FFish says maybe a special GDB hierarchy
19274 @c (eg rooted in val of env var GDBSYMS) could exist for mappable symbol
19278 @item core-file @r{[}@var{filename}@r{]}
19280 Specify the whereabouts of a core dump file to be used as the ``contents
19281 of memory''. Traditionally, core files contain only some parts of the
19282 address space of the process that generated them; @value{GDBN} can access the
19283 executable file itself for other parts.
19285 @code{core-file} with no argument specifies that no core file is
19288 Note that the core file is ignored when your program is actually running
19289 under @value{GDBN}. So, if you have been running your program and you
19290 wish to debug a core file instead, you must kill the subprocess in which
19291 the program is running. To do this, use the @code{kill} command
19292 (@pxref{Kill Process, ,Killing the Child Process}).
19294 @kindex add-symbol-file
19295 @cindex dynamic linking
19296 @item add-symbol-file @var{filename} @r{[} -readnow @r{|} -readnever @r{]} @r{[} -o @var{offset} @r{]} @r{[} @var{textaddress} @r{]} @r{[} -s @var{section} @var{address} @dots{} @r{]}
19297 The @code{add-symbol-file} command reads additional symbol table
19298 information from the file @var{filename}. You would use this command
19299 when @var{filename} has been dynamically loaded (by some other means)
19300 into the program that is running. The @var{textaddress} parameter gives
19301 the memory address at which the file's text section has been loaded.
19302 You can additionally specify the base address of other sections using
19303 an arbitrary number of @samp{-s @var{section} @var{address}} pairs.
19304 If a section is omitted, @value{GDBN} will use its default addresses
19305 as found in @var{filename}. Any @var{address} or @var{textaddress}
19306 can be given as an expression.
19308 If an optional @var{offset} is specified, it is added to the start
19309 address of each section, except those for which the address was
19310 specified explicitly.
19312 The symbol table of the file @var{filename} is added to the symbol table
19313 originally read with the @code{symbol-file} command. You can use the
19314 @code{add-symbol-file} command any number of times; the new symbol data
19315 thus read is kept in addition to the old.
19317 Changes can be reverted using the command @code{remove-symbol-file}.
19319 @cindex relocatable object files, reading symbols from
19320 @cindex object files, relocatable, reading symbols from
19321 @cindex reading symbols from relocatable object files
19322 @cindex symbols, reading from relocatable object files
19323 @cindex @file{.o} files, reading symbols from
19324 Although @var{filename} is typically a shared library file, an
19325 executable file, or some other object file which has been fully
19326 relocated for loading into a process, you can also load symbolic
19327 information from relocatable @file{.o} files, as long as:
19331 the file's symbolic information refers only to linker symbols defined in
19332 that file, not to symbols defined by other object files,
19334 every section the file's symbolic information refers to has actually
19335 been loaded into the inferior, as it appears in the file, and
19337 you can determine the address at which every section was loaded, and
19338 provide these to the @code{add-symbol-file} command.
19342 Some embedded operating systems, like Sun Chorus and VxWorks, can load
19343 relocatable files into an already running program; such systems
19344 typically make the requirements above easy to meet. However, it's
19345 important to recognize that many native systems use complex link
19346 procedures (@code{.linkonce} section factoring and C@t{++} constructor table
19347 assembly, for example) that make the requirements difficult to meet. In
19348 general, one cannot assume that using @code{add-symbol-file} to read a
19349 relocatable object file's symbolic information will have the same effect
19350 as linking the relocatable object file into the program in the normal
19353 @code{add-symbol-file} does not repeat if you press @key{RET} after using it.
19355 @kindex remove-symbol-file
19356 @item remove-symbol-file @var{filename}
19357 @item remove-symbol-file -a @var{address}
19358 Remove a symbol file added via the @code{add-symbol-file} command. The
19359 file to remove can be identified by its @var{filename} or by an @var{address}
19360 that lies within the boundaries of this symbol file in memory. Example:
19363 (gdb) add-symbol-file /home/user/gdb/mylib.so 0x7ffff7ff9480
19364 add symbol table from file "/home/user/gdb/mylib.so" at
19365 .text_addr = 0x7ffff7ff9480
19367 Reading symbols from /home/user/gdb/mylib.so...done.
19368 (gdb) remove-symbol-file -a 0x7ffff7ff9480
19369 Remove symbol table from file "/home/user/gdb/mylib.so"? (y or n) y
19374 @code{remove-symbol-file} does not repeat if you press @key{RET} after using it.
19376 @kindex add-symbol-file-from-memory
19377 @cindex @code{syscall DSO}
19378 @cindex load symbols from memory
19379 @item add-symbol-file-from-memory @var{address}
19380 Load symbols from the given @var{address} in a dynamically loaded
19381 object file whose image is mapped directly into the inferior's memory.
19382 For example, the Linux kernel maps a @code{syscall DSO} into each
19383 process's address space; this DSO provides kernel-specific code for
19384 some system calls. The argument can be any expression whose
19385 evaluation yields the address of the file's shared object file header.
19386 For this command to work, you must have used @code{symbol-file} or
19387 @code{exec-file} commands in advance.
19390 @item section @var{section} @var{addr}
19391 The @code{section} command changes the base address of the named
19392 @var{section} of the exec file to @var{addr}. This can be used if the
19393 exec file does not contain section addresses, (such as in the
19394 @code{a.out} format), or when the addresses specified in the file
19395 itself are wrong. Each section must be changed separately. The
19396 @code{info files} command, described below, lists all the sections and
19400 @kindex info target
19403 @code{info files} and @code{info target} are synonymous; both print the
19404 current target (@pxref{Targets, ,Specifying a Debugging Target}),
19405 including the names of the executable and core dump files currently in
19406 use by @value{GDBN}, and the files from which symbols were loaded. The
19407 command @code{help target} lists all possible targets rather than
19410 @kindex maint info sections
19411 @item maint info sections
19412 Another command that can give you extra information about program sections
19413 is @code{maint info sections}. In addition to the section information
19414 displayed by @code{info files}, this command displays the flags and file
19415 offset of each section in the executable and core dump files. In addition,
19416 @code{maint info sections} provides the following command options (which
19417 may be arbitrarily combined):
19421 Display sections for all loaded object files, including shared libraries.
19422 @item @var{sections}
19423 Display info only for named @var{sections}.
19424 @item @var{section-flags}
19425 Display info only for sections for which @var{section-flags} are true.
19426 The section flags that @value{GDBN} currently knows about are:
19429 Section will have space allocated in the process when loaded.
19430 Set for all sections except those containing debug information.
19432 Section will be loaded from the file into the child process memory.
19433 Set for pre-initialized code and data, clear for @code{.bss} sections.
19435 Section needs to be relocated before loading.
19437 Section cannot be modified by the child process.
19439 Section contains executable code only.
19441 Section contains data only (no executable code).
19443 Section will reside in ROM.
19445 Section contains data for constructor/destructor lists.
19447 Section is not empty.
19449 An instruction to the linker to not output the section.
19450 @item COFF_SHARED_LIBRARY
19451 A notification to the linker that the section contains
19452 COFF shared library information.
19454 Section contains common symbols.
19457 @kindex set trust-readonly-sections
19458 @cindex read-only sections
19459 @item set trust-readonly-sections on
19460 Tell @value{GDBN} that readonly sections in your object file
19461 really are read-only (i.e.@: that their contents will not change).
19462 In that case, @value{GDBN} can fetch values from these sections
19463 out of the object file, rather than from the target program.
19464 For some targets (notably embedded ones), this can be a significant
19465 enhancement to debugging performance.
19467 The default is off.
19469 @item set trust-readonly-sections off
19470 Tell @value{GDBN} not to trust readonly sections. This means that
19471 the contents of the section might change while the program is running,
19472 and must therefore be fetched from the target when needed.
19474 @item show trust-readonly-sections
19475 Show the current setting of trusting readonly sections.
19478 All file-specifying commands allow both absolute and relative file names
19479 as arguments. @value{GDBN} always converts the file name to an absolute file
19480 name and remembers it that way.
19482 @cindex shared libraries
19483 @anchor{Shared Libraries}
19484 @value{GDBN} supports @sc{gnu}/Linux, MS-Windows, SunOS,
19485 Darwin/Mach-O, SVr4, IBM RS/6000 AIX, QNX Neutrino, FDPIC (FR-V), and
19486 DSBT (TIC6X) shared libraries.
19488 On MS-Windows @value{GDBN} must be linked with the Expat library to support
19489 shared libraries. @xref{Expat}.
19491 @value{GDBN} automatically loads symbol definitions from shared libraries
19492 when you use the @code{run} command, or when you examine a core file.
19493 (Before you issue the @code{run} command, @value{GDBN} does not understand
19494 references to a function in a shared library, however---unless you are
19495 debugging a core file).
19497 @c FIXME: some @value{GDBN} release may permit some refs to undef
19498 @c FIXME...symbols---eg in a break cmd---assuming they are from a shared
19499 @c FIXME...lib; check this from time to time when updating manual
19501 There are times, however, when you may wish to not automatically load
19502 symbol definitions from shared libraries, such as when they are
19503 particularly large or there are many of them.
19505 To control the automatic loading of shared library symbols, use the
19509 @kindex set auto-solib-add
19510 @item set auto-solib-add @var{mode}
19511 If @var{mode} is @code{on}, symbols from all shared object libraries
19512 will be loaded automatically when the inferior begins execution, you
19513 attach to an independently started inferior, or when the dynamic linker
19514 informs @value{GDBN} that a new library has been loaded. If @var{mode}
19515 is @code{off}, symbols must be loaded manually, using the
19516 @code{sharedlibrary} command. The default value is @code{on}.
19518 @cindex memory used for symbol tables
19519 If your program uses lots of shared libraries with debug info that
19520 takes large amounts of memory, you can decrease the @value{GDBN}
19521 memory footprint by preventing it from automatically loading the
19522 symbols from shared libraries. To that end, type @kbd{set
19523 auto-solib-add off} before running the inferior, then load each
19524 library whose debug symbols you do need with @kbd{sharedlibrary
19525 @var{regexp}}, where @var{regexp} is a regular expression that matches
19526 the libraries whose symbols you want to be loaded.
19528 @kindex show auto-solib-add
19529 @item show auto-solib-add
19530 Display the current autoloading mode.
19533 @cindex load shared library
19534 To explicitly load shared library symbols, use the @code{sharedlibrary}
19538 @kindex info sharedlibrary
19540 @item info share @var{regex}
19541 @itemx info sharedlibrary @var{regex}
19542 Print the names of the shared libraries which are currently loaded
19543 that match @var{regex}. If @var{regex} is omitted then print
19544 all shared libraries that are loaded.
19547 @item info dll @var{regex}
19548 This is an alias of @code{info sharedlibrary}.
19550 @kindex sharedlibrary
19552 @item sharedlibrary @var{regex}
19553 @itemx share @var{regex}
19554 Load shared object library symbols for files matching a
19555 Unix regular expression.
19556 As with files loaded automatically, it only loads shared libraries
19557 required by your program for a core file or after typing @code{run}. If
19558 @var{regex} is omitted all shared libraries required by your program are
19561 @item nosharedlibrary
19562 @kindex nosharedlibrary
19563 @cindex unload symbols from shared libraries
19564 Unload all shared object library symbols. This discards all symbols
19565 that have been loaded from all shared libraries. Symbols from shared
19566 libraries that were loaded by explicit user requests are not
19570 Sometimes you may wish that @value{GDBN} stops and gives you control
19571 when any of shared library events happen. The best way to do this is
19572 to use @code{catch load} and @code{catch unload} (@pxref{Set
19575 @value{GDBN} also supports the the @code{set stop-on-solib-events}
19576 command for this. This command exists for historical reasons. It is
19577 less useful than setting a catchpoint, because it does not allow for
19578 conditions or commands as a catchpoint does.
19581 @item set stop-on-solib-events
19582 @kindex set stop-on-solib-events
19583 This command controls whether @value{GDBN} should give you control
19584 when the dynamic linker notifies it about some shared library event.
19585 The most common event of interest is loading or unloading of a new
19588 @item show stop-on-solib-events
19589 @kindex show stop-on-solib-events
19590 Show whether @value{GDBN} stops and gives you control when shared
19591 library events happen.
19594 Shared libraries are also supported in many cross or remote debugging
19595 configurations. @value{GDBN} needs to have access to the target's libraries;
19596 this can be accomplished either by providing copies of the libraries
19597 on the host system, or by asking @value{GDBN} to automatically retrieve the
19598 libraries from the target. If copies of the target libraries are
19599 provided, they need to be the same as the target libraries, although the
19600 copies on the target can be stripped as long as the copies on the host are
19603 @cindex where to look for shared libraries
19604 For remote debugging, you need to tell @value{GDBN} where the target
19605 libraries are, so that it can load the correct copies---otherwise, it
19606 may try to load the host's libraries. @value{GDBN} has two variables
19607 to specify the search directories for target libraries.
19610 @cindex prefix for executable and shared library file names
19611 @cindex system root, alternate
19612 @kindex set solib-absolute-prefix
19613 @kindex set sysroot
19614 @item set sysroot @var{path}
19615 Use @var{path} as the system root for the program being debugged. Any
19616 absolute shared library paths will be prefixed with @var{path}; many
19617 runtime loaders store the absolute paths to the shared library in the
19618 target program's memory. When starting processes remotely, and when
19619 attaching to already-running processes (local or remote), their
19620 executable filenames will be prefixed with @var{path} if reported to
19621 @value{GDBN} as absolute by the operating system. If you use
19622 @code{set sysroot} to find executables and shared libraries, they need
19623 to be laid out in the same way that they are on the target, with
19624 e.g.@: a @file{/bin}, @file{/lib} and @file{/usr/lib} hierarchy under
19627 If @var{path} starts with the sequence @file{target:} and the target
19628 system is remote then @value{GDBN} will retrieve the target binaries
19629 from the remote system. This is only supported when using a remote
19630 target that supports the @code{remote get} command (@pxref{File
19631 Transfer,,Sending files to a remote system}). The part of @var{path}
19632 following the initial @file{target:} (if present) is used as system
19633 root prefix on the remote file system. If @var{path} starts with the
19634 sequence @file{remote:} this is converted to the sequence
19635 @file{target:} by @code{set sysroot}@footnote{Historically the
19636 functionality to retrieve binaries from the remote system was
19637 provided by prefixing @var{path} with @file{remote:}}. If you want
19638 to specify a local system root using a directory that happens to be
19639 named @file{target:} or @file{remote:}, you need to use some
19640 equivalent variant of the name like @file{./target:}.
19642 For targets with an MS-DOS based filesystem, such as MS-Windows and
19643 SymbianOS, @value{GDBN} tries prefixing a few variants of the target
19644 absolute file name with @var{path}. But first, on Unix hosts,
19645 @value{GDBN} converts all backslash directory separators into forward
19646 slashes, because the backslash is not a directory separator on Unix:
19649 c:\foo\bar.dll @result{} c:/foo/bar.dll
19652 Then, @value{GDBN} attempts prefixing the target file name with
19653 @var{path}, and looks for the resulting file name in the host file
19657 c:/foo/bar.dll @result{} /path/to/sysroot/c:/foo/bar.dll
19660 If that does not find the binary, @value{GDBN} tries removing
19661 the @samp{:} character from the drive spec, both for convenience, and,
19662 for the case of the host file system not supporting file names with
19666 c:/foo/bar.dll @result{} /path/to/sysroot/c/foo/bar.dll
19669 This makes it possible to have a system root that mirrors a target
19670 with more than one drive. E.g., you may want to setup your local
19671 copies of the target system shared libraries like so (note @samp{c} vs
19675 @file{/path/to/sysroot/c/sys/bin/foo.dll}
19676 @file{/path/to/sysroot/c/sys/bin/bar.dll}
19677 @file{/path/to/sysroot/z/sys/bin/bar.dll}
19681 and point the system root at @file{/path/to/sysroot}, so that
19682 @value{GDBN} can find the correct copies of both
19683 @file{c:\sys\bin\foo.dll}, and @file{z:\sys\bin\bar.dll}.
19685 If that still does not find the binary, @value{GDBN} tries
19686 removing the whole drive spec from the target file name:
19689 c:/foo/bar.dll @result{} /path/to/sysroot/foo/bar.dll
19692 This last lookup makes it possible to not care about the drive name,
19693 if you don't want or need to.
19695 The @code{set solib-absolute-prefix} command is an alias for @code{set
19698 @cindex default system root
19699 @cindex @samp{--with-sysroot}
19700 You can set the default system root by using the configure-time
19701 @samp{--with-sysroot} option. If the system root is inside
19702 @value{GDBN}'s configured binary prefix (set with @samp{--prefix} or
19703 @samp{--exec-prefix}), then the default system root will be updated
19704 automatically if the installed @value{GDBN} is moved to a new
19707 @kindex show sysroot
19709 Display the current executable and shared library prefix.
19711 @kindex set solib-search-path
19712 @item set solib-search-path @var{path}
19713 If this variable is set, @var{path} is a colon-separated list of
19714 directories to search for shared libraries. @samp{solib-search-path}
19715 is used after @samp{sysroot} fails to locate the library, or if the
19716 path to the library is relative instead of absolute. If you want to
19717 use @samp{solib-search-path} instead of @samp{sysroot}, be sure to set
19718 @samp{sysroot} to a nonexistent directory to prevent @value{GDBN} from
19719 finding your host's libraries. @samp{sysroot} is preferred; setting
19720 it to a nonexistent directory may interfere with automatic loading
19721 of shared library symbols.
19723 @kindex show solib-search-path
19724 @item show solib-search-path
19725 Display the current shared library search path.
19727 @cindex DOS file-name semantics of file names.
19728 @kindex set target-file-system-kind (unix|dos-based|auto)
19729 @kindex show target-file-system-kind
19730 @item set target-file-system-kind @var{kind}
19731 Set assumed file system kind for target reported file names.
19733 Shared library file names as reported by the target system may not
19734 make sense as is on the system @value{GDBN} is running on. For
19735 example, when remote debugging a target that has MS-DOS based file
19736 system semantics, from a Unix host, the target may be reporting to
19737 @value{GDBN} a list of loaded shared libraries with file names such as
19738 @file{c:\Windows\kernel32.dll}. On Unix hosts, there's no concept of
19739 drive letters, so the @samp{c:\} prefix is not normally understood as
19740 indicating an absolute file name, and neither is the backslash
19741 normally considered a directory separator character. In that case,
19742 the native file system would interpret this whole absolute file name
19743 as a relative file name with no directory components. This would make
19744 it impossible to point @value{GDBN} at a copy of the remote target's
19745 shared libraries on the host using @code{set sysroot}, and impractical
19746 with @code{set solib-search-path}. Setting
19747 @code{target-file-system-kind} to @code{dos-based} tells @value{GDBN}
19748 to interpret such file names similarly to how the target would, and to
19749 map them to file names valid on @value{GDBN}'s native file system
19750 semantics. The value of @var{kind} can be @code{"auto"}, in addition
19751 to one of the supported file system kinds. In that case, @value{GDBN}
19752 tries to determine the appropriate file system variant based on the
19753 current target's operating system (@pxref{ABI, ,Configuring the
19754 Current ABI}). The supported file system settings are:
19758 Instruct @value{GDBN} to assume the target file system is of Unix
19759 kind. Only file names starting the forward slash (@samp{/}) character
19760 are considered absolute, and the directory separator character is also
19764 Instruct @value{GDBN} to assume the target file system is DOS based.
19765 File names starting with either a forward slash, or a drive letter
19766 followed by a colon (e.g., @samp{c:}), are considered absolute, and
19767 both the slash (@samp{/}) and the backslash (@samp{\\}) characters are
19768 considered directory separators.
19771 Instruct @value{GDBN} to use the file system kind associated with the
19772 target operating system (@pxref{ABI, ,Configuring the Current ABI}).
19773 This is the default.
19777 @cindex file name canonicalization
19778 @cindex base name differences
19779 When processing file names provided by the user, @value{GDBN}
19780 frequently needs to compare them to the file names recorded in the
19781 program's debug info. Normally, @value{GDBN} compares just the
19782 @dfn{base names} of the files as strings, which is reasonably fast
19783 even for very large programs. (The base name of a file is the last
19784 portion of its name, after stripping all the leading directories.)
19785 This shortcut in comparison is based upon the assumption that files
19786 cannot have more than one base name. This is usually true, but
19787 references to files that use symlinks or similar filesystem
19788 facilities violate that assumption. If your program records files
19789 using such facilities, or if you provide file names to @value{GDBN}
19790 using symlinks etc., you can set @code{basenames-may-differ} to
19791 @code{true} to instruct @value{GDBN} to completely canonicalize each
19792 pair of file names it needs to compare. This will make file-name
19793 comparisons accurate, but at a price of a significant slowdown.
19796 @item set basenames-may-differ
19797 @kindex set basenames-may-differ
19798 Set whether a source file may have multiple base names.
19800 @item show basenames-may-differ
19801 @kindex show basenames-may-differ
19802 Show whether a source file may have multiple base names.
19806 @section File Caching
19807 @cindex caching of opened files
19808 @cindex caching of bfd objects
19810 To speed up file loading, and reduce memory usage, @value{GDBN} will
19811 reuse the @code{bfd} objects used to track open files. @xref{Top, ,
19812 BFD, bfd, The Binary File Descriptor Library}. The following commands
19813 allow visibility and control of the caching behavior.
19816 @kindex maint info bfds
19817 @item maint info bfds
19818 This prints information about each @code{bfd} object that is known to
19821 @kindex maint set bfd-sharing
19822 @kindex maint show bfd-sharing
19823 @kindex bfd caching
19824 @item maint set bfd-sharing
19825 @item maint show bfd-sharing
19826 Control whether @code{bfd} objects can be shared. When sharing is
19827 enabled @value{GDBN} reuses already open @code{bfd} objects rather
19828 than reopening the same file. Turning sharing off does not cause
19829 already shared @code{bfd} objects to be unshared, but all future files
19830 that are opened will create a new @code{bfd} object. Similarly,
19831 re-enabling sharing does not cause multiple existing @code{bfd}
19832 objects to be collapsed into a single shared @code{bfd} object.
19834 @kindex set debug bfd-cache @var{level}
19835 @kindex bfd caching
19836 @item set debug bfd-cache @var{level}
19837 Turns on debugging of the bfd cache, setting the level to @var{level}.
19839 @kindex show debug bfd-cache
19840 @kindex bfd caching
19841 @item show debug bfd-cache
19842 Show the current debugging level of the bfd cache.
19845 @node Separate Debug Files
19846 @section Debugging Information in Separate Files
19847 @cindex separate debugging information files
19848 @cindex debugging information in separate files
19849 @cindex @file{.debug} subdirectories
19850 @cindex debugging information directory, global
19851 @cindex global debugging information directories
19852 @cindex build ID, and separate debugging files
19853 @cindex @file{.build-id} directory
19855 @value{GDBN} allows you to put a program's debugging information in a
19856 file separate from the executable itself, in a way that allows
19857 @value{GDBN} to find and load the debugging information automatically.
19858 Since debugging information can be very large---sometimes larger
19859 than the executable code itself---some systems distribute debugging
19860 information for their executables in separate files, which users can
19861 install only when they need to debug a problem.
19863 @value{GDBN} supports two ways of specifying the separate debug info
19868 The executable contains a @dfn{debug link} that specifies the name of
19869 the separate debug info file. The separate debug file's name is
19870 usually @file{@var{executable}.debug}, where @var{executable} is the
19871 name of the corresponding executable file without leading directories
19872 (e.g., @file{ls.debug} for @file{/usr/bin/ls}). In addition, the
19873 debug link specifies a 32-bit @dfn{Cyclic Redundancy Check} (CRC)
19874 checksum for the debug file, which @value{GDBN} uses to validate that
19875 the executable and the debug file came from the same build.
19878 The executable contains a @dfn{build ID}, a unique bit string that is
19879 also present in the corresponding debug info file. (This is supported
19880 only on some operating systems, when using the ELF or PE file formats
19881 for binary files and the @sc{gnu} Binutils.) For more details about
19882 this feature, see the description of the @option{--build-id}
19883 command-line option in @ref{Options, , Command Line Options, ld,
19884 The GNU Linker}. The debug info file's name is not specified
19885 explicitly by the build ID, but can be computed from the build ID, see
19889 Depending on the way the debug info file is specified, @value{GDBN}
19890 uses two different methods of looking for the debug file:
19894 For the ``debug link'' method, @value{GDBN} looks up the named file in
19895 the directory of the executable file, then in a subdirectory of that
19896 directory named @file{.debug}, and finally under each one of the global debug
19897 directories, in a subdirectory whose name is identical to the leading
19898 directories of the executable's absolute file name.
19901 For the ``build ID'' method, @value{GDBN} looks in the
19902 @file{.build-id} subdirectory of each one of the global debug directories for
19903 a file named @file{@var{nn}/@var{nnnnnnnn}.debug}, where @var{nn} are the
19904 first 2 hex characters of the build ID bit string, and @var{nnnnnnnn}
19905 are the rest of the bit string. (Real build ID strings are 32 or more
19906 hex characters, not 10.)
19909 So, for example, suppose you ask @value{GDBN} to debug
19910 @file{/usr/bin/ls}, which has a debug link that specifies the
19911 file @file{ls.debug}, and a build ID whose value in hex is
19912 @code{abcdef1234}. If the list of the global debug directories includes
19913 @file{/usr/lib/debug}, then @value{GDBN} will look for the following
19914 debug information files, in the indicated order:
19918 @file{/usr/lib/debug/.build-id/ab/cdef1234.debug}
19920 @file{/usr/bin/ls.debug}
19922 @file{/usr/bin/.debug/ls.debug}
19924 @file{/usr/lib/debug/usr/bin/ls.debug}.
19927 @anchor{debug-file-directory}
19928 Global debugging info directories default to what is set by @value{GDBN}
19929 configure option @option{--with-separate-debug-dir}. During @value{GDBN} run
19930 you can also set the global debugging info directories, and view the list
19931 @value{GDBN} is currently using.
19935 @kindex set debug-file-directory
19936 @item set debug-file-directory @var{directories}
19937 Set the directories which @value{GDBN} searches for separate debugging
19938 information files to @var{directory}. Multiple path components can be set
19939 concatenating them by a path separator.
19941 @kindex show debug-file-directory
19942 @item show debug-file-directory
19943 Show the directories @value{GDBN} searches for separate debugging
19948 @cindex @code{.gnu_debuglink} sections
19949 @cindex debug link sections
19950 A debug link is a special section of the executable file named
19951 @code{.gnu_debuglink}. The section must contain:
19955 A filename, with any leading directory components removed, followed by
19958 zero to three bytes of padding, as needed to reach the next four-byte
19959 boundary within the section, and
19961 a four-byte CRC checksum, stored in the same endianness used for the
19962 executable file itself. The checksum is computed on the debugging
19963 information file's full contents by the function given below, passing
19964 zero as the @var{crc} argument.
19967 Any executable file format can carry a debug link, as long as it can
19968 contain a section named @code{.gnu_debuglink} with the contents
19971 @cindex @code{.note.gnu.build-id} sections
19972 @cindex build ID sections
19973 The build ID is a special section in the executable file (and in other
19974 ELF binary files that @value{GDBN} may consider). This section is
19975 often named @code{.note.gnu.build-id}, but that name is not mandatory.
19976 It contains unique identification for the built files---the ID remains
19977 the same across multiple builds of the same build tree. The default
19978 algorithm SHA1 produces 160 bits (40 hexadecimal characters) of the
19979 content for the build ID string. The same section with an identical
19980 value is present in the original built binary with symbols, in its
19981 stripped variant, and in the separate debugging information file.
19983 The debugging information file itself should be an ordinary
19984 executable, containing a full set of linker symbols, sections, and
19985 debugging information. The sections of the debugging information file
19986 should have the same names, addresses, and sizes as the original file,
19987 but they need not contain any data---much like a @code{.bss} section
19988 in an ordinary executable.
19990 The @sc{gnu} binary utilities (Binutils) package includes the
19991 @samp{objcopy} utility that can produce
19992 the separated executable / debugging information file pairs using the
19993 following commands:
19996 @kbd{objcopy --only-keep-debug foo foo.debug}
20001 These commands remove the debugging
20002 information from the executable file @file{foo} and place it in the file
20003 @file{foo.debug}. You can use the first, second or both methods to link the
20008 The debug link method needs the following additional command to also leave
20009 behind a debug link in @file{foo}:
20012 @kbd{objcopy --add-gnu-debuglink=foo.debug foo}
20015 Ulrich Drepper's @file{elfutils} package, starting with version 0.53, contains
20016 a version of the @code{strip} command such that the command @kbd{strip foo -f
20017 foo.debug} has the same functionality as the two @code{objcopy} commands and
20018 the @code{ln -s} command above, together.
20021 Build ID gets embedded into the main executable using @code{ld --build-id} or
20022 the @value{NGCC} counterpart @code{gcc -Wl,--build-id}. Build ID support plus
20023 compatibility fixes for debug files separation are present in @sc{gnu} binary
20024 utilities (Binutils) package since version 2.18.
20029 @cindex CRC algorithm definition
20030 The CRC used in @code{.gnu_debuglink} is the CRC-32 defined in
20031 IEEE 802.3 using the polynomial:
20033 @c TexInfo requires naked braces for multi-digit exponents for Tex
20034 @c output, but this causes HTML output to barf. HTML has to be set using
20035 @c raw commands. So we end up having to specify this equation in 2
20040 <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>
20041 + <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
20047 @math{x^{32} + x^{26} + x^{23} + x^{22} + x^{16} + x^{12} + x^{11}}
20048 @math{+ x^{10} + x^8 + x^7 + x^5 + x^4 + x^2 + x + 1}
20052 The function is computed byte at a time, taking the least
20053 significant bit of each byte first. The initial pattern
20054 @code{0xffffffff} is used, to ensure leading zeros affect the CRC and
20055 the final result is inverted to ensure trailing zeros also affect the
20058 @emph{Note:} This is the same CRC polynomial as used in handling the
20059 @dfn{Remote Serial Protocol} @code{qCRC} packet (@pxref{qCRC packet}).
20060 However in the case of the Remote Serial Protocol, the CRC is computed
20061 @emph{most} significant bit first, and the result is not inverted, so
20062 trailing zeros have no effect on the CRC value.
20064 To complete the description, we show below the code of the function
20065 which produces the CRC used in @code{.gnu_debuglink}. Inverting the
20066 initially supplied @code{crc} argument means that an initial call to
20067 this function passing in zero will start computing the CRC using
20070 @kindex gnu_debuglink_crc32
20073 gnu_debuglink_crc32 (unsigned long crc,
20074 unsigned char *buf, size_t len)
20076 static const unsigned long crc32_table[256] =
20078 0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419,
20079 0x706af48f, 0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4,
20080 0xe0d5e91e, 0x97d2d988, 0x09b64c2b, 0x7eb17cbd, 0xe7b82d07,
20081 0x90bf1d91, 0x1db71064, 0x6ab020f2, 0xf3b97148, 0x84be41de,
20082 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7, 0x136c9856,
20083 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9,
20084 0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4,
20085 0xa2677172, 0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b,
20086 0x35b5a8fa, 0x42b2986c, 0xdbbbc9d6, 0xacbcf940, 0x32d86ce3,
20087 0x45df5c75, 0xdcd60dcf, 0xabd13d59, 0x26d930ac, 0x51de003a,
20088 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423, 0xcfba9599,
20089 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
20090 0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190,
20091 0x01db7106, 0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f,
20092 0x9fbfe4a5, 0xe8b8d433, 0x7807c9a2, 0x0f00f934, 0x9609a88e,
20093 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d, 0x91646c97, 0xe6635c01,
20094 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e, 0x6c0695ed,
20095 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950,
20096 0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3,
20097 0xfbd44c65, 0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2,
20098 0x4adfa541, 0x3dd895d7, 0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a,
20099 0x346ed9fc, 0xad678846, 0xda60b8d0, 0x44042d73, 0x33031de5,
20100 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa, 0xbe0b1010,
20101 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
20102 0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17,
20103 0x2eb40d81, 0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6,
20104 0x03b6e20c, 0x74b1d29a, 0xead54739, 0x9dd277af, 0x04db2615,
20105 0x73dc1683, 0xe3630b12, 0x94643b84, 0x0d6d6a3e, 0x7a6a5aa8,
20106 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1, 0xf00f9344,
20107 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb,
20108 0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a,
20109 0x67dd4acc, 0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5,
20110 0xd6d6a3e8, 0xa1d1937e, 0x38d8c2c4, 0x4fdff252, 0xd1bb67f1,
20111 0xa6bc5767, 0x3fb506dd, 0x48b2364b, 0xd80d2bda, 0xaf0a1b4c,
20112 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55, 0x316e8eef,
20113 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236,
20114 0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe,
20115 0xb2bd0b28, 0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31,
20116 0x2cd99e8b, 0x5bdeae1d, 0x9b64c2b0, 0xec63f226, 0x756aa39c,
20117 0x026d930a, 0x9c0906a9, 0xeb0e363f, 0x72076785, 0x05005713,
20118 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38, 0x92d28e9b,
20119 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242,
20120 0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1,
20121 0x18b74777, 0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c,
20122 0x8f659eff, 0xf862ae69, 0x616bffd3, 0x166ccf45, 0xa00ae278,
20123 0xd70dd2ee, 0x4e048354, 0x3903b3c2, 0xa7672661, 0xd06016f7,
20124 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc, 0x40df0b66,
20125 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
20126 0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605,
20127 0xcdd70693, 0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8,
20128 0x5d681b02, 0x2a6f2b94, 0xb40bbe37, 0xc30c8ea1, 0x5a05df1b,
20131 unsigned char *end;
20133 crc = ~crc & 0xffffffff;
20134 for (end = buf + len; buf < end; ++buf)
20135 crc = crc32_table[(crc ^ *buf) & 0xff] ^ (crc >> 8);
20136 return ~crc & 0xffffffff;
20141 This computation does not apply to the ``build ID'' method.
20143 @node MiniDebugInfo
20144 @section Debugging information in a special section
20145 @cindex separate debug sections
20146 @cindex @samp{.gnu_debugdata} section
20148 Some systems ship pre-built executables and libraries that have a
20149 special @samp{.gnu_debugdata} section. This feature is called
20150 @dfn{MiniDebugInfo}. This section holds an LZMA-compressed object and
20151 is used to supply extra symbols for backtraces.
20153 The intent of this section is to provide extra minimal debugging
20154 information for use in simple backtraces. It is not intended to be a
20155 replacement for full separate debugging information (@pxref{Separate
20156 Debug Files}). The example below shows the intended use; however,
20157 @value{GDBN} does not currently put restrictions on what sort of
20158 debugging information might be included in the section.
20160 @value{GDBN} has support for this extension. If the section exists,
20161 then it is used provided that no other source of debugging information
20162 can be found, and that @value{GDBN} was configured with LZMA support.
20164 This section can be easily created using @command{objcopy} and other
20165 standard utilities:
20168 # Extract the dynamic symbols from the main binary, there is no need
20169 # to also have these in the normal symbol table.
20170 nm -D @var{binary} --format=posix --defined-only \
20171 | awk '@{ print $1 @}' | sort > dynsyms
20173 # Extract all the text (i.e. function) symbols from the debuginfo.
20174 # (Note that we actually also accept "D" symbols, for the benefit
20175 # of platforms like PowerPC64 that use function descriptors.)
20176 nm @var{binary} --format=posix --defined-only \
20177 | awk '@{ if ($2 == "T" || $2 == "t" || $2 == "D") print $1 @}' \
20180 # Keep all the function symbols not already in the dynamic symbol
20182 comm -13 dynsyms funcsyms > keep_symbols
20184 # Separate full debug info into debug binary.
20185 objcopy --only-keep-debug @var{binary} debug
20187 # Copy the full debuginfo, keeping only a minimal set of symbols and
20188 # removing some unnecessary sections.
20189 objcopy -S --remove-section .gdb_index --remove-section .comment \
20190 --keep-symbols=keep_symbols debug mini_debuginfo
20192 # Drop the full debug info from the original binary.
20193 strip --strip-all -R .comment @var{binary}
20195 # Inject the compressed data into the .gnu_debugdata section of the
20198 objcopy --add-section .gnu_debugdata=mini_debuginfo.xz @var{binary}
20202 @section Index Files Speed Up @value{GDBN}
20203 @cindex index files
20204 @cindex @samp{.gdb_index} section
20206 When @value{GDBN} finds a symbol file, it scans the symbols in the
20207 file in order to construct an internal symbol table. This lets most
20208 @value{GDBN} operations work quickly---at the cost of a delay early
20209 on. For large programs, this delay can be quite lengthy, so
20210 @value{GDBN} provides a way to build an index, which speeds up
20213 For convenience, @value{GDBN} comes with a program,
20214 @command{gdb-add-index}, which can be used to add the index to a
20215 symbol file. It takes the symbol file as its only argument:
20218 $ gdb-add-index symfile
20221 @xref{gdb-add-index}.
20223 It is also possible to do the work manually. Here is what
20224 @command{gdb-add-index} does behind the curtains.
20226 The index is stored as a section in the symbol file. @value{GDBN} can
20227 write the index to a file, then you can put it into the symbol file
20228 using @command{objcopy}.
20230 To create an index file, use the @code{save gdb-index} command:
20233 @item save gdb-index [-dwarf-5] @var{directory}
20234 @kindex save gdb-index
20235 Create index files for all symbol files currently known by
20236 @value{GDBN}. For each known @var{symbol-file}, this command by
20237 default creates it produces a single file
20238 @file{@var{symbol-file}.gdb-index}. If you invoke this command with
20239 the @option{-dwarf-5} option, it produces 2 files:
20240 @file{@var{symbol-file}.debug_names} and
20241 @file{@var{symbol-file}.debug_str}. The files are created in the
20242 given @var{directory}.
20245 Once you have created an index file you can merge it into your symbol
20246 file, here named @file{symfile}, using @command{objcopy}:
20249 $ objcopy --add-section .gdb_index=symfile.gdb-index \
20250 --set-section-flags .gdb_index=readonly symfile symfile
20253 Or for @code{-dwarf-5}:
20256 $ objcopy --dump-section .debug_str=symfile.debug_str.new symfile
20257 $ cat symfile.debug_str >>symfile.debug_str.new
20258 $ objcopy --add-section .debug_names=symfile.gdb-index \
20259 --set-section-flags .debug_names=readonly \
20260 --update-section .debug_str=symfile.debug_str.new symfile symfile
20263 @value{GDBN} will normally ignore older versions of @file{.gdb_index}
20264 sections that have been deprecated. Usually they are deprecated because
20265 they are missing a new feature or have performance issues.
20266 To tell @value{GDBN} to use a deprecated index section anyway
20267 specify @code{set use-deprecated-index-sections on}.
20268 The default is @code{off}.
20269 This can speed up startup, but may result in some functionality being lost.
20270 @xref{Index Section Format}.
20272 @emph{Warning:} Setting @code{use-deprecated-index-sections} to @code{on}
20273 must be done before gdb reads the file. The following will not work:
20276 $ gdb -ex "set use-deprecated-index-sections on" <program>
20279 Instead you must do, for example,
20282 $ gdb -iex "set use-deprecated-index-sections on" <program>
20285 There are currently some limitation on indices. They only work when
20286 for DWARF debugging information, not stabs. And, they do not
20287 currently work for programs using Ada.
20289 @subsection Automatic symbol index cache
20291 It is possible for @value{GDBN} to automatically save a copy of this index in a
20292 cache on disk and retrieve it from there when loading the same binary in the
20293 future. This feature can be turned on with @kbd{set index-cache on}. The
20294 following commands can be used to tweak the behavior of the index cache.
20298 @item set index-cache on
20299 @itemx set index-cache off
20300 Enable or disable the use of the symbol index cache.
20302 @item set index-cache directory @var{directory}
20303 @itemx show index-cache directory
20304 Set/show the directory where index files will be saved.
20306 The default value for this directory depends on the host platform. On
20307 most systems, the index is cached in the @file{gdb} subdirectory of
20308 the directory pointed to by the @env{XDG_CACHE_HOME} environment
20309 variable, if it is defined, else in the @file{.cache/gdb} subdirectory
20310 of your home directory. However, on some systems, the default may
20311 differ according to local convention.
20313 There is no limit on the disk space used by index cache. It is perfectly safe
20314 to delete the content of that directory to free up disk space.
20316 @item show index-cache stats
20317 Print the number of cache hits and misses since the launch of @value{GDBN}.
20321 @node Symbol Errors
20322 @section Errors Reading Symbol Files
20324 While reading a symbol file, @value{GDBN} occasionally encounters problems,
20325 such as symbol types it does not recognize, or known bugs in compiler
20326 output. By default, @value{GDBN} does not notify you of such problems, since
20327 they are relatively common and primarily of interest to people
20328 debugging compilers. If you are interested in seeing information
20329 about ill-constructed symbol tables, you can either ask @value{GDBN} to print
20330 only one message about each such type of problem, no matter how many
20331 times the problem occurs; or you can ask @value{GDBN} to print more messages,
20332 to see how many times the problems occur, with the @code{set
20333 complaints} command (@pxref{Messages/Warnings, ,Optional Warnings and
20336 The messages currently printed, and their meanings, include:
20339 @item inner block not inside outer block in @var{symbol}
20341 The symbol information shows where symbol scopes begin and end
20342 (such as at the start of a function or a block of statements). This
20343 error indicates that an inner scope block is not fully contained
20344 in its outer scope blocks.
20346 @value{GDBN} circumvents the problem by treating the inner block as if it had
20347 the same scope as the outer block. In the error message, @var{symbol}
20348 may be shown as ``@code{(don't know)}'' if the outer block is not a
20351 @item block at @var{address} out of order
20353 The symbol information for symbol scope blocks should occur in
20354 order of increasing addresses. This error indicates that it does not
20357 @value{GDBN} does not circumvent this problem, and has trouble
20358 locating symbols in the source file whose symbols it is reading. (You
20359 can often determine what source file is affected by specifying
20360 @code{set verbose on}. @xref{Messages/Warnings, ,Optional Warnings and
20363 @item bad block start address patched
20365 The symbol information for a symbol scope block has a start address
20366 smaller than the address of the preceding source line. This is known
20367 to occur in the SunOS 4.1.1 (and earlier) C compiler.
20369 @value{GDBN} circumvents the problem by treating the symbol scope block as
20370 starting on the previous source line.
20372 @item bad string table offset in symbol @var{n}
20375 Symbol number @var{n} contains a pointer into the string table which is
20376 larger than the size of the string table.
20378 @value{GDBN} circumvents the problem by considering the symbol to have the
20379 name @code{foo}, which may cause other problems if many symbols end up
20382 @item unknown symbol type @code{0x@var{nn}}
20384 The symbol information contains new data types that @value{GDBN} does
20385 not yet know how to read. @code{0x@var{nn}} is the symbol type of the
20386 uncomprehended information, in hexadecimal.
20388 @value{GDBN} circumvents the error by ignoring this symbol information.
20389 This usually allows you to debug your program, though certain symbols
20390 are not accessible. If you encounter such a problem and feel like
20391 debugging it, you can debug @code{@value{GDBP}} with itself, breakpoint
20392 on @code{complain}, then go up to the function @code{read_dbx_symtab}
20393 and examine @code{*bufp} to see the symbol.
20395 @item stub type has NULL name
20397 @value{GDBN} could not find the full definition for a struct or class.
20399 @item const/volatile indicator missing (ok if using g++ v1.x), got@dots{}
20400 The symbol information for a C@t{++} member function is missing some
20401 information that recent versions of the compiler should have output for
20404 @item info mismatch between compiler and debugger
20406 @value{GDBN} could not parse a type specification output by the compiler.
20411 @section GDB Data Files
20413 @cindex prefix for data files
20414 @value{GDBN} will sometimes read an auxiliary data file. These files
20415 are kept in a directory known as the @dfn{data directory}.
20417 You can set the data directory's name, and view the name @value{GDBN}
20418 is currently using.
20421 @kindex set data-directory
20422 @item set data-directory @var{directory}
20423 Set the directory which @value{GDBN} searches for auxiliary data files
20424 to @var{directory}.
20426 @kindex show data-directory
20427 @item show data-directory
20428 Show the directory @value{GDBN} searches for auxiliary data files.
20431 @cindex default data directory
20432 @cindex @samp{--with-gdb-datadir}
20433 You can set the default data directory by using the configure-time
20434 @samp{--with-gdb-datadir} option. If the data directory is inside
20435 @value{GDBN}'s configured binary prefix (set with @samp{--prefix} or
20436 @samp{--exec-prefix}), then the default data directory will be updated
20437 automatically if the installed @value{GDBN} is moved to a new
20440 The data directory may also be specified with the
20441 @code{--data-directory} command line option.
20442 @xref{Mode Options}.
20445 @chapter Specifying a Debugging Target
20447 @cindex debugging target
20448 A @dfn{target} is the execution environment occupied by your program.
20450 Often, @value{GDBN} runs in the same host environment as your program;
20451 in that case, the debugging target is specified as a side effect when
20452 you use the @code{file} or @code{core} commands. When you need more
20453 flexibility---for example, running @value{GDBN} on a physically separate
20454 host, or controlling a standalone system over a serial port or a
20455 realtime system over a TCP/IP connection---you can use the @code{target}
20456 command to specify one of the target types configured for @value{GDBN}
20457 (@pxref{Target Commands, ,Commands for Managing Targets}).
20459 @cindex target architecture
20460 It is possible to build @value{GDBN} for several different @dfn{target
20461 architectures}. When @value{GDBN} is built like that, you can choose
20462 one of the available architectures with the @kbd{set architecture}
20466 @kindex set architecture
20467 @kindex show architecture
20468 @item set architecture @var{arch}
20469 This command sets the current target architecture to @var{arch}. The
20470 value of @var{arch} can be @code{"auto"}, in addition to one of the
20471 supported architectures.
20473 @item show architecture
20474 Show the current target architecture.
20476 @item set processor
20478 @kindex set processor
20479 @kindex show processor
20480 These are alias commands for, respectively, @code{set architecture}
20481 and @code{show architecture}.
20485 * Active Targets:: Active targets
20486 * Target Commands:: Commands for managing targets
20487 * Byte Order:: Choosing target byte order
20490 @node Active Targets
20491 @section Active Targets
20493 @cindex stacking targets
20494 @cindex active targets
20495 @cindex multiple targets
20497 There are multiple classes of targets such as: processes, executable files or
20498 recording sessions. Core files belong to the process class, making core file
20499 and process mutually exclusive. Otherwise, @value{GDBN} can work concurrently
20500 on multiple active targets, one in each class. This allows you to (for
20501 example) start a process and inspect its activity, while still having access to
20502 the executable file after the process finishes. Or if you start process
20503 recording (@pxref{Reverse Execution}) and @code{reverse-step} there, you are
20504 presented a virtual layer of the recording target, while the process target
20505 remains stopped at the chronologically last point of the process execution.
20507 Use the @code{core-file} and @code{exec-file} commands to select a new core
20508 file or executable target (@pxref{Files, ,Commands to Specify Files}). To
20509 specify as a target a process that is already running, use the @code{attach}
20510 command (@pxref{Attach, ,Debugging an Already-running Process}).
20512 @node Target Commands
20513 @section Commands for Managing Targets
20516 @item target @var{type} @var{parameters}
20517 Connects the @value{GDBN} host environment to a target machine or
20518 process. A target is typically a protocol for talking to debugging
20519 facilities. You use the argument @var{type} to specify the type or
20520 protocol of the target machine.
20522 Further @var{parameters} are interpreted by the target protocol, but
20523 typically include things like device names or host names to connect
20524 with, process numbers, and baud rates.
20526 The @code{target} command does not repeat if you press @key{RET} again
20527 after executing the command.
20529 @kindex help target
20531 Displays the names of all targets available. To display targets
20532 currently selected, use either @code{info target} or @code{info files}
20533 (@pxref{Files, ,Commands to Specify Files}).
20535 @item help target @var{name}
20536 Describe a particular target, including any parameters necessary to
20539 @kindex set gnutarget
20540 @item set gnutarget @var{args}
20541 @value{GDBN} uses its own library BFD to read your files. @value{GDBN}
20542 knows whether it is reading an @dfn{executable},
20543 a @dfn{core}, or a @dfn{.o} file; however, you can specify the file format
20544 with the @code{set gnutarget} command. Unlike most @code{target} commands,
20545 with @code{gnutarget} the @code{target} refers to a program, not a machine.
20548 @emph{Warning:} To specify a file format with @code{set gnutarget},
20549 you must know the actual BFD name.
20553 @xref{Files, , Commands to Specify Files}.
20555 @kindex show gnutarget
20556 @item show gnutarget
20557 Use the @code{show gnutarget} command to display what file format
20558 @code{gnutarget} is set to read. If you have not set @code{gnutarget},
20559 @value{GDBN} will determine the file format for each file automatically,
20560 and @code{show gnutarget} displays @samp{The current BFD target is "auto"}.
20563 @cindex common targets
20564 Here are some common targets (available, or not, depending on the GDB
20569 @item target exec @var{program}
20570 @cindex executable file target
20571 An executable file. @samp{target exec @var{program}} is the same as
20572 @samp{exec-file @var{program}}.
20574 @item target core @var{filename}
20575 @cindex core dump file target
20576 A core dump file. @samp{target core @var{filename}} is the same as
20577 @samp{core-file @var{filename}}.
20579 @item target remote @var{medium}
20580 @cindex remote target
20581 A remote system connected to @value{GDBN} via a serial line or network
20582 connection. This command tells @value{GDBN} to use its own remote
20583 protocol over @var{medium} for debugging. @xref{Remote Debugging}.
20585 For example, if you have a board connected to @file{/dev/ttya} on the
20586 machine running @value{GDBN}, you could say:
20589 target remote /dev/ttya
20592 @code{target remote} supports the @code{load} command. This is only
20593 useful if you have some other way of getting the stub to the target
20594 system, and you can put it somewhere in memory where it won't get
20595 clobbered by the download.
20597 @item target sim @r{[}@var{simargs}@r{]} @dots{}
20598 @cindex built-in simulator target
20599 Builtin CPU simulator. @value{GDBN} includes simulators for most architectures.
20607 works; however, you cannot assume that a specific memory map, device
20608 drivers, or even basic I/O is available, although some simulators do
20609 provide these. For info about any processor-specific simulator details,
20610 see the appropriate section in @ref{Embedded Processors, ,Embedded
20613 @item target native
20614 @cindex native target
20615 Setup for local/native process debugging. Useful to make the
20616 @code{run} command spawn native processes (likewise @code{attach},
20617 etc.@:) even when @code{set auto-connect-native-target} is @code{off}
20618 (@pxref{set auto-connect-native-target}).
20622 Different targets are available on different configurations of @value{GDBN};
20623 your configuration may have more or fewer targets.
20625 Many remote targets require you to download the executable's code once
20626 you've successfully established a connection. You may wish to control
20627 various aspects of this process.
20632 @kindex set hash@r{, for remote monitors}
20633 @cindex hash mark while downloading
20634 This command controls whether a hash mark @samp{#} is displayed while
20635 downloading a file to the remote monitor. If on, a hash mark is
20636 displayed after each S-record is successfully downloaded to the
20640 @kindex show hash@r{, for remote monitors}
20641 Show the current status of displaying the hash mark.
20643 @item set debug monitor
20644 @kindex set debug monitor
20645 @cindex display remote monitor communications
20646 Enable or disable display of communications messages between
20647 @value{GDBN} and the remote monitor.
20649 @item show debug monitor
20650 @kindex show debug monitor
20651 Show the current status of displaying communications between
20652 @value{GDBN} and the remote monitor.
20657 @kindex load @var{filename} @var{offset}
20658 @item load @var{filename} @var{offset}
20660 Depending on what remote debugging facilities are configured into
20661 @value{GDBN}, the @code{load} command may be available. Where it exists, it
20662 is meant to make @var{filename} (an executable) available for debugging
20663 on the remote system---by downloading, or dynamic linking, for example.
20664 @code{load} also records the @var{filename} symbol table in @value{GDBN}, like
20665 the @code{add-symbol-file} command.
20667 If your @value{GDBN} does not have a @code{load} command, attempting to
20668 execute it gets the error message ``@code{You can't do that when your
20669 target is @dots{}}''
20671 The file is loaded at whatever address is specified in the executable.
20672 For some object file formats, you can specify the load address when you
20673 link the program; for other formats, like a.out, the object file format
20674 specifies a fixed address.
20675 @c FIXME! This would be a good place for an xref to the GNU linker doc.
20677 It is also possible to tell @value{GDBN} to load the executable file at a
20678 specific offset described by the optional argument @var{offset}. When
20679 @var{offset} is provided, @var{filename} must also be provided.
20681 Depending on the remote side capabilities, @value{GDBN} may be able to
20682 load programs into flash memory.
20684 @code{load} does not repeat if you press @key{RET} again after using it.
20689 @kindex flash-erase
20691 @anchor{flash-erase}
20693 Erases all known flash memory regions on the target.
20698 @section Choosing Target Byte Order
20700 @cindex choosing target byte order
20701 @cindex target byte order
20703 Some types of processors, such as the @acronym{MIPS}, PowerPC, and Renesas SH,
20704 offer the ability to run either big-endian or little-endian byte
20705 orders. Usually the executable or symbol will include a bit to
20706 designate the endian-ness, and you will not need to worry about
20707 which to use. However, you may still find it useful to adjust
20708 @value{GDBN}'s idea of processor endian-ness manually.
20712 @item set endian big
20713 Instruct @value{GDBN} to assume the target is big-endian.
20715 @item set endian little
20716 Instruct @value{GDBN} to assume the target is little-endian.
20718 @item set endian auto
20719 Instruct @value{GDBN} to use the byte order associated with the
20723 Display @value{GDBN}'s current idea of the target byte order.
20727 If the @code{set endian auto} mode is in effect and no executable has
20728 been selected, then the endianness used is the last one chosen either
20729 by one of the @code{set endian big} and @code{set endian little}
20730 commands or by inferring from the last executable used. If no
20731 endianness has been previously chosen, then the default for this mode
20732 is inferred from the target @value{GDBN} has been built for, and is
20733 @code{little} if the name of the target CPU has an @code{el} suffix
20734 and @code{big} otherwise.
20736 Note that these commands merely adjust interpretation of symbolic
20737 data on the host, and that they have absolutely no effect on the
20741 @node Remote Debugging
20742 @chapter Debugging Remote Programs
20743 @cindex remote debugging
20745 If you are trying to debug a program running on a machine that cannot run
20746 @value{GDBN} in the usual way, it is often useful to use remote debugging.
20747 For example, you might use remote debugging on an operating system kernel,
20748 or on a small system which does not have a general purpose operating system
20749 powerful enough to run a full-featured debugger.
20751 Some configurations of @value{GDBN} have special serial or TCP/IP interfaces
20752 to make this work with particular debugging targets. In addition,
20753 @value{GDBN} comes with a generic serial protocol (specific to @value{GDBN},
20754 but not specific to any particular target system) which you can use if you
20755 write the remote stubs---the code that runs on the remote system to
20756 communicate with @value{GDBN}.
20758 Other remote targets may be available in your
20759 configuration of @value{GDBN}; use @code{help target} to list them.
20762 * Connecting:: Connecting to a remote target
20763 * File Transfer:: Sending files to a remote system
20764 * Server:: Using the gdbserver program
20765 * Remote Configuration:: Remote configuration
20766 * Remote Stub:: Implementing a remote stub
20770 @section Connecting to a Remote Target
20771 @cindex remote debugging, connecting
20772 @cindex @code{gdbserver}, connecting
20773 @cindex remote debugging, types of connections
20774 @cindex @code{gdbserver}, types of connections
20775 @cindex @code{gdbserver}, @code{target remote} mode
20776 @cindex @code{gdbserver}, @code{target extended-remote} mode
20778 This section describes how to connect to a remote target, including the
20779 types of connections and their differences, how to set up executable and
20780 symbol files on the host and target, and the commands used for
20781 connecting to and disconnecting from the remote target.
20783 @subsection Types of Remote Connections
20785 @value{GDBN} supports two types of remote connections, @code{target remote}
20786 mode and @code{target extended-remote} mode. Note that many remote targets
20787 support only @code{target remote} mode. There are several major
20788 differences between the two types of connections, enumerated here:
20792 @cindex remote debugging, detach and program exit
20793 @item Result of detach or program exit
20794 @strong{With target remote mode:} When the debugged program exits or you
20795 detach from it, @value{GDBN} disconnects from the target. When using
20796 @code{gdbserver}, @code{gdbserver} will exit.
20798 @strong{With target extended-remote mode:} When the debugged program exits or
20799 you detach from it, @value{GDBN} remains connected to the target, even
20800 though no program is running. You can rerun the program, attach to a
20801 running program, or use @code{monitor} commands specific to the target.
20803 When using @code{gdbserver} in this case, it does not exit unless it was
20804 invoked using the @option{--once} option. If the @option{--once} option
20805 was not used, you can ask @code{gdbserver} to exit using the
20806 @code{monitor exit} command (@pxref{Monitor Commands for gdbserver}).
20808 @item Specifying the program to debug
20809 For both connection types you use the @code{file} command to specify the
20810 program on the host system. If you are using @code{gdbserver} there are
20811 some differences in how to specify the location of the program on the
20814 @strong{With target remote mode:} You must either specify the program to debug
20815 on the @code{gdbserver} command line or use the @option{--attach} option
20816 (@pxref{Attaching to a program,,Attaching to a Running Program}).
20818 @cindex @option{--multi}, @code{gdbserver} option
20819 @strong{With target extended-remote mode:} You may specify the program to debug
20820 on the @code{gdbserver} command line, or you can load the program or attach
20821 to it using @value{GDBN} commands after connecting to @code{gdbserver}.
20823 @anchor{--multi Option in Types of Remote Connnections}
20824 You can start @code{gdbserver} without supplying an initial command to run
20825 or process ID to attach. To do this, use the @option{--multi} command line
20826 option. Then you can connect using @code{target extended-remote} and start
20827 the program you want to debug (see below for details on using the
20828 @code{run} command in this scenario). Note that the conditions under which
20829 @code{gdbserver} terminates depend on how @value{GDBN} connects to it
20830 (@code{target remote} or @code{target extended-remote}). The
20831 @option{--multi} option to @code{gdbserver} has no influence on that.
20833 @item The @code{run} command
20834 @strong{With target remote mode:} The @code{run} command is not
20835 supported. Once a connection has been established, you can use all
20836 the usual @value{GDBN} commands to examine and change data. The
20837 remote program is already running, so you can use commands like
20838 @kbd{step} and @kbd{continue}.
20840 @strong{With target extended-remote mode:} The @code{run} command is
20841 supported. The @code{run} command uses the value set by
20842 @code{set remote exec-file} (@pxref{set remote exec-file}) to select
20843 the program to run. Command line arguments are supported, except for
20844 wildcard expansion and I/O redirection (@pxref{Arguments}).
20846 If you specify the program to debug on the command line, then the
20847 @code{run} command is not required to start execution, and you can
20848 resume using commands like @kbd{step} and @kbd{continue} as with
20849 @code{target remote} mode.
20851 @anchor{Attaching in Types of Remote Connections}
20853 @strong{With target remote mode:} The @value{GDBN} command @code{attach} is
20854 not supported. To attach to a running program using @code{gdbserver}, you
20855 must use the @option{--attach} option (@pxref{Running gdbserver}).
20857 @strong{With target extended-remote mode:} To attach to a running program,
20858 you may use the @code{attach} command after the connection has been
20859 established. If you are using @code{gdbserver}, you may also invoke
20860 @code{gdbserver} using the @option{--attach} option
20861 (@pxref{Running gdbserver}).
20865 @anchor{Host and target files}
20866 @subsection Host and Target Files
20867 @cindex remote debugging, symbol files
20868 @cindex symbol files, remote debugging
20870 @value{GDBN}, running on the host, needs access to symbol and debugging
20871 information for your program running on the target. This requires
20872 access to an unstripped copy of your program, and possibly any associated
20873 symbol files. Note that this section applies equally to both @code{target
20874 remote} mode and @code{target extended-remote} mode.
20876 Some remote targets (@pxref{qXfer executable filename read}, and
20877 @pxref{Host I/O Packets}) allow @value{GDBN} to access program files over
20878 the same connection used to communicate with @value{GDBN}. With such a
20879 target, if the remote program is unstripped, the only command you need is
20880 @code{target remote} (or @code{target extended-remote}).
20882 If the remote program is stripped, or the target does not support remote
20883 program file access, start up @value{GDBN} using the name of the local
20884 unstripped copy of your program as the first argument, or use the
20885 @code{file} command. Use @code{set sysroot} to specify the location (on
20886 the host) of target libraries (unless your @value{GDBN} was compiled with
20887 the correct sysroot using @code{--with-sysroot}). Alternatively, you
20888 may use @code{set solib-search-path} to specify how @value{GDBN} locates
20891 The symbol file and target libraries must exactly match the executable
20892 and libraries on the target, with one exception: the files on the host
20893 system should not be stripped, even if the files on the target system
20894 are. Mismatched or missing files will lead to confusing results
20895 during debugging. On @sc{gnu}/Linux targets, mismatched or missing
20896 files may also prevent @code{gdbserver} from debugging multi-threaded
20899 @subsection Remote Connection Commands
20900 @cindex remote connection commands
20901 @value{GDBN} can communicate with the target over a serial line, a
20902 local Unix domain socket, or
20903 over an @acronym{IP} network using @acronym{TCP} or @acronym{UDP}. In
20904 each case, @value{GDBN} uses the same protocol for debugging your
20905 program; only the medium carrying the debugging packets varies. The
20906 @code{target remote} and @code{target extended-remote} commands
20907 establish a connection to the target. Both commands accept the same
20908 arguments, which indicate the medium to use:
20912 @item target remote @var{serial-device}
20913 @itemx target extended-remote @var{serial-device}
20914 @cindex serial line, @code{target remote}
20915 Use @var{serial-device} to communicate with the target. For example,
20916 to use a serial line connected to the device named @file{/dev/ttyb}:
20919 target remote /dev/ttyb
20922 If you're using a serial line, you may want to give @value{GDBN} the
20923 @samp{--baud} option, or use the @code{set serial baud} command
20924 (@pxref{Remote Configuration, set serial baud}) before the
20925 @code{target} command.
20927 @item target remote @var{local-socket}
20928 @itemx target extended-remote @var{local-socket}
20929 @cindex local socket, @code{target remote}
20930 @cindex Unix domain socket
20931 Use @var{local-socket} to communicate with the target. For example,
20932 to use a local Unix domain socket bound to the file system entry @file{/tmp/gdb-socket0}:
20935 target remote /tmp/gdb-socket0
20938 Note that this command has the same form as the command to connect
20939 to a serial line. @value{GDBN} will automatically determine which
20940 kind of file you have specified and will make the appropriate kind
20942 This feature is not available if the host system does not support
20943 Unix domain sockets.
20945 @item target remote @code{@var{host}:@var{port}}
20946 @itemx target remote @code{@var{[host]}:@var{port}}
20947 @itemx target remote @code{tcp:@var{host}:@var{port}}
20948 @itemx target remote @code{tcp:@var{[host]}:@var{port}}
20949 @itemx target remote @code{tcp4:@var{host}:@var{port}}
20950 @itemx target remote @code{tcp6:@var{host}:@var{port}}
20951 @itemx target remote @code{tcp6:@var{[host]}:@var{port}}
20952 @itemx target extended-remote @code{@var{host}:@var{port}}
20953 @itemx target extended-remote @code{@var{[host]}:@var{port}}
20954 @itemx target extended-remote @code{tcp:@var{host}:@var{port}}
20955 @itemx target extended-remote @code{tcp:@var{[host]}:@var{port}}
20956 @itemx target extended-remote @code{tcp4:@var{host}:@var{port}}
20957 @itemx target extended-remote @code{tcp6:@var{host}:@var{port}}
20958 @itemx target extended-remote @code{tcp6:@var{[host]}:@var{port}}
20959 @cindex @acronym{TCP} port, @code{target remote}
20960 Debug using a @acronym{TCP} connection to @var{port} on @var{host}.
20961 The @var{host} may be either a host name, a numeric @acronym{IPv4}
20962 address, or a numeric @acronym{IPv6} address (with or without the
20963 square brackets to separate the address from the port); @var{port}
20964 must be a decimal number. The @var{host} could be the target machine
20965 itself, if it is directly connected to the net, or it might be a
20966 terminal server which in turn has a serial line to the target.
20968 For example, to connect to port 2828 on a terminal server named
20972 target remote manyfarms:2828
20975 To connect to port 2828 on a terminal server whose address is
20976 @code{2001:0db8:85a3:0000:0000:8a2e:0370:7334}, you can either use the
20977 square bracket syntax:
20980 target remote [2001:0db8:85a3:0000:0000:8a2e:0370:7334]:2828
20984 or explicitly specify the @acronym{IPv6} protocol:
20987 target remote tcp6:2001:0db8:85a3:0000:0000:8a2e:0370:7334:2828
20990 This last example may be confusing to the reader, because there is no
20991 visible separation between the hostname and the port number.
20992 Therefore, we recommend the user to provide @acronym{IPv6} addresses
20993 using square brackets for clarity. However, it is important to
20994 mention that for @value{GDBN} there is no ambiguity: the number after
20995 the last colon is considered to be the port number.
20997 If your remote target is actually running on the same machine as your
20998 debugger session (e.g.@: a simulator for your target running on the
20999 same host), you can omit the hostname. For example, to connect to
21000 port 1234 on your local machine:
21003 target remote :1234
21007 Note that the colon is still required here.
21009 @item target remote @code{udp:@var{host}:@var{port}}
21010 @itemx target remote @code{udp:@var{[host]}:@var{port}}
21011 @itemx target remote @code{udp4:@var{host}:@var{port}}
21012 @itemx target remote @code{udp6:@var{[host]}:@var{port}}
21013 @itemx target extended-remote @code{udp:@var{host}:@var{port}}
21014 @itemx target extended-remote @code{udp:@var{host}:@var{port}}
21015 @itemx target extended-remote @code{udp:@var{[host]}:@var{port}}
21016 @itemx target extended-remote @code{udp4:@var{host}:@var{port}}
21017 @itemx target extended-remote @code{udp6:@var{host}:@var{port}}
21018 @itemx target extended-remote @code{udp6:@var{[host]}:@var{port}}
21019 @cindex @acronym{UDP} port, @code{target remote}
21020 Debug using @acronym{UDP} packets to @var{port} on @var{host}. For example, to
21021 connect to @acronym{UDP} port 2828 on a terminal server named @code{manyfarms}:
21024 target remote udp:manyfarms:2828
21027 When using a @acronym{UDP} connection for remote debugging, you should
21028 keep in mind that the `U' stands for ``Unreliable''. @acronym{UDP}
21029 can silently drop packets on busy or unreliable networks, which will
21030 cause havoc with your debugging session.
21032 @item target remote | @var{command}
21033 @itemx target extended-remote | @var{command}
21034 @cindex pipe, @code{target remote} to
21035 Run @var{command} in the background and communicate with it using a
21036 pipe. The @var{command} is a shell command, to be parsed and expanded
21037 by the system's command shell, @code{/bin/sh}; it should expect remote
21038 protocol packets on its standard input, and send replies on its
21039 standard output. You could use this to run a stand-alone simulator
21040 that speaks the remote debugging protocol, to make net connections
21041 using programs like @code{ssh}, or for other similar tricks.
21043 If @var{command} closes its standard output (perhaps by exiting),
21044 @value{GDBN} will try to send it a @code{SIGTERM} signal. (If the
21045 program has already exited, this will have no effect.)
21049 @cindex interrupting remote programs
21050 @cindex remote programs, interrupting
21051 Whenever @value{GDBN} is waiting for the remote program, if you type the
21052 interrupt character (often @kbd{Ctrl-c}), @value{GDBN} attempts to stop the
21053 program. This may or may not succeed, depending in part on the hardware
21054 and the serial drivers the remote system uses. If you type the
21055 interrupt character once again, @value{GDBN} displays this prompt:
21058 Interrupted while waiting for the program.
21059 Give up (and stop debugging it)? (y or n)
21062 In @code{target remote} mode, if you type @kbd{y}, @value{GDBN} abandons
21063 the remote debugging session. (If you decide you want to try again later,
21064 you can use @kbd{target remote} again to connect once more.) If you type
21065 @kbd{n}, @value{GDBN} goes back to waiting.
21067 In @code{target extended-remote} mode, typing @kbd{n} will leave
21068 @value{GDBN} connected to the target.
21071 @kindex detach (remote)
21073 When you have finished debugging the remote program, you can use the
21074 @code{detach} command to release it from @value{GDBN} control.
21075 Detaching from the target normally resumes its execution, but the results
21076 will depend on your particular remote stub. After the @code{detach}
21077 command in @code{target remote} mode, @value{GDBN} is free to connect to
21078 another target. In @code{target extended-remote} mode, @value{GDBN} is
21079 still connected to the target.
21083 The @code{disconnect} command closes the connection to the target, and
21084 the target is generally not resumed. It will wait for @value{GDBN}
21085 (this instance or another one) to connect and continue debugging. After
21086 the @code{disconnect} command, @value{GDBN} is again free to connect to
21089 @cindex send command to remote monitor
21090 @cindex extend @value{GDBN} for remote targets
21091 @cindex add new commands for external monitor
21093 @item monitor @var{cmd}
21094 This command allows you to send arbitrary commands directly to the
21095 remote monitor. Since @value{GDBN} doesn't care about the commands it
21096 sends like this, this command is the way to extend @value{GDBN}---you
21097 can add new commands that only the external monitor will understand
21101 @node File Transfer
21102 @section Sending files to a remote system
21103 @cindex remote target, file transfer
21104 @cindex file transfer
21105 @cindex sending files to remote systems
21107 Some remote targets offer the ability to transfer files over the same
21108 connection used to communicate with @value{GDBN}. This is convenient
21109 for targets accessible through other means, e.g.@: @sc{gnu}/Linux systems
21110 running @code{gdbserver} over a network interface. For other targets,
21111 e.g.@: embedded devices with only a single serial port, this may be
21112 the only way to upload or download files.
21114 Not all remote targets support these commands.
21118 @item remote put @var{hostfile} @var{targetfile}
21119 Copy file @var{hostfile} from the host system (the machine running
21120 @value{GDBN}) to @var{targetfile} on the target system.
21123 @item remote get @var{targetfile} @var{hostfile}
21124 Copy file @var{targetfile} from the target system to @var{hostfile}
21125 on the host system.
21127 @kindex remote delete
21128 @item remote delete @var{targetfile}
21129 Delete @var{targetfile} from the target system.
21134 @section Using the @code{gdbserver} Program
21137 @cindex remote connection without stubs
21138 @code{gdbserver} is a control program for Unix-like systems, which
21139 allows you to connect your program with a remote @value{GDBN} via
21140 @code{target remote} or @code{target extended-remote}---but without
21141 linking in the usual debugging stub.
21143 @code{gdbserver} is not a complete replacement for the debugging stubs,
21144 because it requires essentially the same operating-system facilities
21145 that @value{GDBN} itself does. In fact, a system that can run
21146 @code{gdbserver} to connect to a remote @value{GDBN} could also run
21147 @value{GDBN} locally! @code{gdbserver} is sometimes useful nevertheless,
21148 because it is a much smaller program than @value{GDBN} itself. It is
21149 also easier to port than all of @value{GDBN}, so you may be able to get
21150 started more quickly on a new system by using @code{gdbserver}.
21151 Finally, if you develop code for real-time systems, you may find that
21152 the tradeoffs involved in real-time operation make it more convenient to
21153 do as much development work as possible on another system, for example
21154 by cross-compiling. You can use @code{gdbserver} to make a similar
21155 choice for debugging.
21157 @value{GDBN} and @code{gdbserver} communicate via either a serial line
21158 or a TCP connection, using the standard @value{GDBN} remote serial
21162 @emph{Warning:} @code{gdbserver} does not have any built-in security.
21163 Do not run @code{gdbserver} connected to any public network; a
21164 @value{GDBN} connection to @code{gdbserver} provides access to the
21165 target system with the same privileges as the user running
21169 @anchor{Running gdbserver}
21170 @subsection Running @code{gdbserver}
21171 @cindex arguments, to @code{gdbserver}
21172 @cindex @code{gdbserver}, command-line arguments
21174 Run @code{gdbserver} on the target system. You need a copy of the
21175 program you want to debug, including any libraries it requires.
21176 @code{gdbserver} does not need your program's symbol table, so you can
21177 strip the program if necessary to save space. @value{GDBN} on the host
21178 system does all the symbol handling.
21180 To use the server, you must tell it how to communicate with @value{GDBN};
21181 the name of your program; and the arguments for your program. The usual
21185 target> gdbserver @var{comm} @var{program} [ @var{args} @dots{} ]
21188 @var{comm} is either a device name (to use a serial line), or a TCP
21189 hostname and portnumber, or @code{-} or @code{stdio} to use
21190 stdin/stdout of @code{gdbserver}.
21191 For example, to debug Emacs with the argument
21192 @samp{foo.txt} and communicate with @value{GDBN} over the serial port
21196 target> gdbserver /dev/com1 emacs foo.txt
21199 @code{gdbserver} waits passively for the host @value{GDBN} to communicate
21202 To use a TCP connection instead of a serial line:
21205 target> gdbserver host:2345 emacs foo.txt
21208 The only difference from the previous example is the first argument,
21209 specifying that you are communicating with the host @value{GDBN} via
21210 TCP. The @samp{host:2345} argument means that @code{gdbserver} is to
21211 expect a TCP connection from machine @samp{host} to local TCP port 2345.
21212 (Currently, the @samp{host} part is ignored.) You can choose any number
21213 you want for the port number as long as it does not conflict with any
21214 TCP ports already in use on the target system (for example, @code{23} is
21215 reserved for @code{telnet}).@footnote{If you choose a port number that
21216 conflicts with another service, @code{gdbserver} prints an error message
21217 and exits.} You must use the same port number with the host @value{GDBN}
21218 @code{target remote} command.
21220 The @code{stdio} connection is useful when starting @code{gdbserver}
21224 (gdb) target remote | ssh -T hostname gdbserver - hello
21227 The @samp{-T} option to ssh is provided because we don't need a remote pty,
21228 and we don't want escape-character handling. Ssh does this by default when
21229 a command is provided, the flag is provided to make it explicit.
21230 You could elide it if you want to.
21232 Programs started with stdio-connected gdbserver have @file{/dev/null} for
21233 @code{stdin}, and @code{stdout},@code{stderr} are sent back to gdb for
21234 display through a pipe connected to gdbserver.
21235 Both @code{stdout} and @code{stderr} use the same pipe.
21237 @anchor{Attaching to a program}
21238 @subsubsection Attaching to a Running Program
21239 @cindex attach to a program, @code{gdbserver}
21240 @cindex @option{--attach}, @code{gdbserver} option
21242 On some targets, @code{gdbserver} can also attach to running programs.
21243 This is accomplished via the @code{--attach} argument. The syntax is:
21246 target> gdbserver --attach @var{comm} @var{pid}
21249 @var{pid} is the process ID of a currently running process. It isn't
21250 necessary to point @code{gdbserver} at a binary for the running process.
21252 In @code{target extended-remote} mode, you can also attach using the
21253 @value{GDBN} attach command
21254 (@pxref{Attaching in Types of Remote Connections}).
21257 You can debug processes by name instead of process ID if your target has the
21258 @code{pidof} utility:
21261 target> gdbserver --attach @var{comm} `pidof @var{program}`
21264 In case more than one copy of @var{program} is running, or @var{program}
21265 has multiple threads, most versions of @code{pidof} support the
21266 @code{-s} option to only return the first process ID.
21268 @subsubsection TCP port allocation lifecycle of @code{gdbserver}
21270 This section applies only when @code{gdbserver} is run to listen on a TCP
21273 @code{gdbserver} normally terminates after all of its debugged processes have
21274 terminated in @kbd{target remote} mode. On the other hand, for @kbd{target
21275 extended-remote}, @code{gdbserver} stays running even with no processes left.
21276 @value{GDBN} normally terminates the spawned debugged process on its exit,
21277 which normally also terminates @code{gdbserver} in the @kbd{target remote}
21278 mode. Therefore, when the connection drops unexpectedly, and @value{GDBN}
21279 cannot ask @code{gdbserver} to kill its debugged processes, @code{gdbserver}
21280 stays running even in the @kbd{target remote} mode.
21282 When @code{gdbserver} stays running, @value{GDBN} can connect to it again later.
21283 Such reconnecting is useful for features like @ref{disconnected tracing}. For
21284 completeness, at most one @value{GDBN} can be connected at a time.
21286 @cindex @option{--once}, @code{gdbserver} option
21287 By default, @code{gdbserver} keeps the listening TCP port open, so that
21288 subsequent connections are possible. However, if you start @code{gdbserver}
21289 with the @option{--once} option, it will stop listening for any further
21290 connection attempts after connecting to the first @value{GDBN} session. This
21291 means no further connections to @code{gdbserver} will be possible after the
21292 first one. It also means @code{gdbserver} will terminate after the first
21293 connection with remote @value{GDBN} has closed, even for unexpectedly closed
21294 connections and even in the @kbd{target extended-remote} mode. The
21295 @option{--once} option allows reusing the same port number for connecting to
21296 multiple instances of @code{gdbserver} running on the same host, since each
21297 instance closes its port after the first connection.
21299 @anchor{Other Command-Line Arguments for gdbserver}
21300 @subsubsection Other Command-Line Arguments for @code{gdbserver}
21302 You can use the @option{--multi} option to start @code{gdbserver} without
21303 specifying a program to debug or a process to attach to. Then you can
21304 attach in @code{target extended-remote} mode and run or attach to a
21305 program. For more information,
21306 @pxref{--multi Option in Types of Remote Connnections}.
21308 @cindex @option{--debug}, @code{gdbserver} option
21309 The @option{--debug} option tells @code{gdbserver} to display extra
21310 status information about the debugging process.
21311 @cindex @option{--remote-debug}, @code{gdbserver} option
21312 The @option{--remote-debug} option tells @code{gdbserver} to display
21313 remote protocol debug output. These options are intended for
21314 @code{gdbserver} development and for bug reports to the developers.
21316 @cindex @option{--debug-format}, @code{gdbserver} option
21317 The @option{--debug-format=option1[,option2,...]} option tells
21318 @code{gdbserver} to include additional information in each output.
21319 Possible options are:
21323 Turn off all extra information in debugging output.
21325 Turn on all extra information in debugging output.
21327 Include a timestamp in each line of debugging output.
21330 Options are processed in order. Thus, for example, if @option{none}
21331 appears last then no additional information is added to debugging output.
21333 @cindex @option{--wrapper}, @code{gdbserver} option
21334 The @option{--wrapper} option specifies a wrapper to launch programs
21335 for debugging. The option should be followed by the name of the
21336 wrapper, then any command-line arguments to pass to the wrapper, then
21337 @kbd{--} indicating the end of the wrapper arguments.
21339 @code{gdbserver} runs the specified wrapper program with a combined
21340 command line including the wrapper arguments, then the name of the
21341 program to debug, then any arguments to the program. The wrapper
21342 runs until it executes your program, and then @value{GDBN} gains control.
21344 You can use any program that eventually calls @code{execve} with
21345 its arguments as a wrapper. Several standard Unix utilities do
21346 this, e.g.@: @code{env} and @code{nohup}. Any Unix shell script ending
21347 with @code{exec "$@@"} will also work.
21349 For example, you can use @code{env} to pass an environment variable to
21350 the debugged program, without setting the variable in @code{gdbserver}'s
21354 $ gdbserver --wrapper env LD_PRELOAD=libtest.so -- :2222 ./testprog
21357 @cindex @option{--selftest}
21358 The @option{--selftest} option runs the self tests in @code{gdbserver}:
21361 $ gdbserver --selftest
21362 Ran 2 unit tests, 0 failed
21365 These tests are disabled in release.
21366 @subsection Connecting to @code{gdbserver}
21368 The basic procedure for connecting to the remote target is:
21372 Run @value{GDBN} on the host system.
21375 Make sure you have the necessary symbol files
21376 (@pxref{Host and target files}).
21377 Load symbols for your application using the @code{file} command before you
21378 connect. Use @code{set sysroot} to locate target libraries (unless your
21379 @value{GDBN} was compiled with the correct sysroot using
21380 @code{--with-sysroot}).
21383 Connect to your target (@pxref{Connecting,,Connecting to a Remote Target}).
21384 For TCP connections, you must start up @code{gdbserver} prior to using
21385 the @code{target} command. Otherwise you may get an error whose
21386 text depends on the host system, but which usually looks something like
21387 @samp{Connection refused}. Don't use the @code{load}
21388 command in @value{GDBN} when using @code{target remote} mode, since the
21389 program is already on the target.
21393 @anchor{Monitor Commands for gdbserver}
21394 @subsection Monitor Commands for @code{gdbserver}
21395 @cindex monitor commands, for @code{gdbserver}
21397 During a @value{GDBN} session using @code{gdbserver}, you can use the
21398 @code{monitor} command to send special requests to @code{gdbserver}.
21399 Here are the available commands.
21403 List the available monitor commands.
21405 @item monitor set debug 0
21406 @itemx monitor set debug 1
21407 Disable or enable general debugging messages.
21409 @item monitor set remote-debug 0
21410 @itemx monitor set remote-debug 1
21411 Disable or enable specific debugging messages associated with the remote
21412 protocol (@pxref{Remote Protocol}).
21414 @item monitor set debug-format option1@r{[},option2,...@r{]}
21415 Specify additional text to add to debugging messages.
21416 Possible options are:
21420 Turn off all extra information in debugging output.
21422 Turn on all extra information in debugging output.
21424 Include a timestamp in each line of debugging output.
21427 Options are processed in order. Thus, for example, if @option{none}
21428 appears last then no additional information is added to debugging output.
21430 @item monitor set libthread-db-search-path [PATH]
21431 @cindex gdbserver, search path for @code{libthread_db}
21432 When this command is issued, @var{path} is a colon-separated list of
21433 directories to search for @code{libthread_db} (@pxref{Threads,,set
21434 libthread-db-search-path}). If you omit @var{path},
21435 @samp{libthread-db-search-path} will be reset to its default value.
21437 The special entry @samp{$pdir} for @samp{libthread-db-search-path} is
21438 not supported in @code{gdbserver}.
21441 Tell gdbserver to exit immediately. This command should be followed by
21442 @code{disconnect} to close the debugging session. @code{gdbserver} will
21443 detach from any attached processes and kill any processes it created.
21444 Use @code{monitor exit} to terminate @code{gdbserver} at the end
21445 of a multi-process mode debug session.
21449 @subsection Tracepoints support in @code{gdbserver}
21450 @cindex tracepoints support in @code{gdbserver}
21452 On some targets, @code{gdbserver} supports tracepoints, fast
21453 tracepoints and static tracepoints.
21455 For fast or static tracepoints to work, a special library called the
21456 @dfn{in-process agent} (IPA), must be loaded in the inferior process.
21457 This library is built and distributed as an integral part of
21458 @code{gdbserver}. In addition, support for static tracepoints
21459 requires building the in-process agent library with static tracepoints
21460 support. At present, the UST (LTTng Userspace Tracer,
21461 @url{http://lttng.org/ust}) tracing engine is supported. This support
21462 is automatically available if UST development headers are found in the
21463 standard include path when @code{gdbserver} is built, or if
21464 @code{gdbserver} was explicitly configured using @option{--with-ust}
21465 to point at such headers. You can explicitly disable the support
21466 using @option{--with-ust=no}.
21468 There are several ways to load the in-process agent in your program:
21471 @item Specifying it as dependency at link time
21473 You can link your program dynamically with the in-process agent
21474 library. On most systems, this is accomplished by adding
21475 @code{-linproctrace} to the link command.
21477 @item Using the system's preloading mechanisms
21479 You can force loading the in-process agent at startup time by using
21480 your system's support for preloading shared libraries. Many Unixes
21481 support the concept of preloading user defined libraries. In most
21482 cases, you do that by specifying @code{LD_PRELOAD=libinproctrace.so}
21483 in the environment. See also the description of @code{gdbserver}'s
21484 @option{--wrapper} command line option.
21486 @item Using @value{GDBN} to force loading the agent at run time
21488 On some systems, you can force the inferior to load a shared library,
21489 by calling a dynamic loader function in the inferior that takes care
21490 of dynamically looking up and loading a shared library. On most Unix
21491 systems, the function is @code{dlopen}. You'll use the @code{call}
21492 command for that. For example:
21495 (@value{GDBP}) call dlopen ("libinproctrace.so", ...)
21498 Note that on most Unix systems, for the @code{dlopen} function to be
21499 available, the program needs to be linked with @code{-ldl}.
21502 On systems that have a userspace dynamic loader, like most Unix
21503 systems, when you connect to @code{gdbserver} using @code{target
21504 remote}, you'll find that the program is stopped at the dynamic
21505 loader's entry point, and no shared library has been loaded in the
21506 program's address space yet, including the in-process agent. In that
21507 case, before being able to use any of the fast or static tracepoints
21508 features, you need to let the loader run and load the shared
21509 libraries. The simplest way to do that is to run the program to the
21510 main procedure. E.g., if debugging a C or C@t{++} program, start
21511 @code{gdbserver} like so:
21514 $ gdbserver :9999 myprogram
21517 Start GDB and connect to @code{gdbserver} like so, and run to main:
21521 (@value{GDBP}) target remote myhost:9999
21522 0x00007f215893ba60 in ?? () from /lib64/ld-linux-x86-64.so.2
21523 (@value{GDBP}) b main
21524 (@value{GDBP}) continue
21527 The in-process tracing agent library should now be loaded into the
21528 process; you can confirm it with the @code{info sharedlibrary}
21529 command, which will list @file{libinproctrace.so} as loaded in the
21530 process. You are now ready to install fast tracepoints, list static
21531 tracepoint markers, probe static tracepoints markers, and start
21534 @node Remote Configuration
21535 @section Remote Configuration
21538 @kindex show remote
21539 This section documents the configuration options available when
21540 debugging remote programs. For the options related to the File I/O
21541 extensions of the remote protocol, see @ref{system,
21542 system-call-allowed}.
21545 @item set remoteaddresssize @var{bits}
21546 @cindex address size for remote targets
21547 @cindex bits in remote address
21548 Set the maximum size of address in a memory packet to the specified
21549 number of bits. @value{GDBN} will mask off the address bits above
21550 that number, when it passes addresses to the remote target. The
21551 default value is the number of bits in the target's address.
21553 @item show remoteaddresssize
21554 Show the current value of remote address size in bits.
21556 @item set serial baud @var{n}
21557 @cindex baud rate for remote targets
21558 Set the baud rate for the remote serial I/O to @var{n} baud. The
21559 value is used to set the speed of the serial port used for debugging
21562 @item show serial baud
21563 Show the current speed of the remote connection.
21565 @item set serial parity @var{parity}
21566 Set the parity for the remote serial I/O. Supported values of @var{parity} are:
21567 @code{even}, @code{none}, and @code{odd}. The default is @code{none}.
21569 @item show serial parity
21570 Show the current parity of the serial port.
21572 @item set remotebreak
21573 @cindex interrupt remote programs
21574 @cindex BREAK signal instead of Ctrl-C
21575 @anchor{set remotebreak}
21576 If set to on, @value{GDBN} sends a @code{BREAK} signal to the remote
21577 when you type @kbd{Ctrl-c} to interrupt the program running
21578 on the remote. If set to off, @value{GDBN} sends the @samp{Ctrl-C}
21579 character instead. The default is off, since most remote systems
21580 expect to see @samp{Ctrl-C} as the interrupt signal.
21582 @item show remotebreak
21583 Show whether @value{GDBN} sends @code{BREAK} or @samp{Ctrl-C} to
21584 interrupt the remote program.
21586 @item set remoteflow on
21587 @itemx set remoteflow off
21588 @kindex set remoteflow
21589 Enable or disable hardware flow control (@code{RTS}/@code{CTS})
21590 on the serial port used to communicate to the remote target.
21592 @item show remoteflow
21593 @kindex show remoteflow
21594 Show the current setting of hardware flow control.
21596 @item set remotelogbase @var{base}
21597 Set the base (a.k.a.@: radix) of logging serial protocol
21598 communications to @var{base}. Supported values of @var{base} are:
21599 @code{ascii}, @code{octal}, and @code{hex}. The default is
21602 @item show remotelogbase
21603 Show the current setting of the radix for logging remote serial
21606 @item set remotelogfile @var{file}
21607 @cindex record serial communications on file
21608 Record remote serial communications on the named @var{file}. The
21609 default is not to record at all.
21611 @item show remotelogfile
21612 Show the current setting of the file name on which to record the
21613 serial communications.
21615 @item set remotetimeout @var{num}
21616 @cindex timeout for serial communications
21617 @cindex remote timeout
21618 Set the timeout limit to wait for the remote target to respond to
21619 @var{num} seconds. The default is 2 seconds.
21621 @item show remotetimeout
21622 Show the current number of seconds to wait for the remote target
21625 @cindex limit hardware breakpoints and watchpoints
21626 @cindex remote target, limit break- and watchpoints
21627 @anchor{set remote hardware-watchpoint-limit}
21628 @anchor{set remote hardware-breakpoint-limit}
21629 @item set remote hardware-watchpoint-limit @var{limit}
21630 @itemx set remote hardware-breakpoint-limit @var{limit}
21631 Restrict @value{GDBN} to using @var{limit} remote hardware watchpoints
21632 or breakpoints. The @var{limit} can be set to 0 to disable hardware
21633 watchpoints or breakpoints, and @code{unlimited} for unlimited
21634 watchpoints or breakpoints.
21636 @item show remote hardware-watchpoint-limit
21637 @itemx show remote hardware-breakpoint-limit
21638 Show the current limit for the number of hardware watchpoints or
21639 breakpoints that @value{GDBN} can use.
21641 @cindex limit hardware watchpoints length
21642 @cindex remote target, limit watchpoints length
21643 @anchor{set remote hardware-watchpoint-length-limit}
21644 @item set remote hardware-watchpoint-length-limit @var{limit}
21645 Restrict @value{GDBN} to using @var{limit} bytes for the maximum
21646 length of a remote hardware watchpoint. A @var{limit} of 0 disables
21647 hardware watchpoints and @code{unlimited} allows watchpoints of any
21650 @item show remote hardware-watchpoint-length-limit
21651 Show the current limit (in bytes) of the maximum length of
21652 a remote hardware watchpoint.
21654 @item set remote exec-file @var{filename}
21655 @itemx show remote exec-file
21656 @anchor{set remote exec-file}
21657 @cindex executable file, for remote target
21658 Select the file used for @code{run} with @code{target
21659 extended-remote}. This should be set to a filename valid on the
21660 target system. If it is not set, the target will use a default
21661 filename (e.g.@: the last program run).
21663 @item set remote interrupt-sequence
21664 @cindex interrupt remote programs
21665 @cindex select Ctrl-C, BREAK or BREAK-g
21666 Allow the user to select one of @samp{Ctrl-C}, a @code{BREAK} or
21667 @samp{BREAK-g} as the
21668 sequence to the remote target in order to interrupt the execution.
21669 @samp{Ctrl-C} is a default. Some system prefers @code{BREAK} which
21670 is high level of serial line for some certain time.
21671 Linux kernel prefers @samp{BREAK-g}, a.k.a Magic SysRq g.
21672 It is @code{BREAK} signal followed by character @code{g}.
21674 @item show interrupt-sequence
21675 Show which of @samp{Ctrl-C}, @code{BREAK} or @code{BREAK-g}
21676 is sent by @value{GDBN} to interrupt the remote program.
21677 @code{BREAK-g} is BREAK signal followed by @code{g} and
21678 also known as Magic SysRq g.
21680 @item set remote interrupt-on-connect
21681 @cindex send interrupt-sequence on start
21682 Specify whether interrupt-sequence is sent to remote target when
21683 @value{GDBN} connects to it. This is mostly needed when you debug
21684 Linux kernel. Linux kernel expects @code{BREAK} followed by @code{g}
21685 which is known as Magic SysRq g in order to connect @value{GDBN}.
21687 @item show interrupt-on-connect
21688 Show whether interrupt-sequence is sent
21689 to remote target when @value{GDBN} connects to it.
21693 @item set tcp auto-retry on
21694 @cindex auto-retry, for remote TCP target
21695 Enable auto-retry for remote TCP connections. This is useful if the remote
21696 debugging agent is launched in parallel with @value{GDBN}; there is a race
21697 condition because the agent may not become ready to accept the connection
21698 before @value{GDBN} attempts to connect. When auto-retry is
21699 enabled, if the initial attempt to connect fails, @value{GDBN} reattempts
21700 to establish the connection using the timeout specified by
21701 @code{set tcp connect-timeout}.
21703 @item set tcp auto-retry off
21704 Do not auto-retry failed TCP connections.
21706 @item show tcp auto-retry
21707 Show the current auto-retry setting.
21709 @item set tcp connect-timeout @var{seconds}
21710 @itemx set tcp connect-timeout unlimited
21711 @cindex connection timeout, for remote TCP target
21712 @cindex timeout, for remote target connection
21713 Set the timeout for establishing a TCP connection to the remote target to
21714 @var{seconds}. The timeout affects both polling to retry failed connections
21715 (enabled by @code{set tcp auto-retry on}) and waiting for connections
21716 that are merely slow to complete, and represents an approximate cumulative
21717 value. If @var{seconds} is @code{unlimited}, there is no timeout and
21718 @value{GDBN} will keep attempting to establish a connection forever,
21719 unless interrupted with @kbd{Ctrl-c}. The default is 15 seconds.
21721 @item show tcp connect-timeout
21722 Show the current connection timeout setting.
21725 @cindex remote packets, enabling and disabling
21726 The @value{GDBN} remote protocol autodetects the packets supported by
21727 your debugging stub. If you need to override the autodetection, you
21728 can use these commands to enable or disable individual packets. Each
21729 packet can be set to @samp{on} (the remote target supports this
21730 packet), @samp{off} (the remote target does not support this packet),
21731 or @samp{auto} (detect remote target support for this packet). They
21732 all default to @samp{auto}. For more information about each packet,
21733 see @ref{Remote Protocol}.
21735 During normal use, you should not have to use any of these commands.
21736 If you do, that may be a bug in your remote debugging stub, or a bug
21737 in @value{GDBN}. You may want to report the problem to the
21738 @value{GDBN} developers.
21740 For each packet @var{name}, the command to enable or disable the
21741 packet is @code{set remote @var{name}-packet}. The available settings
21744 @multitable @columnfractions 0.28 0.32 0.25
21747 @tab Related Features
21749 @item @code{fetch-register}
21751 @tab @code{info registers}
21753 @item @code{set-register}
21757 @item @code{binary-download}
21759 @tab @code{load}, @code{set}
21761 @item @code{read-aux-vector}
21762 @tab @code{qXfer:auxv:read}
21763 @tab @code{info auxv}
21765 @item @code{symbol-lookup}
21766 @tab @code{qSymbol}
21767 @tab Detecting multiple threads
21769 @item @code{attach}
21770 @tab @code{vAttach}
21773 @item @code{verbose-resume}
21775 @tab Stepping or resuming multiple threads
21781 @item @code{software-breakpoint}
21785 @item @code{hardware-breakpoint}
21789 @item @code{write-watchpoint}
21793 @item @code{read-watchpoint}
21797 @item @code{access-watchpoint}
21801 @item @code{pid-to-exec-file}
21802 @tab @code{qXfer:exec-file:read}
21803 @tab @code{attach}, @code{run}
21805 @item @code{target-features}
21806 @tab @code{qXfer:features:read}
21807 @tab @code{set architecture}
21809 @item @code{library-info}
21810 @tab @code{qXfer:libraries:read}
21811 @tab @code{info sharedlibrary}
21813 @item @code{memory-map}
21814 @tab @code{qXfer:memory-map:read}
21815 @tab @code{info mem}
21817 @item @code{read-sdata-object}
21818 @tab @code{qXfer:sdata:read}
21819 @tab @code{print $_sdata}
21821 @item @code{read-spu-object}
21822 @tab @code{qXfer:spu:read}
21823 @tab @code{info spu}
21825 @item @code{write-spu-object}
21826 @tab @code{qXfer:spu:write}
21827 @tab @code{info spu}
21829 @item @code{read-siginfo-object}
21830 @tab @code{qXfer:siginfo:read}
21831 @tab @code{print $_siginfo}
21833 @item @code{write-siginfo-object}
21834 @tab @code{qXfer:siginfo:write}
21835 @tab @code{set $_siginfo}
21837 @item @code{threads}
21838 @tab @code{qXfer:threads:read}
21839 @tab @code{info threads}
21841 @item @code{get-thread-local-@*storage-address}
21842 @tab @code{qGetTLSAddr}
21843 @tab Displaying @code{__thread} variables
21845 @item @code{get-thread-information-block-address}
21846 @tab @code{qGetTIBAddr}
21847 @tab Display MS-Windows Thread Information Block.
21849 @item @code{search-memory}
21850 @tab @code{qSearch:memory}
21853 @item @code{supported-packets}
21854 @tab @code{qSupported}
21855 @tab Remote communications parameters
21857 @item @code{catch-syscalls}
21858 @tab @code{QCatchSyscalls}
21859 @tab @code{catch syscall}
21861 @item @code{pass-signals}
21862 @tab @code{QPassSignals}
21863 @tab @code{handle @var{signal}}
21865 @item @code{program-signals}
21866 @tab @code{QProgramSignals}
21867 @tab @code{handle @var{signal}}
21869 @item @code{hostio-close-packet}
21870 @tab @code{vFile:close}
21871 @tab @code{remote get}, @code{remote put}
21873 @item @code{hostio-open-packet}
21874 @tab @code{vFile:open}
21875 @tab @code{remote get}, @code{remote put}
21877 @item @code{hostio-pread-packet}
21878 @tab @code{vFile:pread}
21879 @tab @code{remote get}, @code{remote put}
21881 @item @code{hostio-pwrite-packet}
21882 @tab @code{vFile:pwrite}
21883 @tab @code{remote get}, @code{remote put}
21885 @item @code{hostio-unlink-packet}
21886 @tab @code{vFile:unlink}
21887 @tab @code{remote delete}
21889 @item @code{hostio-readlink-packet}
21890 @tab @code{vFile:readlink}
21893 @item @code{hostio-fstat-packet}
21894 @tab @code{vFile:fstat}
21897 @item @code{hostio-setfs-packet}
21898 @tab @code{vFile:setfs}
21901 @item @code{noack-packet}
21902 @tab @code{QStartNoAckMode}
21903 @tab Packet acknowledgment
21905 @item @code{osdata}
21906 @tab @code{qXfer:osdata:read}
21907 @tab @code{info os}
21909 @item @code{query-attached}
21910 @tab @code{qAttached}
21911 @tab Querying remote process attach state.
21913 @item @code{trace-buffer-size}
21914 @tab @code{QTBuffer:size}
21915 @tab @code{set trace-buffer-size}
21917 @item @code{trace-status}
21918 @tab @code{qTStatus}
21919 @tab @code{tstatus}
21921 @item @code{traceframe-info}
21922 @tab @code{qXfer:traceframe-info:read}
21923 @tab Traceframe info
21925 @item @code{install-in-trace}
21926 @tab @code{InstallInTrace}
21927 @tab Install tracepoint in tracing
21929 @item @code{disable-randomization}
21930 @tab @code{QDisableRandomization}
21931 @tab @code{set disable-randomization}
21933 @item @code{startup-with-shell}
21934 @tab @code{QStartupWithShell}
21935 @tab @code{set startup-with-shell}
21937 @item @code{environment-hex-encoded}
21938 @tab @code{QEnvironmentHexEncoded}
21939 @tab @code{set environment}
21941 @item @code{environment-unset}
21942 @tab @code{QEnvironmentUnset}
21943 @tab @code{unset environment}
21945 @item @code{environment-reset}
21946 @tab @code{QEnvironmentReset}
21947 @tab @code{Reset the inferior environment (i.e., unset user-set variables)}
21949 @item @code{set-working-dir}
21950 @tab @code{QSetWorkingDir}
21951 @tab @code{set cwd}
21953 @item @code{conditional-breakpoints-packet}
21954 @tab @code{Z0 and Z1}
21955 @tab @code{Support for target-side breakpoint condition evaluation}
21957 @item @code{multiprocess-extensions}
21958 @tab @code{multiprocess extensions}
21959 @tab Debug multiple processes and remote process PID awareness
21961 @item @code{swbreak-feature}
21962 @tab @code{swbreak stop reason}
21965 @item @code{hwbreak-feature}
21966 @tab @code{hwbreak stop reason}
21969 @item @code{fork-event-feature}
21970 @tab @code{fork stop reason}
21973 @item @code{vfork-event-feature}
21974 @tab @code{vfork stop reason}
21977 @item @code{exec-event-feature}
21978 @tab @code{exec stop reason}
21981 @item @code{thread-events}
21982 @tab @code{QThreadEvents}
21983 @tab Tracking thread lifetime.
21985 @item @code{no-resumed-stop-reply}
21986 @tab @code{no resumed thread left stop reply}
21987 @tab Tracking thread lifetime.
21992 @section Implementing a Remote Stub
21994 @cindex debugging stub, example
21995 @cindex remote stub, example
21996 @cindex stub example, remote debugging
21997 The stub files provided with @value{GDBN} implement the target side of the
21998 communication protocol, and the @value{GDBN} side is implemented in the
21999 @value{GDBN} source file @file{remote.c}. Normally, you can simply allow
22000 these subroutines to communicate, and ignore the details. (If you're
22001 implementing your own stub file, you can still ignore the details: start
22002 with one of the existing stub files. @file{sparc-stub.c} is the best
22003 organized, and therefore the easiest to read.)
22005 @cindex remote serial debugging, overview
22006 To debug a program running on another machine (the debugging
22007 @dfn{target} machine), you must first arrange for all the usual
22008 prerequisites for the program to run by itself. For example, for a C
22013 A startup routine to set up the C runtime environment; these usually
22014 have a name like @file{crt0}. The startup routine may be supplied by
22015 your hardware supplier, or you may have to write your own.
22018 A C subroutine library to support your program's
22019 subroutine calls, notably managing input and output.
22022 A way of getting your program to the other machine---for example, a
22023 download program. These are often supplied by the hardware
22024 manufacturer, but you may have to write your own from hardware
22028 The next step is to arrange for your program to use a serial port to
22029 communicate with the machine where @value{GDBN} is running (the @dfn{host}
22030 machine). In general terms, the scheme looks like this:
22034 @value{GDBN} already understands how to use this protocol; when everything
22035 else is set up, you can simply use the @samp{target remote} command
22036 (@pxref{Targets,,Specifying a Debugging Target}).
22038 @item On the target,
22039 you must link with your program a few special-purpose subroutines that
22040 implement the @value{GDBN} remote serial protocol. The file containing these
22041 subroutines is called a @dfn{debugging stub}.
22043 On certain remote targets, you can use an auxiliary program
22044 @code{gdbserver} instead of linking a stub into your program.
22045 @xref{Server,,Using the @code{gdbserver} Program}, for details.
22048 The debugging stub is specific to the architecture of the remote
22049 machine; for example, use @file{sparc-stub.c} to debug programs on
22052 @cindex remote serial stub list
22053 These working remote stubs are distributed with @value{GDBN}:
22058 @cindex @file{i386-stub.c}
22061 For Intel 386 and compatible architectures.
22064 @cindex @file{m68k-stub.c}
22065 @cindex Motorola 680x0
22067 For Motorola 680x0 architectures.
22070 @cindex @file{sh-stub.c}
22073 For Renesas SH architectures.
22076 @cindex @file{sparc-stub.c}
22078 For @sc{sparc} architectures.
22080 @item sparcl-stub.c
22081 @cindex @file{sparcl-stub.c}
22084 For Fujitsu @sc{sparclite} architectures.
22088 The @file{README} file in the @value{GDBN} distribution may list other
22089 recently added stubs.
22092 * Stub Contents:: What the stub can do for you
22093 * Bootstrapping:: What you must do for the stub
22094 * Debug Session:: Putting it all together
22097 @node Stub Contents
22098 @subsection What the Stub Can Do for You
22100 @cindex remote serial stub
22101 The debugging stub for your architecture supplies these three
22105 @item set_debug_traps
22106 @findex set_debug_traps
22107 @cindex remote serial stub, initialization
22108 This routine arranges for @code{handle_exception} to run when your
22109 program stops. You must call this subroutine explicitly in your
22110 program's startup code.
22112 @item handle_exception
22113 @findex handle_exception
22114 @cindex remote serial stub, main routine
22115 This is the central workhorse, but your program never calls it
22116 explicitly---the setup code arranges for @code{handle_exception} to
22117 run when a trap is triggered.
22119 @code{handle_exception} takes control when your program stops during
22120 execution (for example, on a breakpoint), and mediates communications
22121 with @value{GDBN} on the host machine. This is where the communications
22122 protocol is implemented; @code{handle_exception} acts as the @value{GDBN}
22123 representative on the target machine. It begins by sending summary
22124 information on the state of your program, then continues to execute,
22125 retrieving and transmitting any information @value{GDBN} needs, until you
22126 execute a @value{GDBN} command that makes your program resume; at that point,
22127 @code{handle_exception} returns control to your own code on the target
22131 @cindex @code{breakpoint} subroutine, remote
22132 Use this auxiliary subroutine to make your program contain a
22133 breakpoint. Depending on the particular situation, this may be the only
22134 way for @value{GDBN} to get control. For instance, if your target
22135 machine has some sort of interrupt button, you won't need to call this;
22136 pressing the interrupt button transfers control to
22137 @code{handle_exception}---in effect, to @value{GDBN}. On some machines,
22138 simply receiving characters on the serial port may also trigger a trap;
22139 again, in that situation, you don't need to call @code{breakpoint} from
22140 your own program---simply running @samp{target remote} from the host
22141 @value{GDBN} session gets control.
22143 Call @code{breakpoint} if none of these is true, or if you simply want
22144 to make certain your program stops at a predetermined point for the
22145 start of your debugging session.
22148 @node Bootstrapping
22149 @subsection What You Must Do for the Stub
22151 @cindex remote stub, support routines
22152 The debugging stubs that come with @value{GDBN} are set up for a particular
22153 chip architecture, but they have no information about the rest of your
22154 debugging target machine.
22156 First of all you need to tell the stub how to communicate with the
22160 @item int getDebugChar()
22161 @findex getDebugChar
22162 Write this subroutine to read a single character from the serial port.
22163 It may be identical to @code{getchar} for your target system; a
22164 different name is used to allow you to distinguish the two if you wish.
22166 @item void putDebugChar(int)
22167 @findex putDebugChar
22168 Write this subroutine to write a single character to the serial port.
22169 It may be identical to @code{putchar} for your target system; a
22170 different name is used to allow you to distinguish the two if you wish.
22173 @cindex control C, and remote debugging
22174 @cindex interrupting remote targets
22175 If you want @value{GDBN} to be able to stop your program while it is
22176 running, you need to use an interrupt-driven serial driver, and arrange
22177 for it to stop when it receives a @code{^C} (@samp{\003}, the control-C
22178 character). That is the character which @value{GDBN} uses to tell the
22179 remote system to stop.
22181 Getting the debugging target to return the proper status to @value{GDBN}
22182 probably requires changes to the standard stub; one quick and dirty way
22183 is to just execute a breakpoint instruction (the ``dirty'' part is that
22184 @value{GDBN} reports a @code{SIGTRAP} instead of a @code{SIGINT}).
22186 Other routines you need to supply are:
22189 @item void exceptionHandler (int @var{exception_number}, void *@var{exception_address})
22190 @findex exceptionHandler
22191 Write this function to install @var{exception_address} in the exception
22192 handling tables. You need to do this because the stub does not have any
22193 way of knowing what the exception handling tables on your target system
22194 are like (for example, the processor's table might be in @sc{rom},
22195 containing entries which point to a table in @sc{ram}).
22196 The @var{exception_number} specifies the exception which should be changed;
22197 its meaning is architecture-dependent (for example, different numbers
22198 might represent divide by zero, misaligned access, etc). When this
22199 exception occurs, control should be transferred directly to
22200 @var{exception_address}, and the processor state (stack, registers,
22201 and so on) should be just as it is when a processor exception occurs. So if
22202 you want to use a jump instruction to reach @var{exception_address}, it
22203 should be a simple jump, not a jump to subroutine.
22205 For the 386, @var{exception_address} should be installed as an interrupt
22206 gate so that interrupts are masked while the handler runs. The gate
22207 should be at privilege level 0 (the most privileged level). The
22208 @sc{sparc} and 68k stubs are able to mask interrupts themselves without
22209 help from @code{exceptionHandler}.
22211 @item void flush_i_cache()
22212 @findex flush_i_cache
22213 On @sc{sparc} and @sc{sparclite} only, write this subroutine to flush the
22214 instruction cache, if any, on your target machine. If there is no
22215 instruction cache, this subroutine may be a no-op.
22217 On target machines that have instruction caches, @value{GDBN} requires this
22218 function to make certain that the state of your program is stable.
22222 You must also make sure this library routine is available:
22225 @item void *memset(void *, int, int)
22227 This is the standard library function @code{memset} that sets an area of
22228 memory to a known value. If you have one of the free versions of
22229 @code{libc.a}, @code{memset} can be found there; otherwise, you must
22230 either obtain it from your hardware manufacturer, or write your own.
22233 If you do not use the GNU C compiler, you may need other standard
22234 library subroutines as well; this varies from one stub to another,
22235 but in general the stubs are likely to use any of the common library
22236 subroutines which @code{@value{NGCC}} generates as inline code.
22239 @node Debug Session
22240 @subsection Putting it All Together
22242 @cindex remote serial debugging summary
22243 In summary, when your program is ready to debug, you must follow these
22248 Make sure you have defined the supporting low-level routines
22249 (@pxref{Bootstrapping,,What You Must Do for the Stub}):
22251 @code{getDebugChar}, @code{putDebugChar},
22252 @code{flush_i_cache}, @code{memset}, @code{exceptionHandler}.
22256 Insert these lines in your program's startup code, before the main
22257 procedure is called:
22264 On some machines, when a breakpoint trap is raised, the hardware
22265 automatically makes the PC point to the instruction after the
22266 breakpoint. If your machine doesn't do that, you may need to adjust
22267 @code{handle_exception} to arrange for it to return to the instruction
22268 after the breakpoint on this first invocation, so that your program
22269 doesn't keep hitting the initial breakpoint instead of making
22273 For the 680x0 stub only, you need to provide a variable called
22274 @code{exceptionHook}. Normally you just use:
22277 void (*exceptionHook)() = 0;
22281 but if before calling @code{set_debug_traps}, you set it to point to a
22282 function in your program, that function is called when
22283 @code{@value{GDBN}} continues after stopping on a trap (for example, bus
22284 error). The function indicated by @code{exceptionHook} is called with
22285 one parameter: an @code{int} which is the exception number.
22288 Compile and link together: your program, the @value{GDBN} debugging stub for
22289 your target architecture, and the supporting subroutines.
22292 Make sure you have a serial connection between your target machine and
22293 the @value{GDBN} host, and identify the serial port on the host.
22296 @c The "remote" target now provides a `load' command, so we should
22297 @c document that. FIXME.
22298 Download your program to your target machine (or get it there by
22299 whatever means the manufacturer provides), and start it.
22302 Start @value{GDBN} on the host, and connect to the target
22303 (@pxref{Connecting,,Connecting to a Remote Target}).
22307 @node Configurations
22308 @chapter Configuration-Specific Information
22310 While nearly all @value{GDBN} commands are available for all native and
22311 cross versions of the debugger, there are some exceptions. This chapter
22312 describes things that are only available in certain configurations.
22314 There are three major categories of configurations: native
22315 configurations, where the host and target are the same, embedded
22316 operating system configurations, which are usually the same for several
22317 different processor architectures, and bare embedded processors, which
22318 are quite different from each other.
22323 * Embedded Processors::
22330 This section describes details specific to particular native
22334 * BSD libkvm Interface:: Debugging BSD kernel memory images
22335 * Process Information:: Process information
22336 * DJGPP Native:: Features specific to the DJGPP port
22337 * Cygwin Native:: Features specific to the Cygwin port
22338 * Hurd Native:: Features specific to @sc{gnu} Hurd
22339 * Darwin:: Features specific to Darwin
22340 * FreeBSD:: Features specific to FreeBSD
22343 @node BSD libkvm Interface
22344 @subsection BSD libkvm Interface
22347 @cindex kernel memory image
22348 @cindex kernel crash dump
22350 BSD-derived systems (FreeBSD/NetBSD/OpenBSD) have a kernel memory
22351 interface that provides a uniform interface for accessing kernel virtual
22352 memory images, including live systems and crash dumps. @value{GDBN}
22353 uses this interface to allow you to debug live kernels and kernel crash
22354 dumps on many native BSD configurations. This is implemented as a
22355 special @code{kvm} debugging target. For debugging a live system, load
22356 the currently running kernel into @value{GDBN} and connect to the
22360 (@value{GDBP}) @b{target kvm}
22363 For debugging crash dumps, provide the file name of the crash dump as an
22367 (@value{GDBP}) @b{target kvm /var/crash/bsd.0}
22370 Once connected to the @code{kvm} target, the following commands are
22376 Set current context from the @dfn{Process Control Block} (PCB) address.
22379 Set current context from proc address. This command isn't available on
22380 modern FreeBSD systems.
22383 @node Process Information
22384 @subsection Process Information
22386 @cindex examine process image
22387 @cindex process info via @file{/proc}
22389 Some operating systems provide interfaces to fetch additional
22390 information about running processes beyond memory and per-thread
22391 register state. If @value{GDBN} is configured for an operating system
22392 with a supported interface, the command @code{info proc} is available
22393 to report information about the process running your program, or about
22394 any process running on your system.
22396 One supported interface is a facility called @samp{/proc} that can be
22397 used to examine the image of a running process using file-system
22398 subroutines. This facility is supported on @sc{gnu}/Linux and Solaris
22401 On FreeBSD systems, system control nodes are used to query process
22404 In addition, some systems may provide additional process information
22405 in core files. Note that a core file may include a subset of the
22406 information available from a live process. Process information is
22407 currently avaiable from cores created on @sc{gnu}/Linux and FreeBSD
22414 @itemx info proc @var{process-id}
22415 Summarize available information about a process. If a
22416 process ID is specified by @var{process-id}, display information about
22417 that process; otherwise display information about the program being
22418 debugged. The summary includes the debugged process ID, the command
22419 line used to invoke it, its current working directory, and its
22420 executable file's absolute file name.
22422 On some systems, @var{process-id} can be of the form
22423 @samp{[@var{pid}]/@var{tid}} which specifies a certain thread ID
22424 within a process. If the optional @var{pid} part is missing, it means
22425 a thread from the process being debugged (the leading @samp{/} still
22426 needs to be present, or else @value{GDBN} will interpret the number as
22427 a process ID rather than a thread ID).
22429 @item info proc cmdline
22430 @cindex info proc cmdline
22431 Show the original command line of the process. This command is
22432 supported on @sc{gnu}/Linux and FreeBSD.
22434 @item info proc cwd
22435 @cindex info proc cwd
22436 Show the current working directory of the process. This command is
22437 supported on @sc{gnu}/Linux and FreeBSD.
22439 @item info proc exe
22440 @cindex info proc exe
22441 Show the name of executable of the process. This command is supported
22442 on @sc{gnu}/Linux and FreeBSD.
22444 @item info proc files
22445 @cindex info proc files
22446 Show the file descriptors open by the process. For each open file
22447 descriptor, @value{GDBN} shows its number, type (file, directory,
22448 character device, socket), file pointer offset, and the name of the
22449 resource open on the descriptor. The resource name can be a file name
22450 (for files, directories, and devices) or a protocol followed by socket
22451 address (for network connections). This command is supported on
22454 This example shows the open file descriptors for a process using a
22455 tty for standard input and output as well as two network sockets:
22458 (gdb) info proc files 22136
22462 FD Type Offset Flags Name
22463 text file - r-------- /usr/bin/ssh
22464 ctty chr - rw------- /dev/pts/20
22465 cwd dir - r-------- /usr/home/john
22466 root dir - r-------- /
22467 0 chr 0x32933a4 rw------- /dev/pts/20
22468 1 chr 0x32933a4 rw------- /dev/pts/20
22469 2 chr 0x32933a4 rw------- /dev/pts/20
22470 3 socket 0x0 rw----n-- tcp4 10.0.1.2:53014 -> 10.0.1.10:22
22471 4 socket 0x0 rw------- unix stream:/tmp/ssh-FIt89oAzOn5f/agent.2456
22474 @item info proc mappings
22475 @cindex memory address space mappings
22476 Report the memory address space ranges accessible in a process. On
22477 Solaris and FreeBSD systems, each memory range includes information on
22478 whether the process has read, write, or execute access rights to each
22479 range. On @sc{gnu}/Linux and FreeBSD systems, each memory range
22480 includes the object file which is mapped to that range.
22482 @item info proc stat
22483 @itemx info proc status
22484 @cindex process detailed status information
22485 Show additional process-related information, including the user ID and
22486 group ID; virtual memory usage; the signals that are pending, blocked,
22487 and ignored; its TTY; its consumption of system and user time; its
22488 stack size; its @samp{nice} value; etc. These commands are supported
22489 on @sc{gnu}/Linux and FreeBSD.
22491 For @sc{gnu}/Linux systems, see the @samp{proc} man page for more
22492 information (type @kbd{man 5 proc} from your shell prompt).
22494 For FreeBSD systems, @code{info proc stat} is an alias for @code{info
22497 @item info proc all
22498 Show all the information about the process described under all of the
22499 above @code{info proc} subcommands.
22502 @comment These sub-options of 'info proc' were not included when
22503 @comment procfs.c was re-written. Keep their descriptions around
22504 @comment against the day when someone finds the time to put them back in.
22505 @kindex info proc times
22506 @item info proc times
22507 Starting time, user CPU time, and system CPU time for your program and
22510 @kindex info proc id
22512 Report on the process IDs related to your program: its own process ID,
22513 the ID of its parent, the process group ID, and the session ID.
22516 @item set procfs-trace
22517 @kindex set procfs-trace
22518 @cindex @code{procfs} API calls
22519 This command enables and disables tracing of @code{procfs} API calls.
22521 @item show procfs-trace
22522 @kindex show procfs-trace
22523 Show the current state of @code{procfs} API call tracing.
22525 @item set procfs-file @var{file}
22526 @kindex set procfs-file
22527 Tell @value{GDBN} to write @code{procfs} API trace to the named
22528 @var{file}. @value{GDBN} appends the trace info to the previous
22529 contents of the file. The default is to display the trace on the
22532 @item show procfs-file
22533 @kindex show procfs-file
22534 Show the file to which @code{procfs} API trace is written.
22536 @item proc-trace-entry
22537 @itemx proc-trace-exit
22538 @itemx proc-untrace-entry
22539 @itemx proc-untrace-exit
22540 @kindex proc-trace-entry
22541 @kindex proc-trace-exit
22542 @kindex proc-untrace-entry
22543 @kindex proc-untrace-exit
22544 These commands enable and disable tracing of entries into and exits
22545 from the @code{syscall} interface.
22548 @kindex info pidlist
22549 @cindex process list, QNX Neutrino
22550 For QNX Neutrino only, this command displays the list of all the
22551 processes and all the threads within each process.
22554 @kindex info meminfo
22555 @cindex mapinfo list, QNX Neutrino
22556 For QNX Neutrino only, this command displays the list of all mapinfos.
22560 @subsection Features for Debugging @sc{djgpp} Programs
22561 @cindex @sc{djgpp} debugging
22562 @cindex native @sc{djgpp} debugging
22563 @cindex MS-DOS-specific commands
22566 @sc{djgpp} is a port of the @sc{gnu} development tools to MS-DOS and
22567 MS-Windows. @sc{djgpp} programs are 32-bit protected-mode programs
22568 that use the @dfn{DPMI} (DOS Protected-Mode Interface) API to run on
22569 top of real-mode DOS systems and their emulations.
22571 @value{GDBN} supports native debugging of @sc{djgpp} programs, and
22572 defines a few commands specific to the @sc{djgpp} port. This
22573 subsection describes those commands.
22578 This is a prefix of @sc{djgpp}-specific commands which print
22579 information about the target system and important OS structures.
22582 @cindex MS-DOS system info
22583 @cindex free memory information (MS-DOS)
22584 @item info dos sysinfo
22585 This command displays assorted information about the underlying
22586 platform: the CPU type and features, the OS version and flavor, the
22587 DPMI version, and the available conventional and DPMI memory.
22592 @cindex segment descriptor tables
22593 @cindex descriptor tables display
22595 @itemx info dos ldt
22596 @itemx info dos idt
22597 These 3 commands display entries from, respectively, Global, Local,
22598 and Interrupt Descriptor Tables (GDT, LDT, and IDT). The descriptor
22599 tables are data structures which store a descriptor for each segment
22600 that is currently in use. The segment's selector is an index into a
22601 descriptor table; the table entry for that index holds the
22602 descriptor's base address and limit, and its attributes and access
22605 A typical @sc{djgpp} program uses 3 segments: a code segment, a data
22606 segment (used for both data and the stack), and a DOS segment (which
22607 allows access to DOS/BIOS data structures and absolute addresses in
22608 conventional memory). However, the DPMI host will usually define
22609 additional segments in order to support the DPMI environment.
22611 @cindex garbled pointers
22612 These commands allow to display entries from the descriptor tables.
22613 Without an argument, all entries from the specified table are
22614 displayed. An argument, which should be an integer expression, means
22615 display a single entry whose index is given by the argument. For
22616 example, here's a convenient way to display information about the
22617 debugged program's data segment:
22620 @exdent @code{(@value{GDBP}) info dos ldt $ds}
22621 @exdent @code{0x13f: base=0x11970000 limit=0x0009ffff 32-Bit Data (Read/Write, Exp-up)}
22625 This comes in handy when you want to see whether a pointer is outside
22626 the data segment's limit (i.e.@: @dfn{garbled}).
22628 @cindex page tables display (MS-DOS)
22630 @itemx info dos pte
22631 These two commands display entries from, respectively, the Page
22632 Directory and the Page Tables. Page Directories and Page Tables are
22633 data structures which control how virtual memory addresses are mapped
22634 into physical addresses. A Page Table includes an entry for every
22635 page of memory that is mapped into the program's address space; there
22636 may be several Page Tables, each one holding up to 4096 entries. A
22637 Page Directory has up to 4096 entries, one each for every Page Table
22638 that is currently in use.
22640 Without an argument, @kbd{info dos pde} displays the entire Page
22641 Directory, and @kbd{info dos pte} displays all the entries in all of
22642 the Page Tables. An argument, an integer expression, given to the
22643 @kbd{info dos pde} command means display only that entry from the Page
22644 Directory table. An argument given to the @kbd{info dos pte} command
22645 means display entries from a single Page Table, the one pointed to by
22646 the specified entry in the Page Directory.
22648 @cindex direct memory access (DMA) on MS-DOS
22649 These commands are useful when your program uses @dfn{DMA} (Direct
22650 Memory Access), which needs physical addresses to program the DMA
22653 These commands are supported only with some DPMI servers.
22655 @cindex physical address from linear address
22656 @item info dos address-pte @var{addr}
22657 This command displays the Page Table entry for a specified linear
22658 address. The argument @var{addr} is a linear address which should
22659 already have the appropriate segment's base address added to it,
22660 because this command accepts addresses which may belong to @emph{any}
22661 segment. For example, here's how to display the Page Table entry for
22662 the page where a variable @code{i} is stored:
22665 @exdent @code{(@value{GDBP}) info dos address-pte __djgpp_base_address + (char *)&i}
22666 @exdent @code{Page Table entry for address 0x11a00d30:}
22667 @exdent @code{Base=0x02698000 Dirty Acc. Not-Cached Write-Back Usr Read-Write +0xd30}
22671 This says that @code{i} is stored at offset @code{0xd30} from the page
22672 whose physical base address is @code{0x02698000}, and shows all the
22673 attributes of that page.
22675 Note that you must cast the addresses of variables to a @code{char *},
22676 since otherwise the value of @code{__djgpp_base_address}, the base
22677 address of all variables and functions in a @sc{djgpp} program, will
22678 be added using the rules of C pointer arithmetics: if @code{i} is
22679 declared an @code{int}, @value{GDBN} will add 4 times the value of
22680 @code{__djgpp_base_address} to the address of @code{i}.
22682 Here's another example, it displays the Page Table entry for the
22686 @exdent @code{(@value{GDBP}) info dos address-pte *((unsigned *)&_go32_info_block + 3)}
22687 @exdent @code{Page Table entry for address 0x29110:}
22688 @exdent @code{Base=0x00029000 Dirty Acc. Not-Cached Write-Back Usr Read-Write +0x110}
22692 (The @code{+ 3} offset is because the transfer buffer's address is the
22693 3rd member of the @code{_go32_info_block} structure.) The output
22694 clearly shows that this DPMI server maps the addresses in conventional
22695 memory 1:1, i.e.@: the physical (@code{0x00029000} + @code{0x110}) and
22696 linear (@code{0x29110}) addresses are identical.
22698 This command is supported only with some DPMI servers.
22701 @cindex DOS serial data link, remote debugging
22702 In addition to native debugging, the DJGPP port supports remote
22703 debugging via a serial data link. The following commands are specific
22704 to remote serial debugging in the DJGPP port of @value{GDBN}.
22707 @kindex set com1base
22708 @kindex set com1irq
22709 @kindex set com2base
22710 @kindex set com2irq
22711 @kindex set com3base
22712 @kindex set com3irq
22713 @kindex set com4base
22714 @kindex set com4irq
22715 @item set com1base @var{addr}
22716 This command sets the base I/O port address of the @file{COM1} serial
22719 @item set com1irq @var{irq}
22720 This command sets the @dfn{Interrupt Request} (@code{IRQ}) line to use
22721 for the @file{COM1} serial port.
22723 There are similar commands @samp{set com2base}, @samp{set com3irq},
22724 etc.@: for setting the port address and the @code{IRQ} lines for the
22727 @kindex show com1base
22728 @kindex show com1irq
22729 @kindex show com2base
22730 @kindex show com2irq
22731 @kindex show com3base
22732 @kindex show com3irq
22733 @kindex show com4base
22734 @kindex show com4irq
22735 The related commands @samp{show com1base}, @samp{show com1irq} etc.@:
22736 display the current settings of the base address and the @code{IRQ}
22737 lines used by the COM ports.
22740 @kindex info serial
22741 @cindex DOS serial port status
22742 This command prints the status of the 4 DOS serial ports. For each
22743 port, it prints whether it's active or not, its I/O base address and
22744 IRQ number, whether it uses a 16550-style FIFO, its baudrate, and the
22745 counts of various errors encountered so far.
22749 @node Cygwin Native
22750 @subsection Features for Debugging MS Windows PE Executables
22751 @cindex MS Windows debugging
22752 @cindex native Cygwin debugging
22753 @cindex Cygwin-specific commands
22755 @value{GDBN} supports native debugging of MS Windows programs, including
22756 DLLs with and without symbolic debugging information.
22758 @cindex Ctrl-BREAK, MS-Windows
22759 @cindex interrupt debuggee on MS-Windows
22760 MS-Windows programs that call @code{SetConsoleMode} to switch off the
22761 special meaning of the @samp{Ctrl-C} keystroke cannot be interrupted
22762 by typing @kbd{C-c}. For this reason, @value{GDBN} on MS-Windows
22763 supports @kbd{C-@key{BREAK}} as an alternative interrupt key
22764 sequence, which can be used to interrupt the debuggee even if it
22767 There are various additional Cygwin-specific commands, described in
22768 this section. Working with DLLs that have no debugging symbols is
22769 described in @ref{Non-debug DLL Symbols}.
22774 This is a prefix of MS Windows-specific commands which print
22775 information about the target system and important OS structures.
22777 @item info w32 selector
22778 This command displays information returned by
22779 the Win32 API @code{GetThreadSelectorEntry} function.
22780 It takes an optional argument that is evaluated to
22781 a long value to give the information about this given selector.
22782 Without argument, this command displays information
22783 about the six segment registers.
22785 @item info w32 thread-information-block
22786 This command displays thread specific information stored in the
22787 Thread Information Block (readable on the X86 CPU family using @code{$fs}
22788 selector for 32-bit programs and @code{$gs} for 64-bit programs).
22790 @kindex signal-event
22791 @item signal-event @var{id}
22792 This command signals an event with user-provided @var{id}. Used to resume
22793 crashing process when attached to it using MS-Windows JIT debugging (AeDebug).
22795 To use it, create or edit the following keys in
22796 @code{HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\AeDebug} and/or
22797 @code{HKLM\SOFTWARE\Wow6432Node\Microsoft\Windows NT\CurrentVersion\AeDebug}
22798 (for x86_64 versions):
22802 @code{Debugger} (REG_SZ) --- a command to launch the debugger.
22803 Suggested command is: @code{@var{fully-qualified-path-to-gdb.exe} -ex
22804 "attach %ld" -ex "signal-event %ld" -ex "continue"}.
22806 The first @code{%ld} will be replaced by the process ID of the
22807 crashing process, the second @code{%ld} will be replaced by the ID of
22808 the event that blocks the crashing process, waiting for @value{GDBN}
22812 @code{Auto} (REG_SZ) --- either @code{1} or @code{0}. @code{1} will
22813 make the system run debugger specified by the Debugger key
22814 automatically, @code{0} will cause a dialog box with ``OK'' and
22815 ``Cancel'' buttons to appear, which allows the user to either
22816 terminate the crashing process (OK) or debug it (Cancel).
22819 @kindex set cygwin-exceptions
22820 @cindex debugging the Cygwin DLL
22821 @cindex Cygwin DLL, debugging
22822 @item set cygwin-exceptions @var{mode}
22823 If @var{mode} is @code{on}, @value{GDBN} will break on exceptions that
22824 happen inside the Cygwin DLL. If @var{mode} is @code{off},
22825 @value{GDBN} will delay recognition of exceptions, and may ignore some
22826 exceptions which seem to be caused by internal Cygwin DLL
22827 ``bookkeeping''. This option is meant primarily for debugging the
22828 Cygwin DLL itself; the default value is @code{off} to avoid annoying
22829 @value{GDBN} users with false @code{SIGSEGV} signals.
22831 @kindex show cygwin-exceptions
22832 @item show cygwin-exceptions
22833 Displays whether @value{GDBN} will break on exceptions that happen
22834 inside the Cygwin DLL itself.
22836 @kindex set new-console
22837 @item set new-console @var{mode}
22838 If @var{mode} is @code{on} the debuggee will
22839 be started in a new console on next start.
22840 If @var{mode} is @code{off}, the debuggee will
22841 be started in the same console as the debugger.
22843 @kindex show new-console
22844 @item show new-console
22845 Displays whether a new console is used
22846 when the debuggee is started.
22848 @kindex set new-group
22849 @item set new-group @var{mode}
22850 This boolean value controls whether the debuggee should
22851 start a new group or stay in the same group as the debugger.
22852 This affects the way the Windows OS handles
22855 @kindex show new-group
22856 @item show new-group
22857 Displays current value of new-group boolean.
22859 @kindex set debugevents
22860 @item set debugevents
22861 This boolean value adds debug output concerning kernel events related
22862 to the debuggee seen by the debugger. This includes events that
22863 signal thread and process creation and exit, DLL loading and
22864 unloading, console interrupts, and debugging messages produced by the
22865 Windows @code{OutputDebugString} API call.
22867 @kindex set debugexec
22868 @item set debugexec
22869 This boolean value adds debug output concerning execute events
22870 (such as resume thread) seen by the debugger.
22872 @kindex set debugexceptions
22873 @item set debugexceptions
22874 This boolean value adds debug output concerning exceptions in the
22875 debuggee seen by the debugger.
22877 @kindex set debugmemory
22878 @item set debugmemory
22879 This boolean value adds debug output concerning debuggee memory reads
22880 and writes by the debugger.
22884 This boolean values specifies whether the debuggee is called
22885 via a shell or directly (default value is on).
22889 Displays if the debuggee will be started with a shell.
22894 * Non-debug DLL Symbols:: Support for DLLs without debugging symbols
22897 @node Non-debug DLL Symbols
22898 @subsubsection Support for DLLs without Debugging Symbols
22899 @cindex DLLs with no debugging symbols
22900 @cindex Minimal symbols and DLLs
22902 Very often on windows, some of the DLLs that your program relies on do
22903 not include symbolic debugging information (for example,
22904 @file{kernel32.dll}). When @value{GDBN} doesn't recognize any debugging
22905 symbols in a DLL, it relies on the minimal amount of symbolic
22906 information contained in the DLL's export table. This section
22907 describes working with such symbols, known internally to @value{GDBN} as
22908 ``minimal symbols''.
22910 Note that before the debugged program has started execution, no DLLs
22911 will have been loaded. The easiest way around this problem is simply to
22912 start the program --- either by setting a breakpoint or letting the
22913 program run once to completion.
22915 @subsubsection DLL Name Prefixes
22917 In keeping with the naming conventions used by the Microsoft debugging
22918 tools, DLL export symbols are made available with a prefix based on the
22919 DLL name, for instance @code{KERNEL32!CreateFileA}. The plain name is
22920 also entered into the symbol table, so @code{CreateFileA} is often
22921 sufficient. In some cases there will be name clashes within a program
22922 (particularly if the executable itself includes full debugging symbols)
22923 necessitating the use of the fully qualified name when referring to the
22924 contents of the DLL. Use single-quotes around the name to avoid the
22925 exclamation mark (``!'') being interpreted as a language operator.
22927 Note that the internal name of the DLL may be all upper-case, even
22928 though the file name of the DLL is lower-case, or vice-versa. Since
22929 symbols within @value{GDBN} are @emph{case-sensitive} this may cause
22930 some confusion. If in doubt, try the @code{info functions} and
22931 @code{info variables} commands or even @code{maint print msymbols}
22932 (@pxref{Symbols}). Here's an example:
22935 (@value{GDBP}) info function CreateFileA
22936 All functions matching regular expression "CreateFileA":
22938 Non-debugging symbols:
22939 0x77e885f4 CreateFileA
22940 0x77e885f4 KERNEL32!CreateFileA
22944 (@value{GDBP}) info function !
22945 All functions matching regular expression "!":
22947 Non-debugging symbols:
22948 0x6100114c cygwin1!__assert
22949 0x61004034 cygwin1!_dll_crt0@@0
22950 0x61004240 cygwin1!dll_crt0(per_process *)
22954 @subsubsection Working with Minimal Symbols
22956 Symbols extracted from a DLL's export table do not contain very much
22957 type information. All that @value{GDBN} can do is guess whether a symbol
22958 refers to a function or variable depending on the linker section that
22959 contains the symbol. Also note that the actual contents of the memory
22960 contained in a DLL are not available unless the program is running. This
22961 means that you cannot examine the contents of a variable or disassemble
22962 a function within a DLL without a running program.
22964 Variables are generally treated as pointers and dereferenced
22965 automatically. For this reason, it is often necessary to prefix a
22966 variable name with the address-of operator (``&'') and provide explicit
22967 type information in the command. Here's an example of the type of
22971 (@value{GDBP}) print 'cygwin1!__argv'
22972 'cygwin1!__argv' has unknown type; cast it to its declared type
22976 (@value{GDBP}) x 'cygwin1!__argv'
22977 'cygwin1!__argv' has unknown type; cast it to its declared type
22980 And two possible solutions:
22983 (@value{GDBP}) print ((char **)'cygwin1!__argv')[0]
22984 $2 = 0x22fd98 "/cygdrive/c/mydirectory/myprogram"
22988 (@value{GDBP}) x/2x &'cygwin1!__argv'
22989 0x610c0aa8 <cygwin1!__argv>: 0x10021608 0x00000000
22990 (@value{GDBP}) x/x 0x10021608
22991 0x10021608: 0x0022fd98
22992 (@value{GDBP}) x/s 0x0022fd98
22993 0x22fd98: "/cygdrive/c/mydirectory/myprogram"
22996 Setting a break point within a DLL is possible even before the program
22997 starts execution. However, under these circumstances, @value{GDBN} can't
22998 examine the initial instructions of the function in order to skip the
22999 function's frame set-up code. You can work around this by using ``*&''
23000 to set the breakpoint at a raw memory address:
23003 (@value{GDBP}) break *&'python22!PyOS_Readline'
23004 Breakpoint 1 at 0x1e04eff0
23007 The author of these extensions is not entirely convinced that setting a
23008 break point within a shared DLL like @file{kernel32.dll} is completely
23012 @subsection Commands Specific to @sc{gnu} Hurd Systems
23013 @cindex @sc{gnu} Hurd debugging
23015 This subsection describes @value{GDBN} commands specific to the
23016 @sc{gnu} Hurd native debugging.
23021 @kindex set signals@r{, Hurd command}
23022 @kindex set sigs@r{, Hurd command}
23023 This command toggles the state of inferior signal interception by
23024 @value{GDBN}. Mach exceptions, such as breakpoint traps, are not
23025 affected by this command. @code{sigs} is a shorthand alias for
23030 @kindex show signals@r{, Hurd command}
23031 @kindex show sigs@r{, Hurd command}
23032 Show the current state of intercepting inferior's signals.
23034 @item set signal-thread
23035 @itemx set sigthread
23036 @kindex set signal-thread
23037 @kindex set sigthread
23038 This command tells @value{GDBN} which thread is the @code{libc} signal
23039 thread. That thread is run when a signal is delivered to a running
23040 process. @code{set sigthread} is the shorthand alias of @code{set
23043 @item show signal-thread
23044 @itemx show sigthread
23045 @kindex show signal-thread
23046 @kindex show sigthread
23047 These two commands show which thread will run when the inferior is
23048 delivered a signal.
23051 @kindex set stopped@r{, Hurd command}
23052 This commands tells @value{GDBN} that the inferior process is stopped,
23053 as with the @code{SIGSTOP} signal. The stopped process can be
23054 continued by delivering a signal to it.
23057 @kindex show stopped@r{, Hurd command}
23058 This command shows whether @value{GDBN} thinks the debuggee is
23061 @item set exceptions
23062 @kindex set exceptions@r{, Hurd command}
23063 Use this command to turn off trapping of exceptions in the inferior.
23064 When exception trapping is off, neither breakpoints nor
23065 single-stepping will work. To restore the default, set exception
23068 @item show exceptions
23069 @kindex show exceptions@r{, Hurd command}
23070 Show the current state of trapping exceptions in the inferior.
23072 @item set task pause
23073 @kindex set task@r{, Hurd commands}
23074 @cindex task attributes (@sc{gnu} Hurd)
23075 @cindex pause current task (@sc{gnu} Hurd)
23076 This command toggles task suspension when @value{GDBN} has control.
23077 Setting it to on takes effect immediately, and the task is suspended
23078 whenever @value{GDBN} gets control. Setting it to off will take
23079 effect the next time the inferior is continued. If this option is set
23080 to off, you can use @code{set thread default pause on} or @code{set
23081 thread pause on} (see below) to pause individual threads.
23083 @item show task pause
23084 @kindex show task@r{, Hurd commands}
23085 Show the current state of task suspension.
23087 @item set task detach-suspend-count
23088 @cindex task suspend count
23089 @cindex detach from task, @sc{gnu} Hurd
23090 This command sets the suspend count the task will be left with when
23091 @value{GDBN} detaches from it.
23093 @item show task detach-suspend-count
23094 Show the suspend count the task will be left with when detaching.
23096 @item set task exception-port
23097 @itemx set task excp
23098 @cindex task exception port, @sc{gnu} Hurd
23099 This command sets the task exception port to which @value{GDBN} will
23100 forward exceptions. The argument should be the value of the @dfn{send
23101 rights} of the task. @code{set task excp} is a shorthand alias.
23103 @item set noninvasive
23104 @cindex noninvasive task options
23105 This command switches @value{GDBN} to a mode that is the least
23106 invasive as far as interfering with the inferior is concerned. This
23107 is the same as using @code{set task pause}, @code{set exceptions}, and
23108 @code{set signals} to values opposite to the defaults.
23110 @item info send-rights
23111 @itemx info receive-rights
23112 @itemx info port-rights
23113 @itemx info port-sets
23114 @itemx info dead-names
23117 @cindex send rights, @sc{gnu} Hurd
23118 @cindex receive rights, @sc{gnu} Hurd
23119 @cindex port rights, @sc{gnu} Hurd
23120 @cindex port sets, @sc{gnu} Hurd
23121 @cindex dead names, @sc{gnu} Hurd
23122 These commands display information about, respectively, send rights,
23123 receive rights, port rights, port sets, and dead names of a task.
23124 There are also shorthand aliases: @code{info ports} for @code{info
23125 port-rights} and @code{info psets} for @code{info port-sets}.
23127 @item set thread pause
23128 @kindex set thread@r{, Hurd command}
23129 @cindex thread properties, @sc{gnu} Hurd
23130 @cindex pause current thread (@sc{gnu} Hurd)
23131 This command toggles current thread suspension when @value{GDBN} has
23132 control. Setting it to on takes effect immediately, and the current
23133 thread is suspended whenever @value{GDBN} gets control. Setting it to
23134 off will take effect the next time the inferior is continued.
23135 Normally, this command has no effect, since when @value{GDBN} has
23136 control, the whole task is suspended. However, if you used @code{set
23137 task pause off} (see above), this command comes in handy to suspend
23138 only the current thread.
23140 @item show thread pause
23141 @kindex show thread@r{, Hurd command}
23142 This command shows the state of current thread suspension.
23144 @item set thread run
23145 This command sets whether the current thread is allowed to run.
23147 @item show thread run
23148 Show whether the current thread is allowed to run.
23150 @item set thread detach-suspend-count
23151 @cindex thread suspend count, @sc{gnu} Hurd
23152 @cindex detach from thread, @sc{gnu} Hurd
23153 This command sets the suspend count @value{GDBN} will leave on a
23154 thread when detaching. This number is relative to the suspend count
23155 found by @value{GDBN} when it notices the thread; use @code{set thread
23156 takeover-suspend-count} to force it to an absolute value.
23158 @item show thread detach-suspend-count
23159 Show the suspend count @value{GDBN} will leave on the thread when
23162 @item set thread exception-port
23163 @itemx set thread excp
23164 Set the thread exception port to which to forward exceptions. This
23165 overrides the port set by @code{set task exception-port} (see above).
23166 @code{set thread excp} is the shorthand alias.
23168 @item set thread takeover-suspend-count
23169 Normally, @value{GDBN}'s thread suspend counts are relative to the
23170 value @value{GDBN} finds when it notices each thread. This command
23171 changes the suspend counts to be absolute instead.
23173 @item set thread default
23174 @itemx show thread default
23175 @cindex thread default settings, @sc{gnu} Hurd
23176 Each of the above @code{set thread} commands has a @code{set thread
23177 default} counterpart (e.g., @code{set thread default pause}, @code{set
23178 thread default exception-port}, etc.). The @code{thread default}
23179 variety of commands sets the default thread properties for all
23180 threads; you can then change the properties of individual threads with
23181 the non-default commands.
23188 @value{GDBN} provides the following commands specific to the Darwin target:
23191 @item set debug darwin @var{num}
23192 @kindex set debug darwin
23193 When set to a non zero value, enables debugging messages specific to
23194 the Darwin support. Higher values produce more verbose output.
23196 @item show debug darwin
23197 @kindex show debug darwin
23198 Show the current state of Darwin messages.
23200 @item set debug mach-o @var{num}
23201 @kindex set debug mach-o
23202 When set to a non zero value, enables debugging messages while
23203 @value{GDBN} is reading Darwin object files. (@dfn{Mach-O} is the
23204 file format used on Darwin for object and executable files.) Higher
23205 values produce more verbose output. This is a command to diagnose
23206 problems internal to @value{GDBN} and should not be needed in normal
23209 @item show debug mach-o
23210 @kindex show debug mach-o
23211 Show the current state of Mach-O file messages.
23213 @item set mach-exceptions on
23214 @itemx set mach-exceptions off
23215 @kindex set mach-exceptions
23216 On Darwin, faults are first reported as a Mach exception and are then
23217 mapped to a Posix signal. Use this command to turn on trapping of
23218 Mach exceptions in the inferior. This might be sometimes useful to
23219 better understand the cause of a fault. The default is off.
23221 @item show mach-exceptions
23222 @kindex show mach-exceptions
23223 Show the current state of exceptions trapping.
23227 @subsection FreeBSD
23230 When the ABI of a system call is changed in the FreeBSD kernel, this
23231 is implemented by leaving a compatibility system call using the old
23232 ABI at the existing number and allocating a new system call number for
23233 the version using the new ABI. As a convenience, when a system call
23234 is caught by name (@pxref{catch syscall}), compatibility system calls
23237 For example, FreeBSD 12 introduced a new variant of the @code{kevent}
23238 system call and catching the @code{kevent} system call by name catches
23242 (@value{GDBP}) catch syscall kevent
23243 Catchpoint 1 (syscalls 'freebsd11_kevent' [363] 'kevent' [560])
23249 @section Embedded Operating Systems
23251 This section describes configurations involving the debugging of
23252 embedded operating systems that are available for several different
23255 @value{GDBN} includes the ability to debug programs running on
23256 various real-time operating systems.
23258 @node Embedded Processors
23259 @section Embedded Processors
23261 This section goes into details specific to particular embedded
23264 @cindex send command to simulator
23265 Whenever a specific embedded processor has a simulator, @value{GDBN}
23266 allows to send an arbitrary command to the simulator.
23269 @item sim @var{command}
23270 @kindex sim@r{, a command}
23271 Send an arbitrary @var{command} string to the simulator. Consult the
23272 documentation for the specific simulator in use for information about
23273 acceptable commands.
23278 * ARC:: Synopsys ARC
23280 * M68K:: Motorola M68K
23281 * MicroBlaze:: Xilinx MicroBlaze
23282 * MIPS Embedded:: MIPS Embedded
23283 * OpenRISC 1000:: OpenRISC 1000 (or1k)
23284 * PowerPC Embedded:: PowerPC Embedded
23287 * Super-H:: Renesas Super-H
23291 @subsection Synopsys ARC
23292 @cindex Synopsys ARC
23293 @cindex ARC specific commands
23299 @value{GDBN} provides the following ARC-specific commands:
23302 @item set debug arc
23303 @kindex set debug arc
23304 Control the level of ARC specific debug messages. Use 0 for no messages (the
23305 default), 1 for debug messages, and 2 for even more debug messages.
23307 @item show debug arc
23308 @kindex show debug arc
23309 Show the level of ARC specific debugging in operation.
23311 @item maint print arc arc-instruction @var{address}
23312 @kindex maint print arc arc-instruction
23313 Print internal disassembler information about instruction at a given address.
23320 @value{GDBN} provides the following ARM-specific commands:
23323 @item set arm disassembler
23325 This commands selects from a list of disassembly styles. The
23326 @code{"std"} style is the standard style.
23328 @item show arm disassembler
23330 Show the current disassembly style.
23332 @item set arm apcs32
23333 @cindex ARM 32-bit mode
23334 This command toggles ARM operation mode between 32-bit and 26-bit.
23336 @item show arm apcs32
23337 Display the current usage of the ARM 32-bit mode.
23339 @item set arm fpu @var{fputype}
23340 This command sets the ARM floating-point unit (FPU) type. The
23341 argument @var{fputype} can be one of these:
23345 Determine the FPU type by querying the OS ABI.
23347 Software FPU, with mixed-endian doubles on little-endian ARM
23350 GCC-compiled FPA co-processor.
23352 Software FPU with pure-endian doubles.
23358 Show the current type of the FPU.
23361 This command forces @value{GDBN} to use the specified ABI.
23364 Show the currently used ABI.
23366 @item set arm fallback-mode (arm|thumb|auto)
23367 @value{GDBN} uses the symbol table, when available, to determine
23368 whether instructions are ARM or Thumb. This command controls
23369 @value{GDBN}'s default behavior when the symbol table is not
23370 available. The default is @samp{auto}, which causes @value{GDBN} to
23371 use the current execution mode (from the @code{T} bit in the @code{CPSR}
23374 @item show arm fallback-mode
23375 Show the current fallback instruction mode.
23377 @item set arm force-mode (arm|thumb|auto)
23378 This command overrides use of the symbol table to determine whether
23379 instructions are ARM or Thumb. The default is @samp{auto}, which
23380 causes @value{GDBN} to use the symbol table and then the setting
23381 of @samp{set arm fallback-mode}.
23383 @item show arm force-mode
23384 Show the current forced instruction mode.
23386 @item set debug arm
23387 Toggle whether to display ARM-specific debugging messages from the ARM
23388 target support subsystem.
23390 @item show debug arm
23391 Show whether ARM-specific debugging messages are enabled.
23395 @item target sim @r{[}@var{simargs}@r{]} @dots{}
23396 The @value{GDBN} ARM simulator accepts the following optional arguments.
23399 @item --swi-support=@var{type}
23400 Tell the simulator which SWI interfaces to support. The argument
23401 @var{type} may be a comma separated list of the following values.
23402 The default value is @code{all}.
23417 The Motorola m68k configuration includes ColdFire support.
23420 @subsection MicroBlaze
23421 @cindex Xilinx MicroBlaze
23422 @cindex XMD, Xilinx Microprocessor Debugger
23424 The MicroBlaze is a soft-core processor supported on various Xilinx
23425 FPGAs, such as Spartan or Virtex series. Boards with these processors
23426 usually have JTAG ports which connect to a host system running the Xilinx
23427 Embedded Development Kit (EDK) or Software Development Kit (SDK).
23428 This host system is used to download the configuration bitstream to
23429 the target FPGA. The Xilinx Microprocessor Debugger (XMD) program
23430 communicates with the target board using the JTAG interface and
23431 presents a @code{gdbserver} interface to the board. By default
23432 @code{xmd} uses port @code{1234}. (While it is possible to change
23433 this default port, it requires the use of undocumented @code{xmd}
23434 commands. Contact Xilinx support if you need to do this.)
23436 Use these GDB commands to connect to the MicroBlaze target processor.
23439 @item target remote :1234
23440 Use this command to connect to the target if you are running @value{GDBN}
23441 on the same system as @code{xmd}.
23443 @item target remote @var{xmd-host}:1234
23444 Use this command to connect to the target if it is connected to @code{xmd}
23445 running on a different system named @var{xmd-host}.
23448 Use this command to download a program to the MicroBlaze target.
23450 @item set debug microblaze @var{n}
23451 Enable MicroBlaze-specific debugging messages if non-zero.
23453 @item show debug microblaze @var{n}
23454 Show MicroBlaze-specific debugging level.
23457 @node MIPS Embedded
23458 @subsection @acronym{MIPS} Embedded
23461 @value{GDBN} supports these special commands for @acronym{MIPS} targets:
23464 @item set mipsfpu double
23465 @itemx set mipsfpu single
23466 @itemx set mipsfpu none
23467 @itemx set mipsfpu auto
23468 @itemx show mipsfpu
23469 @kindex set mipsfpu
23470 @kindex show mipsfpu
23471 @cindex @acronym{MIPS} remote floating point
23472 @cindex floating point, @acronym{MIPS} remote
23473 If your target board does not support the @acronym{MIPS} floating point
23474 coprocessor, you should use the command @samp{set mipsfpu none} (if you
23475 need this, you may wish to put the command in your @value{GDBN} init
23476 file). This tells @value{GDBN} how to find the return value of
23477 functions which return floating point values. It also allows
23478 @value{GDBN} to avoid saving the floating point registers when calling
23479 functions on the board. If you are using a floating point coprocessor
23480 with only single precision floating point support, as on the @sc{r4650}
23481 processor, use the command @samp{set mipsfpu single}. The default
23482 double precision floating point coprocessor may be selected using
23483 @samp{set mipsfpu double}.
23485 In previous versions the only choices were double precision or no
23486 floating point, so @samp{set mipsfpu on} will select double precision
23487 and @samp{set mipsfpu off} will select no floating point.
23489 As usual, you can inquire about the @code{mipsfpu} variable with
23490 @samp{show mipsfpu}.
23493 @node OpenRISC 1000
23494 @subsection OpenRISC 1000
23495 @cindex OpenRISC 1000
23498 The OpenRISC 1000 provides a free RISC instruction set architecture. It is
23499 mainly provided as a soft-core which can run on Xilinx, Altera and other
23502 @value{GDBN} for OpenRISC supports the below commands when connecting to
23510 Runs the builtin CPU simulator which can run very basic
23511 programs but does not support most hardware functions like MMU.
23512 For more complex use cases the user is advised to run an external
23513 target, and connect using @samp{target remote}.
23515 Example: @code{target sim}
23517 @item set debug or1k
23518 Toggle whether to display OpenRISC-specific debugging messages from the
23519 OpenRISC target support subsystem.
23521 @item show debug or1k
23522 Show whether OpenRISC-specific debugging messages are enabled.
23525 @node PowerPC Embedded
23526 @subsection PowerPC Embedded
23528 @cindex DVC register
23529 @value{GDBN} supports using the DVC (Data Value Compare) register to
23530 implement in hardware simple hardware watchpoint conditions of the form:
23533 (@value{GDBP}) watch @var{ADDRESS|VARIABLE} \
23534 if @var{ADDRESS|VARIABLE} == @var{CONSTANT EXPRESSION}
23537 The DVC register will be automatically used when @value{GDBN} detects
23538 such pattern in a condition expression, and the created watchpoint uses one
23539 debug register (either the @code{exact-watchpoints} option is on and the
23540 variable is scalar, or the variable has a length of one byte). This feature
23541 is available in native @value{GDBN} running on a Linux kernel version 2.6.34
23544 When running on PowerPC embedded processors, @value{GDBN} automatically uses
23545 ranged hardware watchpoints, unless the @code{exact-watchpoints} option is on,
23546 in which case watchpoints using only one debug register are created when
23547 watching variables of scalar types.
23549 You can create an artificial array to watch an arbitrary memory
23550 region using one of the following commands (@pxref{Expressions}):
23553 (@value{GDBP}) watch *((char *) @var{address})@@@var{length}
23554 (@value{GDBP}) watch @{char[@var{length}]@} @var{address}
23557 PowerPC embedded processors support masked watchpoints. See the discussion
23558 about the @code{mask} argument in @ref{Set Watchpoints}.
23560 @cindex ranged breakpoint
23561 PowerPC embedded processors support hardware accelerated
23562 @dfn{ranged breakpoints}. A ranged breakpoint stops execution of
23563 the inferior whenever it executes an instruction at any address within
23564 the range it specifies. To set a ranged breakpoint in @value{GDBN},
23565 use the @code{break-range} command.
23567 @value{GDBN} provides the following PowerPC-specific commands:
23570 @kindex break-range
23571 @item break-range @var{start-location}, @var{end-location}
23572 Set a breakpoint for an address range given by
23573 @var{start-location} and @var{end-location}, which can specify a function name,
23574 a line number, an offset of lines from the current line or from the start
23575 location, or an address of an instruction (see @ref{Specify Location},
23576 for a list of all the possible ways to specify a @var{location}.)
23577 The breakpoint will stop execution of the inferior whenever it
23578 executes an instruction at any address within the specified range,
23579 (including @var{start-location} and @var{end-location}.)
23581 @kindex set powerpc
23582 @item set powerpc soft-float
23583 @itemx show powerpc soft-float
23584 Force @value{GDBN} to use (or not use) a software floating point calling
23585 convention. By default, @value{GDBN} selects the calling convention based
23586 on the selected architecture and the provided executable file.
23588 @item set powerpc vector-abi
23589 @itemx show powerpc vector-abi
23590 Force @value{GDBN} to use the specified calling convention for vector
23591 arguments and return values. The valid options are @samp{auto};
23592 @samp{generic}, to avoid vector registers even if they are present;
23593 @samp{altivec}, to use AltiVec registers; and @samp{spe} to use SPE
23594 registers. By default, @value{GDBN} selects the calling convention
23595 based on the selected architecture and the provided executable file.
23597 @item set powerpc exact-watchpoints
23598 @itemx show powerpc exact-watchpoints
23599 Allow @value{GDBN} to use only one debug register when watching a variable
23600 of scalar type, thus assuming that the variable is accessed through the
23601 address of its first byte.
23606 @subsection Atmel AVR
23609 When configured for debugging the Atmel AVR, @value{GDBN} supports the
23610 following AVR-specific commands:
23613 @item info io_registers
23614 @kindex info io_registers@r{, AVR}
23615 @cindex I/O registers (Atmel AVR)
23616 This command displays information about the AVR I/O registers. For
23617 each register, @value{GDBN} prints its number and value.
23624 When configured for debugging CRIS, @value{GDBN} provides the
23625 following CRIS-specific commands:
23628 @item set cris-version @var{ver}
23629 @cindex CRIS version
23630 Set the current CRIS version to @var{ver}, either @samp{10} or @samp{32}.
23631 The CRIS version affects register names and sizes. This command is useful in
23632 case autodetection of the CRIS version fails.
23634 @item show cris-version
23635 Show the current CRIS version.
23637 @item set cris-dwarf2-cfi
23638 @cindex DWARF-2 CFI and CRIS
23639 Set the usage of DWARF-2 CFI for CRIS debugging. The default is @samp{on}.
23640 Change to @samp{off} when using @code{gcc-cris} whose version is below
23643 @item show cris-dwarf2-cfi
23644 Show the current state of using DWARF-2 CFI.
23646 @item set cris-mode @var{mode}
23648 Set the current CRIS mode to @var{mode}. It should only be changed when
23649 debugging in guru mode, in which case it should be set to
23650 @samp{guru} (the default is @samp{normal}).
23652 @item show cris-mode
23653 Show the current CRIS mode.
23657 @subsection Renesas Super-H
23660 For the Renesas Super-H processor, @value{GDBN} provides these
23664 @item set sh calling-convention @var{convention}
23665 @kindex set sh calling-convention
23666 Set the calling-convention used when calling functions from @value{GDBN}.
23667 Allowed values are @samp{gcc}, which is the default setting, and @samp{renesas}.
23668 With the @samp{gcc} setting, functions are called using the @value{NGCC} calling
23669 convention. If the DWARF-2 information of the called function specifies
23670 that the function follows the Renesas calling convention, the function
23671 is called using the Renesas calling convention. If the calling convention
23672 is set to @samp{renesas}, the Renesas calling convention is always used,
23673 regardless of the DWARF-2 information. This can be used to override the
23674 default of @samp{gcc} if debug information is missing, or the compiler
23675 does not emit the DWARF-2 calling convention entry for a function.
23677 @item show sh calling-convention
23678 @kindex show sh calling-convention
23679 Show the current calling convention setting.
23684 @node Architectures
23685 @section Architectures
23687 This section describes characteristics of architectures that affect
23688 all uses of @value{GDBN} with the architecture, both native and cross.
23695 * HPPA:: HP PA architecture
23696 * SPU:: Cell Broadband Engine SPU architecture
23704 @subsection AArch64
23705 @cindex AArch64 support
23707 When @value{GDBN} is debugging the AArch64 architecture, it provides the
23708 following special commands:
23711 @item set debug aarch64
23712 @kindex set debug aarch64
23713 This command determines whether AArch64 architecture-specific debugging
23714 messages are to be displayed.
23716 @item show debug aarch64
23717 Show whether AArch64 debugging messages are displayed.
23721 @subsubsection AArch64 SVE.
23722 @cindex AArch64 SVE.
23724 When @value{GDBN} is debugging the AArch64 architecture, if the Scalable Vector
23725 Extension (SVE) is present, then @value{GDBN} will provide the vector registers
23726 @code{$z0} through @code{$z31}, vector predicate registers @code{$p0} through
23727 @code{$p15}, and the @code{$ffr} register. In addition, the pseudo register
23728 @code{$vg} will be provided. This is the vector granule for the current thread
23729 and represents the number of 64-bit chunks in an SVE @code{z} register.
23731 If the vector length changes, then the @code{$vg} register will be updated,
23732 but the lengths of the @code{z} and @code{p} registers will not change. This
23733 is a known limitation of @value{GDBN} and does not affect the execution of the
23738 @subsection x86 Architecture-specific Issues
23741 @item set struct-convention @var{mode}
23742 @kindex set struct-convention
23743 @cindex struct return convention
23744 @cindex struct/union returned in registers
23745 Set the convention used by the inferior to return @code{struct}s and
23746 @code{union}s from functions to @var{mode}. Possible values of
23747 @var{mode} are @code{"pcc"}, @code{"reg"}, and @code{"default"} (the
23748 default). @code{"default"} or @code{"pcc"} means that @code{struct}s
23749 are returned on the stack, while @code{"reg"} means that a
23750 @code{struct} or a @code{union} whose size is 1, 2, 4, or 8 bytes will
23751 be returned in a register.
23753 @item show struct-convention
23754 @kindex show struct-convention
23755 Show the current setting of the convention to return @code{struct}s
23760 @subsubsection Intel @dfn{Memory Protection Extensions} (MPX).
23761 @cindex Intel Memory Protection Extensions (MPX).
23763 Memory Protection Extension (MPX) adds the bound registers @samp{BND0}
23764 @footnote{The register named with capital letters represent the architecture
23765 registers.} through @samp{BND3}. Bound registers store a pair of 64-bit values
23766 which are the lower bound and upper bound. Bounds are effective addresses or
23767 memory locations. The upper bounds are architecturally represented in 1's
23768 complement form. A bound having lower bound = 0, and upper bound = 0
23769 (1's complement of all bits set) will allow access to the entire address space.
23771 @samp{BND0} through @samp{BND3} are represented in @value{GDBN} as @samp{bnd0raw}
23772 through @samp{bnd3raw}. Pseudo registers @samp{bnd0} through @samp{bnd3}
23773 display the upper bound performing the complement of one operation on the
23774 upper bound value, i.e.@ when upper bound in @samp{bnd0raw} is 0 in the
23775 @value{GDBN} @samp{bnd0} it will be @code{0xfff@dots{}}. In this sense it
23776 can also be noted that the upper bounds are inclusive.
23778 As an example, assume that the register BND0 holds bounds for a pointer having
23779 access allowed for the range between 0x32 and 0x71. The values present on
23780 bnd0raw and bnd registers are presented as follows:
23783 bnd0raw = @{0x32, 0xffffffff8e@}
23784 bnd0 = @{lbound = 0x32, ubound = 0x71@} : size 64
23787 This way the raw value can be accessed via bnd0raw@dots{}bnd3raw. Any
23788 change on bnd0@dots{}bnd3 or bnd0raw@dots{}bnd3raw is reflect on its
23789 counterpart. When the bnd0@dots{}bnd3 registers are displayed via
23790 Python, the display includes the memory size, in bits, accessible to
23793 Bounds can also be stored in bounds tables, which are stored in
23794 application memory. These tables store bounds for pointers by specifying
23795 the bounds pointer's value along with its bounds. Evaluating and changing
23796 bounds located in bound tables is therefore interesting while investigating
23797 bugs on MPX context. @value{GDBN} provides commands for this purpose:
23800 @item show mpx bound @var{pointer}
23801 @kindex show mpx bound
23802 Display bounds of the given @var{pointer}.
23804 @item set mpx bound @var{pointer}, @var{lbound}, @var{ubound}
23805 @kindex set mpx bound
23806 Set the bounds of a pointer in the bound table.
23807 This command takes three parameters: @var{pointer} is the pointers
23808 whose bounds are to be changed, @var{lbound} and @var{ubound} are new values
23809 for lower and upper bounds respectively.
23812 When you call an inferior function on an Intel MPX enabled program,
23813 GDB sets the inferior's bound registers to the init (disabled) state
23814 before calling the function. As a consequence, bounds checks for the
23815 pointer arguments passed to the function will always pass.
23817 This is necessary because when you call an inferior function, the
23818 program is usually in the middle of the execution of other function.
23819 Since at that point bound registers are in an arbitrary state, not
23820 clearing them would lead to random bound violations in the called
23823 You can still examine the influence of the bound registers on the
23824 execution of the called function by stopping the execution of the
23825 called function at its prologue, setting bound registers, and
23826 continuing the execution. For example:
23830 Breakpoint 2 at 0x4009de: file i386-mpx-call.c, line 47.
23831 $ print upper (a, b, c, d, 1)
23832 Breakpoint 2, upper (a=0x0, b=0x6e0000005b, c=0x0, d=0x0, len=48)....
23834 @{lbound = 0x0, ubound = ffffffff@} : size -1
23837 At this last step the value of bnd0 can be changed for investigation of bound
23838 violations caused along the execution of the call. In order to know how to
23839 set the bound registers or bound table for the call consult the ABI.
23844 See the following section.
23847 @subsection @acronym{MIPS}
23849 @cindex stack on Alpha
23850 @cindex stack on @acronym{MIPS}
23851 @cindex Alpha stack
23852 @cindex @acronym{MIPS} stack
23853 Alpha- and @acronym{MIPS}-based computers use an unusual stack frame, which
23854 sometimes requires @value{GDBN} to search backward in the object code to
23855 find the beginning of a function.
23857 @cindex response time, @acronym{MIPS} debugging
23858 To improve response time (especially for embedded applications, where
23859 @value{GDBN} may be restricted to a slow serial line for this search)
23860 you may want to limit the size of this search, using one of these
23864 @cindex @code{heuristic-fence-post} (Alpha, @acronym{MIPS})
23865 @item set heuristic-fence-post @var{limit}
23866 Restrict @value{GDBN} to examining at most @var{limit} bytes in its
23867 search for the beginning of a function. A value of @var{0} (the
23868 default) means there is no limit. However, except for @var{0}, the
23869 larger the limit the more bytes @code{heuristic-fence-post} must search
23870 and therefore the longer it takes to run. You should only need to use
23871 this command when debugging a stripped executable.
23873 @item show heuristic-fence-post
23874 Display the current limit.
23878 These commands are available @emph{only} when @value{GDBN} is configured
23879 for debugging programs on Alpha or @acronym{MIPS} processors.
23881 Several @acronym{MIPS}-specific commands are available when debugging @acronym{MIPS}
23885 @item set mips abi @var{arg}
23886 @kindex set mips abi
23887 @cindex set ABI for @acronym{MIPS}
23888 Tell @value{GDBN} which @acronym{MIPS} ABI is used by the inferior. Possible
23889 values of @var{arg} are:
23893 The default ABI associated with the current binary (this is the
23903 @item show mips abi
23904 @kindex show mips abi
23905 Show the @acronym{MIPS} ABI used by @value{GDBN} to debug the inferior.
23907 @item set mips compression @var{arg}
23908 @kindex set mips compression
23909 @cindex code compression, @acronym{MIPS}
23910 Tell @value{GDBN} which @acronym{MIPS} compressed
23911 @acronym{ISA, Instruction Set Architecture} encoding is used by the
23912 inferior. @value{GDBN} uses this for code disassembly and other
23913 internal interpretation purposes. This setting is only referred to
23914 when no executable has been associated with the debugging session or
23915 the executable does not provide information about the encoding it uses.
23916 Otherwise this setting is automatically updated from information
23917 provided by the executable.
23919 Possible values of @var{arg} are @samp{mips16} and @samp{micromips}.
23920 The default compressed @acronym{ISA} encoding is @samp{mips16}, as
23921 executables containing @acronym{MIPS16} code frequently are not
23922 identified as such.
23924 This setting is ``sticky''; that is, it retains its value across
23925 debugging sessions until reset either explicitly with this command or
23926 implicitly from an executable.
23928 The compiler and/or assembler typically add symbol table annotations to
23929 identify functions compiled for the @acronym{MIPS16} or
23930 @acronym{microMIPS} @acronym{ISA}s. If these function-scope annotations
23931 are present, @value{GDBN} uses them in preference to the global
23932 compressed @acronym{ISA} encoding setting.
23934 @item show mips compression
23935 @kindex show mips compression
23936 Show the @acronym{MIPS} compressed @acronym{ISA} encoding used by
23937 @value{GDBN} to debug the inferior.
23940 @itemx show mipsfpu
23941 @xref{MIPS Embedded, set mipsfpu}.
23943 @item set mips mask-address @var{arg}
23944 @kindex set mips mask-address
23945 @cindex @acronym{MIPS} addresses, masking
23946 This command determines whether the most-significant 32 bits of 64-bit
23947 @acronym{MIPS} addresses are masked off. The argument @var{arg} can be
23948 @samp{on}, @samp{off}, or @samp{auto}. The latter is the default
23949 setting, which lets @value{GDBN} determine the correct value.
23951 @item show mips mask-address
23952 @kindex show mips mask-address
23953 Show whether the upper 32 bits of @acronym{MIPS} addresses are masked off or
23956 @item set remote-mips64-transfers-32bit-regs
23957 @kindex set remote-mips64-transfers-32bit-regs
23958 This command controls compatibility with 64-bit @acronym{MIPS} targets that
23959 transfer data in 32-bit quantities. If you have an old @acronym{MIPS} 64 target
23960 that transfers 32 bits for some registers, like @sc{sr} and @sc{fsr},
23961 and 64 bits for other registers, set this option to @samp{on}.
23963 @item show remote-mips64-transfers-32bit-regs
23964 @kindex show remote-mips64-transfers-32bit-regs
23965 Show the current setting of compatibility with older @acronym{MIPS} 64 targets.
23967 @item set debug mips
23968 @kindex set debug mips
23969 This command turns on and off debugging messages for the @acronym{MIPS}-specific
23970 target code in @value{GDBN}.
23972 @item show debug mips
23973 @kindex show debug mips
23974 Show the current setting of @acronym{MIPS} debugging messages.
23980 @cindex HPPA support
23982 When @value{GDBN} is debugging the HP PA architecture, it provides the
23983 following special commands:
23986 @item set debug hppa
23987 @kindex set debug hppa
23988 This command determines whether HPPA architecture-specific debugging
23989 messages are to be displayed.
23991 @item show debug hppa
23992 Show whether HPPA debugging messages are displayed.
23994 @item maint print unwind @var{address}
23995 @kindex maint print unwind@r{, HPPA}
23996 This command displays the contents of the unwind table entry at the
23997 given @var{address}.
24003 @subsection Cell Broadband Engine SPU architecture
24004 @cindex Cell Broadband Engine
24007 When @value{GDBN} is debugging the Cell Broadband Engine SPU architecture,
24008 it provides the following special commands:
24011 @item info spu event
24013 Display SPU event facility status. Shows current event mask
24014 and pending event status.
24016 @item info spu signal
24017 Display SPU signal notification facility status. Shows pending
24018 signal-control word and signal notification mode of both signal
24019 notification channels.
24021 @item info spu mailbox
24022 Display SPU mailbox facility status. Shows all pending entries,
24023 in order of processing, in each of the SPU Write Outbound,
24024 SPU Write Outbound Interrupt, and SPU Read Inbound mailboxes.
24027 Display MFC DMA status. Shows all pending commands in the MFC
24028 DMA queue. For each entry, opcode, tag, class IDs, effective
24029 and local store addresses and transfer size are shown.
24031 @item info spu proxydma
24032 Display MFC Proxy-DMA status. Shows all pending commands in the MFC
24033 Proxy-DMA queue. For each entry, opcode, tag, class IDs, effective
24034 and local store addresses and transfer size are shown.
24038 When @value{GDBN} is debugging a combined PowerPC/SPU application
24039 on the Cell Broadband Engine, it provides in addition the following
24043 @item set spu stop-on-load @var{arg}
24045 Set whether to stop for new SPE threads. When set to @code{on}, @value{GDBN}
24046 will give control to the user when a new SPE thread enters its @code{main}
24047 function. The default is @code{off}.
24049 @item show spu stop-on-load
24051 Show whether to stop for new SPE threads.
24053 @item set spu auto-flush-cache @var{arg}
24054 Set whether to automatically flush the software-managed cache. When set to
24055 @code{on}, @value{GDBN} will automatically cause the SPE software-managed
24056 cache to be flushed whenever SPE execution stops. This provides a consistent
24057 view of PowerPC memory that is accessed via the cache. If an application
24058 does not use the software-managed cache, this option has no effect.
24060 @item show spu auto-flush-cache
24061 Show whether to automatically flush the software-managed cache.
24066 @subsection PowerPC
24067 @cindex PowerPC architecture
24069 When @value{GDBN} is debugging the PowerPC architecture, it provides a set of
24070 pseudo-registers to enable inspection of 128-bit wide Decimal Floating Point
24071 numbers stored in the floating point registers. These values must be stored
24072 in two consecutive registers, always starting at an even register like
24073 @code{f0} or @code{f2}.
24075 The pseudo-registers go from @code{$dl0} through @code{$dl15}, and are formed
24076 by joining the even/odd register pairs @code{f0} and @code{f1} for @code{$dl0},
24077 @code{f2} and @code{f3} for @code{$dl1} and so on.
24079 For POWER7 processors, @value{GDBN} provides a set of pseudo-registers, the 64-bit
24080 wide Extended Floating Point Registers (@samp{f32} through @samp{f63}).
24083 @subsection Nios II
24084 @cindex Nios II architecture
24086 When @value{GDBN} is debugging the Nios II architecture,
24087 it provides the following special commands:
24091 @item set debug nios2
24092 @kindex set debug nios2
24093 This command turns on and off debugging messages for the Nios II
24094 target code in @value{GDBN}.
24096 @item show debug nios2
24097 @kindex show debug nios2
24098 Show the current setting of Nios II debugging messages.
24102 @subsection Sparc64
24103 @cindex Sparc64 support
24104 @cindex Application Data Integrity
24105 @subsubsection ADI Support
24107 The M7 processor supports an Application Data Integrity (ADI) feature that
24108 detects invalid data accesses. When software allocates memory and enables
24109 ADI on the allocated memory, it chooses a 4-bit version number, sets the
24110 version in the upper 4 bits of the 64-bit pointer to that data, and stores
24111 the 4-bit version in every cacheline of that data. Hardware saves the latter
24112 in spare bits in the cache and memory hierarchy. On each load and store,
24113 the processor compares the upper 4 VA (virtual address) bits to the
24114 cacheline's version. If there is a mismatch, the processor generates a
24115 version mismatch trap which can be either precise or disrupting. The trap
24116 is an error condition which the kernel delivers to the process as a SIGSEGV
24119 Note that only 64-bit applications can use ADI and need to be built with
24122 Values of the ADI version tags, which are in granularity of a
24123 cacheline (64 bytes), can be viewed or modified.
24127 @kindex adi examine
24128 @item adi (examine | x) [ / @var{n} ] @var{addr}
24130 The @code{adi examine} command displays the value of one ADI version tag per
24133 @var{n} is a decimal integer specifying the number in bytes; the default
24134 is 1. It specifies how much ADI version information, at the ratio of 1:ADI
24135 block size, to display.
24137 @var{addr} is the address in user address space where you want @value{GDBN}
24138 to begin displaying the ADI version tags.
24140 Below is an example of displaying ADI versions of variable "shmaddr".
24143 (@value{GDBP}) adi x/100 shmaddr
24144 0xfff800010002c000: 0 0
24148 @item adi (assign | a) [ / @var{n} ] @var{addr} = @var{tag}
24150 The @code{adi assign} command is used to assign new ADI version tag
24153 @var{n} is a decimal integer specifying the number in bytes;
24154 the default is 1. It specifies how much ADI version information, at the
24155 ratio of 1:ADI block size, to modify.
24157 @var{addr} is the address in user address space where you want @value{GDBN}
24158 to begin modifying the ADI version tags.
24160 @var{tag} is the new ADI version tag.
24162 For example, do the following to modify then verify ADI versions of
24163 variable "shmaddr":
24166 (@value{GDBP}) adi a/100 shmaddr = 7
24167 (@value{GDBP}) adi x/100 shmaddr
24168 0xfff800010002c000: 7 7
24175 @cindex S12Z support
24177 When @value{GDBN} is debugging the S12Z architecture,
24178 it provides the following special command:
24181 @item maint info bdccsr
24182 @kindex maint info bdccsr@r{, S12Z}
24183 This command displays the current value of the microprocessor's
24188 @node Controlling GDB
24189 @chapter Controlling @value{GDBN}
24191 You can alter the way @value{GDBN} interacts with you by using the
24192 @code{set} command. For commands controlling how @value{GDBN} displays
24193 data, see @ref{Print Settings, ,Print Settings}. Other settings are
24198 * Editing:: Command editing
24199 * Command History:: Command history
24200 * Screen Size:: Screen size
24201 * Output Styling:: Output styling
24202 * Numbers:: Numbers
24203 * ABI:: Configuring the current ABI
24204 * Auto-loading:: Automatically loading associated files
24205 * Messages/Warnings:: Optional warnings and messages
24206 * Debugging Output:: Optional messages about internal happenings
24207 * Other Misc Settings:: Other Miscellaneous Settings
24215 @value{GDBN} indicates its readiness to read a command by printing a string
24216 called the @dfn{prompt}. This string is normally @samp{(@value{GDBP})}. You
24217 can change the prompt string with the @code{set prompt} command. For
24218 instance, when debugging @value{GDBN} with @value{GDBN}, it is useful to change
24219 the prompt in one of the @value{GDBN} sessions so that you can always tell
24220 which one you are talking to.
24222 @emph{Note:} @code{set prompt} does not add a space for you after the
24223 prompt you set. This allows you to set a prompt which ends in a space
24224 or a prompt that does not.
24228 @item set prompt @var{newprompt}
24229 Directs @value{GDBN} to use @var{newprompt} as its prompt string henceforth.
24231 @kindex show prompt
24233 Prints a line of the form: @samp{Gdb's prompt is: @var{your-prompt}}
24236 Versions of @value{GDBN} that ship with Python scripting enabled have
24237 prompt extensions. The commands for interacting with these extensions
24241 @kindex set extended-prompt
24242 @item set extended-prompt @var{prompt}
24243 Set an extended prompt that allows for substitutions.
24244 @xref{gdb.prompt}, for a list of escape sequences that can be used for
24245 substitution. Any escape sequences specified as part of the prompt
24246 string are replaced with the corresponding strings each time the prompt
24252 set extended-prompt Current working directory: \w (gdb)
24255 Note that when an extended-prompt is set, it takes control of the
24256 @var{prompt_hook} hook. @xref{prompt_hook}, for further information.
24258 @kindex show extended-prompt
24259 @item show extended-prompt
24260 Prints the extended prompt. Any escape sequences specified as part of
24261 the prompt string with @code{set extended-prompt}, are replaced with the
24262 corresponding strings each time the prompt is displayed.
24266 @section Command Editing
24268 @cindex command line editing
24270 @value{GDBN} reads its input commands via the @dfn{Readline} interface. This
24271 @sc{gnu} library provides consistent behavior for programs which provide a
24272 command line interface to the user. Advantages are @sc{gnu} Emacs-style
24273 or @dfn{vi}-style inline editing of commands, @code{csh}-like history
24274 substitution, and a storage and recall of command history across
24275 debugging sessions.
24277 You may control the behavior of command line editing in @value{GDBN} with the
24278 command @code{set}.
24281 @kindex set editing
24284 @itemx set editing on
24285 Enable command line editing (enabled by default).
24287 @item set editing off
24288 Disable command line editing.
24290 @kindex show editing
24292 Show whether command line editing is enabled.
24295 @ifset SYSTEM_READLINE
24296 @xref{Command Line Editing, , , rluserman, GNU Readline Library},
24298 @ifclear SYSTEM_READLINE
24299 @xref{Command Line Editing},
24301 for more details about the Readline
24302 interface. Users unfamiliar with @sc{gnu} Emacs or @code{vi} are
24303 encouraged to read that chapter.
24305 @node Command History
24306 @section Command History
24307 @cindex command history
24309 @value{GDBN} can keep track of the commands you type during your
24310 debugging sessions, so that you can be certain of precisely what
24311 happened. Use these commands to manage the @value{GDBN} command
24314 @value{GDBN} uses the @sc{gnu} History library, a part of the Readline
24315 package, to provide the history facility.
24316 @ifset SYSTEM_READLINE
24317 @xref{Using History Interactively, , , history, GNU History Library},
24319 @ifclear SYSTEM_READLINE
24320 @xref{Using History Interactively},
24322 for the detailed description of the History library.
24324 To issue a command to @value{GDBN} without affecting certain aspects of
24325 the state which is seen by users, prefix it with @samp{server }
24326 (@pxref{Server Prefix}). This
24327 means that this command will not affect the command history, nor will it
24328 affect @value{GDBN}'s notion of which command to repeat if @key{RET} is
24329 pressed on a line by itself.
24331 @cindex @code{server}, command prefix
24332 The server prefix does not affect the recording of values into the value
24333 history; to print a value without recording it into the value history,
24334 use the @code{output} command instead of the @code{print} command.
24336 Here is the description of @value{GDBN} commands related to command
24340 @cindex history substitution
24341 @cindex history file
24342 @kindex set history filename
24343 @cindex @env{GDBHISTFILE}, environment variable
24344 @item set history filename @var{fname}
24345 Set the name of the @value{GDBN} command history file to @var{fname}.
24346 This is the file where @value{GDBN} reads an initial command history
24347 list, and where it writes the command history from this session when it
24348 exits. You can access this list through history expansion or through
24349 the history command editing characters listed below. This file defaults
24350 to the value of the environment variable @code{GDBHISTFILE}, or to
24351 @file{./.gdb_history} (@file{./_gdb_history} on MS-DOS) if this variable
24354 @cindex save command history
24355 @kindex set history save
24356 @item set history save
24357 @itemx set history save on
24358 Record command history in a file, whose name may be specified with the
24359 @code{set history filename} command. By default, this option is disabled.
24361 @item set history save off
24362 Stop recording command history in a file.
24364 @cindex history size
24365 @kindex set history size
24366 @cindex @env{GDBHISTSIZE}, environment variable
24367 @item set history size @var{size}
24368 @itemx set history size unlimited
24369 Set the number of commands which @value{GDBN} keeps in its history list.
24370 This defaults to the value of the environment variable @env{GDBHISTSIZE}, or
24371 to 256 if this variable is not set. Non-numeric values of @env{GDBHISTSIZE}
24372 are ignored. If @var{size} is @code{unlimited} or if @env{GDBHISTSIZE} is
24373 either a negative number or the empty string, then the number of commands
24374 @value{GDBN} keeps in the history list is unlimited.
24376 @cindex remove duplicate history
24377 @kindex set history remove-duplicates
24378 @item set history remove-duplicates @var{count}
24379 @itemx set history remove-duplicates unlimited
24380 Control the removal of duplicate history entries in the command history list.
24381 If @var{count} is non-zero, @value{GDBN} will look back at the last @var{count}
24382 history entries and remove the first entry that is a duplicate of the current
24383 entry being added to the command history list. If @var{count} is
24384 @code{unlimited} then this lookbehind is unbounded. If @var{count} is 0, then
24385 removal of duplicate history entries is disabled.
24387 Only history entries added during the current session are considered for
24388 removal. This option is set to 0 by default.
24392 History expansion assigns special meaning to the character @kbd{!}.
24393 @ifset SYSTEM_READLINE
24394 @xref{Event Designators, , , history, GNU History Library},
24396 @ifclear SYSTEM_READLINE
24397 @xref{Event Designators},
24401 @cindex history expansion, turn on/off
24402 Since @kbd{!} is also the logical not operator in C, history expansion
24403 is off by default. If you decide to enable history expansion with the
24404 @code{set history expansion on} command, you may sometimes need to
24405 follow @kbd{!} (when it is used as logical not, in an expression) with
24406 a space or a tab to prevent it from being expanded. The readline
24407 history facilities do not attempt substitution on the strings
24408 @kbd{!=} and @kbd{!(}, even when history expansion is enabled.
24410 The commands to control history expansion are:
24413 @item set history expansion on
24414 @itemx set history expansion
24415 @kindex set history expansion
24416 Enable history expansion. History expansion is off by default.
24418 @item set history expansion off
24419 Disable history expansion.
24422 @kindex show history
24424 @itemx show history filename
24425 @itemx show history save
24426 @itemx show history size
24427 @itemx show history expansion
24428 These commands display the state of the @value{GDBN} history parameters.
24429 @code{show history} by itself displays all four states.
24434 @kindex show commands
24435 @cindex show last commands
24436 @cindex display command history
24437 @item show commands
24438 Display the last ten commands in the command history.
24440 @item show commands @var{n}
24441 Print ten commands centered on command number @var{n}.
24443 @item show commands +
24444 Print ten commands just after the commands last printed.
24448 @section Screen Size
24449 @cindex size of screen
24450 @cindex screen size
24453 @cindex pauses in output
24455 Certain commands to @value{GDBN} may produce large amounts of
24456 information output to the screen. To help you read all of it,
24457 @value{GDBN} pauses and asks you for input at the end of each page of
24458 output. Type @key{RET} when you want to see one more page of output,
24459 @kbd{q} to discard the remaining output, or @kbd{c} to continue
24460 without paging for the rest of the current command. Also, the screen
24461 width setting determines when to wrap lines of output. Depending on
24462 what is being printed, @value{GDBN} tries to break the line at a
24463 readable place, rather than simply letting it overflow onto the
24466 Normally @value{GDBN} knows the size of the screen from the terminal
24467 driver software. For example, on Unix @value{GDBN} uses the termcap data base
24468 together with the value of the @code{TERM} environment variable and the
24469 @code{stty rows} and @code{stty cols} settings. If this is not correct,
24470 you can override it with the @code{set height} and @code{set
24477 @kindex show height
24478 @item set height @var{lpp}
24479 @itemx set height unlimited
24481 @itemx set width @var{cpl}
24482 @itemx set width unlimited
24484 These @code{set} commands specify a screen height of @var{lpp} lines and
24485 a screen width of @var{cpl} characters. The associated @code{show}
24486 commands display the current settings.
24488 If you specify a height of either @code{unlimited} or zero lines,
24489 @value{GDBN} does not pause during output no matter how long the
24490 output is. This is useful if output is to a file or to an editor
24493 Likewise, you can specify @samp{set width unlimited} or @samp{set
24494 width 0} to prevent @value{GDBN} from wrapping its output.
24496 @item set pagination on
24497 @itemx set pagination off
24498 @kindex set pagination
24499 Turn the output pagination on or off; the default is on. Turning
24500 pagination off is the alternative to @code{set height unlimited}. Note that
24501 running @value{GDBN} with the @option{--batch} option (@pxref{Mode
24502 Options, -batch}) also automatically disables pagination.
24504 @item show pagination
24505 @kindex show pagination
24506 Show the current pagination mode.
24509 @node Output Styling
24510 @section Output Styling
24516 @value{GDBN} can style its output on a capable terminal. This is
24517 enabled by default on most systems, but disabled by default when in
24518 batch mode (@pxref{Mode Options}). Various style settings are available;
24519 and styles can also be disabled entirely.
24522 @item set style enabled @samp{on|off}
24523 Enable or disable all styling. The default is host-dependent, with
24524 most hosts defaulting to @samp{on}.
24526 @item show style enabled
24527 Show the current state of styling.
24530 Subcommands of @code{set style} control specific forms of styling.
24531 These subcommands all follow the same pattern: each style-able object
24532 can be styled with a foreground color, a background color, and an
24535 For example, the style of file names can be controlled using the
24536 @code{set style filename} group of commands:
24539 @item set style filename background @var{color}
24540 Set the background to @var{color}. Valid colors are @samp{none}
24541 (meaning the terminal's default color), @samp{black}, @samp{red},
24542 @samp{green}, @samp{yellow}, @samp{vlue}, @samp{magenta}, @samp{cyan},
24545 @item set style filename foreground @var{color}
24546 Set the foreground to @var{color}. Valid colors are @samp{none}
24547 (meaning the terminal's default color), @samp{black}, @samp{red},
24548 @samp{green}, @samp{yellow}, @samp{vlue}, @samp{magenta}, @samp{cyan},
24551 @item set style filename intensity @var{value}
24552 Set the intensity to @var{value}. Valid intensities are @samp{normal}
24553 (the default), @samp{bold}, and @samp{dim}.
24556 The style-able objects are:
24559 Control the styling of file names.
24562 Control the styling of function names. These are managed with the
24563 @code{set style function} family of commands.
24566 Control the styling of variable names. These are managed with the
24567 @code{set style variable} family of commands.
24570 Control the styling of addresses. These are managed with the
24571 @code{set style address} family of commands.
24576 @cindex number representation
24577 @cindex entering numbers
24579 You can always enter numbers in octal, decimal, or hexadecimal in
24580 @value{GDBN} by the usual conventions: octal numbers begin with
24581 @samp{0}, decimal numbers end with @samp{.}, and hexadecimal numbers
24582 begin with @samp{0x}. Numbers that neither begin with @samp{0} or
24583 @samp{0x}, nor end with a @samp{.} are, by default, entered in base
24584 10; likewise, the default display for numbers---when no particular
24585 format is specified---is base 10. You can change the default base for
24586 both input and output with the commands described below.
24589 @kindex set input-radix
24590 @item set input-radix @var{base}
24591 Set the default base for numeric input. Supported choices
24592 for @var{base} are decimal 8, 10, or 16. The base must itself be
24593 specified either unambiguously or using the current input radix; for
24597 set input-radix 012
24598 set input-radix 10.
24599 set input-radix 0xa
24603 sets the input base to decimal. On the other hand, @samp{set input-radix 10}
24604 leaves the input radix unchanged, no matter what it was, since
24605 @samp{10}, being without any leading or trailing signs of its base, is
24606 interpreted in the current radix. Thus, if the current radix is 16,
24607 @samp{10} is interpreted in hex, i.e.@: as 16 decimal, which doesn't
24610 @kindex set output-radix
24611 @item set output-radix @var{base}
24612 Set the default base for numeric display. Supported choices
24613 for @var{base} are decimal 8, 10, or 16. The base must itself be
24614 specified either unambiguously or using the current input radix.
24616 @kindex show input-radix
24617 @item show input-radix
24618 Display the current default base for numeric input.
24620 @kindex show output-radix
24621 @item show output-radix
24622 Display the current default base for numeric display.
24624 @item set radix @r{[}@var{base}@r{]}
24628 These commands set and show the default base for both input and output
24629 of numbers. @code{set radix} sets the radix of input and output to
24630 the same base; without an argument, it resets the radix back to its
24631 default value of 10.
24636 @section Configuring the Current ABI
24638 @value{GDBN} can determine the @dfn{ABI} (Application Binary Interface) of your
24639 application automatically. However, sometimes you need to override its
24640 conclusions. Use these commands to manage @value{GDBN}'s view of the
24646 @cindex Newlib OS ABI and its influence on the longjmp handling
24648 One @value{GDBN} configuration can debug binaries for multiple operating
24649 system targets, either via remote debugging or native emulation.
24650 @value{GDBN} will autodetect the @dfn{OS ABI} (Operating System ABI) in use,
24651 but you can override its conclusion using the @code{set osabi} command.
24652 One example where this is useful is in debugging of binaries which use
24653 an alternate C library (e.g.@: @sc{uClibc} for @sc{gnu}/Linux) which does
24654 not have the same identifying marks that the standard C library for your
24657 When @value{GDBN} is debugging the AArch64 architecture, it provides a
24658 ``Newlib'' OS ABI. This is useful for handling @code{setjmp} and
24659 @code{longjmp} when debugging binaries that use the @sc{newlib} C library.
24660 The ``Newlib'' OS ABI can be selected by @code{set osabi Newlib}.
24664 Show the OS ABI currently in use.
24667 With no argument, show the list of registered available OS ABI's.
24669 @item set osabi @var{abi}
24670 Set the current OS ABI to @var{abi}.
24673 @cindex float promotion
24675 Generally, the way that an argument of type @code{float} is passed to a
24676 function depends on whether the function is prototyped. For a prototyped
24677 (i.e.@: ANSI/ISO style) function, @code{float} arguments are passed unchanged,
24678 according to the architecture's convention for @code{float}. For unprototyped
24679 (i.e.@: K&R style) functions, @code{float} arguments are first promoted to type
24680 @code{double} and then passed.
24682 Unfortunately, some forms of debug information do not reliably indicate whether
24683 a function is prototyped. If @value{GDBN} calls a function that is not marked
24684 as prototyped, it consults @kbd{set coerce-float-to-double}.
24687 @kindex set coerce-float-to-double
24688 @item set coerce-float-to-double
24689 @itemx set coerce-float-to-double on
24690 Arguments of type @code{float} will be promoted to @code{double} when passed
24691 to an unprototyped function. This is the default setting.
24693 @item set coerce-float-to-double off
24694 Arguments of type @code{float} will be passed directly to unprototyped
24697 @kindex show coerce-float-to-double
24698 @item show coerce-float-to-double
24699 Show the current setting of promoting @code{float} to @code{double}.
24703 @kindex show cp-abi
24704 @value{GDBN} needs to know the ABI used for your program's C@t{++}
24705 objects. The correct C@t{++} ABI depends on which C@t{++} compiler was
24706 used to build your application. @value{GDBN} only fully supports
24707 programs with a single C@t{++} ABI; if your program contains code using
24708 multiple C@t{++} ABI's or if @value{GDBN} can not identify your
24709 program's ABI correctly, you can tell @value{GDBN} which ABI to use.
24710 Currently supported ABI's include ``gnu-v2'', for @code{g++} versions
24711 before 3.0, ``gnu-v3'', for @code{g++} versions 3.0 and later, and
24712 ``hpaCC'' for the HP ANSI C@t{++} compiler. Other C@t{++} compilers may
24713 use the ``gnu-v2'' or ``gnu-v3'' ABI's as well. The default setting is
24718 Show the C@t{++} ABI currently in use.
24721 With no argument, show the list of supported C@t{++} ABI's.
24723 @item set cp-abi @var{abi}
24724 @itemx set cp-abi auto
24725 Set the current C@t{++} ABI to @var{abi}, or return to automatic detection.
24729 @section Automatically loading associated files
24730 @cindex auto-loading
24732 @value{GDBN} sometimes reads files with commands and settings automatically,
24733 without being explicitly told so by the user. We call this feature
24734 @dfn{auto-loading}. While auto-loading is useful for automatically adapting
24735 @value{GDBN} to the needs of your project, it can sometimes produce unexpected
24736 results or introduce security risks (e.g., if the file comes from untrusted
24740 * Init File in the Current Directory:: @samp{set/show/info auto-load local-gdbinit}
24741 * libthread_db.so.1 file:: @samp{set/show/info auto-load libthread-db}
24743 * Auto-loading safe path:: @samp{set/show/info auto-load safe-path}
24744 * Auto-loading verbose mode:: @samp{set/show debug auto-load}
24747 There are various kinds of files @value{GDBN} can automatically load.
24748 In addition to these files, @value{GDBN} supports auto-loading code written
24749 in various extension languages. @xref{Auto-loading extensions}.
24751 Note that loading of these associated files (including the local @file{.gdbinit}
24752 file) requires accordingly configured @code{auto-load safe-path}
24753 (@pxref{Auto-loading safe path}).
24755 For these reasons, @value{GDBN} includes commands and options to let you
24756 control when to auto-load files and which files should be auto-loaded.
24759 @anchor{set auto-load off}
24760 @kindex set auto-load off
24761 @item set auto-load off
24762 Globally disable loading of all auto-loaded files.
24763 You may want to use this command with the @samp{-iex} option
24764 (@pxref{Option -init-eval-command}) such as:
24766 $ @kbd{gdb -iex "set auto-load off" untrusted-executable corefile}
24769 Be aware that system init file (@pxref{System-wide configuration})
24770 and init files from your home directory (@pxref{Home Directory Init File})
24771 still get read (as they come from generally trusted directories).
24772 To prevent @value{GDBN} from auto-loading even those init files, use the
24773 @option{-nx} option (@pxref{Mode Options}), in addition to
24774 @code{set auto-load no}.
24776 @anchor{show auto-load}
24777 @kindex show auto-load
24778 @item show auto-load
24779 Show whether auto-loading of each specific @samp{auto-load} file(s) is enabled
24783 (gdb) show auto-load
24784 gdb-scripts: Auto-loading of canned sequences of commands scripts is on.
24785 libthread-db: Auto-loading of inferior specific libthread_db is on.
24786 local-gdbinit: Auto-loading of .gdbinit script from current directory
24788 python-scripts: Auto-loading of Python scripts is on.
24789 safe-path: List of directories from which it is safe to auto-load files
24790 is $debugdir:$datadir/auto-load.
24791 scripts-directory: List of directories from which to load auto-loaded scripts
24792 is $debugdir:$datadir/auto-load.
24795 @anchor{info auto-load}
24796 @kindex info auto-load
24797 @item info auto-load
24798 Print whether each specific @samp{auto-load} file(s) have been auto-loaded or
24802 (gdb) info auto-load
24805 Yes /home/user/gdb/gdb-gdb.gdb
24806 libthread-db: No auto-loaded libthread-db.
24807 local-gdbinit: Local .gdbinit file "/home/user/gdb/.gdbinit" has been
24811 Yes /home/user/gdb/gdb-gdb.py
24815 These are @value{GDBN} control commands for the auto-loading:
24817 @multitable @columnfractions .5 .5
24818 @item @xref{set auto-load off}.
24819 @tab Disable auto-loading globally.
24820 @item @xref{show auto-load}.
24821 @tab Show setting of all kinds of files.
24822 @item @xref{info auto-load}.
24823 @tab Show state of all kinds of files.
24824 @item @xref{set auto-load gdb-scripts}.
24825 @tab Control for @value{GDBN} command scripts.
24826 @item @xref{show auto-load gdb-scripts}.
24827 @tab Show setting of @value{GDBN} command scripts.
24828 @item @xref{info auto-load gdb-scripts}.
24829 @tab Show state of @value{GDBN} command scripts.
24830 @item @xref{set auto-load python-scripts}.
24831 @tab Control for @value{GDBN} Python scripts.
24832 @item @xref{show auto-load python-scripts}.
24833 @tab Show setting of @value{GDBN} Python scripts.
24834 @item @xref{info auto-load python-scripts}.
24835 @tab Show state of @value{GDBN} Python scripts.
24836 @item @xref{set auto-load guile-scripts}.
24837 @tab Control for @value{GDBN} Guile scripts.
24838 @item @xref{show auto-load guile-scripts}.
24839 @tab Show setting of @value{GDBN} Guile scripts.
24840 @item @xref{info auto-load guile-scripts}.
24841 @tab Show state of @value{GDBN} Guile scripts.
24842 @item @xref{set auto-load scripts-directory}.
24843 @tab Control for @value{GDBN} auto-loaded scripts location.
24844 @item @xref{show auto-load scripts-directory}.
24845 @tab Show @value{GDBN} auto-loaded scripts location.
24846 @item @xref{add-auto-load-scripts-directory}.
24847 @tab Add directory for auto-loaded scripts location list.
24848 @item @xref{set auto-load local-gdbinit}.
24849 @tab Control for init file in the current directory.
24850 @item @xref{show auto-load local-gdbinit}.
24851 @tab Show setting of init file in the current directory.
24852 @item @xref{info auto-load local-gdbinit}.
24853 @tab Show state of init file in the current directory.
24854 @item @xref{set auto-load libthread-db}.
24855 @tab Control for thread debugging library.
24856 @item @xref{show auto-load libthread-db}.
24857 @tab Show setting of thread debugging library.
24858 @item @xref{info auto-load libthread-db}.
24859 @tab Show state of thread debugging library.
24860 @item @xref{set auto-load safe-path}.
24861 @tab Control directories trusted for automatic loading.
24862 @item @xref{show auto-load safe-path}.
24863 @tab Show directories trusted for automatic loading.
24864 @item @xref{add-auto-load-safe-path}.
24865 @tab Add directory trusted for automatic loading.
24868 @node Init File in the Current Directory
24869 @subsection Automatically loading init file in the current directory
24870 @cindex auto-loading init file in the current directory
24872 By default, @value{GDBN} reads and executes the canned sequences of commands
24873 from init file (if any) in the current working directory,
24874 see @ref{Init File in the Current Directory during Startup}.
24876 Note that loading of this local @file{.gdbinit} file also requires accordingly
24877 configured @code{auto-load safe-path} (@pxref{Auto-loading safe path}).
24880 @anchor{set auto-load local-gdbinit}
24881 @kindex set auto-load local-gdbinit
24882 @item set auto-load local-gdbinit [on|off]
24883 Enable or disable the auto-loading of canned sequences of commands
24884 (@pxref{Sequences}) found in init file in the current directory.
24886 @anchor{show auto-load local-gdbinit}
24887 @kindex show auto-load local-gdbinit
24888 @item show auto-load local-gdbinit
24889 Show whether auto-loading of canned sequences of commands from init file in the
24890 current directory is enabled or disabled.
24892 @anchor{info auto-load local-gdbinit}
24893 @kindex info auto-load local-gdbinit
24894 @item info auto-load local-gdbinit
24895 Print whether canned sequences of commands from init file in the
24896 current directory have been auto-loaded.
24899 @node libthread_db.so.1 file
24900 @subsection Automatically loading thread debugging library
24901 @cindex auto-loading libthread_db.so.1
24903 This feature is currently present only on @sc{gnu}/Linux native hosts.
24905 @value{GDBN} reads in some cases thread debugging library from places specific
24906 to the inferior (@pxref{set libthread-db-search-path}).
24908 The special @samp{libthread-db-search-path} entry @samp{$sdir} is processed
24909 without checking this @samp{set auto-load libthread-db} switch as system
24910 libraries have to be trusted in general. In all other cases of
24911 @samp{libthread-db-search-path} entries @value{GDBN} checks first if @samp{set
24912 auto-load libthread-db} is enabled before trying to open such thread debugging
24915 Note that loading of this debugging library also requires accordingly configured
24916 @code{auto-load safe-path} (@pxref{Auto-loading safe path}).
24919 @anchor{set auto-load libthread-db}
24920 @kindex set auto-load libthread-db
24921 @item set auto-load libthread-db [on|off]
24922 Enable or disable the auto-loading of inferior specific thread debugging library.
24924 @anchor{show auto-load libthread-db}
24925 @kindex show auto-load libthread-db
24926 @item show auto-load libthread-db
24927 Show whether auto-loading of inferior specific thread debugging library is
24928 enabled or disabled.
24930 @anchor{info auto-load libthread-db}
24931 @kindex info auto-load libthread-db
24932 @item info auto-load libthread-db
24933 Print the list of all loaded inferior specific thread debugging libraries and
24934 for each such library print list of inferior @var{pid}s using it.
24937 @node Auto-loading safe path
24938 @subsection Security restriction for auto-loading
24939 @cindex auto-loading safe-path
24941 As the files of inferior can come from untrusted source (such as submitted by
24942 an application user) @value{GDBN} does not always load any files automatically.
24943 @value{GDBN} provides the @samp{set auto-load safe-path} setting to list
24944 directories trusted for loading files not explicitly requested by user.
24945 Each directory can also be a shell wildcard pattern.
24947 If the path is not set properly you will see a warning and the file will not
24952 Reading symbols from /home/user/gdb/gdb...done.
24953 warning: File "/home/user/gdb/gdb-gdb.gdb" auto-loading has been
24954 declined by your `auto-load safe-path' set
24955 to "$debugdir:$datadir/auto-load".
24956 warning: File "/home/user/gdb/gdb-gdb.py" auto-loading has been
24957 declined by your `auto-load safe-path' set
24958 to "$debugdir:$datadir/auto-load".
24962 To instruct @value{GDBN} to go ahead and use the init files anyway,
24963 invoke @value{GDBN} like this:
24966 $ gdb -q -iex "set auto-load safe-path /home/user/gdb" ./gdb
24969 The list of trusted directories is controlled by the following commands:
24972 @anchor{set auto-load safe-path}
24973 @kindex set auto-load safe-path
24974 @item set auto-load safe-path @r{[}@var{directories}@r{]}
24975 Set the list of directories (and their subdirectories) trusted for automatic
24976 loading and execution of scripts. You can also enter a specific trusted file.
24977 Each directory can also be a shell wildcard pattern; wildcards do not match
24978 directory separator - see @code{FNM_PATHNAME} for system function @code{fnmatch}
24979 (@pxref{Wildcard Matching, fnmatch, , libc, GNU C Library Reference Manual}).
24980 If you omit @var{directories}, @samp{auto-load safe-path} will be reset to
24981 its default value as specified during @value{GDBN} compilation.
24983 The list of directories uses path separator (@samp{:} on GNU and Unix
24984 systems, @samp{;} on MS-Windows and MS-DOS) to separate directories, similarly
24985 to the @env{PATH} environment variable.
24987 @anchor{show auto-load safe-path}
24988 @kindex show auto-load safe-path
24989 @item show auto-load safe-path
24990 Show the list of directories trusted for automatic loading and execution of
24993 @anchor{add-auto-load-safe-path}
24994 @kindex add-auto-load-safe-path
24995 @item add-auto-load-safe-path
24996 Add an entry (or list of entries) to the list of directories trusted for
24997 automatic loading and execution of scripts. Multiple entries may be delimited
24998 by the host platform path separator in use.
25001 This variable defaults to what @code{--with-auto-load-dir} has been configured
25002 to (@pxref{with-auto-load-dir}). @file{$debugdir} and @file{$datadir}
25003 substitution applies the same as for @ref{set auto-load scripts-directory}.
25004 The default @code{set auto-load safe-path} value can be also overriden by
25005 @value{GDBN} configuration option @option{--with-auto-load-safe-path}.
25007 Setting this variable to @file{/} disables this security protection,
25008 corresponding @value{GDBN} configuration option is
25009 @option{--without-auto-load-safe-path}.
25010 This variable is supposed to be set to the system directories writable by the
25011 system superuser only. Users can add their source directories in init files in
25012 their home directories (@pxref{Home Directory Init File}). See also deprecated
25013 init file in the current directory
25014 (@pxref{Init File in the Current Directory during Startup}).
25016 To force @value{GDBN} to load the files it declined to load in the previous
25017 example, you could use one of the following ways:
25020 @item @file{~/.gdbinit}: @samp{add-auto-load-safe-path ~/src/gdb}
25021 Specify this trusted directory (or a file) as additional component of the list.
25022 You have to specify also any existing directories displayed by
25023 by @samp{show auto-load safe-path} (such as @samp{/usr:/bin} in this example).
25025 @item @kbd{gdb -iex "set auto-load safe-path /usr:/bin:~/src/gdb" @dots{}}
25026 Specify this directory as in the previous case but just for a single
25027 @value{GDBN} session.
25029 @item @kbd{gdb -iex "set auto-load safe-path /" @dots{}}
25030 Disable auto-loading safety for a single @value{GDBN} session.
25031 This assumes all the files you debug during this @value{GDBN} session will come
25032 from trusted sources.
25034 @item @kbd{./configure --without-auto-load-safe-path}
25035 During compilation of @value{GDBN} you may disable any auto-loading safety.
25036 This assumes all the files you will ever debug with this @value{GDBN} come from
25040 On the other hand you can also explicitly forbid automatic files loading which
25041 also suppresses any such warning messages:
25044 @item @kbd{gdb -iex "set auto-load no" @dots{}}
25045 You can use @value{GDBN} command-line option for a single @value{GDBN} session.
25047 @item @file{~/.gdbinit}: @samp{set auto-load no}
25048 Disable auto-loading globally for the user
25049 (@pxref{Home Directory Init File}). While it is improbable, you could also
25050 use system init file instead (@pxref{System-wide configuration}).
25053 This setting applies to the file names as entered by user. If no entry matches
25054 @value{GDBN} tries as a last resort to also resolve all the file names into
25055 their canonical form (typically resolving symbolic links) and compare the
25056 entries again. @value{GDBN} already canonicalizes most of the filenames on its
25057 own before starting the comparison so a canonical form of directories is
25058 recommended to be entered.
25060 @node Auto-loading verbose mode
25061 @subsection Displaying files tried for auto-load
25062 @cindex auto-loading verbose mode
25064 For better visibility of all the file locations where you can place scripts to
25065 be auto-loaded with inferior --- or to protect yourself against accidental
25066 execution of untrusted scripts --- @value{GDBN} provides a feature for printing
25067 all the files attempted to be loaded. Both existing and non-existing files may
25070 For example the list of directories from which it is safe to auto-load files
25071 (@pxref{Auto-loading safe path}) applies also to canonicalized filenames which
25072 may not be too obvious while setting it up.
25075 (gdb) set debug auto-load on
25076 (gdb) file ~/src/t/true
25077 auto-load: Loading canned sequences of commands script "/tmp/true-gdb.gdb"
25078 for objfile "/tmp/true".
25079 auto-load: Updating directories of "/usr:/opt".
25080 auto-load: Using directory "/usr".
25081 auto-load: Using directory "/opt".
25082 warning: File "/tmp/true-gdb.gdb" auto-loading has been declined
25083 by your `auto-load safe-path' set to "/usr:/opt".
25087 @anchor{set debug auto-load}
25088 @kindex set debug auto-load
25089 @item set debug auto-load [on|off]
25090 Set whether to print the filenames attempted to be auto-loaded.
25092 @anchor{show debug auto-load}
25093 @kindex show debug auto-load
25094 @item show debug auto-load
25095 Show whether printing of the filenames attempted to be auto-loaded is turned
25099 @node Messages/Warnings
25100 @section Optional Warnings and Messages
25102 @cindex verbose operation
25103 @cindex optional warnings
25104 By default, @value{GDBN} is silent about its inner workings. If you are
25105 running on a slow machine, you may want to use the @code{set verbose}
25106 command. This makes @value{GDBN} tell you when it does a lengthy
25107 internal operation, so you will not think it has crashed.
25109 Currently, the messages controlled by @code{set verbose} are those
25110 which announce that the symbol table for a source file is being read;
25111 see @code{symbol-file} in @ref{Files, ,Commands to Specify Files}.
25114 @kindex set verbose
25115 @item set verbose on
25116 Enables @value{GDBN} output of certain informational messages.
25118 @item set verbose off
25119 Disables @value{GDBN} output of certain informational messages.
25121 @kindex show verbose
25123 Displays whether @code{set verbose} is on or off.
25126 By default, if @value{GDBN} encounters bugs in the symbol table of an
25127 object file, it is silent; but if you are debugging a compiler, you may
25128 find this information useful (@pxref{Symbol Errors, ,Errors Reading
25133 @kindex set complaints
25134 @item set complaints @var{limit}
25135 Permits @value{GDBN} to output @var{limit} complaints about each type of
25136 unusual symbols before becoming silent about the problem. Set
25137 @var{limit} to zero to suppress all complaints; set it to a large number
25138 to prevent complaints from being suppressed.
25140 @kindex show complaints
25141 @item show complaints
25142 Displays how many symbol complaints @value{GDBN} is permitted to produce.
25146 @anchor{confirmation requests}
25147 By default, @value{GDBN} is cautious, and asks what sometimes seems to be a
25148 lot of stupid questions to confirm certain commands. For example, if
25149 you try to run a program which is already running:
25153 The program being debugged has been started already.
25154 Start it from the beginning? (y or n)
25157 If you are willing to unflinchingly face the consequences of your own
25158 commands, you can disable this ``feature'':
25162 @kindex set confirm
25164 @cindex confirmation
25165 @cindex stupid questions
25166 @item set confirm off
25167 Disables confirmation requests. Note that running @value{GDBN} with
25168 the @option{--batch} option (@pxref{Mode Options, -batch}) also
25169 automatically disables confirmation requests.
25171 @item set confirm on
25172 Enables confirmation requests (the default).
25174 @kindex show confirm
25176 Displays state of confirmation requests.
25180 @cindex command tracing
25181 If you need to debug user-defined commands or sourced files you may find it
25182 useful to enable @dfn{command tracing}. In this mode each command will be
25183 printed as it is executed, prefixed with one or more @samp{+} symbols, the
25184 quantity denoting the call depth of each command.
25187 @kindex set trace-commands
25188 @cindex command scripts, debugging
25189 @item set trace-commands on
25190 Enable command tracing.
25191 @item set trace-commands off
25192 Disable command tracing.
25193 @item show trace-commands
25194 Display the current state of command tracing.
25197 @node Debugging Output
25198 @section Optional Messages about Internal Happenings
25199 @cindex optional debugging messages
25201 @value{GDBN} has commands that enable optional debugging messages from
25202 various @value{GDBN} subsystems; normally these commands are of
25203 interest to @value{GDBN} maintainers, or when reporting a bug. This
25204 section documents those commands.
25207 @kindex set exec-done-display
25208 @item set exec-done-display
25209 Turns on or off the notification of asynchronous commands'
25210 completion. When on, @value{GDBN} will print a message when an
25211 asynchronous command finishes its execution. The default is off.
25212 @kindex show exec-done-display
25213 @item show exec-done-display
25214 Displays the current setting of asynchronous command completion
25217 @cindex ARM AArch64
25218 @item set debug aarch64
25219 Turns on or off display of debugging messages related to ARM AArch64.
25220 The default is off.
25222 @item show debug aarch64
25223 Displays the current state of displaying debugging messages related to
25225 @cindex gdbarch debugging info
25226 @cindex architecture debugging info
25227 @item set debug arch
25228 Turns on or off display of gdbarch debugging info. The default is off
25229 @item show debug arch
25230 Displays the current state of displaying gdbarch debugging info.
25231 @item set debug aix-solib
25232 @cindex AIX shared library debugging
25233 Control display of debugging messages from the AIX shared library
25234 support module. The default is off.
25235 @item show debug aix-thread
25236 Show the current state of displaying AIX shared library debugging messages.
25237 @item set debug aix-thread
25238 @cindex AIX threads
25239 Display debugging messages about inner workings of the AIX thread
25241 @item show debug aix-thread
25242 Show the current state of AIX thread debugging info display.
25243 @item set debug check-physname
25245 Check the results of the ``physname'' computation. When reading DWARF
25246 debugging information for C@t{++}, @value{GDBN} attempts to compute
25247 each entity's name. @value{GDBN} can do this computation in two
25248 different ways, depending on exactly what information is present.
25249 When enabled, this setting causes @value{GDBN} to compute the names
25250 both ways and display any discrepancies.
25251 @item show debug check-physname
25252 Show the current state of ``physname'' checking.
25253 @item set debug coff-pe-read
25254 @cindex COFF/PE exported symbols
25255 Control display of debugging messages related to reading of COFF/PE
25256 exported symbols. The default is off.
25257 @item show debug coff-pe-read
25258 Displays the current state of displaying debugging messages related to
25259 reading of COFF/PE exported symbols.
25260 @item set debug dwarf-die
25262 Dump DWARF DIEs after they are read in.
25263 The value is the number of nesting levels to print.
25264 A value of zero turns off the display.
25265 @item show debug dwarf-die
25266 Show the current state of DWARF DIE debugging.
25267 @item set debug dwarf-line
25268 @cindex DWARF Line Tables
25269 Turns on or off display of debugging messages related to reading
25270 DWARF line tables. The default is 0 (off).
25271 A value of 1 provides basic information.
25272 A value greater than 1 provides more verbose information.
25273 @item show debug dwarf-line
25274 Show the current state of DWARF line table debugging.
25275 @item set debug dwarf-read
25276 @cindex DWARF Reading
25277 Turns on or off display of debugging messages related to reading
25278 DWARF debug info. The default is 0 (off).
25279 A value of 1 provides basic information.
25280 A value greater than 1 provides more verbose information.
25281 @item show debug dwarf-read
25282 Show the current state of DWARF reader debugging.
25283 @item set debug displaced
25284 @cindex displaced stepping debugging info
25285 Turns on or off display of @value{GDBN} debugging info for the
25286 displaced stepping support. The default is off.
25287 @item show debug displaced
25288 Displays the current state of displaying @value{GDBN} debugging info
25289 related to displaced stepping.
25290 @item set debug event
25291 @cindex event debugging info
25292 Turns on or off display of @value{GDBN} event debugging info. The
25294 @item show debug event
25295 Displays the current state of displaying @value{GDBN} event debugging
25297 @item set debug expression
25298 @cindex expression debugging info
25299 Turns on or off display of debugging info about @value{GDBN}
25300 expression parsing. The default is off.
25301 @item show debug expression
25302 Displays the current state of displaying debugging info about
25303 @value{GDBN} expression parsing.
25304 @item set debug fbsd-lwp
25305 @cindex FreeBSD LWP debug messages
25306 Turns on or off debugging messages from the FreeBSD LWP debug support.
25307 @item show debug fbsd-lwp
25308 Show the current state of FreeBSD LWP debugging messages.
25309 @item set debug fbsd-nat
25310 @cindex FreeBSD native target debug messages
25311 Turns on or off debugging messages from the FreeBSD native target.
25312 @item show debug fbsd-nat
25313 Show the current state of FreeBSD native target debugging messages.
25314 @item set debug frame
25315 @cindex frame debugging info
25316 Turns on or off display of @value{GDBN} frame debugging info. The
25318 @item show debug frame
25319 Displays the current state of displaying @value{GDBN} frame debugging
25321 @item set debug gnu-nat
25322 @cindex @sc{gnu}/Hurd debug messages
25323 Turn on or off debugging messages from the @sc{gnu}/Hurd debug support.
25324 @item show debug gnu-nat
25325 Show the current state of @sc{gnu}/Hurd debugging messages.
25326 @item set debug infrun
25327 @cindex inferior debugging info
25328 Turns on or off display of @value{GDBN} debugging info for running the inferior.
25329 The default is off. @file{infrun.c} contains GDB's runtime state machine used
25330 for implementing operations such as single-stepping the inferior.
25331 @item show debug infrun
25332 Displays the current state of @value{GDBN} inferior debugging.
25333 @item set debug jit
25334 @cindex just-in-time compilation, debugging messages
25335 Turn on or off debugging messages from JIT debug support.
25336 @item show debug jit
25337 Displays the current state of @value{GDBN} JIT debugging.
25338 @item set debug lin-lwp
25339 @cindex @sc{gnu}/Linux LWP debug messages
25340 @cindex Linux lightweight processes
25341 Turn on or off debugging messages from the Linux LWP debug support.
25342 @item show debug lin-lwp
25343 Show the current state of Linux LWP debugging messages.
25344 @item set debug linux-namespaces
25345 @cindex @sc{gnu}/Linux namespaces debug messages
25346 Turn on or off debugging messages from the Linux namespaces debug support.
25347 @item show debug linux-namespaces
25348 Show the current state of Linux namespaces debugging messages.
25349 @item set debug mach-o
25350 @cindex Mach-O symbols processing
25351 Control display of debugging messages related to Mach-O symbols
25352 processing. The default is off.
25353 @item show debug mach-o
25354 Displays the current state of displaying debugging messages related to
25355 reading of COFF/PE exported symbols.
25356 @item set debug notification
25357 @cindex remote async notification debugging info
25358 Turn on or off debugging messages about remote async notification.
25359 The default is off.
25360 @item show debug notification
25361 Displays the current state of remote async notification debugging messages.
25362 @item set debug observer
25363 @cindex observer debugging info
25364 Turns on or off display of @value{GDBN} observer debugging. This
25365 includes info such as the notification of observable events.
25366 @item show debug observer
25367 Displays the current state of observer debugging.
25368 @item set debug overload
25369 @cindex C@t{++} overload debugging info
25370 Turns on or off display of @value{GDBN} C@t{++} overload debugging
25371 info. This includes info such as ranking of functions, etc. The default
25373 @item show debug overload
25374 Displays the current state of displaying @value{GDBN} C@t{++} overload
25376 @cindex expression parser, debugging info
25377 @cindex debug expression parser
25378 @item set debug parser
25379 Turns on or off the display of expression parser debugging output.
25380 Internally, this sets the @code{yydebug} variable in the expression
25381 parser. @xref{Tracing, , Tracing Your Parser, bison, Bison}, for
25382 details. The default is off.
25383 @item show debug parser
25384 Show the current state of expression parser debugging.
25385 @cindex packets, reporting on stdout
25386 @cindex serial connections, debugging
25387 @cindex debug remote protocol
25388 @cindex remote protocol debugging
25389 @cindex display remote packets
25390 @item set debug remote
25391 Turns on or off display of reports on all packets sent back and forth across
25392 the serial line to the remote machine. The info is printed on the
25393 @value{GDBN} standard output stream. The default is off.
25394 @item show debug remote
25395 Displays the state of display of remote packets.
25397 @item set debug separate-debug-file
25398 Turns on or off display of debug output about separate debug file search.
25399 @item show debug separate-debug-file
25400 Displays the state of separate debug file search debug output.
25402 @item set debug serial
25403 Turns on or off display of @value{GDBN} serial debugging info. The
25405 @item show debug serial
25406 Displays the current state of displaying @value{GDBN} serial debugging
25408 @item set debug solib-frv
25409 @cindex FR-V shared-library debugging
25410 Turn on or off debugging messages for FR-V shared-library code.
25411 @item show debug solib-frv
25412 Display the current state of FR-V shared-library code debugging
25414 @item set debug symbol-lookup
25415 @cindex symbol lookup
25416 Turns on or off display of debugging messages related to symbol lookup.
25417 The default is 0 (off).
25418 A value of 1 provides basic information.
25419 A value greater than 1 provides more verbose information.
25420 @item show debug symbol-lookup
25421 Show the current state of symbol lookup debugging messages.
25422 @item set debug symfile
25423 @cindex symbol file functions
25424 Turns on or off display of debugging messages related to symbol file functions.
25425 The default is off. @xref{Files}.
25426 @item show debug symfile
25427 Show the current state of symbol file debugging messages.
25428 @item set debug symtab-create
25429 @cindex symbol table creation
25430 Turns on or off display of debugging messages related to symbol table creation.
25431 The default is 0 (off).
25432 A value of 1 provides basic information.
25433 A value greater than 1 provides more verbose information.
25434 @item show debug symtab-create
25435 Show the current state of symbol table creation debugging.
25436 @item set debug target
25437 @cindex target debugging info
25438 Turns on or off display of @value{GDBN} target debugging info. This info
25439 includes what is going on at the target level of GDB, as it happens. The
25440 default is 0. Set it to 1 to track events, and to 2 to also track the
25441 value of large memory transfers.
25442 @item show debug target
25443 Displays the current state of displaying @value{GDBN} target debugging
25445 @item set debug timestamp
25446 @cindex timestampping debugging info
25447 Turns on or off display of timestamps with @value{GDBN} debugging info.
25448 When enabled, seconds and microseconds are displayed before each debugging
25450 @item show debug timestamp
25451 Displays the current state of displaying timestamps with @value{GDBN}
25453 @item set debug varobj
25454 @cindex variable object debugging info
25455 Turns on or off display of @value{GDBN} variable object debugging
25456 info. The default is off.
25457 @item show debug varobj
25458 Displays the current state of displaying @value{GDBN} variable object
25460 @item set debug xml
25461 @cindex XML parser debugging
25462 Turn on or off debugging messages for built-in XML parsers.
25463 @item show debug xml
25464 Displays the current state of XML debugging messages.
25467 @node Other Misc Settings
25468 @section Other Miscellaneous Settings
25469 @cindex miscellaneous settings
25472 @kindex set interactive-mode
25473 @item set interactive-mode
25474 If @code{on}, forces @value{GDBN} to assume that GDB was started
25475 in a terminal. In practice, this means that @value{GDBN} should wait
25476 for the user to answer queries generated by commands entered at
25477 the command prompt. If @code{off}, forces @value{GDBN} to operate
25478 in the opposite mode, and it uses the default answers to all queries.
25479 If @code{auto} (the default), @value{GDBN} tries to determine whether
25480 its standard input is a terminal, and works in interactive-mode if it
25481 is, non-interactively otherwise.
25483 In the vast majority of cases, the debugger should be able to guess
25484 correctly which mode should be used. But this setting can be useful
25485 in certain specific cases, such as running a MinGW @value{GDBN}
25486 inside a cygwin window.
25488 @kindex show interactive-mode
25489 @item show interactive-mode
25490 Displays whether the debugger is operating in interactive mode or not.
25493 @node Extending GDB
25494 @chapter Extending @value{GDBN}
25495 @cindex extending GDB
25497 @value{GDBN} provides several mechanisms for extension.
25498 @value{GDBN} also provides the ability to automatically load
25499 extensions when it reads a file for debugging. This allows the
25500 user to automatically customize @value{GDBN} for the program
25504 * Sequences:: Canned Sequences of @value{GDBN} Commands
25505 * Python:: Extending @value{GDBN} using Python
25506 * Guile:: Extending @value{GDBN} using Guile
25507 * Auto-loading extensions:: Automatically loading extensions
25508 * Multiple Extension Languages:: Working with multiple extension languages
25509 * Aliases:: Creating new spellings of existing commands
25512 To facilitate the use of extension languages, @value{GDBN} is capable
25513 of evaluating the contents of a file. When doing so, @value{GDBN}
25514 can recognize which extension language is being used by looking at
25515 the filename extension. Files with an unrecognized filename extension
25516 are always treated as a @value{GDBN} Command Files.
25517 @xref{Command Files,, Command files}.
25519 You can control how @value{GDBN} evaluates these files with the following
25523 @kindex set script-extension
25524 @kindex show script-extension
25525 @item set script-extension off
25526 All scripts are always evaluated as @value{GDBN} Command Files.
25528 @item set script-extension soft
25529 The debugger determines the scripting language based on filename
25530 extension. If this scripting language is supported, @value{GDBN}
25531 evaluates the script using that language. Otherwise, it evaluates
25532 the file as a @value{GDBN} Command File.
25534 @item set script-extension strict
25535 The debugger determines the scripting language based on filename
25536 extension, and evaluates the script using that language. If the
25537 language is not supported, then the evaluation fails.
25539 @item show script-extension
25540 Display the current value of the @code{script-extension} option.
25545 @section Canned Sequences of Commands
25547 Aside from breakpoint commands (@pxref{Break Commands, ,Breakpoint
25548 Command Lists}), @value{GDBN} provides two ways to store sequences of
25549 commands for execution as a unit: user-defined commands and command
25553 * Define:: How to define your own commands
25554 * Hooks:: Hooks for user-defined commands
25555 * Command Files:: How to write scripts of commands to be stored in a file
25556 * Output:: Commands for controlled output
25557 * Auto-loading sequences:: Controlling auto-loaded command files
25561 @subsection User-defined Commands
25563 @cindex user-defined command
25564 @cindex arguments, to user-defined commands
25565 A @dfn{user-defined command} is a sequence of @value{GDBN} commands to
25566 which you assign a new name as a command. This is done with the
25567 @code{define} command. User commands may accept an unlimited number of arguments
25568 separated by whitespace. Arguments are accessed within the user command
25569 via @code{$arg0@dots{}$argN}. A trivial example:
25573 print $arg0 + $arg1 + $arg2
25578 To execute the command use:
25585 This defines the command @code{adder}, which prints the sum of
25586 its three arguments. Note the arguments are text substitutions, so they may
25587 reference variables, use complex expressions, or even perform inferior
25590 @cindex argument count in user-defined commands
25591 @cindex how many arguments (user-defined commands)
25592 In addition, @code{$argc} may be used to find out how many arguments have
25598 print $arg0 + $arg1
25601 print $arg0 + $arg1 + $arg2
25606 Combining with the @code{eval} command (@pxref{eval}) makes it easier
25607 to process a variable number of arguments:
25614 eval "set $sum = $sum + $arg%d", $i
25624 @item define @var{commandname}
25625 Define a command named @var{commandname}. If there is already a command
25626 by that name, you are asked to confirm that you want to redefine it.
25627 The argument @var{commandname} may be a bare command name consisting of letters,
25628 numbers, dashes, and underscores. It may also start with any predefined
25629 prefix command. For example, @samp{define target my-target} creates
25630 a user-defined @samp{target my-target} command.
25632 The definition of the command is made up of other @value{GDBN} command lines,
25633 which are given following the @code{define} command. The end of these
25634 commands is marked by a line containing @code{end}.
25637 @kindex end@r{ (user-defined commands)}
25638 @item document @var{commandname}
25639 Document the user-defined command @var{commandname}, so that it can be
25640 accessed by @code{help}. The command @var{commandname} must already be
25641 defined. This command reads lines of documentation just as @code{define}
25642 reads the lines of the command definition, ending with @code{end}.
25643 After the @code{document} command is finished, @code{help} on command
25644 @var{commandname} displays the documentation you have written.
25646 You may use the @code{document} command again to change the
25647 documentation of a command. Redefining the command with @code{define}
25648 does not change the documentation.
25650 @kindex dont-repeat
25651 @cindex don't repeat command
25653 Used inside a user-defined command, this tells @value{GDBN} that this
25654 command should not be repeated when the user hits @key{RET}
25655 (@pxref{Command Syntax, repeat last command}).
25657 @kindex help user-defined
25658 @item help user-defined
25659 List all user-defined commands and all python commands defined in class
25660 COMAND_USER. The first line of the documentation or docstring is
25665 @itemx show user @var{commandname}
25666 Display the @value{GDBN} commands used to define @var{commandname} (but
25667 not its documentation). If no @var{commandname} is given, display the
25668 definitions for all user-defined commands.
25669 This does not work for user-defined python commands.
25671 @cindex infinite recursion in user-defined commands
25672 @kindex show max-user-call-depth
25673 @kindex set max-user-call-depth
25674 @item show max-user-call-depth
25675 @itemx set max-user-call-depth
25676 The value of @code{max-user-call-depth} controls how many recursion
25677 levels are allowed in user-defined commands before @value{GDBN} suspects an
25678 infinite recursion and aborts the command.
25679 This does not apply to user-defined python commands.
25682 In addition to the above commands, user-defined commands frequently
25683 use control flow commands, described in @ref{Command Files}.
25685 When user-defined commands are executed, the
25686 commands of the definition are not printed. An error in any command
25687 stops execution of the user-defined command.
25689 If used interactively, commands that would ask for confirmation proceed
25690 without asking when used inside a user-defined command. Many @value{GDBN}
25691 commands that normally print messages to say what they are doing omit the
25692 messages when used in a user-defined command.
25695 @subsection User-defined Command Hooks
25696 @cindex command hooks
25697 @cindex hooks, for commands
25698 @cindex hooks, pre-command
25701 You may define @dfn{hooks}, which are a special kind of user-defined
25702 command. Whenever you run the command @samp{foo}, if the user-defined
25703 command @samp{hook-foo} exists, it is executed (with no arguments)
25704 before that command.
25706 @cindex hooks, post-command
25708 A hook may also be defined which is run after the command you executed.
25709 Whenever you run the command @samp{foo}, if the user-defined command
25710 @samp{hookpost-foo} exists, it is executed (with no arguments) after
25711 that command. Post-execution hooks may exist simultaneously with
25712 pre-execution hooks, for the same command.
25714 It is valid for a hook to call the command which it hooks. If this
25715 occurs, the hook is not re-executed, thereby avoiding infinite recursion.
25717 @c It would be nice if hookpost could be passed a parameter indicating
25718 @c if the command it hooks executed properly or not. FIXME!
25720 @kindex stop@r{, a pseudo-command}
25721 In addition, a pseudo-command, @samp{stop} exists. Defining
25722 (@samp{hook-stop}) makes the associated commands execute every time
25723 execution stops in your program: before breakpoint commands are run,
25724 displays are printed, or the stack frame is printed.
25726 For example, to ignore @code{SIGALRM} signals while
25727 single-stepping, but treat them normally during normal execution,
25732 handle SIGALRM nopass
25736 handle SIGALRM pass
25739 define hook-continue
25740 handle SIGALRM pass
25744 As a further example, to hook at the beginning and end of the @code{echo}
25745 command, and to add extra text to the beginning and end of the message,
25753 define hookpost-echo
25757 (@value{GDBP}) echo Hello World
25758 <<<---Hello World--->>>
25763 You can define a hook for any single-word command in @value{GDBN}, but
25764 not for command aliases; you should define a hook for the basic command
25765 name, e.g.@: @code{backtrace} rather than @code{bt}.
25766 @c FIXME! So how does Joe User discover whether a command is an alias
25768 You can hook a multi-word command by adding @code{hook-} or
25769 @code{hookpost-} to the last word of the command, e.g.@:
25770 @samp{define target hook-remote} to add a hook to @samp{target remote}.
25772 If an error occurs during the execution of your hook, execution of
25773 @value{GDBN} commands stops and @value{GDBN} issues a prompt
25774 (before the command that you actually typed had a chance to run).
25776 If you try to define a hook which does not match any known command, you
25777 get a warning from the @code{define} command.
25779 @node Command Files
25780 @subsection Command Files
25782 @cindex command files
25783 @cindex scripting commands
25784 A command file for @value{GDBN} is a text file made of lines that are
25785 @value{GDBN} commands. Comments (lines starting with @kbd{#}) may
25786 also be included. An empty line in a command file does nothing; it
25787 does not mean to repeat the last command, as it would from the
25790 You can request the execution of a command file with the @code{source}
25791 command. Note that the @code{source} command is also used to evaluate
25792 scripts that are not Command Files. The exact behavior can be configured
25793 using the @code{script-extension} setting.
25794 @xref{Extending GDB,, Extending GDB}.
25798 @cindex execute commands from a file
25799 @item source [-s] [-v] @var{filename}
25800 Execute the command file @var{filename}.
25803 The lines in a command file are generally executed sequentially,
25804 unless the order of execution is changed by one of the
25805 @emph{flow-control commands} described below. The commands are not
25806 printed as they are executed. An error in any command terminates
25807 execution of the command file and control is returned to the console.
25809 @value{GDBN} first searches for @var{filename} in the current directory.
25810 If the file is not found there, and @var{filename} does not specify a
25811 directory, then @value{GDBN} also looks for the file on the source search path
25812 (specified with the @samp{directory} command);
25813 except that @file{$cdir} is not searched because the compilation directory
25814 is not relevant to scripts.
25816 If @code{-s} is specified, then @value{GDBN} searches for @var{filename}
25817 on the search path even if @var{filename} specifies a directory.
25818 The search is done by appending @var{filename} to each element of the
25819 search path. So, for example, if @var{filename} is @file{mylib/myscript}
25820 and the search path contains @file{/home/user} then @value{GDBN} will
25821 look for the script @file{/home/user/mylib/myscript}.
25822 The search is also done if @var{filename} is an absolute path.
25823 For example, if @var{filename} is @file{/tmp/myscript} and
25824 the search path contains @file{/home/user} then @value{GDBN} will
25825 look for the script @file{/home/user/tmp/myscript}.
25826 For DOS-like systems, if @var{filename} contains a drive specification,
25827 it is stripped before concatenation. For example, if @var{filename} is
25828 @file{d:myscript} and the search path contains @file{c:/tmp} then @value{GDBN}
25829 will look for the script @file{c:/tmp/myscript}.
25831 If @code{-v}, for verbose mode, is given then @value{GDBN} displays
25832 each command as it is executed. The option must be given before
25833 @var{filename}, and is interpreted as part of the filename anywhere else.
25835 Commands that would ask for confirmation if used interactively proceed
25836 without asking when used in a command file. Many @value{GDBN} commands that
25837 normally print messages to say what they are doing omit the messages
25838 when called from command files.
25840 @value{GDBN} also accepts command input from standard input. In this
25841 mode, normal output goes to standard output and error output goes to
25842 standard error. Errors in a command file supplied on standard input do
25843 not terminate execution of the command file---execution continues with
25847 gdb < cmds > log 2>&1
25850 (The syntax above will vary depending on the shell used.) This example
25851 will execute commands from the file @file{cmds}. All output and errors
25852 would be directed to @file{log}.
25854 Since commands stored on command files tend to be more general than
25855 commands typed interactively, they frequently need to deal with
25856 complicated situations, such as different or unexpected values of
25857 variables and symbols, changes in how the program being debugged is
25858 built, etc. @value{GDBN} provides a set of flow-control commands to
25859 deal with these complexities. Using these commands, you can write
25860 complex scripts that loop over data structures, execute commands
25861 conditionally, etc.
25868 This command allows to include in your script conditionally executed
25869 commands. The @code{if} command takes a single argument, which is an
25870 expression to evaluate. It is followed by a series of commands that
25871 are executed only if the expression is true (its value is nonzero).
25872 There can then optionally be an @code{else} line, followed by a series
25873 of commands that are only executed if the expression was false. The
25874 end of the list is marked by a line containing @code{end}.
25878 This command allows to write loops. Its syntax is similar to
25879 @code{if}: the command takes a single argument, which is an expression
25880 to evaluate, and must be followed by the commands to execute, one per
25881 line, terminated by an @code{end}. These commands are called the
25882 @dfn{body} of the loop. The commands in the body of @code{while} are
25883 executed repeatedly as long as the expression evaluates to true.
25887 This command exits the @code{while} loop in whose body it is included.
25888 Execution of the script continues after that @code{while}s @code{end}
25891 @kindex loop_continue
25892 @item loop_continue
25893 This command skips the execution of the rest of the body of commands
25894 in the @code{while} loop in whose body it is included. Execution
25895 branches to the beginning of the @code{while} loop, where it evaluates
25896 the controlling expression.
25898 @kindex end@r{ (if/else/while commands)}
25900 Terminate the block of commands that are the body of @code{if},
25901 @code{else}, or @code{while} flow-control commands.
25906 @subsection Commands for Controlled Output
25908 During the execution of a command file or a user-defined command, normal
25909 @value{GDBN} output is suppressed; the only output that appears is what is
25910 explicitly printed by the commands in the definition. This section
25911 describes three commands useful for generating exactly the output you
25916 @item echo @var{text}
25917 @c I do not consider backslash-space a standard C escape sequence
25918 @c because it is not in ANSI.
25919 Print @var{text}. Nonprinting characters can be included in
25920 @var{text} using C escape sequences, such as @samp{\n} to print a
25921 newline. @strong{No newline is printed unless you specify one.}
25922 In addition to the standard C escape sequences, a backslash followed
25923 by a space stands for a space. This is useful for displaying a
25924 string with spaces at the beginning or the end, since leading and
25925 trailing spaces are otherwise trimmed from all arguments.
25926 To print @samp{@w{ }and foo =@w{ }}, use the command
25927 @samp{echo \@w{ }and foo = \@w{ }}.
25929 A backslash at the end of @var{text} can be used, as in C, to continue
25930 the command onto subsequent lines. For example,
25933 echo This is some text\n\
25934 which is continued\n\
25935 onto several lines.\n
25938 produces the same output as
25941 echo This is some text\n
25942 echo which is continued\n
25943 echo onto several lines.\n
25947 @item output @var{expression}
25948 Print the value of @var{expression} and nothing but that value: no
25949 newlines, no @samp{$@var{nn} = }. The value is not entered in the
25950 value history either. @xref{Expressions, ,Expressions}, for more information
25953 @item output/@var{fmt} @var{expression}
25954 Print the value of @var{expression} in format @var{fmt}. You can use
25955 the same formats as for @code{print}. @xref{Output Formats,,Output
25956 Formats}, for more information.
25959 @item printf @var{template}, @var{expressions}@dots{}
25960 Print the values of one or more @var{expressions} under the control of
25961 the string @var{template}. To print several values, make
25962 @var{expressions} be a comma-separated list of individual expressions,
25963 which may be either numbers or pointers. Their values are printed as
25964 specified by @var{template}, exactly as a C program would do by
25965 executing the code below:
25968 printf (@var{template}, @var{expressions}@dots{});
25971 As in @code{C} @code{printf}, ordinary characters in @var{template}
25972 are printed verbatim, while @dfn{conversion specification} introduced
25973 by the @samp{%} character cause subsequent @var{expressions} to be
25974 evaluated, their values converted and formatted according to type and
25975 style information encoded in the conversion specifications, and then
25978 For example, you can print two values in hex like this:
25981 printf "foo, bar-foo = 0x%x, 0x%x\n", foo, bar-foo
25984 @code{printf} supports all the standard @code{C} conversion
25985 specifications, including the flags and modifiers between the @samp{%}
25986 character and the conversion letter, with the following exceptions:
25990 The argument-ordering modifiers, such as @samp{2$}, are not supported.
25993 The modifier @samp{*} is not supported for specifying precision or
25997 The @samp{'} flag (for separation of digits into groups according to
25998 @code{LC_NUMERIC'}) is not supported.
26001 The type modifiers @samp{hh}, @samp{j}, @samp{t}, and @samp{z} are not
26005 The conversion letter @samp{n} (as in @samp{%n}) is not supported.
26008 The conversion letters @samp{a} and @samp{A} are not supported.
26012 Note that the @samp{ll} type modifier is supported only if the
26013 underlying @code{C} implementation used to build @value{GDBN} supports
26014 the @code{long long int} type, and the @samp{L} type modifier is
26015 supported only if @code{long double} type is available.
26017 As in @code{C}, @code{printf} supports simple backslash-escape
26018 sequences, such as @code{\n}, @samp{\t}, @samp{\\}, @samp{\"},
26019 @samp{\a}, and @samp{\f}, that consist of backslash followed by a
26020 single character. Octal and hexadecimal escape sequences are not
26023 Additionally, @code{printf} supports conversion specifications for DFP
26024 (@dfn{Decimal Floating Point}) types using the following length modifiers
26025 together with a floating point specifier.
26030 @samp{H} for printing @code{Decimal32} types.
26033 @samp{D} for printing @code{Decimal64} types.
26036 @samp{DD} for printing @code{Decimal128} types.
26039 If the underlying @code{C} implementation used to build @value{GDBN} has
26040 support for the three length modifiers for DFP types, other modifiers
26041 such as width and precision will also be available for @value{GDBN} to use.
26043 In case there is no such @code{C} support, no additional modifiers will be
26044 available and the value will be printed in the standard way.
26046 Here's an example of printing DFP types using the above conversion letters:
26048 printf "D32: %Hf - D64: %Df - D128: %DDf\n",1.2345df,1.2E10dd,1.2E1dl
26053 @item eval @var{template}, @var{expressions}@dots{}
26054 Convert the values of one or more @var{expressions} under the control of
26055 the string @var{template} to a command line, and call it.
26059 @node Auto-loading sequences
26060 @subsection Controlling auto-loading native @value{GDBN} scripts
26061 @cindex native script auto-loading
26063 When a new object file is read (for example, due to the @code{file}
26064 command, or because the inferior has loaded a shared library),
26065 @value{GDBN} will look for the command file @file{@var{objfile}-gdb.gdb}.
26066 @xref{Auto-loading extensions}.
26068 Auto-loading can be enabled or disabled,
26069 and the list of auto-loaded scripts can be printed.
26072 @anchor{set auto-load gdb-scripts}
26073 @kindex set auto-load gdb-scripts
26074 @item set auto-load gdb-scripts [on|off]
26075 Enable or disable the auto-loading of canned sequences of commands scripts.
26077 @anchor{show auto-load gdb-scripts}
26078 @kindex show auto-load gdb-scripts
26079 @item show auto-load gdb-scripts
26080 Show whether auto-loading of canned sequences of commands scripts is enabled or
26083 @anchor{info auto-load gdb-scripts}
26084 @kindex info auto-load gdb-scripts
26085 @cindex print list of auto-loaded canned sequences of commands scripts
26086 @item info auto-load gdb-scripts [@var{regexp}]
26087 Print the list of all canned sequences of commands scripts that @value{GDBN}
26091 If @var{regexp} is supplied only canned sequences of commands scripts with
26092 matching names are printed.
26094 @c Python docs live in a separate file.
26095 @include python.texi
26097 @c Guile docs live in a separate file.
26098 @include guile.texi
26100 @node Auto-loading extensions
26101 @section Auto-loading extensions
26102 @cindex auto-loading extensions
26104 @value{GDBN} provides two mechanisms for automatically loading extensions
26105 when a new object file is read (for example, due to the @code{file}
26106 command, or because the inferior has loaded a shared library):
26107 @file{@var{objfile}-gdb.@var{ext}} and the @code{.debug_gdb_scripts}
26108 section of modern file formats like ELF.
26111 * objfile-gdb.ext file: objfile-gdbdotext file. The @file{@var{objfile}-gdb.@var{ext}} file
26112 * .debug_gdb_scripts section: dotdebug_gdb_scripts section. The @code{.debug_gdb_scripts} section
26113 * Which flavor to choose?::
26116 The auto-loading feature is useful for supplying application-specific
26117 debugging commands and features.
26119 Auto-loading can be enabled or disabled,
26120 and the list of auto-loaded scripts can be printed.
26121 See the @samp{auto-loading} section of each extension language
26122 for more information.
26123 For @value{GDBN} command files see @ref{Auto-loading sequences}.
26124 For Python files see @ref{Python Auto-loading}.
26126 Note that loading of this script file also requires accordingly configured
26127 @code{auto-load safe-path} (@pxref{Auto-loading safe path}).
26129 @node objfile-gdbdotext file
26130 @subsection The @file{@var{objfile}-gdb.@var{ext}} file
26131 @cindex @file{@var{objfile}-gdb.gdb}
26132 @cindex @file{@var{objfile}-gdb.py}
26133 @cindex @file{@var{objfile}-gdb.scm}
26135 When a new object file is read, @value{GDBN} looks for a file named
26136 @file{@var{objfile}-gdb.@var{ext}} (we call it @var{script-name} below),
26137 where @var{objfile} is the object file's name and
26138 where @var{ext} is the file extension for the extension language:
26141 @item @file{@var{objfile}-gdb.gdb}
26142 GDB's own command language
26143 @item @file{@var{objfile}-gdb.py}
26145 @item @file{@var{objfile}-gdb.scm}
26149 @var{script-name} is formed by ensuring that the file name of @var{objfile}
26150 is absolute, following all symlinks, and resolving @code{.} and @code{..}
26151 components, and appending the @file{-gdb.@var{ext}} suffix.
26152 If this file exists and is readable, @value{GDBN} will evaluate it as a
26153 script in the specified extension language.
26155 If this file does not exist, then @value{GDBN} will look for
26156 @var{script-name} file in all of the directories as specified below.
26158 Note that loading of these files requires an accordingly configured
26159 @code{auto-load safe-path} (@pxref{Auto-loading safe path}).
26161 For object files using @file{.exe} suffix @value{GDBN} tries to load first the
26162 scripts normally according to its @file{.exe} filename. But if no scripts are
26163 found @value{GDBN} also tries script filenames matching the object file without
26164 its @file{.exe} suffix. This @file{.exe} stripping is case insensitive and it
26165 is attempted on any platform. This makes the script filenames compatible
26166 between Unix and MS-Windows hosts.
26169 @anchor{set auto-load scripts-directory}
26170 @kindex set auto-load scripts-directory
26171 @item set auto-load scripts-directory @r{[}@var{directories}@r{]}
26172 Control @value{GDBN} auto-loaded scripts location. Multiple directory entries
26173 may be delimited by the host platform path separator in use
26174 (@samp{:} on Unix, @samp{;} on MS-Windows and MS-DOS).
26176 Each entry here needs to be covered also by the security setting
26177 @code{set auto-load safe-path} (@pxref{set auto-load safe-path}).
26179 @anchor{with-auto-load-dir}
26180 This variable defaults to @file{$debugdir:$datadir/auto-load}. The default
26181 @code{set auto-load safe-path} value can be also overriden by @value{GDBN}
26182 configuration option @option{--with-auto-load-dir}.
26184 Any reference to @file{$debugdir} will get replaced by
26185 @var{debug-file-directory} value (@pxref{Separate Debug Files}) and any
26186 reference to @file{$datadir} will get replaced by @var{data-directory} which is
26187 determined at @value{GDBN} startup (@pxref{Data Files}). @file{$debugdir} and
26188 @file{$datadir} must be placed as a directory component --- either alone or
26189 delimited by @file{/} or @file{\} directory separators, depending on the host
26192 The list of directories uses path separator (@samp{:} on GNU and Unix
26193 systems, @samp{;} on MS-Windows and MS-DOS) to separate directories, similarly
26194 to the @env{PATH} environment variable.
26196 @anchor{show auto-load scripts-directory}
26197 @kindex show auto-load scripts-directory
26198 @item show auto-load scripts-directory
26199 Show @value{GDBN} auto-loaded scripts location.
26201 @anchor{add-auto-load-scripts-directory}
26202 @kindex add-auto-load-scripts-directory
26203 @item add-auto-load-scripts-directory @r{[}@var{directories}@dots{}@r{]}
26204 Add an entry (or list of entries) to the list of auto-loaded scripts locations.
26205 Multiple entries may be delimited by the host platform path separator in use.
26208 @value{GDBN} does not track which files it has already auto-loaded this way.
26209 @value{GDBN} will load the associated script every time the corresponding
26210 @var{objfile} is opened.
26211 So your @file{-gdb.@var{ext}} file should be careful to avoid errors if it
26212 is evaluated more than once.
26214 @node dotdebug_gdb_scripts section
26215 @subsection The @code{.debug_gdb_scripts} section
26216 @cindex @code{.debug_gdb_scripts} section
26218 For systems using file formats like ELF and COFF,
26219 when @value{GDBN} loads a new object file
26220 it will look for a special section named @code{.debug_gdb_scripts}.
26221 If this section exists, its contents is a list of null-terminated entries
26222 specifying scripts to load. Each entry begins with a non-null prefix byte that
26223 specifies the kind of entry, typically the extension language and whether the
26224 script is in a file or inlined in @code{.debug_gdb_scripts}.
26226 The following entries are supported:
26229 @item SECTION_SCRIPT_ID_PYTHON_FILE = 1
26230 @item SECTION_SCRIPT_ID_SCHEME_FILE = 3
26231 @item SECTION_SCRIPT_ID_PYTHON_TEXT = 4
26232 @item SECTION_SCRIPT_ID_SCHEME_TEXT = 6
26235 @subsubsection Script File Entries
26237 If the entry specifies a file, @value{GDBN} will look for the file first
26238 in the current directory and then along the source search path
26239 (@pxref{Source Path, ,Specifying Source Directories}),
26240 except that @file{$cdir} is not searched, since the compilation
26241 directory is not relevant to scripts.
26243 File entries can be placed in section @code{.debug_gdb_scripts} with,
26244 for example, this GCC macro for Python scripts.
26247 /* Note: The "MS" section flags are to remove duplicates. */
26248 #define DEFINE_GDB_PY_SCRIPT(script_name) \
26250 .pushsection \".debug_gdb_scripts\", \"MS\",@@progbits,1\n\
26251 .byte 1 /* Python */\n\
26252 .asciz \"" script_name "\"\n\
26258 For Guile scripts, replace @code{.byte 1} with @code{.byte 3}.
26259 Then one can reference the macro in a header or source file like this:
26262 DEFINE_GDB_PY_SCRIPT ("my-app-scripts.py")
26265 The script name may include directories if desired.
26267 Note that loading of this script file also requires accordingly configured
26268 @code{auto-load safe-path} (@pxref{Auto-loading safe path}).
26270 If the macro invocation is put in a header, any application or library
26271 using this header will get a reference to the specified script,
26272 and with the use of @code{"MS"} attributes on the section, the linker
26273 will remove duplicates.
26275 @subsubsection Script Text Entries
26277 Script text entries allow to put the executable script in the entry
26278 itself instead of loading it from a file.
26279 The first line of the entry, everything after the prefix byte and up to
26280 the first newline (@code{0xa}) character, is the script name, and must not
26281 contain any kind of space character, e.g., spaces or tabs.
26282 The rest of the entry, up to the trailing null byte, is the script to
26283 execute in the specified language. The name needs to be unique among
26284 all script names, as @value{GDBN} executes each script only once based
26287 Here is an example from file @file{py-section-script.c} in the @value{GDBN}
26291 #include "symcat.h"
26292 #include "gdb/section-scripts.h"
26294 ".pushsection \".debug_gdb_scripts\", \"MS\",@@progbits,1\n"
26295 ".byte " XSTRING (SECTION_SCRIPT_ID_PYTHON_TEXT) "\n"
26296 ".ascii \"gdb.inlined-script\\n\"\n"
26297 ".ascii \"class test_cmd (gdb.Command):\\n\"\n"
26298 ".ascii \" def __init__ (self):\\n\"\n"
26299 ".ascii \" super (test_cmd, self).__init__ ("
26300 "\\\"test-cmd\\\", gdb.COMMAND_OBSCURE)\\n\"\n"
26301 ".ascii \" def invoke (self, arg, from_tty):\\n\"\n"
26302 ".ascii \" print (\\\"test-cmd output, arg = %s\\\" % arg)\\n\"\n"
26303 ".ascii \"test_cmd ()\\n\"\n"
26309 Loading of inlined scripts requires a properly configured
26310 @code{auto-load safe-path} (@pxref{Auto-loading safe path}).
26311 The path to specify in @code{auto-load safe-path} is the path of the file
26312 containing the @code{.debug_gdb_scripts} section.
26314 @node Which flavor to choose?
26315 @subsection Which flavor to choose?
26317 Given the multiple ways of auto-loading extensions, it might not always
26318 be clear which one to choose. This section provides some guidance.
26321 Benefits of the @file{-gdb.@var{ext}} way:
26325 Can be used with file formats that don't support multiple sections.
26328 Ease of finding scripts for public libraries.
26330 Scripts specified in the @code{.debug_gdb_scripts} section are searched for
26331 in the source search path.
26332 For publicly installed libraries, e.g., @file{libstdc++}, there typically
26333 isn't a source directory in which to find the script.
26336 Doesn't require source code additions.
26340 Benefits of the @code{.debug_gdb_scripts} way:
26344 Works with static linking.
26346 Scripts for libraries done the @file{-gdb.@var{ext}} way require an objfile to
26347 trigger their loading. When an application is statically linked the only
26348 objfile available is the executable, and it is cumbersome to attach all the
26349 scripts from all the input libraries to the executable's
26350 @file{-gdb.@var{ext}} script.
26353 Works with classes that are entirely inlined.
26355 Some classes can be entirely inlined, and thus there may not be an associated
26356 shared library to attach a @file{-gdb.@var{ext}} script to.
26359 Scripts needn't be copied out of the source tree.
26361 In some circumstances, apps can be built out of large collections of internal
26362 libraries, and the build infrastructure necessary to install the
26363 @file{-gdb.@var{ext}} scripts in a place where @value{GDBN} can find them is
26364 cumbersome. It may be easier to specify the scripts in the
26365 @code{.debug_gdb_scripts} section as relative paths, and add a path to the
26366 top of the source tree to the source search path.
26369 @node Multiple Extension Languages
26370 @section Multiple Extension Languages
26372 The Guile and Python extension languages do not share any state,
26373 and generally do not interfere with each other.
26374 There are some things to be aware of, however.
26376 @subsection Python comes first
26378 Python was @value{GDBN}'s first extension language, and to avoid breaking
26379 existing behaviour Python comes first. This is generally solved by the
26380 ``first one wins'' principle. @value{GDBN} maintains a list of enabled
26381 extension languages, and when it makes a call to an extension language,
26382 (say to pretty-print a value), it tries each in turn until an extension
26383 language indicates it has performed the request (e.g., has returned the
26384 pretty-printed form of a value).
26385 This extends to errors while performing such requests: If an error happens
26386 while, for example, trying to pretty-print an object then the error is
26387 reported and any following extension languages are not tried.
26390 @section Creating new spellings of existing commands
26391 @cindex aliases for commands
26393 It is often useful to define alternate spellings of existing commands.
26394 For example, if a new @value{GDBN} command defined in Python has
26395 a long name to type, it is handy to have an abbreviated version of it
26396 that involves less typing.
26398 @value{GDBN} itself uses aliases. For example @samp{s} is an alias
26399 of the @samp{step} command even though it is otherwise an ambiguous
26400 abbreviation of other commands like @samp{set} and @samp{show}.
26402 Aliases are also used to provide shortened or more common versions
26403 of multi-word commands. For example, @value{GDBN} provides the
26404 @samp{tty} alias of the @samp{set inferior-tty} command.
26406 You can define a new alias with the @samp{alias} command.
26411 @item alias [-a] [--] @var{ALIAS} = @var{COMMAND}
26415 @var{ALIAS} specifies the name of the new alias.
26416 Each word of @var{ALIAS} must consist of letters, numbers, dashes and
26419 @var{COMMAND} specifies the name of an existing command
26420 that is being aliased.
26422 The @samp{-a} option specifies that the new alias is an abbreviation
26423 of the command. Abbreviations are not shown in command
26424 lists displayed by the @samp{help} command.
26426 The @samp{--} option specifies the end of options,
26427 and is useful when @var{ALIAS} begins with a dash.
26429 Here is a simple example showing how to make an abbreviation
26430 of a command so that there is less to type.
26431 Suppose you were tired of typing @samp{disas}, the current
26432 shortest unambiguous abbreviation of the @samp{disassemble} command
26433 and you wanted an even shorter version named @samp{di}.
26434 The following will accomplish this.
26437 (gdb) alias -a di = disas
26440 Note that aliases are different from user-defined commands.
26441 With a user-defined command, you also need to write documentation
26442 for it with the @samp{document} command.
26443 An alias automatically picks up the documentation of the existing command.
26445 Here is an example where we make @samp{elms} an abbreviation of
26446 @samp{elements} in the @samp{set print elements} command.
26447 This is to show that you can make an abbreviation of any part
26451 (gdb) alias -a set print elms = set print elements
26452 (gdb) alias -a show print elms = show print elements
26453 (gdb) set p elms 20
26455 Limit on string chars or array elements to print is 200.
26458 Note that if you are defining an alias of a @samp{set} command,
26459 and you want to have an alias for the corresponding @samp{show}
26460 command, then you need to define the latter separately.
26462 Unambiguously abbreviated commands are allowed in @var{COMMAND} and
26463 @var{ALIAS}, just as they are normally.
26466 (gdb) alias -a set pr elms = set p ele
26469 Finally, here is an example showing the creation of a one word
26470 alias for a more complex command.
26471 This creates alias @samp{spe} of the command @samp{set print elements}.
26474 (gdb) alias spe = set print elements
26479 @chapter Command Interpreters
26480 @cindex command interpreters
26482 @value{GDBN} supports multiple command interpreters, and some command
26483 infrastructure to allow users or user interface writers to switch
26484 between interpreters or run commands in other interpreters.
26486 @value{GDBN} currently supports two command interpreters, the console
26487 interpreter (sometimes called the command-line interpreter or @sc{cli})
26488 and the machine interface interpreter (or @sc{gdb/mi}). This manual
26489 describes both of these interfaces in great detail.
26491 By default, @value{GDBN} will start with the console interpreter.
26492 However, the user may choose to start @value{GDBN} with another
26493 interpreter by specifying the @option{-i} or @option{--interpreter}
26494 startup options. Defined interpreters include:
26498 @cindex console interpreter
26499 The traditional console or command-line interpreter. This is the most often
26500 used interpreter with @value{GDBN}. With no interpreter specified at runtime,
26501 @value{GDBN} will use this interpreter.
26504 @cindex mi interpreter
26505 The newest @sc{gdb/mi} interface (currently @code{mi2}). Used primarily
26506 by programs wishing to use @value{GDBN} as a backend for a debugger GUI
26507 or an IDE. For more information, see @ref{GDB/MI, ,The @sc{gdb/mi}
26511 @cindex mi2 interpreter
26512 The current @sc{gdb/mi} interface.
26515 @cindex mi1 interpreter
26516 The @sc{gdb/mi} interface included in @value{GDBN} 5.1, 5.2, and 5.3.
26520 @cindex invoke another interpreter
26522 @kindex interpreter-exec
26523 You may execute commands in any interpreter from the current
26524 interpreter using the appropriate command. If you are running the
26525 console interpreter, simply use the @code{interpreter-exec} command:
26528 interpreter-exec mi "-data-list-register-names"
26531 @sc{gdb/mi} has a similar command, although it is only available in versions of
26532 @value{GDBN} which support @sc{gdb/mi} version 2 (or greater).
26534 Note that @code{interpreter-exec} only changes the interpreter for the
26535 duration of the specified command. It does not change the interpreter
26538 @cindex start a new independent interpreter
26540 Although you may only choose a single interpreter at startup, it is
26541 possible to run an independent interpreter on a specified input/output
26542 device (usually a tty).
26544 For example, consider a debugger GUI or IDE that wants to provide a
26545 @value{GDBN} console view. It may do so by embedding a terminal
26546 emulator widget in its GUI, starting @value{GDBN} in the traditional
26547 command-line mode with stdin/stdout/stderr redirected to that
26548 terminal, and then creating an MI interpreter running on a specified
26549 input/output device. The console interpreter created by @value{GDBN}
26550 at startup handles commands the user types in the terminal widget,
26551 while the GUI controls and synchronizes state with @value{GDBN} using
26552 the separate MI interpreter.
26554 To start a new secondary @dfn{user interface} running MI, use the
26555 @code{new-ui} command:
26558 @cindex new user interface
26560 new-ui @var{interpreter} @var{tty}
26563 The @var{interpreter} parameter specifies the interpreter to run.
26564 This accepts the same values as the @code{interpreter-exec} command.
26565 For example, @samp{console}, @samp{mi}, @samp{mi2}, etc. The
26566 @var{tty} parameter specifies the name of the bidirectional file the
26567 interpreter uses for input/output, usually the name of a
26568 pseudoterminal slave on Unix systems. For example:
26571 (@value{GDBP}) new-ui mi /dev/pts/9
26575 runs an MI interpreter on @file{/dev/pts/9}.
26578 @chapter @value{GDBN} Text User Interface
26580 @cindex Text User Interface
26583 * TUI Overview:: TUI overview
26584 * TUI Keys:: TUI key bindings
26585 * TUI Single Key Mode:: TUI single key mode
26586 * TUI Commands:: TUI-specific commands
26587 * TUI Configuration:: TUI configuration variables
26590 The @value{GDBN} Text User Interface (TUI) is a terminal
26591 interface which uses the @code{curses} library to show the source
26592 file, the assembly output, the program registers and @value{GDBN}
26593 commands in separate text windows. The TUI mode is supported only
26594 on platforms where a suitable version of the @code{curses} library
26597 The TUI mode is enabled by default when you invoke @value{GDBN} as
26598 @samp{@value{GDBP} -tui}.
26599 You can also switch in and out of TUI mode while @value{GDBN} runs by
26600 using various TUI commands and key bindings, such as @command{tui
26601 enable} or @kbd{C-x C-a}. @xref{TUI Commands, ,TUI Commands}, and
26602 @ref{TUI Keys, ,TUI Key Bindings}.
26605 @section TUI Overview
26607 In TUI mode, @value{GDBN} can display several text windows:
26611 This window is the @value{GDBN} command window with the @value{GDBN}
26612 prompt and the @value{GDBN} output. The @value{GDBN} input is still
26613 managed using readline.
26616 The source window shows the source file of the program. The current
26617 line and active breakpoints are displayed in this window.
26620 The assembly window shows the disassembly output of the program.
26623 This window shows the processor registers. Registers are highlighted
26624 when their values change.
26627 The source and assembly windows show the current program position
26628 by highlighting the current line and marking it with a @samp{>} marker.
26629 Breakpoints are indicated with two markers. The first marker
26630 indicates the breakpoint type:
26634 Breakpoint which was hit at least once.
26637 Breakpoint which was never hit.
26640 Hardware breakpoint which was hit at least once.
26643 Hardware breakpoint which was never hit.
26646 The second marker indicates whether the breakpoint is enabled or not:
26650 Breakpoint is enabled.
26653 Breakpoint is disabled.
26656 The source, assembly and register windows are updated when the current
26657 thread changes, when the frame changes, or when the program counter
26660 These windows are not all visible at the same time. The command
26661 window is always visible. The others can be arranged in several
26672 source and assembly,
26675 source and registers, or
26678 assembly and registers.
26681 A status line above the command window shows the following information:
26685 Indicates the current @value{GDBN} target.
26686 (@pxref{Targets, ,Specifying a Debugging Target}).
26689 Gives the current process or thread number.
26690 When no process is being debugged, this field is set to @code{No process}.
26693 Gives the current function name for the selected frame.
26694 The name is demangled if demangling is turned on (@pxref{Print Settings}).
26695 When there is no symbol corresponding to the current program counter,
26696 the string @code{??} is displayed.
26699 Indicates the current line number for the selected frame.
26700 When the current line number is not known, the string @code{??} is displayed.
26703 Indicates the current program counter address.
26707 @section TUI Key Bindings
26708 @cindex TUI key bindings
26710 The TUI installs several key bindings in the readline keymaps
26711 @ifset SYSTEM_READLINE
26712 (@pxref{Command Line Editing, , , rluserman, GNU Readline Library}).
26714 @ifclear SYSTEM_READLINE
26715 (@pxref{Command Line Editing}).
26717 The following key bindings are installed for both TUI mode and the
26718 @value{GDBN} standard mode.
26727 Enter or leave the TUI mode. When leaving the TUI mode,
26728 the curses window management stops and @value{GDBN} operates using
26729 its standard mode, writing on the terminal directly. When reentering
26730 the TUI mode, control is given back to the curses windows.
26731 The screen is then refreshed.
26735 Use a TUI layout with only one window. The layout will
26736 either be @samp{source} or @samp{assembly}. When the TUI mode
26737 is not active, it will switch to the TUI mode.
26739 Think of this key binding as the Emacs @kbd{C-x 1} binding.
26743 Use a TUI layout with at least two windows. When the current
26744 layout already has two windows, the next layout with two windows is used.
26745 When a new layout is chosen, one window will always be common to the
26746 previous layout and the new one.
26748 Think of it as the Emacs @kbd{C-x 2} binding.
26752 Change the active window. The TUI associates several key bindings
26753 (like scrolling and arrow keys) with the active window. This command
26754 gives the focus to the next TUI window.
26756 Think of it as the Emacs @kbd{C-x o} binding.
26760 Switch in and out of the TUI SingleKey mode that binds single
26761 keys to @value{GDBN} commands (@pxref{TUI Single Key Mode}).
26764 The following key bindings only work in the TUI mode:
26769 Scroll the active window one page up.
26773 Scroll the active window one page down.
26777 Scroll the active window one line up.
26781 Scroll the active window one line down.
26785 Scroll the active window one column left.
26789 Scroll the active window one column right.
26793 Refresh the screen.
26796 Because the arrow keys scroll the active window in the TUI mode, they
26797 are not available for their normal use by readline unless the command
26798 window has the focus. When another window is active, you must use
26799 other readline key bindings such as @kbd{C-p}, @kbd{C-n}, @kbd{C-b}
26800 and @kbd{C-f} to control the command window.
26802 @node TUI Single Key Mode
26803 @section TUI Single Key Mode
26804 @cindex TUI single key mode
26806 The TUI also provides a @dfn{SingleKey} mode, which binds several
26807 frequently used @value{GDBN} commands to single keys. Type @kbd{C-x s} to
26808 switch into this mode, where the following key bindings are used:
26811 @kindex c @r{(SingleKey TUI key)}
26815 @kindex d @r{(SingleKey TUI key)}
26819 @kindex f @r{(SingleKey TUI key)}
26823 @kindex n @r{(SingleKey TUI key)}
26827 @kindex o @r{(SingleKey TUI key)}
26829 nexti. The shortcut letter @samp{o} stands for ``step Over''.
26831 @kindex q @r{(SingleKey TUI key)}
26833 exit the SingleKey mode.
26835 @kindex r @r{(SingleKey TUI key)}
26839 @kindex s @r{(SingleKey TUI key)}
26843 @kindex i @r{(SingleKey TUI key)}
26845 stepi. The shortcut letter @samp{i} stands for ``step Into''.
26847 @kindex u @r{(SingleKey TUI key)}
26851 @kindex v @r{(SingleKey TUI key)}
26855 @kindex w @r{(SingleKey TUI key)}
26860 Other keys temporarily switch to the @value{GDBN} command prompt.
26861 The key that was pressed is inserted in the editing buffer so that
26862 it is possible to type most @value{GDBN} commands without interaction
26863 with the TUI SingleKey mode. Once the command is entered the TUI
26864 SingleKey mode is restored. The only way to permanently leave
26865 this mode is by typing @kbd{q} or @kbd{C-x s}.
26869 @section TUI-specific Commands
26870 @cindex TUI commands
26872 The TUI has specific commands to control the text windows.
26873 These commands are always available, even when @value{GDBN} is not in
26874 the TUI mode. When @value{GDBN} is in the standard mode, most
26875 of these commands will automatically switch to the TUI mode.
26877 Note that if @value{GDBN}'s @code{stdout} is not connected to a
26878 terminal, or @value{GDBN} has been started with the machine interface
26879 interpreter (@pxref{GDB/MI, ,The @sc{gdb/mi} Interface}), most of
26880 these commands will fail with an error, because it would not be
26881 possible or desirable to enable curses window management.
26886 Activate TUI mode. The last active TUI window layout will be used if
26887 TUI mode has prevsiouly been used in the current debugging session,
26888 otherwise a default layout is used.
26891 @kindex tui disable
26892 Disable TUI mode, returning to the console interpreter.
26896 List and give the size of all displayed windows.
26898 @item layout @var{name}
26900 Changes which TUI windows are displayed. In each layout the command
26901 window is always displayed, the @var{name} parameter controls which
26902 additional windows are displayed, and can be any of the following:
26906 Display the next layout.
26909 Display the previous layout.
26912 Display the source and command windows.
26915 Display the assembly and command windows.
26918 Display the source, assembly, and command windows.
26921 When in @code{src} layout display the register, source, and command
26922 windows. When in @code{asm} or @code{split} layout display the
26923 register, assembler, and command windows.
26926 @item focus @var{name}
26928 Changes which TUI window is currently active for scrolling. The
26929 @var{name} parameter can be any of the following:
26933 Make the next window active for scrolling.
26936 Make the previous window active for scrolling.
26939 Make the source window active for scrolling.
26942 Make the assembly window active for scrolling.
26945 Make the register window active for scrolling.
26948 Make the command window active for scrolling.
26953 Refresh the screen. This is similar to typing @kbd{C-L}.
26955 @item tui reg @var{group}
26957 Changes the register group displayed in the tui register window to
26958 @var{group}. If the register window is not currently displayed this
26959 command will cause the register window to be displayed. The list of
26960 register groups, as well as their order is target specific. The
26961 following groups are available on most targets:
26964 Repeatedly selecting this group will cause the display to cycle
26965 through all of the available register groups.
26968 Repeatedly selecting this group will cause the display to cycle
26969 through all of the available register groups in the reverse order to
26973 Display the general registers.
26975 Display the floating point registers.
26977 Display the system registers.
26979 Display the vector registers.
26981 Display all registers.
26986 Update the source window and the current execution point.
26988 @item winheight @var{name} +@var{count}
26989 @itemx winheight @var{name} -@var{count}
26991 Change the height of the window @var{name} by @var{count}
26992 lines. Positive counts increase the height, while negative counts
26993 decrease it. The @var{name} parameter can be one of @code{src} (the
26994 source window), @code{cmd} (the command window), @code{asm} (the
26995 disassembly window), or @code{regs} (the register display window).
26998 @node TUI Configuration
26999 @section TUI Configuration Variables
27000 @cindex TUI configuration variables
27002 Several configuration variables control the appearance of TUI windows.
27005 @item set tui border-kind @var{kind}
27006 @kindex set tui border-kind
27007 Select the border appearance for the source, assembly and register windows.
27008 The possible values are the following:
27011 Use a space character to draw the border.
27014 Use @sc{ascii} characters @samp{+}, @samp{-} and @samp{|} to draw the border.
27017 Use the Alternate Character Set to draw the border. The border is
27018 drawn using character line graphics if the terminal supports them.
27021 @item set tui border-mode @var{mode}
27022 @kindex set tui border-mode
27023 @itemx set tui active-border-mode @var{mode}
27024 @kindex set tui active-border-mode
27025 Select the display attributes for the borders of the inactive windows
27026 or the active window. The @var{mode} can be one of the following:
27029 Use normal attributes to display the border.
27035 Use reverse video mode.
27038 Use half bright mode.
27040 @item half-standout
27041 Use half bright and standout mode.
27044 Use extra bright or bold mode.
27046 @item bold-standout
27047 Use extra bright or bold and standout mode.
27050 @item set tui tab-width @var{nchars}
27051 @kindex set tui tab-width
27053 Set the width of tab stops to be @var{nchars} characters. This
27054 setting affects the display of TAB characters in the source and
27059 @chapter Using @value{GDBN} under @sc{gnu} Emacs
27062 @cindex @sc{gnu} Emacs
27063 A special interface allows you to use @sc{gnu} Emacs to view (and
27064 edit) the source files for the program you are debugging with
27067 To use this interface, use the command @kbd{M-x gdb} in Emacs. Give the
27068 executable file you want to debug as an argument. This command starts
27069 @value{GDBN} as a subprocess of Emacs, with input and output through a newly
27070 created Emacs buffer.
27071 @c (Do not use the @code{-tui} option to run @value{GDBN} from Emacs.)
27073 Running @value{GDBN} under Emacs can be just like running @value{GDBN} normally except for two
27078 All ``terminal'' input and output goes through an Emacs buffer, called
27081 This applies both to @value{GDBN} commands and their output, and to the input
27082 and output done by the program you are debugging.
27084 This is useful because it means that you can copy the text of previous
27085 commands and input them again; you can even use parts of the output
27088 All the facilities of Emacs' Shell mode are available for interacting
27089 with your program. In particular, you can send signals the usual
27090 way---for example, @kbd{C-c C-c} for an interrupt, @kbd{C-c C-z} for a
27094 @value{GDBN} displays source code through Emacs.
27096 Each time @value{GDBN} displays a stack frame, Emacs automatically finds the
27097 source file for that frame and puts an arrow (@samp{=>}) at the
27098 left margin of the current line. Emacs uses a separate buffer for
27099 source display, and splits the screen to show both your @value{GDBN} session
27102 Explicit @value{GDBN} @code{list} or search commands still produce output as
27103 usual, but you probably have no reason to use them from Emacs.
27106 We call this @dfn{text command mode}. Emacs 22.1, and later, also uses
27107 a graphical mode, enabled by default, which provides further buffers
27108 that can control the execution and describe the state of your program.
27109 @xref{GDB Graphical Interface,,, Emacs, The @sc{gnu} Emacs Manual}.
27111 If you specify an absolute file name when prompted for the @kbd{M-x
27112 gdb} argument, then Emacs sets your current working directory to where
27113 your program resides. If you only specify the file name, then Emacs
27114 sets your current working directory to the directory associated
27115 with the previous buffer. In this case, @value{GDBN} may find your
27116 program by searching your environment's @code{PATH} variable, but on
27117 some operating systems it might not find the source. So, although the
27118 @value{GDBN} input and output session proceeds normally, the auxiliary
27119 buffer does not display the current source and line of execution.
27121 The initial working directory of @value{GDBN} is printed on the top
27122 line of the GUD buffer and this serves as a default for the commands
27123 that specify files for @value{GDBN} to operate on. @xref{Files,
27124 ,Commands to Specify Files}.
27126 By default, @kbd{M-x gdb} calls the program called @file{gdb}. If you
27127 need to call @value{GDBN} by a different name (for example, if you
27128 keep several configurations around, with different names) you can
27129 customize the Emacs variable @code{gud-gdb-command-name} to run the
27132 In the GUD buffer, you can use these special Emacs commands in
27133 addition to the standard Shell mode commands:
27137 Describe the features of Emacs' GUD Mode.
27140 Execute to another source line, like the @value{GDBN} @code{step} command; also
27141 update the display window to show the current file and location.
27144 Execute to next source line in this function, skipping all function
27145 calls, like the @value{GDBN} @code{next} command. Then update the display window
27146 to show the current file and location.
27149 Execute one instruction, like the @value{GDBN} @code{stepi} command; update
27150 display window accordingly.
27153 Execute until exit from the selected stack frame, like the @value{GDBN}
27154 @code{finish} command.
27157 Continue execution of your program, like the @value{GDBN} @code{continue}
27161 Go up the number of frames indicated by the numeric argument
27162 (@pxref{Arguments, , Numeric Arguments, Emacs, The @sc{gnu} Emacs Manual}),
27163 like the @value{GDBN} @code{up} command.
27166 Go down the number of frames indicated by the numeric argument, like the
27167 @value{GDBN} @code{down} command.
27170 In any source file, the Emacs command @kbd{C-x @key{SPC}} (@code{gud-break})
27171 tells @value{GDBN} to set a breakpoint on the source line point is on.
27173 In text command mode, if you type @kbd{M-x speedbar}, Emacs displays a
27174 separate frame which shows a backtrace when the GUD buffer is current.
27175 Move point to any frame in the stack and type @key{RET} to make it
27176 become the current frame and display the associated source in the
27177 source buffer. Alternatively, click @kbd{Mouse-2} to make the
27178 selected frame become the current one. In graphical mode, the
27179 speedbar displays watch expressions.
27181 If you accidentally delete the source-display buffer, an easy way to get
27182 it back is to type the command @code{f} in the @value{GDBN} buffer, to
27183 request a frame display; when you run under Emacs, this recreates
27184 the source buffer if necessary to show you the context of the current
27187 The source files displayed in Emacs are in ordinary Emacs buffers
27188 which are visiting the source files in the usual way. You can edit
27189 the files with these buffers if you wish; but keep in mind that @value{GDBN}
27190 communicates with Emacs in terms of line numbers. If you add or
27191 delete lines from the text, the line numbers that @value{GDBN} knows cease
27192 to correspond properly with the code.
27194 A more detailed description of Emacs' interaction with @value{GDBN} is
27195 given in the Emacs manual (@pxref{Debuggers,,, Emacs, The @sc{gnu}
27199 @chapter The @sc{gdb/mi} Interface
27201 @unnumberedsec Function and Purpose
27203 @cindex @sc{gdb/mi}, its purpose
27204 @sc{gdb/mi} is a line based machine oriented text interface to
27205 @value{GDBN} and is activated by specifying using the
27206 @option{--interpreter} command line option (@pxref{Mode Options}). It
27207 is specifically intended to support the development of systems which
27208 use the debugger as just one small component of a larger system.
27210 This chapter is a specification of the @sc{gdb/mi} interface. It is written
27211 in the form of a reference manual.
27213 Note that @sc{gdb/mi} is still under construction, so some of the
27214 features described below are incomplete and subject to change
27215 (@pxref{GDB/MI Development and Front Ends, , @sc{gdb/mi} Development and Front Ends}).
27217 @unnumberedsec Notation and Terminology
27219 @cindex notational conventions, for @sc{gdb/mi}
27220 This chapter uses the following notation:
27224 @code{|} separates two alternatives.
27227 @code{[ @var{something} ]} indicates that @var{something} is optional:
27228 it may or may not be given.
27231 @code{( @var{group} )*} means that @var{group} inside the parentheses
27232 may repeat zero or more times.
27235 @code{( @var{group} )+} means that @var{group} inside the parentheses
27236 may repeat one or more times.
27239 @code{"@var{string}"} means a literal @var{string}.
27243 @heading Dependencies
27247 * GDB/MI General Design::
27248 * GDB/MI Command Syntax::
27249 * GDB/MI Compatibility with CLI::
27250 * GDB/MI Development and Front Ends::
27251 * GDB/MI Output Records::
27252 * GDB/MI Simple Examples::
27253 * GDB/MI Command Description Format::
27254 * GDB/MI Breakpoint Commands::
27255 * GDB/MI Catchpoint Commands::
27256 * GDB/MI Program Context::
27257 * GDB/MI Thread Commands::
27258 * GDB/MI Ada Tasking Commands::
27259 * GDB/MI Program Execution::
27260 * GDB/MI Stack Manipulation::
27261 * GDB/MI Variable Objects::
27262 * GDB/MI Data Manipulation::
27263 * GDB/MI Tracepoint Commands::
27264 * GDB/MI Symbol Query::
27265 * GDB/MI File Commands::
27267 * GDB/MI Kod Commands::
27268 * GDB/MI Memory Overlay Commands::
27269 * GDB/MI Signal Handling Commands::
27271 * GDB/MI Target Manipulation::
27272 * GDB/MI File Transfer Commands::
27273 * GDB/MI Ada Exceptions Commands::
27274 * GDB/MI Support Commands::
27275 * GDB/MI Miscellaneous Commands::
27278 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
27279 @node GDB/MI General Design
27280 @section @sc{gdb/mi} General Design
27281 @cindex GDB/MI General Design
27283 Interaction of a @sc{GDB/MI} frontend with @value{GDBN} involves three
27284 parts---commands sent to @value{GDBN}, responses to those commands
27285 and notifications. Each command results in exactly one response,
27286 indicating either successful completion of the command, or an error.
27287 For the commands that do not resume the target, the response contains the
27288 requested information. For the commands that resume the target, the
27289 response only indicates whether the target was successfully resumed.
27290 Notifications is the mechanism for reporting changes in the state of the
27291 target, or in @value{GDBN} state, that cannot conveniently be associated with
27292 a command and reported as part of that command response.
27294 The important examples of notifications are:
27298 Exec notifications. These are used to report changes in
27299 target state---when a target is resumed, or stopped. It would not
27300 be feasible to include this information in response of resuming
27301 commands, because one resume commands can result in multiple events in
27302 different threads. Also, quite some time may pass before any event
27303 happens in the target, while a frontend needs to know whether the resuming
27304 command itself was successfully executed.
27307 Console output, and status notifications. Console output
27308 notifications are used to report output of CLI commands, as well as
27309 diagnostics for other commands. Status notifications are used to
27310 report the progress of a long-running operation. Naturally, including
27311 this information in command response would mean no output is produced
27312 until the command is finished, which is undesirable.
27315 General notifications. Commands may have various side effects on
27316 the @value{GDBN} or target state beyond their official purpose. For example,
27317 a command may change the selected thread. Although such changes can
27318 be included in command response, using notification allows for more
27319 orthogonal frontend design.
27323 There's no guarantee that whenever an MI command reports an error,
27324 @value{GDBN} or the target are in any specific state, and especially,
27325 the state is not reverted to the state before the MI command was
27326 processed. Therefore, whenever an MI command results in an error,
27327 we recommend that the frontend refreshes all the information shown in
27328 the user interface.
27332 * Context management::
27333 * Asynchronous and non-stop modes::
27337 @node Context management
27338 @subsection Context management
27340 @subsubsection Threads and Frames
27342 In most cases when @value{GDBN} accesses the target, this access is
27343 done in context of a specific thread and frame (@pxref{Frames}).
27344 Often, even when accessing global data, the target requires that a thread
27345 be specified. The CLI interface maintains the selected thread and frame,
27346 and supplies them to target on each command. This is convenient,
27347 because a command line user would not want to specify that information
27348 explicitly on each command, and because user interacts with
27349 @value{GDBN} via a single terminal, so no confusion is possible as
27350 to what thread and frame are the current ones.
27352 In the case of MI, the concept of selected thread and frame is less
27353 useful. First, a frontend can easily remember this information
27354 itself. Second, a graphical frontend can have more than one window,
27355 each one used for debugging a different thread, and the frontend might
27356 want to access additional threads for internal purposes. This
27357 increases the risk that by relying on implicitly selected thread, the
27358 frontend may be operating on a wrong one. Therefore, each MI command
27359 should explicitly specify which thread and frame to operate on. To
27360 make it possible, each MI command accepts the @samp{--thread} and
27361 @samp{--frame} options, the value to each is @value{GDBN} global
27362 identifier for thread and frame to operate on.
27364 Usually, each top-level window in a frontend allows the user to select
27365 a thread and a frame, and remembers the user selection for further
27366 operations. However, in some cases @value{GDBN} may suggest that the
27367 current thread or frame be changed. For example, when stopping on a
27368 breakpoint it is reasonable to switch to the thread where breakpoint is
27369 hit. For another example, if the user issues the CLI @samp{thread} or
27370 @samp{frame} commands via the frontend, it is desirable to change the
27371 frontend's selection to the one specified by user. @value{GDBN}
27372 communicates the suggestion to change current thread and frame using the
27373 @samp{=thread-selected} notification.
27375 Note that historically, MI shares the selected thread with CLI, so
27376 frontends used the @code{-thread-select} to execute commands in the
27377 right context. However, getting this to work right is cumbersome. The
27378 simplest way is for frontend to emit @code{-thread-select} command
27379 before every command. This doubles the number of commands that need
27380 to be sent. The alternative approach is to suppress @code{-thread-select}
27381 if the selected thread in @value{GDBN} is supposed to be identical to the
27382 thread the frontend wants to operate on. However, getting this
27383 optimization right can be tricky. In particular, if the frontend
27384 sends several commands to @value{GDBN}, and one of the commands changes the
27385 selected thread, then the behaviour of subsequent commands will
27386 change. So, a frontend should either wait for response from such
27387 problematic commands, or explicitly add @code{-thread-select} for
27388 all subsequent commands. No frontend is known to do this exactly
27389 right, so it is suggested to just always pass the @samp{--thread} and
27390 @samp{--frame} options.
27392 @subsubsection Language
27394 The execution of several commands depends on which language is selected.
27395 By default, the current language (@pxref{show language}) is used.
27396 But for commands known to be language-sensitive, it is recommended
27397 to use the @samp{--language} option. This option takes one argument,
27398 which is the name of the language to use while executing the command.
27402 -data-evaluate-expression --language c "sizeof (void*)"
27407 The valid language names are the same names accepted by the
27408 @samp{set language} command (@pxref{Manually}), excluding @samp{auto},
27409 @samp{local} or @samp{unknown}.
27411 @node Asynchronous and non-stop modes
27412 @subsection Asynchronous command execution and non-stop mode
27414 On some targets, @value{GDBN} is capable of processing MI commands
27415 even while the target is running. This is called @dfn{asynchronous
27416 command execution} (@pxref{Background Execution}). The frontend may
27417 specify a preferrence for asynchronous execution using the
27418 @code{-gdb-set mi-async 1} command, which should be emitted before
27419 either running the executable or attaching to the target. After the
27420 frontend has started the executable or attached to the target, it can
27421 find if asynchronous execution is enabled using the
27422 @code{-list-target-features} command.
27425 @item -gdb-set mi-async on
27426 @item -gdb-set mi-async off
27427 Set whether MI is in asynchronous mode.
27429 When @code{off}, which is the default, MI execution commands (e.g.,
27430 @code{-exec-continue}) are foreground commands, and @value{GDBN} waits
27431 for the program to stop before processing further commands.
27433 When @code{on}, MI execution commands are background execution
27434 commands (e.g., @code{-exec-continue} becomes the equivalent of the
27435 @code{c&} CLI command), and so @value{GDBN} is capable of processing
27436 MI commands even while the target is running.
27438 @item -gdb-show mi-async
27439 Show whether MI asynchronous mode is enabled.
27442 Note: In @value{GDBN} version 7.7 and earlier, this option was called
27443 @code{target-async} instead of @code{mi-async}, and it had the effect
27444 of both putting MI in asynchronous mode and making CLI background
27445 commands possible. CLI background commands are now always possible
27446 ``out of the box'' if the target supports them. The old spelling is
27447 kept as a deprecated alias for backwards compatibility.
27449 Even if @value{GDBN} can accept a command while target is running,
27450 many commands that access the target do not work when the target is
27451 running. Therefore, asynchronous command execution is most useful
27452 when combined with non-stop mode (@pxref{Non-Stop Mode}). Then,
27453 it is possible to examine the state of one thread, while other threads
27456 When a given thread is running, MI commands that try to access the
27457 target in the context of that thread may not work, or may work only on
27458 some targets. In particular, commands that try to operate on thread's
27459 stack will not work, on any target. Commands that read memory, or
27460 modify breakpoints, may work or not work, depending on the target. Note
27461 that even commands that operate on global state, such as @code{print},
27462 @code{set}, and breakpoint commands, still access the target in the
27463 context of a specific thread, so frontend should try to find a
27464 stopped thread and perform the operation on that thread (using the
27465 @samp{--thread} option).
27467 Which commands will work in the context of a running thread is
27468 highly target dependent. However, the two commands
27469 @code{-exec-interrupt}, to stop a thread, and @code{-thread-info},
27470 to find the state of a thread, will always work.
27472 @node Thread groups
27473 @subsection Thread groups
27474 @value{GDBN} may be used to debug several processes at the same time.
27475 On some platfroms, @value{GDBN} may support debugging of several
27476 hardware systems, each one having several cores with several different
27477 processes running on each core. This section describes the MI
27478 mechanism to support such debugging scenarios.
27480 The key observation is that regardless of the structure of the
27481 target, MI can have a global list of threads, because most commands that
27482 accept the @samp{--thread} option do not need to know what process that
27483 thread belongs to. Therefore, it is not necessary to introduce
27484 neither additional @samp{--process} option, nor an notion of the
27485 current process in the MI interface. The only strictly new feature
27486 that is required is the ability to find how the threads are grouped
27489 To allow the user to discover such grouping, and to support arbitrary
27490 hierarchy of machines/cores/processes, MI introduces the concept of a
27491 @dfn{thread group}. Thread group is a collection of threads and other
27492 thread groups. A thread group always has a string identifier, a type,
27493 and may have additional attributes specific to the type. A new
27494 command, @code{-list-thread-groups}, returns the list of top-level
27495 thread groups, which correspond to processes that @value{GDBN} is
27496 debugging at the moment. By passing an identifier of a thread group
27497 to the @code{-list-thread-groups} command, it is possible to obtain
27498 the members of specific thread group.
27500 To allow the user to easily discover processes, and other objects, he
27501 wishes to debug, a concept of @dfn{available thread group} is
27502 introduced. Available thread group is an thread group that
27503 @value{GDBN} is not debugging, but that can be attached to, using the
27504 @code{-target-attach} command. The list of available top-level thread
27505 groups can be obtained using @samp{-list-thread-groups --available}.
27506 In general, the content of a thread group may be only retrieved only
27507 after attaching to that thread group.
27509 Thread groups are related to inferiors (@pxref{Inferiors and
27510 Programs}). Each inferior corresponds to a thread group of a special
27511 type @samp{process}, and some additional operations are permitted on
27512 such thread groups.
27514 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
27515 @node GDB/MI Command Syntax
27516 @section @sc{gdb/mi} Command Syntax
27519 * GDB/MI Input Syntax::
27520 * GDB/MI Output Syntax::
27523 @node GDB/MI Input Syntax
27524 @subsection @sc{gdb/mi} Input Syntax
27526 @cindex input syntax for @sc{gdb/mi}
27527 @cindex @sc{gdb/mi}, input syntax
27529 @item @var{command} @expansion{}
27530 @code{@var{cli-command} | @var{mi-command}}
27532 @item @var{cli-command} @expansion{}
27533 @code{[ @var{token} ] @var{cli-command} @var{nl}}, where
27534 @var{cli-command} is any existing @value{GDBN} CLI command.
27536 @item @var{mi-command} @expansion{}
27537 @code{[ @var{token} ] "-" @var{operation} ( " " @var{option} )*
27538 @code{[} " --" @code{]} ( " " @var{parameter} )* @var{nl}}
27540 @item @var{token} @expansion{}
27541 "any sequence of digits"
27543 @item @var{option} @expansion{}
27544 @code{"-" @var{parameter} [ " " @var{parameter} ]}
27546 @item @var{parameter} @expansion{}
27547 @code{@var{non-blank-sequence} | @var{c-string}}
27549 @item @var{operation} @expansion{}
27550 @emph{any of the operations described in this chapter}
27552 @item @var{non-blank-sequence} @expansion{}
27553 @emph{anything, provided it doesn't contain special characters such as
27554 "-", @var{nl}, """ and of course " "}
27556 @item @var{c-string} @expansion{}
27557 @code{""" @var{seven-bit-iso-c-string-content} """}
27559 @item @var{nl} @expansion{}
27568 The CLI commands are still handled by the @sc{mi} interpreter; their
27569 output is described below.
27572 The @code{@var{token}}, when present, is passed back when the command
27576 Some @sc{mi} commands accept optional arguments as part of the parameter
27577 list. Each option is identified by a leading @samp{-} (dash) and may be
27578 followed by an optional argument parameter. Options occur first in the
27579 parameter list and can be delimited from normal parameters using
27580 @samp{--} (this is useful when some parameters begin with a dash).
27587 We want easy access to the existing CLI syntax (for debugging).
27590 We want it to be easy to spot a @sc{mi} operation.
27593 @node GDB/MI Output Syntax
27594 @subsection @sc{gdb/mi} Output Syntax
27596 @cindex output syntax of @sc{gdb/mi}
27597 @cindex @sc{gdb/mi}, output syntax
27598 The output from @sc{gdb/mi} consists of zero or more out-of-band records
27599 followed, optionally, by a single result record. This result record
27600 is for the most recent command. The sequence of output records is
27601 terminated by @samp{(gdb)}.
27603 If an input command was prefixed with a @code{@var{token}} then the
27604 corresponding output for that command will also be prefixed by that same
27608 @item @var{output} @expansion{}
27609 @code{( @var{out-of-band-record} )* [ @var{result-record} ] "(gdb)" @var{nl}}
27611 @item @var{result-record} @expansion{}
27612 @code{ [ @var{token} ] "^" @var{result-class} ( "," @var{result} )* @var{nl}}
27614 @item @var{out-of-band-record} @expansion{}
27615 @code{@var{async-record} | @var{stream-record}}
27617 @item @var{async-record} @expansion{}
27618 @code{@var{exec-async-output} | @var{status-async-output} | @var{notify-async-output}}
27620 @item @var{exec-async-output} @expansion{}
27621 @code{[ @var{token} ] "*" @var{async-output nl}}
27623 @item @var{status-async-output} @expansion{}
27624 @code{[ @var{token} ] "+" @var{async-output nl}}
27626 @item @var{notify-async-output} @expansion{}
27627 @code{[ @var{token} ] "=" @var{async-output nl}}
27629 @item @var{async-output} @expansion{}
27630 @code{@var{async-class} ( "," @var{result} )*}
27632 @item @var{result-class} @expansion{}
27633 @code{"done" | "running" | "connected" | "error" | "exit"}
27635 @item @var{async-class} @expansion{}
27636 @code{"stopped" | @var{others}} (where @var{others} will be added
27637 depending on the needs---this is still in development).
27639 @item @var{result} @expansion{}
27640 @code{ @var{variable} "=" @var{value}}
27642 @item @var{variable} @expansion{}
27643 @code{ @var{string} }
27645 @item @var{value} @expansion{}
27646 @code{ @var{const} | @var{tuple} | @var{list} }
27648 @item @var{const} @expansion{}
27649 @code{@var{c-string}}
27651 @item @var{tuple} @expansion{}
27652 @code{ "@{@}" | "@{" @var{result} ( "," @var{result} )* "@}" }
27654 @item @var{list} @expansion{}
27655 @code{ "[]" | "[" @var{value} ( "," @var{value} )* "]" | "["
27656 @var{result} ( "," @var{result} )* "]" }
27658 @item @var{stream-record} @expansion{}
27659 @code{@var{console-stream-output} | @var{target-stream-output} | @var{log-stream-output}}
27661 @item @var{console-stream-output} @expansion{}
27662 @code{"~" @var{c-string nl}}
27664 @item @var{target-stream-output} @expansion{}
27665 @code{"@@" @var{c-string nl}}
27667 @item @var{log-stream-output} @expansion{}
27668 @code{"&" @var{c-string nl}}
27670 @item @var{nl} @expansion{}
27673 @item @var{token} @expansion{}
27674 @emph{any sequence of digits}.
27682 All output sequences end in a single line containing a period.
27685 The @code{@var{token}} is from the corresponding request. Note that
27686 for all async output, while the token is allowed by the grammar and
27687 may be output by future versions of @value{GDBN} for select async
27688 output messages, it is generally omitted. Frontends should treat
27689 all async output as reporting general changes in the state of the
27690 target and there should be no need to associate async output to any
27694 @cindex status output in @sc{gdb/mi}
27695 @var{status-async-output} contains on-going status information about the
27696 progress of a slow operation. It can be discarded. All status output is
27697 prefixed by @samp{+}.
27700 @cindex async output in @sc{gdb/mi}
27701 @var{exec-async-output} contains asynchronous state change on the target
27702 (stopped, started, disappeared). All async output is prefixed by
27706 @cindex notify output in @sc{gdb/mi}
27707 @var{notify-async-output} contains supplementary information that the
27708 client should handle (e.g., a new breakpoint information). All notify
27709 output is prefixed by @samp{=}.
27712 @cindex console output in @sc{gdb/mi}
27713 @var{console-stream-output} is output that should be displayed as is in the
27714 console. It is the textual response to a CLI command. All the console
27715 output is prefixed by @samp{~}.
27718 @cindex target output in @sc{gdb/mi}
27719 @var{target-stream-output} is the output produced by the target program.
27720 All the target output is prefixed by @samp{@@}.
27723 @cindex log output in @sc{gdb/mi}
27724 @var{log-stream-output} is output text coming from @value{GDBN}'s internals, for
27725 instance messages that should be displayed as part of an error log. All
27726 the log output is prefixed by @samp{&}.
27729 @cindex list output in @sc{gdb/mi}
27730 New @sc{gdb/mi} commands should only output @var{lists} containing
27736 @xref{GDB/MI Stream Records, , @sc{gdb/mi} Stream Records}, for more
27737 details about the various output records.
27739 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
27740 @node GDB/MI Compatibility with CLI
27741 @section @sc{gdb/mi} Compatibility with CLI
27743 @cindex compatibility, @sc{gdb/mi} and CLI
27744 @cindex @sc{gdb/mi}, compatibility with CLI
27746 For the developers convenience CLI commands can be entered directly,
27747 but there may be some unexpected behaviour. For example, commands
27748 that query the user will behave as if the user replied yes, breakpoint
27749 command lists are not executed and some CLI commands, such as
27750 @code{if}, @code{when} and @code{define}, prompt for further input with
27751 @samp{>}, which is not valid MI output.
27753 This feature may be removed at some stage in the future and it is
27754 recommended that front ends use the @code{-interpreter-exec} command
27755 (@pxref{-interpreter-exec}).
27757 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
27758 @node GDB/MI Development and Front Ends
27759 @section @sc{gdb/mi} Development and Front Ends
27760 @cindex @sc{gdb/mi} development
27762 The application which takes the MI output and presents the state of the
27763 program being debugged to the user is called a @dfn{front end}.
27765 Since @sc{gdb/mi} is used by a variety of front ends to @value{GDBN}, changes
27766 to the MI interface may break existing usage. This section describes how the
27767 protocol changes and how to request previous version of the protocol when it
27770 Some changes in MI need not break a carefully designed front end, and
27771 for these the MI version will remain unchanged. The following is a
27772 list of changes that may occur within one level, so front ends should
27773 parse MI output in a way that can handle them:
27777 New MI commands may be added.
27780 New fields may be added to the output of any MI command.
27783 The range of values for fields with specified values, e.g.,
27784 @code{in_scope} (@pxref{-var-update}) may be extended.
27786 @c The format of field's content e.g type prefix, may change so parse it
27787 @c at your own risk. Yes, in general?
27789 @c The order of fields may change? Shouldn't really matter but it might
27790 @c resolve inconsistencies.
27793 If the changes are likely to break front ends, the MI version level
27794 will be increased by one. The new versions of the MI protocol are not compatible
27795 with the old versions. Old versions of MI remain available, allowing front ends
27796 to keep using them until they are modified to use the latest MI version.
27798 Since @code{--interpreter=mi} always points to the latest MI version, it is
27799 recommended that front ends request a specific version of MI when launching
27800 @value{GDBN} (e.g. @code{--interpreter=mi2}) to make sure they get an
27801 interpreter with the MI version they expect.
27803 The following table gives a summary of the the released versions of the MI
27804 interface: the version number, the version of GDB in which it first appeared
27805 and the breaking changes compared to the previous version.
27807 @multitable @columnfractions .05 .05 .9
27808 @headitem MI version @tab GDB version @tab Breaking changes
27825 The @code{-environment-pwd}, @code{-environment-directory} and
27826 @code{-environment-path} commands now returns values using the MI output
27827 syntax, rather than CLI output syntax.
27830 @code{-var-list-children}'s @code{children} result field is now a list, rather
27834 @code{-var-update}'s @code{changelist} result field is now a list, rather than
27840 The best way to avoid unexpected changes in MI that might break your front
27841 end is to make your project known to @value{GDBN} developers and
27842 follow development on @email{gdb@@sourceware.org} and
27843 @email{gdb-patches@@sourceware.org}.
27844 @cindex mailing lists
27846 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
27847 @node GDB/MI Output Records
27848 @section @sc{gdb/mi} Output Records
27851 * GDB/MI Result Records::
27852 * GDB/MI Stream Records::
27853 * GDB/MI Async Records::
27854 * GDB/MI Breakpoint Information::
27855 * GDB/MI Frame Information::
27856 * GDB/MI Thread Information::
27857 * GDB/MI Ada Exception Information::
27860 @node GDB/MI Result Records
27861 @subsection @sc{gdb/mi} Result Records
27863 @cindex result records in @sc{gdb/mi}
27864 @cindex @sc{gdb/mi}, result records
27865 In addition to a number of out-of-band notifications, the response to a
27866 @sc{gdb/mi} command includes one of the following result indications:
27870 @item "^done" [ "," @var{results} ]
27871 The synchronous operation was successful, @code{@var{results}} are the return
27876 This result record is equivalent to @samp{^done}. Historically, it
27877 was output instead of @samp{^done} if the command has resumed the
27878 target. This behaviour is maintained for backward compatibility, but
27879 all frontends should treat @samp{^done} and @samp{^running}
27880 identically and rely on the @samp{*running} output record to determine
27881 which threads are resumed.
27885 @value{GDBN} has connected to a remote target.
27887 @item "^error" "," "msg=" @var{c-string} [ "," "code=" @var{c-string} ]
27889 The operation failed. The @code{msg=@var{c-string}} variable contains
27890 the corresponding error message.
27892 If present, the @code{code=@var{c-string}} variable provides an error
27893 code on which consumers can rely on to detect the corresponding
27894 error condition. At present, only one error code is defined:
27897 @item "undefined-command"
27898 Indicates that the command causing the error does not exist.
27903 @value{GDBN} has terminated.
27907 @node GDB/MI Stream Records
27908 @subsection @sc{gdb/mi} Stream Records
27910 @cindex @sc{gdb/mi}, stream records
27911 @cindex stream records in @sc{gdb/mi}
27912 @value{GDBN} internally maintains a number of output streams: the console, the
27913 target, and the log. The output intended for each of these streams is
27914 funneled through the @sc{gdb/mi} interface using @dfn{stream records}.
27916 Each stream record begins with a unique @dfn{prefix character} which
27917 identifies its stream (@pxref{GDB/MI Output Syntax, , @sc{gdb/mi} Output
27918 Syntax}). In addition to the prefix, each stream record contains a
27919 @code{@var{string-output}}. This is either raw text (with an implicit new
27920 line) or a quoted C string (which does not contain an implicit newline).
27923 @item "~" @var{string-output}
27924 The console output stream contains text that should be displayed in the
27925 CLI console window. It contains the textual responses to CLI commands.
27927 @item "@@" @var{string-output}
27928 The target output stream contains any textual output from the running
27929 target. This is only present when GDB's event loop is truly
27930 asynchronous, which is currently only the case for remote targets.
27932 @item "&" @var{string-output}
27933 The log stream contains debugging messages being produced by @value{GDBN}'s
27937 @node GDB/MI Async Records
27938 @subsection @sc{gdb/mi} Async Records
27940 @cindex async records in @sc{gdb/mi}
27941 @cindex @sc{gdb/mi}, async records
27942 @dfn{Async} records are used to notify the @sc{gdb/mi} client of
27943 additional changes that have occurred. Those changes can either be a
27944 consequence of @sc{gdb/mi} commands (e.g., a breakpoint modified) or a result of
27945 target activity (e.g., target stopped).
27947 The following is the list of possible async records:
27951 @item *running,thread-id="@var{thread}"
27952 The target is now running. The @var{thread} field can be the global
27953 thread ID of the the thread that is now running, and it can be
27954 @samp{all} if all threads are running. The frontend should assume
27955 that no interaction with a running thread is possible after this
27956 notification is produced. The frontend should not assume that this
27957 notification is output only once for any command. @value{GDBN} may
27958 emit this notification several times, either for different threads,
27959 because it cannot resume all threads together, or even for a single
27960 thread, if the thread must be stepped though some code before letting
27963 @item *stopped,reason="@var{reason}",thread-id="@var{id}",stopped-threads="@var{stopped}",core="@var{core}"
27964 The target has stopped. The @var{reason} field can have one of the
27968 @item breakpoint-hit
27969 A breakpoint was reached.
27970 @item watchpoint-trigger
27971 A watchpoint was triggered.
27972 @item read-watchpoint-trigger
27973 A read watchpoint was triggered.
27974 @item access-watchpoint-trigger
27975 An access watchpoint was triggered.
27976 @item function-finished
27977 An -exec-finish or similar CLI command was accomplished.
27978 @item location-reached
27979 An -exec-until or similar CLI command was accomplished.
27980 @item watchpoint-scope
27981 A watchpoint has gone out of scope.
27982 @item end-stepping-range
27983 An -exec-next, -exec-next-instruction, -exec-step, -exec-step-instruction or
27984 similar CLI command was accomplished.
27985 @item exited-signalled
27986 The inferior exited because of a signal.
27988 The inferior exited.
27989 @item exited-normally
27990 The inferior exited normally.
27991 @item signal-received
27992 A signal was received by the inferior.
27994 The inferior has stopped due to a library being loaded or unloaded.
27995 This can happen when @code{stop-on-solib-events} (@pxref{Files}) is
27996 set or when a @code{catch load} or @code{catch unload} catchpoint is
27997 in use (@pxref{Set Catchpoints}).
27999 The inferior has forked. This is reported when @code{catch fork}
28000 (@pxref{Set Catchpoints}) has been used.
28002 The inferior has vforked. This is reported in when @code{catch vfork}
28003 (@pxref{Set Catchpoints}) has been used.
28004 @item syscall-entry
28005 The inferior entered a system call. This is reported when @code{catch
28006 syscall} (@pxref{Set Catchpoints}) has been used.
28007 @item syscall-return
28008 The inferior returned from a system call. This is reported when
28009 @code{catch syscall} (@pxref{Set Catchpoints}) has been used.
28011 The inferior called @code{exec}. This is reported when @code{catch exec}
28012 (@pxref{Set Catchpoints}) has been used.
28015 The @var{id} field identifies the global thread ID of the thread
28016 that directly caused the stop -- for example by hitting a breakpoint.
28017 Depending on whether all-stop
28018 mode is in effect (@pxref{All-Stop Mode}), @value{GDBN} may either
28019 stop all threads, or only the thread that directly triggered the stop.
28020 If all threads are stopped, the @var{stopped} field will have the
28021 value of @code{"all"}. Otherwise, the value of the @var{stopped}
28022 field will be a list of thread identifiers. Presently, this list will
28023 always include a single thread, but frontend should be prepared to see
28024 several threads in the list. The @var{core} field reports the
28025 processor core on which the stop event has happened. This field may be absent
28026 if such information is not available.
28028 @item =thread-group-added,id="@var{id}"
28029 @itemx =thread-group-removed,id="@var{id}"
28030 A thread group was either added or removed. The @var{id} field
28031 contains the @value{GDBN} identifier of the thread group. When a thread
28032 group is added, it generally might not be associated with a running
28033 process. When a thread group is removed, its id becomes invalid and
28034 cannot be used in any way.
28036 @item =thread-group-started,id="@var{id}",pid="@var{pid}"
28037 A thread group became associated with a running program,
28038 either because the program was just started or the thread group
28039 was attached to a program. The @var{id} field contains the
28040 @value{GDBN} identifier of the thread group. The @var{pid} field
28041 contains process identifier, specific to the operating system.
28043 @item =thread-group-exited,id="@var{id}"[,exit-code="@var{code}"]
28044 A thread group is no longer associated with a running program,
28045 either because the program has exited, or because it was detached
28046 from. The @var{id} field contains the @value{GDBN} identifier of the
28047 thread group. The @var{code} field is the exit code of the inferior; it exists
28048 only when the inferior exited with some code.
28050 @item =thread-created,id="@var{id}",group-id="@var{gid}"
28051 @itemx =thread-exited,id="@var{id}",group-id="@var{gid}"
28052 A thread either was created, or has exited. The @var{id} field
28053 contains the global @value{GDBN} identifier of the thread. The @var{gid}
28054 field identifies the thread group this thread belongs to.
28056 @item =thread-selected,id="@var{id}"[,frame="@var{frame}"]
28057 Informs that the selected thread or frame were changed. This notification
28058 is not emitted as result of the @code{-thread-select} or
28059 @code{-stack-select-frame} commands, but is emitted whenever an MI command
28060 that is not documented to change the selected thread and frame actually
28061 changes them. In particular, invoking, directly or indirectly
28062 (via user-defined command), the CLI @code{thread} or @code{frame} commands,
28063 will generate this notification. Changing the thread or frame from another
28064 user interface (see @ref{Interpreters}) will also generate this notification.
28066 The @var{frame} field is only present if the newly selected thread is
28067 stopped. See @ref{GDB/MI Frame Information} for the format of its value.
28069 We suggest that in response to this notification, front ends
28070 highlight the selected thread and cause subsequent commands to apply to
28073 @item =library-loaded,...
28074 Reports that a new library file was loaded by the program. This
28075 notification has 5 fields---@var{id}, @var{target-name},
28076 @var{host-name}, @var{symbols-loaded} and @var{ranges}. The @var{id} field is an
28077 opaque identifier of the library. For remote debugging case,
28078 @var{target-name} and @var{host-name} fields give the name of the
28079 library file on the target, and on the host respectively. For native
28080 debugging, both those fields have the same value. The
28081 @var{symbols-loaded} field is emitted only for backward compatibility
28082 and should not be relied on to convey any useful information. The
28083 @var{thread-group} field, if present, specifies the id of the thread
28084 group in whose context the library was loaded. If the field is
28085 absent, it means the library was loaded in the context of all present
28086 thread groups. The @var{ranges} field specifies the ranges of addresses belonging
28089 @item =library-unloaded,...
28090 Reports that a library was unloaded by the program. This notification
28091 has 3 fields---@var{id}, @var{target-name} and @var{host-name} with
28092 the same meaning as for the @code{=library-loaded} notification.
28093 The @var{thread-group} field, if present, specifies the id of the
28094 thread group in whose context the library was unloaded. If the field is
28095 absent, it means the library was unloaded in the context of all present
28098 @item =traceframe-changed,num=@var{tfnum},tracepoint=@var{tpnum}
28099 @itemx =traceframe-changed,end
28100 Reports that the trace frame was changed and its new number is
28101 @var{tfnum}. The number of the tracepoint associated with this trace
28102 frame is @var{tpnum}.
28104 @item =tsv-created,name=@var{name},initial=@var{initial}
28105 Reports that the new trace state variable @var{name} is created with
28106 initial value @var{initial}.
28108 @item =tsv-deleted,name=@var{name}
28109 @itemx =tsv-deleted
28110 Reports that the trace state variable @var{name} is deleted or all
28111 trace state variables are deleted.
28113 @item =tsv-modified,name=@var{name},initial=@var{initial}[,current=@var{current}]
28114 Reports that the trace state variable @var{name} is modified with
28115 the initial value @var{initial}. The current value @var{current} of
28116 trace state variable is optional and is reported if the current
28117 value of trace state variable is known.
28119 @item =breakpoint-created,bkpt=@{...@}
28120 @itemx =breakpoint-modified,bkpt=@{...@}
28121 @itemx =breakpoint-deleted,id=@var{number}
28122 Reports that a breakpoint was created, modified, or deleted,
28123 respectively. Only user-visible breakpoints are reported to the MI
28126 The @var{bkpt} argument is of the same form as returned by the various
28127 breakpoint commands; @xref{GDB/MI Breakpoint Commands}. The
28128 @var{number} is the ordinal number of the breakpoint.
28130 Note that if a breakpoint is emitted in the result record of a
28131 command, then it will not also be emitted in an async record.
28133 @item =record-started,thread-group="@var{id}",method="@var{method}"[,format="@var{format}"]
28134 @itemx =record-stopped,thread-group="@var{id}"
28135 Execution log recording was either started or stopped on an
28136 inferior. The @var{id} is the @value{GDBN} identifier of the thread
28137 group corresponding to the affected inferior.
28139 The @var{method} field indicates the method used to record execution. If the
28140 method in use supports multiple recording formats, @var{format} will be present
28141 and contain the currently used format. @xref{Process Record and Replay},
28142 for existing method and format values.
28144 @item =cmd-param-changed,param=@var{param},value=@var{value}
28145 Reports that a parameter of the command @code{set @var{param}} is
28146 changed to @var{value}. In the multi-word @code{set} command,
28147 the @var{param} is the whole parameter list to @code{set} command.
28148 For example, In command @code{set check type on}, @var{param}
28149 is @code{check type} and @var{value} is @code{on}.
28151 @item =memory-changed,thread-group=@var{id},addr=@var{addr},len=@var{len}[,type="code"]
28152 Reports that bytes from @var{addr} to @var{data} + @var{len} were
28153 written in an inferior. The @var{id} is the identifier of the
28154 thread group corresponding to the affected inferior. The optional
28155 @code{type="code"} part is reported if the memory written to holds
28159 @node GDB/MI Breakpoint Information
28160 @subsection @sc{gdb/mi} Breakpoint Information
28162 When @value{GDBN} reports information about a breakpoint, a
28163 tracepoint, a watchpoint, or a catchpoint, it uses a tuple with the
28168 The breakpoint number. For a breakpoint that represents one location
28169 of a multi-location breakpoint, this will be a dotted pair, like
28173 The type of the breakpoint. For ordinary breakpoints this will be
28174 @samp{breakpoint}, but many values are possible.
28177 If the type of the breakpoint is @samp{catchpoint}, then this
28178 indicates the exact type of catchpoint.
28181 This is the breakpoint disposition---either @samp{del}, meaning that
28182 the breakpoint will be deleted at the next stop, or @samp{keep},
28183 meaning that the breakpoint will not be deleted.
28186 This indicates whether the breakpoint is enabled, in which case the
28187 value is @samp{y}, or disabled, in which case the value is @samp{n}.
28188 Note that this is not the same as the field @code{enable}.
28191 The address of the breakpoint. This may be a hexidecimal number,
28192 giving the address; or the string @samp{<PENDING>}, for a pending
28193 breakpoint; or the string @samp{<MULTIPLE>}, for a breakpoint with
28194 multiple locations. This field will not be present if no address can
28195 be determined. For example, a watchpoint does not have an address.
28198 If known, the function in which the breakpoint appears.
28199 If not known, this field is not present.
28202 The name of the source file which contains this function, if known.
28203 If not known, this field is not present.
28206 The full file name of the source file which contains this function, if
28207 known. If not known, this field is not present.
28210 The line number at which this breakpoint appears, if known.
28211 If not known, this field is not present.
28214 If the source file is not known, this field may be provided. If
28215 provided, this holds the address of the breakpoint, possibly followed
28219 If this breakpoint is pending, this field is present and holds the
28220 text used to set the breakpoint, as entered by the user.
28223 Where this breakpoint's condition is evaluated, either @samp{host} or
28227 If this is a thread-specific breakpoint, then this identifies the
28228 thread in which the breakpoint can trigger.
28231 If this breakpoint is restricted to a particular Ada task, then this
28232 field will hold the task identifier.
28235 If the breakpoint is conditional, this is the condition expression.
28238 The ignore count of the breakpoint.
28241 The enable count of the breakpoint.
28243 @item traceframe-usage
28246 @item static-tracepoint-marker-string-id
28247 For a static tracepoint, the name of the static tracepoint marker.
28250 For a masked watchpoint, this is the mask.
28253 A tracepoint's pass count.
28255 @item original-location
28256 The location of the breakpoint as originally specified by the user.
28257 This field is optional.
28260 The number of times the breakpoint has been hit.
28263 This field is only given for tracepoints. This is either @samp{y},
28264 meaning that the tracepoint is installed, or @samp{n}, meaning that it
28268 Some extra data, the exact contents of which are type-dependent.
28272 For example, here is what the output of @code{-break-insert}
28273 (@pxref{GDB/MI Breakpoint Commands}) might be:
28276 -> -break-insert main
28277 <- ^done,bkpt=@{number="1",type="breakpoint",disp="keep",
28278 enabled="y",addr="0x08048564",func="main",file="myprog.c",
28279 fullname="/home/nickrob/myprog.c",line="68",thread-groups=["i1"],
28284 @node GDB/MI Frame Information
28285 @subsection @sc{gdb/mi} Frame Information
28287 Response from many MI commands includes an information about stack
28288 frame. This information is a tuple that may have the following
28293 The level of the stack frame. The innermost frame has the level of
28294 zero. This field is always present.
28297 The name of the function corresponding to the frame. This field may
28298 be absent if @value{GDBN} is unable to determine the function name.
28301 The code address for the frame. This field is always present.
28304 The name of the source files that correspond to the frame's code
28305 address. This field may be absent.
28308 The source line corresponding to the frames' code address. This field
28312 The name of the binary file (either executable or shared library) the
28313 corresponds to the frame's code address. This field may be absent.
28317 @node GDB/MI Thread Information
28318 @subsection @sc{gdb/mi} Thread Information
28320 Whenever @value{GDBN} has to report an information about a thread, it
28321 uses a tuple with the following fields. The fields are always present unless
28326 The global numeric id assigned to the thread by @value{GDBN}.
28329 The target-specific string identifying the thread.
28332 Additional information about the thread provided by the target.
28333 It is supposed to be human-readable and not interpreted by the
28334 frontend. This field is optional.
28337 The name of the thread. If the user specified a name using the
28338 @code{thread name} command, then this name is given. Otherwise, if
28339 @value{GDBN} can extract the thread name from the target, then that
28340 name is given. If @value{GDBN} cannot find the thread name, then this
28344 The execution state of the thread, either @samp{stopped} or @samp{running},
28345 depending on whether the thread is presently running.
28348 The stack frame currently executing in the thread. This field is only present
28349 if the thread is stopped. Its format is documented in
28350 @ref{GDB/MI Frame Information}.
28353 The value of this field is an integer number of the processor core the
28354 thread was last seen on. This field is optional.
28357 @node GDB/MI Ada Exception Information
28358 @subsection @sc{gdb/mi} Ada Exception Information
28360 Whenever a @code{*stopped} record is emitted because the program
28361 stopped after hitting an exception catchpoint (@pxref{Set Catchpoints}),
28362 @value{GDBN} provides the name of the exception that was raised via
28363 the @code{exception-name} field. Also, for exceptions that were raised
28364 with an exception message, @value{GDBN} provides that message via
28365 the @code{exception-message} field.
28367 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
28368 @node GDB/MI Simple Examples
28369 @section Simple Examples of @sc{gdb/mi} Interaction
28370 @cindex @sc{gdb/mi}, simple examples
28372 This subsection presents several simple examples of interaction using
28373 the @sc{gdb/mi} interface. In these examples, @samp{->} means that the
28374 following line is passed to @sc{gdb/mi} as input, while @samp{<-} means
28375 the output received from @sc{gdb/mi}.
28377 Note the line breaks shown in the examples are here only for
28378 readability, they don't appear in the real output.
28380 @subheading Setting a Breakpoint
28382 Setting a breakpoint generates synchronous output which contains detailed
28383 information of the breakpoint.
28386 -> -break-insert main
28387 <- ^done,bkpt=@{number="1",type="breakpoint",disp="keep",
28388 enabled="y",addr="0x08048564",func="main",file="myprog.c",
28389 fullname="/home/nickrob/myprog.c",line="68",thread-groups=["i1"],
28394 @subheading Program Execution
28396 Program execution generates asynchronous records and MI gives the
28397 reason that execution stopped.
28403 <- *stopped,reason="breakpoint-hit",disp="keep",bkptno="1",thread-id="0",
28404 frame=@{addr="0x08048564",func="main",
28405 args=[@{name="argc",value="1"@},@{name="argv",value="0xbfc4d4d4"@}],
28406 file="myprog.c",fullname="/home/nickrob/myprog.c",line="68",
28407 arch="i386:x86_64"@}
28412 <- *stopped,reason="exited-normally"
28416 @subheading Quitting @value{GDBN}
28418 Quitting @value{GDBN} just prints the result class @samp{^exit}.
28426 Please note that @samp{^exit} is printed immediately, but it might
28427 take some time for @value{GDBN} to actually exit. During that time, @value{GDBN}
28428 performs necessary cleanups, including killing programs being debugged
28429 or disconnecting from debug hardware, so the frontend should wait till
28430 @value{GDBN} exits and should only forcibly kill @value{GDBN} if it
28431 fails to exit in reasonable time.
28433 @subheading A Bad Command
28435 Here's what happens if you pass a non-existent command:
28439 <- ^error,msg="Undefined MI command: rubbish"
28444 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
28445 @node GDB/MI Command Description Format
28446 @section @sc{gdb/mi} Command Description Format
28448 The remaining sections describe blocks of commands. Each block of
28449 commands is laid out in a fashion similar to this section.
28451 @subheading Motivation
28453 The motivation for this collection of commands.
28455 @subheading Introduction
28457 A brief introduction to this collection of commands as a whole.
28459 @subheading Commands
28461 For each command in the block, the following is described:
28463 @subsubheading Synopsis
28466 -command @var{args}@dots{}
28469 @subsubheading Result
28471 @subsubheading @value{GDBN} Command
28473 The corresponding @value{GDBN} CLI command(s), if any.
28475 @subsubheading Example
28477 Example(s) formatted for readability. Some of the described commands have
28478 not been implemented yet and these are labeled N.A.@: (not available).
28481 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
28482 @node GDB/MI Breakpoint Commands
28483 @section @sc{gdb/mi} Breakpoint Commands
28485 @cindex breakpoint commands for @sc{gdb/mi}
28486 @cindex @sc{gdb/mi}, breakpoint commands
28487 This section documents @sc{gdb/mi} commands for manipulating
28490 @subheading The @code{-break-after} Command
28491 @findex -break-after
28493 @subsubheading Synopsis
28496 -break-after @var{number} @var{count}
28499 The breakpoint number @var{number} is not in effect until it has been
28500 hit @var{count} times. To see how this is reflected in the output of
28501 the @samp{-break-list} command, see the description of the
28502 @samp{-break-list} command below.
28504 @subsubheading @value{GDBN} Command
28506 The corresponding @value{GDBN} command is @samp{ignore}.
28508 @subsubheading Example
28513 ^done,bkpt=@{number="1",type="breakpoint",disp="keep",
28514 enabled="y",addr="0x000100d0",func="main",file="hello.c",
28515 fullname="/home/foo/hello.c",line="5",thread-groups=["i1"],
28523 ^done,BreakpointTable=@{nr_rows="1",nr_cols="6",
28524 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
28525 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
28526 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
28527 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
28528 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
28529 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
28530 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
28531 addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c",
28532 line="5",thread-groups=["i1"],times="0",ignore="3"@}]@}
28537 @subheading The @code{-break-catch} Command
28538 @findex -break-catch
28541 @subheading The @code{-break-commands} Command
28542 @findex -break-commands
28544 @subsubheading Synopsis
28547 -break-commands @var{number} [ @var{command1} ... @var{commandN} ]
28550 Specifies the CLI commands that should be executed when breakpoint
28551 @var{number} is hit. The parameters @var{command1} to @var{commandN}
28552 are the commands. If no command is specified, any previously-set
28553 commands are cleared. @xref{Break Commands}. Typical use of this
28554 functionality is tracing a program, that is, printing of values of
28555 some variables whenever breakpoint is hit and then continuing.
28557 @subsubheading @value{GDBN} Command
28559 The corresponding @value{GDBN} command is @samp{commands}.
28561 @subsubheading Example
28566 ^done,bkpt=@{number="1",type="breakpoint",disp="keep",
28567 enabled="y",addr="0x000100d0",func="main",file="hello.c",
28568 fullname="/home/foo/hello.c",line="5",thread-groups=["i1"],
28571 -break-commands 1 "print v" "continue"
28576 @subheading The @code{-break-condition} Command
28577 @findex -break-condition
28579 @subsubheading Synopsis
28582 -break-condition @var{number} @var{expr}
28585 Breakpoint @var{number} will stop the program only if the condition in
28586 @var{expr} is true. The condition becomes part of the
28587 @samp{-break-list} output (see the description of the @samp{-break-list}
28590 @subsubheading @value{GDBN} Command
28592 The corresponding @value{GDBN} command is @samp{condition}.
28594 @subsubheading Example
28598 -break-condition 1 1
28602 ^done,BreakpointTable=@{nr_rows="1",nr_cols="6",
28603 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
28604 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
28605 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
28606 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
28607 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
28608 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
28609 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
28610 addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c",
28611 line="5",cond="1",thread-groups=["i1"],times="0",ignore="3"@}]@}
28615 @subheading The @code{-break-delete} Command
28616 @findex -break-delete
28618 @subsubheading Synopsis
28621 -break-delete ( @var{breakpoint} )+
28624 Delete the breakpoint(s) whose number(s) are specified in the argument
28625 list. This is obviously reflected in the breakpoint list.
28627 @subsubheading @value{GDBN} Command
28629 The corresponding @value{GDBN} command is @samp{delete}.
28631 @subsubheading Example
28639 ^done,BreakpointTable=@{nr_rows="0",nr_cols="6",
28640 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
28641 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
28642 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
28643 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
28644 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
28645 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
28650 @subheading The @code{-break-disable} Command
28651 @findex -break-disable
28653 @subsubheading Synopsis
28656 -break-disable ( @var{breakpoint} )+
28659 Disable the named @var{breakpoint}(s). The field @samp{enabled} in the
28660 break list is now set to @samp{n} for the named @var{breakpoint}(s).
28662 @subsubheading @value{GDBN} Command
28664 The corresponding @value{GDBN} command is @samp{disable}.
28666 @subsubheading Example
28674 ^done,BreakpointTable=@{nr_rows="1",nr_cols="6",
28675 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
28676 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
28677 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
28678 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
28679 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
28680 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
28681 body=[bkpt=@{number="2",type="breakpoint",disp="keep",enabled="n",
28682 addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c",
28683 line="5",thread-groups=["i1"],times="0"@}]@}
28687 @subheading The @code{-break-enable} Command
28688 @findex -break-enable
28690 @subsubheading Synopsis
28693 -break-enable ( @var{breakpoint} )+
28696 Enable (previously disabled) @var{breakpoint}(s).
28698 @subsubheading @value{GDBN} Command
28700 The corresponding @value{GDBN} command is @samp{enable}.
28702 @subsubheading Example
28710 ^done,BreakpointTable=@{nr_rows="1",nr_cols="6",
28711 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
28712 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
28713 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
28714 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
28715 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
28716 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
28717 body=[bkpt=@{number="2",type="breakpoint",disp="keep",enabled="y",
28718 addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c",
28719 line="5",thread-groups=["i1"],times="0"@}]@}
28723 @subheading The @code{-break-info} Command
28724 @findex -break-info
28726 @subsubheading Synopsis
28729 -break-info @var{breakpoint}
28733 Get information about a single breakpoint.
28735 The result is a table of breakpoints. @xref{GDB/MI Breakpoint
28736 Information}, for details on the format of each breakpoint in the
28739 @subsubheading @value{GDBN} Command
28741 The corresponding @value{GDBN} command is @samp{info break @var{breakpoint}}.
28743 @subsubheading Example
28746 @subheading The @code{-break-insert} Command
28747 @findex -break-insert
28748 @anchor{-break-insert}
28750 @subsubheading Synopsis
28753 -break-insert [ -t ] [ -h ] [ -f ] [ -d ] [ -a ]
28754 [ -c @var{condition} ] [ -i @var{ignore-count} ]
28755 [ -p @var{thread-id} ] [ @var{location} ]
28759 If specified, @var{location}, can be one of:
28762 @item linespec location
28763 A linespec location. @xref{Linespec Locations}.
28765 @item explicit location
28766 An explicit location. @sc{gdb/mi} explicit locations are
28767 analogous to the CLI's explicit locations using the option names
28768 listed below. @xref{Explicit Locations}.
28771 @item --source @var{filename}
28772 The source file name of the location. This option requires the use
28773 of either @samp{--function} or @samp{--line}.
28775 @item --function @var{function}
28776 The name of a function or method.
28778 @item --label @var{label}
28779 The name of a label.
28781 @item --line @var{lineoffset}
28782 An absolute or relative line offset from the start of the location.
28785 @item address location
28786 An address location, *@var{address}. @xref{Address Locations}.
28790 The possible optional parameters of this command are:
28794 Insert a temporary breakpoint.
28796 Insert a hardware breakpoint.
28798 If @var{location} cannot be parsed (for example if it
28799 refers to unknown files or functions), create a pending
28800 breakpoint. Without this flag, @value{GDBN} will report
28801 an error, and won't create a breakpoint, if @var{location}
28804 Create a disabled breakpoint.
28806 Create a tracepoint. @xref{Tracepoints}. When this parameter
28807 is used together with @samp{-h}, a fast tracepoint is created.
28808 @item -c @var{condition}
28809 Make the breakpoint conditional on @var{condition}.
28810 @item -i @var{ignore-count}
28811 Initialize the @var{ignore-count}.
28812 @item -p @var{thread-id}
28813 Restrict the breakpoint to the thread with the specified global
28817 @subsubheading Result
28819 @xref{GDB/MI Breakpoint Information}, for details on the format of the
28820 resulting breakpoint.
28822 Note: this format is open to change.
28823 @c An out-of-band breakpoint instead of part of the result?
28825 @subsubheading @value{GDBN} Command
28827 The corresponding @value{GDBN} commands are @samp{break}, @samp{tbreak},
28828 @samp{hbreak}, and @samp{thbreak}. @c and @samp{rbreak}.
28830 @subsubheading Example
28835 ^done,bkpt=@{number="1",addr="0x0001072c",file="recursive2.c",
28836 fullname="/home/foo/recursive2.c,line="4",thread-groups=["i1"],
28839 -break-insert -t foo
28840 ^done,bkpt=@{number="2",addr="0x00010774",file="recursive2.c",
28841 fullname="/home/foo/recursive2.c,line="11",thread-groups=["i1"],
28845 ^done,BreakpointTable=@{nr_rows="2",nr_cols="6",
28846 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
28847 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
28848 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
28849 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
28850 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
28851 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
28852 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
28853 addr="0x0001072c", func="main",file="recursive2.c",
28854 fullname="/home/foo/recursive2.c,"line="4",thread-groups=["i1"],
28856 bkpt=@{number="2",type="breakpoint",disp="del",enabled="y",
28857 addr="0x00010774",func="foo",file="recursive2.c",
28858 fullname="/home/foo/recursive2.c",line="11",thread-groups=["i1"],
28861 @c -break-insert -r foo.*
28862 @c ~int foo(int, int);
28863 @c ^done,bkpt=@{number="3",addr="0x00010774",file="recursive2.c,
28864 @c "fullname="/home/foo/recursive2.c",line="11",thread-groups=["i1"],
28869 @subheading The @code{-dprintf-insert} Command
28870 @findex -dprintf-insert
28872 @subsubheading Synopsis
28875 -dprintf-insert [ -t ] [ -f ] [ -d ]
28876 [ -c @var{condition} ] [ -i @var{ignore-count} ]
28877 [ -p @var{thread-id} ] [ @var{location} ] [ @var{format} ]
28882 If supplied, @var{location} may be specified the same way as for
28883 the @code{-break-insert} command. @xref{-break-insert}.
28885 The possible optional parameters of this command are:
28889 Insert a temporary breakpoint.
28891 If @var{location} cannot be parsed (for example, if it
28892 refers to unknown files or functions), create a pending
28893 breakpoint. Without this flag, @value{GDBN} will report
28894 an error, and won't create a breakpoint, if @var{location}
28897 Create a disabled breakpoint.
28898 @item -c @var{condition}
28899 Make the breakpoint conditional on @var{condition}.
28900 @item -i @var{ignore-count}
28901 Set the ignore count of the breakpoint (@pxref{Conditions, ignore count})
28902 to @var{ignore-count}.
28903 @item -p @var{thread-id}
28904 Restrict the breakpoint to the thread with the specified global
28908 @subsubheading Result
28910 @xref{GDB/MI Breakpoint Information}, for details on the format of the
28911 resulting breakpoint.
28913 @c An out-of-band breakpoint instead of part of the result?
28915 @subsubheading @value{GDBN} Command
28917 The corresponding @value{GDBN} command is @samp{dprintf}.
28919 @subsubheading Example
28923 4-dprintf-insert foo "At foo entry\n"
28924 4^done,bkpt=@{number="1",type="dprintf",disp="keep",enabled="y",
28925 addr="0x000000000040061b",func="foo",file="mi-dprintf.c",
28926 fullname="mi-dprintf.c",line="25",thread-groups=["i1"],
28927 times="0",script=@{"printf \"At foo entry\\n\"","continue"@},
28928 original-location="foo"@}
28930 5-dprintf-insert 26 "arg=%d, g=%d\n" arg g
28931 5^done,bkpt=@{number="2",type="dprintf",disp="keep",enabled="y",
28932 addr="0x000000000040062a",func="foo",file="mi-dprintf.c",
28933 fullname="mi-dprintf.c",line="26",thread-groups=["i1"],
28934 times="0",script=@{"printf \"arg=%d, g=%d\\n\", arg, g","continue"@},
28935 original-location="mi-dprintf.c:26"@}
28939 @subheading The @code{-break-list} Command
28940 @findex -break-list
28942 @subsubheading Synopsis
28948 Displays the list of inserted breakpoints, showing the following fields:
28952 number of the breakpoint
28954 type of the breakpoint: @samp{breakpoint} or @samp{watchpoint}
28956 should the breakpoint be deleted or disabled when it is hit: @samp{keep}
28959 is the breakpoint enabled or no: @samp{y} or @samp{n}
28961 memory location at which the breakpoint is set
28963 logical location of the breakpoint, expressed by function name, file
28965 @item Thread-groups
28966 list of thread groups to which this breakpoint applies
28968 number of times the breakpoint has been hit
28971 If there are no breakpoints or watchpoints, the @code{BreakpointTable}
28972 @code{body} field is an empty list.
28974 @subsubheading @value{GDBN} Command
28976 The corresponding @value{GDBN} command is @samp{info break}.
28978 @subsubheading Example
28983 ^done,BreakpointTable=@{nr_rows="2",nr_cols="6",
28984 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
28985 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
28986 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
28987 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
28988 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
28989 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
28990 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
28991 addr="0x000100d0",func="main",file="hello.c",line="5",thread-groups=["i1"],
28993 bkpt=@{number="2",type="breakpoint",disp="keep",enabled="y",
28994 addr="0x00010114",func="foo",file="hello.c",fullname="/home/foo/hello.c",
28995 line="13",thread-groups=["i1"],times="0"@}]@}
28999 Here's an example of the result when there are no breakpoints:
29004 ^done,BreakpointTable=@{nr_rows="0",nr_cols="6",
29005 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
29006 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
29007 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
29008 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
29009 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
29010 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
29015 @subheading The @code{-break-passcount} Command
29016 @findex -break-passcount
29018 @subsubheading Synopsis
29021 -break-passcount @var{tracepoint-number} @var{passcount}
29024 Set the passcount for tracepoint @var{tracepoint-number} to
29025 @var{passcount}. If the breakpoint referred to by @var{tracepoint-number}
29026 is not a tracepoint, error is emitted. This corresponds to CLI
29027 command @samp{passcount}.
29029 @subheading The @code{-break-watch} Command
29030 @findex -break-watch
29032 @subsubheading Synopsis
29035 -break-watch [ -a | -r ]
29038 Create a watchpoint. With the @samp{-a} option it will create an
29039 @dfn{access} watchpoint, i.e., a watchpoint that triggers either on a
29040 read from or on a write to the memory location. With the @samp{-r}
29041 option, the watchpoint created is a @dfn{read} watchpoint, i.e., it will
29042 trigger only when the memory location is accessed for reading. Without
29043 either of the options, the watchpoint created is a regular watchpoint,
29044 i.e., it will trigger when the memory location is accessed for writing.
29045 @xref{Set Watchpoints, , Setting Watchpoints}.
29047 Note that @samp{-break-list} will report a single list of watchpoints and
29048 breakpoints inserted.
29050 @subsubheading @value{GDBN} Command
29052 The corresponding @value{GDBN} commands are @samp{watch}, @samp{awatch}, and
29055 @subsubheading Example
29057 Setting a watchpoint on a variable in the @code{main} function:
29062 ^done,wpt=@{number="2",exp="x"@}
29067 *stopped,reason="watchpoint-trigger",wpt=@{number="2",exp="x"@},
29068 value=@{old="-268439212",new="55"@},
29069 frame=@{func="main",args=[],file="recursive2.c",
29070 fullname="/home/foo/bar/recursive2.c",line="5",arch="i386:x86_64"@}
29074 Setting a watchpoint on a variable local to a function. @value{GDBN} will stop
29075 the program execution twice: first for the variable changing value, then
29076 for the watchpoint going out of scope.
29081 ^done,wpt=@{number="5",exp="C"@}
29086 *stopped,reason="watchpoint-trigger",
29087 wpt=@{number="5",exp="C"@},value=@{old="-276895068",new="3"@},
29088 frame=@{func="callee4",args=[],
29089 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
29090 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="13",
29091 arch="i386:x86_64"@}
29096 *stopped,reason="watchpoint-scope",wpnum="5",
29097 frame=@{func="callee3",args=[@{name="strarg",
29098 value="0x11940 \"A string argument.\""@}],
29099 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
29100 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="18",
29101 arch="i386:x86_64"@}
29105 Listing breakpoints and watchpoints, at different points in the program
29106 execution. Note that once the watchpoint goes out of scope, it is
29112 ^done,wpt=@{number="2",exp="C"@}
29115 ^done,BreakpointTable=@{nr_rows="2",nr_cols="6",
29116 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
29117 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
29118 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
29119 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
29120 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
29121 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
29122 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
29123 addr="0x00010734",func="callee4",
29124 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
29125 fullname="/home/foo/devo/gdb/testsuite/gdb.mi/basics.c"line="8",thread-groups=["i1"],
29127 bkpt=@{number="2",type="watchpoint",disp="keep",
29128 enabled="y",addr="",what="C",thread-groups=["i1"],times="0"@}]@}
29133 *stopped,reason="watchpoint-trigger",wpt=@{number="2",exp="C"@},
29134 value=@{old="-276895068",new="3"@},
29135 frame=@{func="callee4",args=[],
29136 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
29137 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="13",
29138 arch="i386:x86_64"@}
29141 ^done,BreakpointTable=@{nr_rows="2",nr_cols="6",
29142 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
29143 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
29144 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
29145 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
29146 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
29147 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
29148 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
29149 addr="0x00010734",func="callee4",
29150 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
29151 fullname="/home/foo/devo/gdb/testsuite/gdb.mi/basics.c",line="8",thread-groups=["i1"],
29153 bkpt=@{number="2",type="watchpoint",disp="keep",
29154 enabled="y",addr="",what="C",thread-groups=["i1"],times="-5"@}]@}
29158 ^done,reason="watchpoint-scope",wpnum="2",
29159 frame=@{func="callee3",args=[@{name="strarg",
29160 value="0x11940 \"A string argument.\""@}],
29161 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
29162 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="18",
29163 arch="i386:x86_64"@}
29166 ^done,BreakpointTable=@{nr_rows="1",nr_cols="6",
29167 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
29168 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
29169 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
29170 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
29171 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
29172 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
29173 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
29174 addr="0x00010734",func="callee4",
29175 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
29176 fullname="/home/foo/devo/gdb/testsuite/gdb.mi/basics.c",line="8",
29177 thread-groups=["i1"],times="1"@}]@}
29182 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
29183 @node GDB/MI Catchpoint Commands
29184 @section @sc{gdb/mi} Catchpoint Commands
29186 This section documents @sc{gdb/mi} commands for manipulating
29190 * Shared Library GDB/MI Catchpoint Commands::
29191 * Ada Exception GDB/MI Catchpoint Commands::
29194 @node Shared Library GDB/MI Catchpoint Commands
29195 @subsection Shared Library @sc{gdb/mi} Catchpoints
29197 @subheading The @code{-catch-load} Command
29198 @findex -catch-load
29200 @subsubheading Synopsis
29203 -catch-load [ -t ] [ -d ] @var{regexp}
29206 Add a catchpoint for library load events. If the @samp{-t} option is used,
29207 the catchpoint is a temporary one (@pxref{Set Breaks, ,Setting
29208 Breakpoints}). If the @samp{-d} option is used, the catchpoint is created
29209 in a disabled state. The @samp{regexp} argument is a regular
29210 expression used to match the name of the loaded library.
29213 @subsubheading @value{GDBN} Command
29215 The corresponding @value{GDBN} command is @samp{catch load}.
29217 @subsubheading Example
29220 -catch-load -t foo.so
29221 ^done,bkpt=@{number="1",type="catchpoint",disp="del",enabled="y",
29222 what="load of library matching foo.so",catch-type="load",times="0"@}
29227 @subheading The @code{-catch-unload} Command
29228 @findex -catch-unload
29230 @subsubheading Synopsis
29233 -catch-unload [ -t ] [ -d ] @var{regexp}
29236 Add a catchpoint for library unload events. If the @samp{-t} option is
29237 used, the catchpoint is a temporary one (@pxref{Set Breaks, ,Setting
29238 Breakpoints}). If the @samp{-d} option is used, the catchpoint is
29239 created in a disabled state. The @samp{regexp} argument is a regular
29240 expression used to match the name of the unloaded library.
29242 @subsubheading @value{GDBN} Command
29244 The corresponding @value{GDBN} command is @samp{catch unload}.
29246 @subsubheading Example
29249 -catch-unload -d bar.so
29250 ^done,bkpt=@{number="2",type="catchpoint",disp="keep",enabled="n",
29251 what="load of library matching bar.so",catch-type="unload",times="0"@}
29255 @node Ada Exception GDB/MI Catchpoint Commands
29256 @subsection Ada Exception @sc{gdb/mi} Catchpoints
29258 The following @sc{gdb/mi} commands can be used to create catchpoints
29259 that stop the execution when Ada exceptions are being raised.
29261 @subheading The @code{-catch-assert} Command
29262 @findex -catch-assert
29264 @subsubheading Synopsis
29267 -catch-assert [ -c @var{condition}] [ -d ] [ -t ]
29270 Add a catchpoint for failed Ada assertions.
29272 The possible optional parameters for this command are:
29275 @item -c @var{condition}
29276 Make the catchpoint conditional on @var{condition}.
29278 Create a disabled catchpoint.
29280 Create a temporary catchpoint.
29283 @subsubheading @value{GDBN} Command
29285 The corresponding @value{GDBN} command is @samp{catch assert}.
29287 @subsubheading Example
29291 ^done,bkptno="5",bkpt=@{number="5",type="breakpoint",disp="keep",
29292 enabled="y",addr="0x0000000000404888",what="failed Ada assertions",
29293 thread-groups=["i1"],times="0",
29294 original-location="__gnat_debug_raise_assert_failure"@}
29298 @subheading The @code{-catch-exception} Command
29299 @findex -catch-exception
29301 @subsubheading Synopsis
29304 -catch-exception [ -c @var{condition}] [ -d ] [ -e @var{exception-name} ]
29308 Add a catchpoint stopping when Ada exceptions are raised.
29309 By default, the command stops the program when any Ada exception
29310 gets raised. But it is also possible, by using some of the
29311 optional parameters described below, to create more selective
29314 The possible optional parameters for this command are:
29317 @item -c @var{condition}
29318 Make the catchpoint conditional on @var{condition}.
29320 Create a disabled catchpoint.
29321 @item -e @var{exception-name}
29322 Only stop when @var{exception-name} is raised. This option cannot
29323 be used combined with @samp{-u}.
29325 Create a temporary catchpoint.
29327 Stop only when an unhandled exception gets raised. This option
29328 cannot be used combined with @samp{-e}.
29331 @subsubheading @value{GDBN} Command
29333 The corresponding @value{GDBN} commands are @samp{catch exception}
29334 and @samp{catch exception unhandled}.
29336 @subsubheading Example
29339 -catch-exception -e Program_Error
29340 ^done,bkptno="4",bkpt=@{number="4",type="breakpoint",disp="keep",
29341 enabled="y",addr="0x0000000000404874",
29342 what="`Program_Error' Ada exception", thread-groups=["i1"],
29343 times="0",original-location="__gnat_debug_raise_exception"@}
29347 @subheading The @code{-catch-handlers} Command
29348 @findex -catch-handlers
29350 @subsubheading Synopsis
29353 -catch-handlers [ -c @var{condition}] [ -d ] [ -e @var{exception-name} ]
29357 Add a catchpoint stopping when Ada exceptions are handled.
29358 By default, the command stops the program when any Ada exception
29359 gets handled. But it is also possible, by using some of the
29360 optional parameters described below, to create more selective
29363 The possible optional parameters for this command are:
29366 @item -c @var{condition}
29367 Make the catchpoint conditional on @var{condition}.
29369 Create a disabled catchpoint.
29370 @item -e @var{exception-name}
29371 Only stop when @var{exception-name} is handled.
29373 Create a temporary catchpoint.
29376 @subsubheading @value{GDBN} Command
29378 The corresponding @value{GDBN} command is @samp{catch handlers}.
29380 @subsubheading Example
29383 -catch-handlers -e Constraint_Error
29384 ^done,bkptno="4",bkpt=@{number="4",type="breakpoint",disp="keep",
29385 enabled="y",addr="0x0000000000402f68",
29386 what="`Constraint_Error' Ada exception handlers",thread-groups=["i1"],
29387 times="0",original-location="__gnat_begin_handler"@}
29391 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
29392 @node GDB/MI Program Context
29393 @section @sc{gdb/mi} Program Context
29395 @subheading The @code{-exec-arguments} Command
29396 @findex -exec-arguments
29399 @subsubheading Synopsis
29402 -exec-arguments @var{args}
29405 Set the inferior program arguments, to be used in the next
29408 @subsubheading @value{GDBN} Command
29410 The corresponding @value{GDBN} command is @samp{set args}.
29412 @subsubheading Example
29416 -exec-arguments -v word
29423 @subheading The @code{-exec-show-arguments} Command
29424 @findex -exec-show-arguments
29426 @subsubheading Synopsis
29429 -exec-show-arguments
29432 Print the arguments of the program.
29434 @subsubheading @value{GDBN} Command
29436 The corresponding @value{GDBN} command is @samp{show args}.
29438 @subsubheading Example
29443 @subheading The @code{-environment-cd} Command
29444 @findex -environment-cd
29446 @subsubheading Synopsis
29449 -environment-cd @var{pathdir}
29452 Set @value{GDBN}'s working directory.
29454 @subsubheading @value{GDBN} Command
29456 The corresponding @value{GDBN} command is @samp{cd}.
29458 @subsubheading Example
29462 -environment-cd /kwikemart/marge/ezannoni/flathead-dev/devo/gdb
29468 @subheading The @code{-environment-directory} Command
29469 @findex -environment-directory
29471 @subsubheading Synopsis
29474 -environment-directory [ -r ] [ @var{pathdir} ]+
29477 Add directories @var{pathdir} to beginning of search path for source files.
29478 If the @samp{-r} option is used, the search path is reset to the default
29479 search path. If directories @var{pathdir} are supplied in addition to the
29480 @samp{-r} option, the search path is first reset and then addition
29482 Multiple directories may be specified, separated by blanks. Specifying
29483 multiple directories in a single command
29484 results in the directories added to the beginning of the
29485 search path in the same order they were presented in the command.
29486 If blanks are needed as
29487 part of a directory name, double-quotes should be used around
29488 the name. In the command output, the path will show up separated
29489 by the system directory-separator character. The directory-separator
29490 character must not be used
29491 in any directory name.
29492 If no directories are specified, the current search path is displayed.
29494 @subsubheading @value{GDBN} Command
29496 The corresponding @value{GDBN} command is @samp{dir}.
29498 @subsubheading Example
29502 -environment-directory /kwikemart/marge/ezannoni/flathead-dev/devo/gdb
29503 ^done,source-path="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb:$cdir:$cwd"
29505 -environment-directory ""
29506 ^done,source-path="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb:$cdir:$cwd"
29508 -environment-directory -r /home/jjohnstn/src/gdb /usr/src
29509 ^done,source-path="/home/jjohnstn/src/gdb:/usr/src:$cdir:$cwd"
29511 -environment-directory -r
29512 ^done,source-path="$cdir:$cwd"
29517 @subheading The @code{-environment-path} Command
29518 @findex -environment-path
29520 @subsubheading Synopsis
29523 -environment-path [ -r ] [ @var{pathdir} ]+
29526 Add directories @var{pathdir} to beginning of search path for object files.
29527 If the @samp{-r} option is used, the search path is reset to the original
29528 search path that existed at gdb start-up. If directories @var{pathdir} are
29529 supplied in addition to the
29530 @samp{-r} option, the search path is first reset and then addition
29532 Multiple directories may be specified, separated by blanks. Specifying
29533 multiple directories in a single command
29534 results in the directories added to the beginning of the
29535 search path in the same order they were presented in the command.
29536 If blanks are needed as
29537 part of a directory name, double-quotes should be used around
29538 the name. In the command output, the path will show up separated
29539 by the system directory-separator character. The directory-separator
29540 character must not be used
29541 in any directory name.
29542 If no directories are specified, the current path is displayed.
29545 @subsubheading @value{GDBN} Command
29547 The corresponding @value{GDBN} command is @samp{path}.
29549 @subsubheading Example
29554 ^done,path="/usr/bin"
29556 -environment-path /kwikemart/marge/ezannoni/flathead-dev/ppc-eabi/gdb /bin
29557 ^done,path="/kwikemart/marge/ezannoni/flathead-dev/ppc-eabi/gdb:/bin:/usr/bin"
29559 -environment-path -r /usr/local/bin
29560 ^done,path="/usr/local/bin:/usr/bin"
29565 @subheading The @code{-environment-pwd} Command
29566 @findex -environment-pwd
29568 @subsubheading Synopsis
29574 Show the current working directory.
29576 @subsubheading @value{GDBN} Command
29578 The corresponding @value{GDBN} command is @samp{pwd}.
29580 @subsubheading Example
29585 ^done,cwd="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb"
29589 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
29590 @node GDB/MI Thread Commands
29591 @section @sc{gdb/mi} Thread Commands
29594 @subheading The @code{-thread-info} Command
29595 @findex -thread-info
29597 @subsubheading Synopsis
29600 -thread-info [ @var{thread-id} ]
29603 Reports information about either a specific thread, if the
29604 @var{thread-id} parameter is present, or about all threads.
29605 @var{thread-id} is the thread's global thread ID. When printing
29606 information about all threads, also reports the global ID of the
29609 @subsubheading @value{GDBN} Command
29611 The @samp{info thread} command prints the same information
29614 @subsubheading Result
29616 The result contains the following attributes:
29620 A list of threads. The format of the elements of the list is described in
29621 @ref{GDB/MI Thread Information}.
29623 @item current-thread-id
29624 The global id of the currently selected thread. This field is omitted if there
29625 is no selected thread (for example, when the selected inferior is not running,
29626 and therefore has no threads) or if a @var{thread-id} argument was passed to
29631 @subsubheading Example
29636 @{id="2",target-id="Thread 0xb7e14b90 (LWP 21257)",
29637 frame=@{level="0",addr="0xffffe410",func="__kernel_vsyscall",
29638 args=[]@},state="running"@},
29639 @{id="1",target-id="Thread 0xb7e156b0 (LWP 21254)",
29640 frame=@{level="0",addr="0x0804891f",func="foo",
29641 args=[@{name="i",value="10"@}],
29642 file="/tmp/a.c",fullname="/tmp/a.c",line="158",arch="i386:x86_64"@},
29643 state="running"@}],
29644 current-thread-id="1"
29648 @subheading The @code{-thread-list-ids} Command
29649 @findex -thread-list-ids
29651 @subsubheading Synopsis
29657 Produces a list of the currently known global @value{GDBN} thread ids.
29658 At the end of the list it also prints the total number of such
29661 This command is retained for historical reasons, the
29662 @code{-thread-info} command should be used instead.
29664 @subsubheading @value{GDBN} Command
29666 Part of @samp{info threads} supplies the same information.
29668 @subsubheading Example
29673 ^done,thread-ids=@{thread-id="3",thread-id="2",thread-id="1"@},
29674 current-thread-id="1",number-of-threads="3"
29679 @subheading The @code{-thread-select} Command
29680 @findex -thread-select
29682 @subsubheading Synopsis
29685 -thread-select @var{thread-id}
29688 Make thread with global thread number @var{thread-id} the current
29689 thread. It prints the number of the new current thread, and the
29690 topmost frame for that thread.
29692 This command is deprecated in favor of explicitly using the
29693 @samp{--thread} option to each command.
29695 @subsubheading @value{GDBN} Command
29697 The corresponding @value{GDBN} command is @samp{thread}.
29699 @subsubheading Example
29706 *stopped,reason="end-stepping-range",thread-id="2",line="187",
29707 file="../../../devo/gdb/testsuite/gdb.threads/linux-dp.c"
29711 thread-ids=@{thread-id="3",thread-id="2",thread-id="1"@},
29712 number-of-threads="3"
29715 ^done,new-thread-id="3",
29716 frame=@{level="0",func="vprintf",
29717 args=[@{name="format",value="0x8048e9c \"%*s%c %d %c\\n\""@},
29718 @{name="arg",value="0x2"@}],file="vprintf.c",line="31",arch="i386:x86_64"@}
29722 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
29723 @node GDB/MI Ada Tasking Commands
29724 @section @sc{gdb/mi} Ada Tasking Commands
29726 @subheading The @code{-ada-task-info} Command
29727 @findex -ada-task-info
29729 @subsubheading Synopsis
29732 -ada-task-info [ @var{task-id} ]
29735 Reports information about either a specific Ada task, if the
29736 @var{task-id} parameter is present, or about all Ada tasks.
29738 @subsubheading @value{GDBN} Command
29740 The @samp{info tasks} command prints the same information
29741 about all Ada tasks (@pxref{Ada Tasks}).
29743 @subsubheading Result
29745 The result is a table of Ada tasks. The following columns are
29746 defined for each Ada task:
29750 This field exists only for the current thread. It has the value @samp{*}.
29753 The identifier that @value{GDBN} uses to refer to the Ada task.
29756 The identifier that the target uses to refer to the Ada task.
29759 The global thread identifier of the thread corresponding to the Ada
29762 This field should always exist, as Ada tasks are always implemented
29763 on top of a thread. But if @value{GDBN} cannot find this corresponding
29764 thread for any reason, the field is omitted.
29767 This field exists only when the task was created by another task.
29768 In this case, it provides the ID of the parent task.
29771 The base priority of the task.
29774 The current state of the task. For a detailed description of the
29775 possible states, see @ref{Ada Tasks}.
29778 The name of the task.
29782 @subsubheading Example
29786 ^done,tasks=@{nr_rows="3",nr_cols="8",
29787 hdr=[@{width="1",alignment="-1",col_name="current",colhdr=""@},
29788 @{width="3",alignment="1",col_name="id",colhdr="ID"@},
29789 @{width="9",alignment="1",col_name="task-id",colhdr="TID"@},
29790 @{width="4",alignment="1",col_name="thread-id",colhdr=""@},
29791 @{width="4",alignment="1",col_name="parent-id",colhdr="P-ID"@},
29792 @{width="3",alignment="1",col_name="priority",colhdr="Pri"@},
29793 @{width="22",alignment="-1",col_name="state",colhdr="State"@},
29794 @{width="1",alignment="2",col_name="name",colhdr="Name"@}],
29795 body=[@{current="*",id="1",task-id=" 644010",thread-id="1",priority="48",
29796 state="Child Termination Wait",name="main_task"@}]@}
29800 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
29801 @node GDB/MI Program Execution
29802 @section @sc{gdb/mi} Program Execution
29804 These are the asynchronous commands which generate the out-of-band
29805 record @samp{*stopped}. Currently @value{GDBN} only really executes
29806 asynchronously with remote targets and this interaction is mimicked in
29809 @subheading The @code{-exec-continue} Command
29810 @findex -exec-continue
29812 @subsubheading Synopsis
29815 -exec-continue [--reverse] [--all|--thread-group N]
29818 Resumes the execution of the inferior program, which will continue
29819 to execute until it reaches a debugger stop event. If the
29820 @samp{--reverse} option is specified, execution resumes in reverse until
29821 it reaches a stop event. Stop events may include
29824 breakpoints or watchpoints
29826 signals or exceptions
29828 the end of the process (or its beginning under @samp{--reverse})
29830 the end or beginning of a replay log if one is being used.
29832 In all-stop mode (@pxref{All-Stop
29833 Mode}), may resume only one thread, or all threads, depending on the
29834 value of the @samp{scheduler-locking} variable. If @samp{--all} is
29835 specified, all threads (in all inferiors) will be resumed. The @samp{--all} option is
29836 ignored in all-stop mode. If the @samp{--thread-group} options is
29837 specified, then all threads in that thread group are resumed.
29839 @subsubheading @value{GDBN} Command
29841 The corresponding @value{GDBN} corresponding is @samp{continue}.
29843 @subsubheading Example
29850 *stopped,reason="breakpoint-hit",disp="keep",bkptno="2",frame=@{
29851 func="foo",args=[],file="hello.c",fullname="/home/foo/bar/hello.c",
29852 line="13",arch="i386:x86_64"@}
29857 @subheading The @code{-exec-finish} Command
29858 @findex -exec-finish
29860 @subsubheading Synopsis
29863 -exec-finish [--reverse]
29866 Resumes the execution of the inferior program until the current
29867 function is exited. Displays the results returned by the function.
29868 If the @samp{--reverse} option is specified, resumes the reverse
29869 execution of the inferior program until the point where current
29870 function was called.
29872 @subsubheading @value{GDBN} Command
29874 The corresponding @value{GDBN} command is @samp{finish}.
29876 @subsubheading Example
29878 Function returning @code{void}.
29885 *stopped,reason="function-finished",frame=@{func="main",args=[],
29886 file="hello.c",fullname="/home/foo/bar/hello.c",line="7",arch="i386:x86_64"@}
29890 Function returning other than @code{void}. The name of the internal
29891 @value{GDBN} variable storing the result is printed, together with the
29898 *stopped,reason="function-finished",frame=@{addr="0x000107b0",func="foo",
29899 args=[@{name="a",value="1"],@{name="b",value="9"@}@},
29900 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14",
29901 arch="i386:x86_64"@},
29902 gdb-result-var="$1",return-value="0"
29907 @subheading The @code{-exec-interrupt} Command
29908 @findex -exec-interrupt
29910 @subsubheading Synopsis
29913 -exec-interrupt [--all|--thread-group N]
29916 Interrupts the background execution of the target. Note how the token
29917 associated with the stop message is the one for the execution command
29918 that has been interrupted. The token for the interrupt itself only
29919 appears in the @samp{^done} output. If the user is trying to
29920 interrupt a non-running program, an error message will be printed.
29922 Note that when asynchronous execution is enabled, this command is
29923 asynchronous just like other execution commands. That is, first the
29924 @samp{^done} response will be printed, and the target stop will be
29925 reported after that using the @samp{*stopped} notification.
29927 In non-stop mode, only the context thread is interrupted by default.
29928 All threads (in all inferiors) will be interrupted if the
29929 @samp{--all} option is specified. If the @samp{--thread-group}
29930 option is specified, all threads in that group will be interrupted.
29932 @subsubheading @value{GDBN} Command
29934 The corresponding @value{GDBN} command is @samp{interrupt}.
29936 @subsubheading Example
29947 111*stopped,signal-name="SIGINT",signal-meaning="Interrupt",
29948 frame=@{addr="0x00010140",func="foo",args=[],file="try.c",
29949 fullname="/home/foo/bar/try.c",line="13",arch="i386:x86_64"@}
29954 ^error,msg="mi_cmd_exec_interrupt: Inferior not executing."
29958 @subheading The @code{-exec-jump} Command
29961 @subsubheading Synopsis
29964 -exec-jump @var{location}
29967 Resumes execution of the inferior program at the location specified by
29968 parameter. @xref{Specify Location}, for a description of the
29969 different forms of @var{location}.
29971 @subsubheading @value{GDBN} Command
29973 The corresponding @value{GDBN} command is @samp{jump}.
29975 @subsubheading Example
29978 -exec-jump foo.c:10
29979 *running,thread-id="all"
29984 @subheading The @code{-exec-next} Command
29987 @subsubheading Synopsis
29990 -exec-next [--reverse]
29993 Resumes execution of the inferior program, stopping when the beginning
29994 of the next source line is reached.
29996 If the @samp{--reverse} option is specified, resumes reverse execution
29997 of the inferior program, stopping at the beginning of the previous
29998 source line. If you issue this command on the first line of a
29999 function, it will take you back to the caller of that function, to the
30000 source line where the function was called.
30003 @subsubheading @value{GDBN} Command
30005 The corresponding @value{GDBN} command is @samp{next}.
30007 @subsubheading Example
30013 *stopped,reason="end-stepping-range",line="8",file="hello.c"
30018 @subheading The @code{-exec-next-instruction} Command
30019 @findex -exec-next-instruction
30021 @subsubheading Synopsis
30024 -exec-next-instruction [--reverse]
30027 Executes one machine instruction. If the instruction is a function
30028 call, continues until the function returns. If the program stops at an
30029 instruction in the middle of a source line, the address will be
30032 If the @samp{--reverse} option is specified, resumes reverse execution
30033 of the inferior program, stopping at the previous instruction. If the
30034 previously executed instruction was a return from another function,
30035 it will continue to execute in reverse until the call to that function
30036 (from the current stack frame) is reached.
30038 @subsubheading @value{GDBN} Command
30040 The corresponding @value{GDBN} command is @samp{nexti}.
30042 @subsubheading Example
30046 -exec-next-instruction
30050 *stopped,reason="end-stepping-range",
30051 addr="0x000100d4",line="5",file="hello.c"
30056 @subheading The @code{-exec-return} Command
30057 @findex -exec-return
30059 @subsubheading Synopsis
30065 Makes current function return immediately. Doesn't execute the inferior.
30066 Displays the new current frame.
30068 @subsubheading @value{GDBN} Command
30070 The corresponding @value{GDBN} command is @samp{return}.
30072 @subsubheading Example
30076 200-break-insert callee4
30077 200^done,bkpt=@{number="1",addr="0x00010734",
30078 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="8"@}
30083 000*stopped,reason="breakpoint-hit",disp="keep",bkptno="1",
30084 frame=@{func="callee4",args=[],
30085 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
30086 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="8",
30087 arch="i386:x86_64"@}
30093 111^done,frame=@{level="0",func="callee3",
30094 args=[@{name="strarg",
30095 value="0x11940 \"A string argument.\""@}],
30096 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
30097 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="18",
30098 arch="i386:x86_64"@}
30103 @subheading The @code{-exec-run} Command
30106 @subsubheading Synopsis
30109 -exec-run [ --all | --thread-group N ] [ --start ]
30112 Starts execution of the inferior from the beginning. The inferior
30113 executes until either a breakpoint is encountered or the program
30114 exits. In the latter case the output will include an exit code, if
30115 the program has exited exceptionally.
30117 When neither the @samp{--all} nor the @samp{--thread-group} option
30118 is specified, the current inferior is started. If the
30119 @samp{--thread-group} option is specified, it should refer to a thread
30120 group of type @samp{process}, and that thread group will be started.
30121 If the @samp{--all} option is specified, then all inferiors will be started.
30123 Using the @samp{--start} option instructs the debugger to stop
30124 the execution at the start of the inferior's main subprogram,
30125 following the same behavior as the @code{start} command
30126 (@pxref{Starting}).
30128 @subsubheading @value{GDBN} Command
30130 The corresponding @value{GDBN} command is @samp{run}.
30132 @subsubheading Examples
30137 ^done,bkpt=@{number="1",addr="0x0001072c",file="recursive2.c",line="4"@}
30142 *stopped,reason="breakpoint-hit",disp="keep",bkptno="1",
30143 frame=@{func="main",args=[],file="recursive2.c",
30144 fullname="/home/foo/bar/recursive2.c",line="4",arch="i386:x86_64"@}
30149 Program exited normally:
30157 *stopped,reason="exited-normally"
30162 Program exited exceptionally:
30170 *stopped,reason="exited",exit-code="01"
30174 Another way the program can terminate is if it receives a signal such as
30175 @code{SIGINT}. In this case, @sc{gdb/mi} displays this:
30179 *stopped,reason="exited-signalled",signal-name="SIGINT",
30180 signal-meaning="Interrupt"
30184 @c @subheading -exec-signal
30187 @subheading The @code{-exec-step} Command
30190 @subsubheading Synopsis
30193 -exec-step [--reverse]
30196 Resumes execution of the inferior program, stopping when the beginning
30197 of the next source line is reached, if the next source line is not a
30198 function call. If it is, stop at the first instruction of the called
30199 function. If the @samp{--reverse} option is specified, resumes reverse
30200 execution of the inferior program, stopping at the beginning of the
30201 previously executed source line.
30203 @subsubheading @value{GDBN} Command
30205 The corresponding @value{GDBN} command is @samp{step}.
30207 @subsubheading Example
30209 Stepping into a function:
30215 *stopped,reason="end-stepping-range",
30216 frame=@{func="foo",args=[@{name="a",value="10"@},
30217 @{name="b",value="0"@}],file="recursive2.c",
30218 fullname="/home/foo/bar/recursive2.c",line="11",arch="i386:x86_64"@}
30228 *stopped,reason="end-stepping-range",line="14",file="recursive2.c"
30233 @subheading The @code{-exec-step-instruction} Command
30234 @findex -exec-step-instruction
30236 @subsubheading Synopsis
30239 -exec-step-instruction [--reverse]
30242 Resumes the inferior which executes one machine instruction. If the
30243 @samp{--reverse} option is specified, resumes reverse execution of the
30244 inferior program, stopping at the previously executed instruction.
30245 The output, once @value{GDBN} has stopped, will vary depending on
30246 whether we have stopped in the middle of a source line or not. In the
30247 former case, the address at which the program stopped will be printed
30250 @subsubheading @value{GDBN} Command
30252 The corresponding @value{GDBN} command is @samp{stepi}.
30254 @subsubheading Example
30258 -exec-step-instruction
30262 *stopped,reason="end-stepping-range",
30263 frame=@{func="foo",args=[],file="try.c",
30264 fullname="/home/foo/bar/try.c",line="10",arch="i386:x86_64"@}
30266 -exec-step-instruction
30270 *stopped,reason="end-stepping-range",
30271 frame=@{addr="0x000100f4",func="foo",args=[],file="try.c",
30272 fullname="/home/foo/bar/try.c",line="10",arch="i386:x86_64"@}
30277 @subheading The @code{-exec-until} Command
30278 @findex -exec-until
30280 @subsubheading Synopsis
30283 -exec-until [ @var{location} ]
30286 Executes the inferior until the @var{location} specified in the
30287 argument is reached. If there is no argument, the inferior executes
30288 until a source line greater than the current one is reached. The
30289 reason for stopping in this case will be @samp{location-reached}.
30291 @subsubheading @value{GDBN} Command
30293 The corresponding @value{GDBN} command is @samp{until}.
30295 @subsubheading Example
30299 -exec-until recursive2.c:6
30303 *stopped,reason="location-reached",frame=@{func="main",args=[],
30304 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="6",
30305 arch="i386:x86_64"@}
30310 @subheading -file-clear
30311 Is this going away????
30314 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
30315 @node GDB/MI Stack Manipulation
30316 @section @sc{gdb/mi} Stack Manipulation Commands
30318 @subheading The @code{-enable-frame-filters} Command
30319 @findex -enable-frame-filters
30322 -enable-frame-filters
30325 @value{GDBN} allows Python-based frame filters to affect the output of
30326 the MI commands relating to stack traces. As there is no way to
30327 implement this in a fully backward-compatible way, a front end must
30328 request that this functionality be enabled.
30330 Once enabled, this feature cannot be disabled.
30332 Note that if Python support has not been compiled into @value{GDBN},
30333 this command will still succeed (and do nothing).
30335 @subheading The @code{-stack-info-frame} Command
30336 @findex -stack-info-frame
30338 @subsubheading Synopsis
30344 Get info on the selected frame.
30346 @subsubheading @value{GDBN} Command
30348 The corresponding @value{GDBN} command is @samp{info frame} or @samp{frame}
30349 (without arguments).
30351 @subsubheading Example
30356 ^done,frame=@{level="1",addr="0x0001076c",func="callee3",
30357 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
30358 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="17",
30359 arch="i386:x86_64"@}
30363 @subheading The @code{-stack-info-depth} Command
30364 @findex -stack-info-depth
30366 @subsubheading Synopsis
30369 -stack-info-depth [ @var{max-depth} ]
30372 Return the depth of the stack. If the integer argument @var{max-depth}
30373 is specified, do not count beyond @var{max-depth} frames.
30375 @subsubheading @value{GDBN} Command
30377 There's no equivalent @value{GDBN} command.
30379 @subsubheading Example
30381 For a stack with frame levels 0 through 11:
30388 -stack-info-depth 4
30391 -stack-info-depth 12
30394 -stack-info-depth 11
30397 -stack-info-depth 13
30402 @anchor{-stack-list-arguments}
30403 @subheading The @code{-stack-list-arguments} Command
30404 @findex -stack-list-arguments
30406 @subsubheading Synopsis
30409 -stack-list-arguments [ --no-frame-filters ] [ --skip-unavailable ] @var{print-values}
30410 [ @var{low-frame} @var{high-frame} ]
30413 Display a list of the arguments for the frames between @var{low-frame}
30414 and @var{high-frame} (inclusive). If @var{low-frame} and
30415 @var{high-frame} are not provided, list the arguments for the whole
30416 call stack. If the two arguments are equal, show the single frame
30417 at the corresponding level. It is an error if @var{low-frame} is
30418 larger than the actual number of frames. On the other hand,
30419 @var{high-frame} may be larger than the actual number of frames, in
30420 which case only existing frames will be returned.
30422 If @var{print-values} is 0 or @code{--no-values}, print only the names of
30423 the variables; if it is 1 or @code{--all-values}, print also their
30424 values; and if it is 2 or @code{--simple-values}, print the name,
30425 type and value for simple data types, and the name and type for arrays,
30426 structures and unions. If the option @code{--no-frame-filters} is
30427 supplied, then Python frame filters will not be executed.
30429 If the @code{--skip-unavailable} option is specified, arguments that
30430 are not available are not listed. Partially available arguments
30431 are still displayed, however.
30433 Use of this command to obtain arguments in a single frame is
30434 deprecated in favor of the @samp{-stack-list-variables} command.
30436 @subsubheading @value{GDBN} Command
30438 @value{GDBN} does not have an equivalent command. @code{gdbtk} has a
30439 @samp{gdb_get_args} command which partially overlaps with the
30440 functionality of @samp{-stack-list-arguments}.
30442 @subsubheading Example
30449 frame=@{level="0",addr="0x00010734",func="callee4",
30450 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
30451 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="8",
30452 arch="i386:x86_64"@},
30453 frame=@{level="1",addr="0x0001076c",func="callee3",
30454 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
30455 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="17",
30456 arch="i386:x86_64"@},
30457 frame=@{level="2",addr="0x0001078c",func="callee2",
30458 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
30459 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="22",
30460 arch="i386:x86_64"@},
30461 frame=@{level="3",addr="0x000107b4",func="callee1",
30462 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
30463 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="27",
30464 arch="i386:x86_64"@},
30465 frame=@{level="4",addr="0x000107e0",func="main",
30466 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
30467 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="32",
30468 arch="i386:x86_64"@}]
30470 -stack-list-arguments 0
30473 frame=@{level="0",args=[]@},
30474 frame=@{level="1",args=[name="strarg"]@},
30475 frame=@{level="2",args=[name="intarg",name="strarg"]@},
30476 frame=@{level="3",args=[name="intarg",name="strarg",name="fltarg"]@},
30477 frame=@{level="4",args=[]@}]
30479 -stack-list-arguments 1
30482 frame=@{level="0",args=[]@},
30484 args=[@{name="strarg",value="0x11940 \"A string argument.\""@}]@},
30485 frame=@{level="2",args=[
30486 @{name="intarg",value="2"@},
30487 @{name="strarg",value="0x11940 \"A string argument.\""@}]@},
30488 @{frame=@{level="3",args=[
30489 @{name="intarg",value="2"@},
30490 @{name="strarg",value="0x11940 \"A string argument.\""@},
30491 @{name="fltarg",value="3.5"@}]@},
30492 frame=@{level="4",args=[]@}]
30494 -stack-list-arguments 0 2 2
30495 ^done,stack-args=[frame=@{level="2",args=[name="intarg",name="strarg"]@}]
30497 -stack-list-arguments 1 2 2
30498 ^done,stack-args=[frame=@{level="2",
30499 args=[@{name="intarg",value="2"@},
30500 @{name="strarg",value="0x11940 \"A string argument.\""@}]@}]
30504 @c @subheading -stack-list-exception-handlers
30507 @anchor{-stack-list-frames}
30508 @subheading The @code{-stack-list-frames} Command
30509 @findex -stack-list-frames
30511 @subsubheading Synopsis
30514 -stack-list-frames [ --no-frame-filters @var{low-frame} @var{high-frame} ]
30517 List the frames currently on the stack. For each frame it displays the
30522 The frame number, 0 being the topmost frame, i.e., the innermost function.
30524 The @code{$pc} value for that frame.
30528 File name of the source file where the function lives.
30529 @item @var{fullname}
30530 The full file name of the source file where the function lives.
30532 Line number corresponding to the @code{$pc}.
30534 The shared library where this function is defined. This is only given
30535 if the frame's function is not known.
30537 Frame's architecture.
30540 If invoked without arguments, this command prints a backtrace for the
30541 whole stack. If given two integer arguments, it shows the frames whose
30542 levels are between the two arguments (inclusive). If the two arguments
30543 are equal, it shows the single frame at the corresponding level. It is
30544 an error if @var{low-frame} is larger than the actual number of
30545 frames. On the other hand, @var{high-frame} may be larger than the
30546 actual number of frames, in which case only existing frames will be
30547 returned. If the option @code{--no-frame-filters} is supplied, then
30548 Python frame filters will not be executed.
30550 @subsubheading @value{GDBN} Command
30552 The corresponding @value{GDBN} commands are @samp{backtrace} and @samp{where}.
30554 @subsubheading Example
30556 Full stack backtrace:
30562 [frame=@{level="0",addr="0x0001076c",func="foo",
30563 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="11",
30564 arch="i386:x86_64"@},
30565 frame=@{level="1",addr="0x000107a4",func="foo",
30566 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14",
30567 arch="i386:x86_64"@},
30568 frame=@{level="2",addr="0x000107a4",func="foo",
30569 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14",
30570 arch="i386:x86_64"@},
30571 frame=@{level="3",addr="0x000107a4",func="foo",
30572 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14",
30573 arch="i386:x86_64"@},
30574 frame=@{level="4",addr="0x000107a4",func="foo",
30575 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14",
30576 arch="i386:x86_64"@},
30577 frame=@{level="5",addr="0x000107a4",func="foo",
30578 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14",
30579 arch="i386:x86_64"@},
30580 frame=@{level="6",addr="0x000107a4",func="foo",
30581 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14",
30582 arch="i386:x86_64"@},
30583 frame=@{level="7",addr="0x000107a4",func="foo",
30584 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14",
30585 arch="i386:x86_64"@},
30586 frame=@{level="8",addr="0x000107a4",func="foo",
30587 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14",
30588 arch="i386:x86_64"@},
30589 frame=@{level="9",addr="0x000107a4",func="foo",
30590 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14",
30591 arch="i386:x86_64"@},
30592 frame=@{level="10",addr="0x000107a4",func="foo",
30593 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14",
30594 arch="i386:x86_64"@},
30595 frame=@{level="11",addr="0x00010738",func="main",
30596 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="4",
30597 arch="i386:x86_64"@}]
30601 Show frames between @var{low_frame} and @var{high_frame}:
30605 -stack-list-frames 3 5
30607 [frame=@{level="3",addr="0x000107a4",func="foo",
30608 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14",
30609 arch="i386:x86_64"@},
30610 frame=@{level="4",addr="0x000107a4",func="foo",
30611 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14",
30612 arch="i386:x86_64"@},
30613 frame=@{level="5",addr="0x000107a4",func="foo",
30614 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14",
30615 arch="i386:x86_64"@}]
30619 Show a single frame:
30623 -stack-list-frames 3 3
30625 [frame=@{level="3",addr="0x000107a4",func="foo",
30626 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14",
30627 arch="i386:x86_64"@}]
30632 @subheading The @code{-stack-list-locals} Command
30633 @findex -stack-list-locals
30634 @anchor{-stack-list-locals}
30636 @subsubheading Synopsis
30639 -stack-list-locals [ --no-frame-filters ] [ --skip-unavailable ] @var{print-values}
30642 Display the local variable names for the selected frame. If
30643 @var{print-values} is 0 or @code{--no-values}, print only the names of
30644 the variables; if it is 1 or @code{--all-values}, print also their
30645 values; and if it is 2 or @code{--simple-values}, print the name,
30646 type and value for simple data types, and the name and type for arrays,
30647 structures and unions. In this last case, a frontend can immediately
30648 display the value of simple data types and create variable objects for
30649 other data types when the user wishes to explore their values in
30650 more detail. If the option @code{--no-frame-filters} is supplied, then
30651 Python frame filters will not be executed.
30653 If the @code{--skip-unavailable} option is specified, local variables
30654 that are not available are not listed. Partially available local
30655 variables are still displayed, however.
30657 This command is deprecated in favor of the
30658 @samp{-stack-list-variables} command.
30660 @subsubheading @value{GDBN} Command
30662 @samp{info locals} in @value{GDBN}, @samp{gdb_get_locals} in @code{gdbtk}.
30664 @subsubheading Example
30668 -stack-list-locals 0
30669 ^done,locals=[name="A",name="B",name="C"]
30671 -stack-list-locals --all-values
30672 ^done,locals=[@{name="A",value="1"@},@{name="B",value="2"@},
30673 @{name="C",value="@{1, 2, 3@}"@}]
30674 -stack-list-locals --simple-values
30675 ^done,locals=[@{name="A",type="int",value="1"@},
30676 @{name="B",type="int",value="2"@},@{name="C",type="int [3]"@}]
30680 @anchor{-stack-list-variables}
30681 @subheading The @code{-stack-list-variables} Command
30682 @findex -stack-list-variables
30684 @subsubheading Synopsis
30687 -stack-list-variables [ --no-frame-filters ] [ --skip-unavailable ] @var{print-values}
30690 Display the names of local variables and function arguments for the selected frame. If
30691 @var{print-values} is 0 or @code{--no-values}, print only the names of
30692 the variables; if it is 1 or @code{--all-values}, print also their
30693 values; and if it is 2 or @code{--simple-values}, print the name,
30694 type and value for simple data types, and the name and type for arrays,
30695 structures and unions. If the option @code{--no-frame-filters} is
30696 supplied, then Python frame filters will not be executed.
30698 If the @code{--skip-unavailable} option is specified, local variables
30699 and arguments that are not available are not listed. Partially
30700 available arguments and local variables are still displayed, however.
30702 @subsubheading Example
30706 -stack-list-variables --thread 1 --frame 0 --all-values
30707 ^done,variables=[@{name="x",value="11"@},@{name="s",value="@{a = 1, b = 2@}"@}]
30712 @subheading The @code{-stack-select-frame} Command
30713 @findex -stack-select-frame
30715 @subsubheading Synopsis
30718 -stack-select-frame @var{framenum}
30721 Change the selected frame. Select a different frame @var{framenum} on
30724 This command in deprecated in favor of passing the @samp{--frame}
30725 option to every command.
30727 @subsubheading @value{GDBN} Command
30729 The corresponding @value{GDBN} commands are @samp{frame}, @samp{up},
30730 @samp{down}, @samp{select-frame}, @samp{up-silent}, and @samp{down-silent}.
30732 @subsubheading Example
30736 -stack-select-frame 2
30741 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
30742 @node GDB/MI Variable Objects
30743 @section @sc{gdb/mi} Variable Objects
30747 @subheading Motivation for Variable Objects in @sc{gdb/mi}
30749 For the implementation of a variable debugger window (locals, watched
30750 expressions, etc.), we are proposing the adaptation of the existing code
30751 used by @code{Insight}.
30753 The two main reasons for that are:
30757 It has been proven in practice (it is already on its second generation).
30760 It will shorten development time (needless to say how important it is
30764 The original interface was designed to be used by Tcl code, so it was
30765 slightly changed so it could be used through @sc{gdb/mi}. This section
30766 describes the @sc{gdb/mi} operations that will be available and gives some
30767 hints about their use.
30769 @emph{Note}: In addition to the set of operations described here, we
30770 expect the @sc{gui} implementation of a variable window to require, at
30771 least, the following operations:
30774 @item @code{-gdb-show} @code{output-radix}
30775 @item @code{-stack-list-arguments}
30776 @item @code{-stack-list-locals}
30777 @item @code{-stack-select-frame}
30782 @subheading Introduction to Variable Objects
30784 @cindex variable objects in @sc{gdb/mi}
30786 Variable objects are "object-oriented" MI interface for examining and
30787 changing values of expressions. Unlike some other MI interfaces that
30788 work with expressions, variable objects are specifically designed for
30789 simple and efficient presentation in the frontend. A variable object
30790 is identified by string name. When a variable object is created, the
30791 frontend specifies the expression for that variable object. The
30792 expression can be a simple variable, or it can be an arbitrary complex
30793 expression, and can even involve CPU registers. After creating a
30794 variable object, the frontend can invoke other variable object
30795 operations---for example to obtain or change the value of a variable
30796 object, or to change display format.
30798 Variable objects have hierarchical tree structure. Any variable object
30799 that corresponds to a composite type, such as structure in C, has
30800 a number of child variable objects, for example corresponding to each
30801 element of a structure. A child variable object can itself have
30802 children, recursively. Recursion ends when we reach
30803 leaf variable objects, which always have built-in types. Child variable
30804 objects are created only by explicit request, so if a frontend
30805 is not interested in the children of a particular variable object, no
30806 child will be created.
30808 For a leaf variable object it is possible to obtain its value as a
30809 string, or set the value from a string. String value can be also
30810 obtained for a non-leaf variable object, but it's generally a string
30811 that only indicates the type of the object, and does not list its
30812 contents. Assignment to a non-leaf variable object is not allowed.
30814 A frontend does not need to read the values of all variable objects each time
30815 the program stops. Instead, MI provides an update command that lists all
30816 variable objects whose values has changed since the last update
30817 operation. This considerably reduces the amount of data that must
30818 be transferred to the frontend. As noted above, children variable
30819 objects are created on demand, and only leaf variable objects have a
30820 real value. As result, gdb will read target memory only for leaf
30821 variables that frontend has created.
30823 The automatic update is not always desirable. For example, a frontend
30824 might want to keep a value of some expression for future reference,
30825 and never update it. For another example, fetching memory is
30826 relatively slow for embedded targets, so a frontend might want
30827 to disable automatic update for the variables that are either not
30828 visible on the screen, or ``closed''. This is possible using so
30829 called ``frozen variable objects''. Such variable objects are never
30830 implicitly updated.
30832 Variable objects can be either @dfn{fixed} or @dfn{floating}. For the
30833 fixed variable object, the expression is parsed when the variable
30834 object is created, including associating identifiers to specific
30835 variables. The meaning of expression never changes. For a floating
30836 variable object the values of variables whose names appear in the
30837 expressions are re-evaluated every time in the context of the current
30838 frame. Consider this example:
30843 struct work_state state;
30850 If a fixed variable object for the @code{state} variable is created in
30851 this function, and we enter the recursive call, the variable
30852 object will report the value of @code{state} in the top-level
30853 @code{do_work} invocation. On the other hand, a floating variable
30854 object will report the value of @code{state} in the current frame.
30856 If an expression specified when creating a fixed variable object
30857 refers to a local variable, the variable object becomes bound to the
30858 thread and frame in which the variable object is created. When such
30859 variable object is updated, @value{GDBN} makes sure that the
30860 thread/frame combination the variable object is bound to still exists,
30861 and re-evaluates the variable object in context of that thread/frame.
30863 The following is the complete set of @sc{gdb/mi} operations defined to
30864 access this functionality:
30866 @multitable @columnfractions .4 .6
30867 @item @strong{Operation}
30868 @tab @strong{Description}
30870 @item @code{-enable-pretty-printing}
30871 @tab enable Python-based pretty-printing
30872 @item @code{-var-create}
30873 @tab create a variable object
30874 @item @code{-var-delete}
30875 @tab delete the variable object and/or its children
30876 @item @code{-var-set-format}
30877 @tab set the display format of this variable
30878 @item @code{-var-show-format}
30879 @tab show the display format of this variable
30880 @item @code{-var-info-num-children}
30881 @tab tells how many children this object has
30882 @item @code{-var-list-children}
30883 @tab return a list of the object's children
30884 @item @code{-var-info-type}
30885 @tab show the type of this variable object
30886 @item @code{-var-info-expression}
30887 @tab print parent-relative expression that this variable object represents
30888 @item @code{-var-info-path-expression}
30889 @tab print full expression that this variable object represents
30890 @item @code{-var-show-attributes}
30891 @tab is this variable editable? does it exist here?
30892 @item @code{-var-evaluate-expression}
30893 @tab get the value of this variable
30894 @item @code{-var-assign}
30895 @tab set the value of this variable
30896 @item @code{-var-update}
30897 @tab update the variable and its children
30898 @item @code{-var-set-frozen}
30899 @tab set frozeness attribute
30900 @item @code{-var-set-update-range}
30901 @tab set range of children to display on update
30904 In the next subsection we describe each operation in detail and suggest
30905 how it can be used.
30907 @subheading Description And Use of Operations on Variable Objects
30909 @subheading The @code{-enable-pretty-printing} Command
30910 @findex -enable-pretty-printing
30913 -enable-pretty-printing
30916 @value{GDBN} allows Python-based visualizers to affect the output of the
30917 MI variable object commands. However, because there was no way to
30918 implement this in a fully backward-compatible way, a front end must
30919 request that this functionality be enabled.
30921 Once enabled, this feature cannot be disabled.
30923 Note that if Python support has not been compiled into @value{GDBN},
30924 this command will still succeed (and do nothing).
30926 This feature is currently (as of @value{GDBN} 7.0) experimental, and
30927 may work differently in future versions of @value{GDBN}.
30929 @subheading The @code{-var-create} Command
30930 @findex -var-create
30932 @subsubheading Synopsis
30935 -var-create @{@var{name} | "-"@}
30936 @{@var{frame-addr} | "*" | "@@"@} @var{expression}
30939 This operation creates a variable object, which allows the monitoring of
30940 a variable, the result of an expression, a memory cell or a CPU
30943 The @var{name} parameter is the string by which the object can be
30944 referenced. It must be unique. If @samp{-} is specified, the varobj
30945 system will generate a string ``varNNNNNN'' automatically. It will be
30946 unique provided that one does not specify @var{name} of that format.
30947 The command fails if a duplicate name is found.
30949 The frame under which the expression should be evaluated can be
30950 specified by @var{frame-addr}. A @samp{*} indicates that the current
30951 frame should be used. A @samp{@@} indicates that a floating variable
30952 object must be created.
30954 @var{expression} is any expression valid on the current language set (must not
30955 begin with a @samp{*}), or one of the following:
30959 @samp{*@var{addr}}, where @var{addr} is the address of a memory cell
30962 @samp{*@var{addr}-@var{addr}} --- a memory address range (TBD)
30965 @samp{$@var{regname}} --- a CPU register name
30968 @cindex dynamic varobj
30969 A varobj's contents may be provided by a Python-based pretty-printer. In this
30970 case the varobj is known as a @dfn{dynamic varobj}. Dynamic varobjs
30971 have slightly different semantics in some cases. If the
30972 @code{-enable-pretty-printing} command is not sent, then @value{GDBN}
30973 will never create a dynamic varobj. This ensures backward
30974 compatibility for existing clients.
30976 @subsubheading Result
30978 This operation returns attributes of the newly-created varobj. These
30983 The name of the varobj.
30986 The number of children of the varobj. This number is not necessarily
30987 reliable for a dynamic varobj. Instead, you must examine the
30988 @samp{has_more} attribute.
30991 The varobj's scalar value. For a varobj whose type is some sort of
30992 aggregate (e.g., a @code{struct}), or for a dynamic varobj, this value
30993 will not be interesting.
30996 The varobj's type. This is a string representation of the type, as
30997 would be printed by the @value{GDBN} CLI. If @samp{print object}
30998 (@pxref{Print Settings, set print object}) is set to @code{on}, the
30999 @emph{actual} (derived) type of the object is shown rather than the
31000 @emph{declared} one.
31003 If a variable object is bound to a specific thread, then this is the
31004 thread's global identifier.
31007 For a dynamic varobj, this indicates whether there appear to be any
31008 children available. For a non-dynamic varobj, this will be 0.
31011 This attribute will be present and have the value @samp{1} if the
31012 varobj is a dynamic varobj. If the varobj is not a dynamic varobj,
31013 then this attribute will not be present.
31016 A dynamic varobj can supply a display hint to the front end. The
31017 value comes directly from the Python pretty-printer object's
31018 @code{display_hint} method. @xref{Pretty Printing API}.
31021 Typical output will look like this:
31024 name="@var{name}",numchild="@var{N}",type="@var{type}",thread-id="@var{M}",
31025 has_more="@var{has_more}"
31029 @subheading The @code{-var-delete} Command
31030 @findex -var-delete
31032 @subsubheading Synopsis
31035 -var-delete [ -c ] @var{name}
31038 Deletes a previously created variable object and all of its children.
31039 With the @samp{-c} option, just deletes the children.
31041 Returns an error if the object @var{name} is not found.
31044 @subheading The @code{-var-set-format} Command
31045 @findex -var-set-format
31047 @subsubheading Synopsis
31050 -var-set-format @var{name} @var{format-spec}
31053 Sets the output format for the value of the object @var{name} to be
31056 @anchor{-var-set-format}
31057 The syntax for the @var{format-spec} is as follows:
31060 @var{format-spec} @expansion{}
31061 @{binary | decimal | hexadecimal | octal | natural | zero-hexadecimal@}
31064 The natural format is the default format choosen automatically
31065 based on the variable type (like decimal for an @code{int}, hex
31066 for pointers, etc.).
31068 The zero-hexadecimal format has a representation similar to hexadecimal
31069 but with padding zeroes to the left of the value. For example, a 32-bit
31070 hexadecimal value of 0x1234 would be represented as 0x00001234 in the
31071 zero-hexadecimal format.
31073 For a variable with children, the format is set only on the
31074 variable itself, and the children are not affected.
31076 @subheading The @code{-var-show-format} Command
31077 @findex -var-show-format
31079 @subsubheading Synopsis
31082 -var-show-format @var{name}
31085 Returns the format used to display the value of the object @var{name}.
31088 @var{format} @expansion{}
31093 @subheading The @code{-var-info-num-children} Command
31094 @findex -var-info-num-children
31096 @subsubheading Synopsis
31099 -var-info-num-children @var{name}
31102 Returns the number of children of a variable object @var{name}:
31108 Note that this number is not completely reliable for a dynamic varobj.
31109 It will return the current number of children, but more children may
31113 @subheading The @code{-var-list-children} Command
31114 @findex -var-list-children
31116 @subsubheading Synopsis
31119 -var-list-children [@var{print-values}] @var{name} [@var{from} @var{to}]
31121 @anchor{-var-list-children}
31123 Return a list of the children of the specified variable object and
31124 create variable objects for them, if they do not already exist. With
31125 a single argument or if @var{print-values} has a value of 0 or
31126 @code{--no-values}, print only the names of the variables; if
31127 @var{print-values} is 1 or @code{--all-values}, also print their
31128 values; and if it is 2 or @code{--simple-values} print the name and
31129 value for simple data types and just the name for arrays, structures
31132 @var{from} and @var{to}, if specified, indicate the range of children
31133 to report. If @var{from} or @var{to} is less than zero, the range is
31134 reset and all children will be reported. Otherwise, children starting
31135 at @var{from} (zero-based) and up to and excluding @var{to} will be
31138 If a child range is requested, it will only affect the current call to
31139 @code{-var-list-children}, but not future calls to @code{-var-update}.
31140 For this, you must instead use @code{-var-set-update-range}. The
31141 intent of this approach is to enable a front end to implement any
31142 update approach it likes; for example, scrolling a view may cause the
31143 front end to request more children with @code{-var-list-children}, and
31144 then the front end could call @code{-var-set-update-range} with a
31145 different range to ensure that future updates are restricted to just
31148 For each child the following results are returned:
31153 Name of the variable object created for this child.
31156 The expression to be shown to the user by the front end to designate this child.
31157 For example this may be the name of a structure member.
31159 For a dynamic varobj, this value cannot be used to form an
31160 expression. There is no way to do this at all with a dynamic varobj.
31162 For C/C@t{++} structures there are several pseudo children returned to
31163 designate access qualifiers. For these pseudo children @var{exp} is
31164 @samp{public}, @samp{private}, or @samp{protected}. In this case the
31165 type and value are not present.
31167 A dynamic varobj will not report the access qualifying
31168 pseudo-children, regardless of the language. This information is not
31169 available at all with a dynamic varobj.
31172 Number of children this child has. For a dynamic varobj, this will be
31176 The type of the child. If @samp{print object}
31177 (@pxref{Print Settings, set print object}) is set to @code{on}, the
31178 @emph{actual} (derived) type of the object is shown rather than the
31179 @emph{declared} one.
31182 If values were requested, this is the value.
31185 If this variable object is associated with a thread, this is the
31186 thread's global thread id. Otherwise this result is not present.
31189 If the variable object is frozen, this variable will be present with a value of 1.
31192 A dynamic varobj can supply a display hint to the front end. The
31193 value comes directly from the Python pretty-printer object's
31194 @code{display_hint} method. @xref{Pretty Printing API}.
31197 This attribute will be present and have the value @samp{1} if the
31198 varobj is a dynamic varobj. If the varobj is not a dynamic varobj,
31199 then this attribute will not be present.
31203 The result may have its own attributes:
31207 A dynamic varobj can supply a display hint to the front end. The
31208 value comes directly from the Python pretty-printer object's
31209 @code{display_hint} method. @xref{Pretty Printing API}.
31212 This is an integer attribute which is nonzero if there are children
31213 remaining after the end of the selected range.
31216 @subsubheading Example
31220 -var-list-children n
31221 ^done,numchild=@var{n},children=[child=@{name=@var{name},exp=@var{exp},
31222 numchild=@var{n},type=@var{type}@},@r{(repeats N times)}]
31224 -var-list-children --all-values n
31225 ^done,numchild=@var{n},children=[child=@{name=@var{name},exp=@var{exp},
31226 numchild=@var{n},value=@var{value},type=@var{type}@},@r{(repeats N times)}]
31230 @subheading The @code{-var-info-type} Command
31231 @findex -var-info-type
31233 @subsubheading Synopsis
31236 -var-info-type @var{name}
31239 Returns the type of the specified variable @var{name}. The type is
31240 returned as a string in the same format as it is output by the
31244 type=@var{typename}
31248 @subheading The @code{-var-info-expression} Command
31249 @findex -var-info-expression
31251 @subsubheading Synopsis
31254 -var-info-expression @var{name}
31257 Returns a string that is suitable for presenting this
31258 variable object in user interface. The string is generally
31259 not valid expression in the current language, and cannot be evaluated.
31261 For example, if @code{a} is an array, and variable object
31262 @code{A} was created for @code{a}, then we'll get this output:
31265 (gdb) -var-info-expression A.1
31266 ^done,lang="C",exp="1"
31270 Here, the value of @code{lang} is the language name, which can be
31271 found in @ref{Supported Languages}.
31273 Note that the output of the @code{-var-list-children} command also
31274 includes those expressions, so the @code{-var-info-expression} command
31277 @subheading The @code{-var-info-path-expression} Command
31278 @findex -var-info-path-expression
31280 @subsubheading Synopsis
31283 -var-info-path-expression @var{name}
31286 Returns an expression that can be evaluated in the current
31287 context and will yield the same value that a variable object has.
31288 Compare this with the @code{-var-info-expression} command, which
31289 result can be used only for UI presentation. Typical use of
31290 the @code{-var-info-path-expression} command is creating a
31291 watchpoint from a variable object.
31293 This command is currently not valid for children of a dynamic varobj,
31294 and will give an error when invoked on one.
31296 For example, suppose @code{C} is a C@t{++} class, derived from class
31297 @code{Base}, and that the @code{Base} class has a member called
31298 @code{m_size}. Assume a variable @code{c} is has the type of
31299 @code{C} and a variable object @code{C} was created for variable
31300 @code{c}. Then, we'll get this output:
31302 (gdb) -var-info-path-expression C.Base.public.m_size
31303 ^done,path_expr=((Base)c).m_size)
31306 @subheading The @code{-var-show-attributes} Command
31307 @findex -var-show-attributes
31309 @subsubheading Synopsis
31312 -var-show-attributes @var{name}
31315 List attributes of the specified variable object @var{name}:
31318 status=@var{attr} [ ( ,@var{attr} )* ]
31322 where @var{attr} is @code{@{ @{ editable | noneditable @} | TBD @}}.
31324 @subheading The @code{-var-evaluate-expression} Command
31325 @findex -var-evaluate-expression
31327 @subsubheading Synopsis
31330 -var-evaluate-expression [-f @var{format-spec}] @var{name}
31333 Evaluates the expression that is represented by the specified variable
31334 object and returns its value as a string. The format of the string
31335 can be specified with the @samp{-f} option. The possible values of
31336 this option are the same as for @code{-var-set-format}
31337 (@pxref{-var-set-format}). If the @samp{-f} option is not specified,
31338 the current display format will be used. The current display format
31339 can be changed using the @code{-var-set-format} command.
31345 Note that one must invoke @code{-var-list-children} for a variable
31346 before the value of a child variable can be evaluated.
31348 @subheading The @code{-var-assign} Command
31349 @findex -var-assign
31351 @subsubheading Synopsis
31354 -var-assign @var{name} @var{expression}
31357 Assigns the value of @var{expression} to the variable object specified
31358 by @var{name}. The object must be @samp{editable}. If the variable's
31359 value is altered by the assign, the variable will show up in any
31360 subsequent @code{-var-update} list.
31362 @subsubheading Example
31370 ^done,changelist=[@{name="var1",in_scope="true",type_changed="false"@}]
31374 @subheading The @code{-var-update} Command
31375 @findex -var-update
31377 @subsubheading Synopsis
31380 -var-update [@var{print-values}] @{@var{name} | "*"@}
31383 Reevaluate the expressions corresponding to the variable object
31384 @var{name} and all its direct and indirect children, and return the
31385 list of variable objects whose values have changed; @var{name} must
31386 be a root variable object. Here, ``changed'' means that the result of
31387 @code{-var-evaluate-expression} before and after the
31388 @code{-var-update} is different. If @samp{*} is used as the variable
31389 object names, all existing variable objects are updated, except
31390 for frozen ones (@pxref{-var-set-frozen}). The option
31391 @var{print-values} determines whether both names and values, or just
31392 names are printed. The possible values of this option are the same
31393 as for @code{-var-list-children} (@pxref{-var-list-children}). It is
31394 recommended to use the @samp{--all-values} option, to reduce the
31395 number of MI commands needed on each program stop.
31397 With the @samp{*} parameter, if a variable object is bound to a
31398 currently running thread, it will not be updated, without any
31401 If @code{-var-set-update-range} was previously used on a varobj, then
31402 only the selected range of children will be reported.
31404 @code{-var-update} reports all the changed varobjs in a tuple named
31407 Each item in the change list is itself a tuple holding:
31411 The name of the varobj.
31414 If values were requested for this update, then this field will be
31415 present and will hold the value of the varobj.
31418 @anchor{-var-update}
31419 This field is a string which may take one of three values:
31423 The variable object's current value is valid.
31426 The variable object does not currently hold a valid value but it may
31427 hold one in the future if its associated expression comes back into
31431 The variable object no longer holds a valid value.
31432 This can occur when the executable file being debugged has changed,
31433 either through recompilation or by using the @value{GDBN} @code{file}
31434 command. The front end should normally choose to delete these variable
31438 In the future new values may be added to this list so the front should
31439 be prepared for this possibility. @xref{GDB/MI Development and Front Ends, ,@sc{GDB/MI} Development and Front Ends}.
31442 This is only present if the varobj is still valid. If the type
31443 changed, then this will be the string @samp{true}; otherwise it will
31446 When a varobj's type changes, its children are also likely to have
31447 become incorrect. Therefore, the varobj's children are automatically
31448 deleted when this attribute is @samp{true}. Also, the varobj's update
31449 range, when set using the @code{-var-set-update-range} command, is
31453 If the varobj's type changed, then this field will be present and will
31456 @item new_num_children
31457 For a dynamic varobj, if the number of children changed, or if the
31458 type changed, this will be the new number of children.
31460 The @samp{numchild} field in other varobj responses is generally not
31461 valid for a dynamic varobj -- it will show the number of children that
31462 @value{GDBN} knows about, but because dynamic varobjs lazily
31463 instantiate their children, this will not reflect the number of
31464 children which may be available.
31466 The @samp{new_num_children} attribute only reports changes to the
31467 number of children known by @value{GDBN}. This is the only way to
31468 detect whether an update has removed children (which necessarily can
31469 only happen at the end of the update range).
31472 The display hint, if any.
31475 This is an integer value, which will be 1 if there are more children
31476 available outside the varobj's update range.
31479 This attribute will be present and have the value @samp{1} if the
31480 varobj is a dynamic varobj. If the varobj is not a dynamic varobj,
31481 then this attribute will not be present.
31484 If new children were added to a dynamic varobj within the selected
31485 update range (as set by @code{-var-set-update-range}), then they will
31486 be listed in this attribute.
31489 @subsubheading Example
31496 -var-update --all-values var1
31497 ^done,changelist=[@{name="var1",value="3",in_scope="true",
31498 type_changed="false"@}]
31502 @subheading The @code{-var-set-frozen} Command
31503 @findex -var-set-frozen
31504 @anchor{-var-set-frozen}
31506 @subsubheading Synopsis
31509 -var-set-frozen @var{name} @var{flag}
31512 Set the frozenness flag on the variable object @var{name}. The
31513 @var{flag} parameter should be either @samp{1} to make the variable
31514 frozen or @samp{0} to make it unfrozen. If a variable object is
31515 frozen, then neither itself, nor any of its children, are
31516 implicitly updated by @code{-var-update} of
31517 a parent variable or by @code{-var-update *}. Only
31518 @code{-var-update} of the variable itself will update its value and
31519 values of its children. After a variable object is unfrozen, it is
31520 implicitly updated by all subsequent @code{-var-update} operations.
31521 Unfreezing a variable does not update it, only subsequent
31522 @code{-var-update} does.
31524 @subsubheading Example
31528 -var-set-frozen V 1
31533 @subheading The @code{-var-set-update-range} command
31534 @findex -var-set-update-range
31535 @anchor{-var-set-update-range}
31537 @subsubheading Synopsis
31540 -var-set-update-range @var{name} @var{from} @var{to}
31543 Set the range of children to be returned by future invocations of
31544 @code{-var-update}.
31546 @var{from} and @var{to} indicate the range of children to report. If
31547 @var{from} or @var{to} is less than zero, the range is reset and all
31548 children will be reported. Otherwise, children starting at @var{from}
31549 (zero-based) and up to and excluding @var{to} will be reported.
31551 @subsubheading Example
31555 -var-set-update-range V 1 2
31559 @subheading The @code{-var-set-visualizer} command
31560 @findex -var-set-visualizer
31561 @anchor{-var-set-visualizer}
31563 @subsubheading Synopsis
31566 -var-set-visualizer @var{name} @var{visualizer}
31569 Set a visualizer for the variable object @var{name}.
31571 @var{visualizer} is the visualizer to use. The special value
31572 @samp{None} means to disable any visualizer in use.
31574 If not @samp{None}, @var{visualizer} must be a Python expression.
31575 This expression must evaluate to a callable object which accepts a
31576 single argument. @value{GDBN} will call this object with the value of
31577 the varobj @var{name} as an argument (this is done so that the same
31578 Python pretty-printing code can be used for both the CLI and MI).
31579 When called, this object must return an object which conforms to the
31580 pretty-printing interface (@pxref{Pretty Printing API}).
31582 The pre-defined function @code{gdb.default_visualizer} may be used to
31583 select a visualizer by following the built-in process
31584 (@pxref{Selecting Pretty-Printers}). This is done automatically when
31585 a varobj is created, and so ordinarily is not needed.
31587 This feature is only available if Python support is enabled. The MI
31588 command @code{-list-features} (@pxref{GDB/MI Support Commands})
31589 can be used to check this.
31591 @subsubheading Example
31593 Resetting the visualizer:
31597 -var-set-visualizer V None
31601 Reselecting the default (type-based) visualizer:
31605 -var-set-visualizer V gdb.default_visualizer
31609 Suppose @code{SomeClass} is a visualizer class. A lambda expression
31610 can be used to instantiate this class for a varobj:
31614 -var-set-visualizer V "lambda val: SomeClass()"
31618 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
31619 @node GDB/MI Data Manipulation
31620 @section @sc{gdb/mi} Data Manipulation
31622 @cindex data manipulation, in @sc{gdb/mi}
31623 @cindex @sc{gdb/mi}, data manipulation
31624 This section describes the @sc{gdb/mi} commands that manipulate data:
31625 examine memory and registers, evaluate expressions, etc.
31627 For details about what an addressable memory unit is,
31628 @pxref{addressable memory unit}.
31630 @c REMOVED FROM THE INTERFACE.
31631 @c @subheading -data-assign
31632 @c Change the value of a program variable. Plenty of side effects.
31633 @c @subsubheading GDB Command
31635 @c @subsubheading Example
31638 @subheading The @code{-data-disassemble} Command
31639 @findex -data-disassemble
31641 @subsubheading Synopsis
31645 [ -s @var{start-addr} -e @var{end-addr} ]
31646 | [ -a @var{addr} ]
31647 | [ -f @var{filename} -l @var{linenum} [ -n @var{lines} ] ]
31655 @item @var{start-addr}
31656 is the beginning address (or @code{$pc})
31657 @item @var{end-addr}
31660 is an address anywhere within (or the name of) the function to
31661 disassemble. If an address is specified, the whole function
31662 surrounding that address will be disassembled. If a name is
31663 specified, the whole function with that name will be disassembled.
31664 @item @var{filename}
31665 is the name of the file to disassemble
31666 @item @var{linenum}
31667 is the line number to disassemble around
31669 is the number of disassembly lines to be produced. If it is -1,
31670 the whole function will be disassembled, in case no @var{end-addr} is
31671 specified. If @var{end-addr} is specified as a non-zero value, and
31672 @var{lines} is lower than the number of disassembly lines between
31673 @var{start-addr} and @var{end-addr}, only @var{lines} lines are
31674 displayed; if @var{lines} is higher than the number of lines between
31675 @var{start-addr} and @var{end-addr}, only the lines up to @var{end-addr}
31680 @item 0 disassembly only
31681 @item 1 mixed source and disassembly (deprecated)
31682 @item 2 disassembly with raw opcodes
31683 @item 3 mixed source and disassembly with raw opcodes (deprecated)
31684 @item 4 mixed source and disassembly
31685 @item 5 mixed source and disassembly with raw opcodes
31688 Modes 1 and 3 are deprecated. The output is ``source centric''
31689 which hasn't proved useful in practice.
31690 @xref{Machine Code}, for a discussion of the difference between
31691 @code{/m} and @code{/s} output of the @code{disassemble} command.
31694 @subsubheading Result
31696 The result of the @code{-data-disassemble} command will be a list named
31697 @samp{asm_insns}, the contents of this list depend on the @var{mode}
31698 used with the @code{-data-disassemble} command.
31700 For modes 0 and 2 the @samp{asm_insns} list contains tuples with the
31705 The address at which this instruction was disassembled.
31708 The name of the function this instruction is within.
31711 The decimal offset in bytes from the start of @samp{func-name}.
31714 The text disassembly for this @samp{address}.
31717 This field is only present for modes 2, 3 and 5. This contains the raw opcode
31718 bytes for the @samp{inst} field.
31722 For modes 1, 3, 4 and 5 the @samp{asm_insns} list contains tuples named
31723 @samp{src_and_asm_line}, each of which has the following fields:
31727 The line number within @samp{file}.
31730 The file name from the compilation unit. This might be an absolute
31731 file name or a relative file name depending on the compile command
31735 Absolute file name of @samp{file}. It is converted to a canonical form
31736 using the source file search path
31737 (@pxref{Source Path, ,Specifying Source Directories})
31738 and after resolving all the symbolic links.
31740 If the source file is not found this field will contain the path as
31741 present in the debug information.
31743 @item line_asm_insn
31744 This is a list of tuples containing the disassembly for @samp{line} in
31745 @samp{file}. The fields of each tuple are the same as for
31746 @code{-data-disassemble} in @var{mode} 0 and 2, so @samp{address},
31747 @samp{func-name}, @samp{offset}, @samp{inst}, and optionally
31752 Note that whatever included in the @samp{inst} field, is not
31753 manipulated directly by @sc{gdb/mi}, i.e., it is not possible to
31756 @subsubheading @value{GDBN} Command
31758 The corresponding @value{GDBN} command is @samp{disassemble}.
31760 @subsubheading Example
31762 Disassemble from the current value of @code{$pc} to @code{$pc + 20}:
31766 -data-disassemble -s $pc -e "$pc + 20" -- 0
31769 @{address="0x000107c0",func-name="main",offset="4",
31770 inst="mov 2, %o0"@},
31771 @{address="0x000107c4",func-name="main",offset="8",
31772 inst="sethi %hi(0x11800), %o2"@},
31773 @{address="0x000107c8",func-name="main",offset="12",
31774 inst="or %o2, 0x140, %o1\t! 0x11940 <_lib_version+8>"@},
31775 @{address="0x000107cc",func-name="main",offset="16",
31776 inst="sethi %hi(0x11800), %o2"@},
31777 @{address="0x000107d0",func-name="main",offset="20",
31778 inst="or %o2, 0x168, %o4\t! 0x11968 <_lib_version+48>"@}]
31782 Disassemble the whole @code{main} function. Line 32 is part of
31786 -data-disassemble -f basics.c -l 32 -- 0
31788 @{address="0x000107bc",func-name="main",offset="0",
31789 inst="save %sp, -112, %sp"@},
31790 @{address="0x000107c0",func-name="main",offset="4",
31791 inst="mov 2, %o0"@},
31792 @{address="0x000107c4",func-name="main",offset="8",
31793 inst="sethi %hi(0x11800), %o2"@},
31795 @{address="0x0001081c",func-name="main",offset="96",inst="ret "@},
31796 @{address="0x00010820",func-name="main",offset="100",inst="restore "@}]
31800 Disassemble 3 instructions from the start of @code{main}:
31804 -data-disassemble -f basics.c -l 32 -n 3 -- 0
31806 @{address="0x000107bc",func-name="main",offset="0",
31807 inst="save %sp, -112, %sp"@},
31808 @{address="0x000107c0",func-name="main",offset="4",
31809 inst="mov 2, %o0"@},
31810 @{address="0x000107c4",func-name="main",offset="8",
31811 inst="sethi %hi(0x11800), %o2"@}]
31815 Disassemble 3 instructions from the start of @code{main} in mixed mode:
31819 -data-disassemble -f basics.c -l 32 -n 3 -- 1
31821 src_and_asm_line=@{line="31",
31822 file="../../../src/gdb/testsuite/gdb.mi/basics.c",
31823 fullname="/absolute/path/to/src/gdb/testsuite/gdb.mi/basics.c",
31824 line_asm_insn=[@{address="0x000107bc",
31825 func-name="main",offset="0",inst="save %sp, -112, %sp"@}]@},
31826 src_and_asm_line=@{line="32",
31827 file="../../../src/gdb/testsuite/gdb.mi/basics.c",
31828 fullname="/absolute/path/to/src/gdb/testsuite/gdb.mi/basics.c",
31829 line_asm_insn=[@{address="0x000107c0",
31830 func-name="main",offset="4",inst="mov 2, %o0"@},
31831 @{address="0x000107c4",func-name="main",offset="8",
31832 inst="sethi %hi(0x11800), %o2"@}]@}]
31837 @subheading The @code{-data-evaluate-expression} Command
31838 @findex -data-evaluate-expression
31840 @subsubheading Synopsis
31843 -data-evaluate-expression @var{expr}
31846 Evaluate @var{expr} as an expression. The expression could contain an
31847 inferior function call. The function call will execute synchronously.
31848 If the expression contains spaces, it must be enclosed in double quotes.
31850 @subsubheading @value{GDBN} Command
31852 The corresponding @value{GDBN} commands are @samp{print}, @samp{output}, and
31853 @samp{call}. In @code{gdbtk} only, there's a corresponding
31854 @samp{gdb_eval} command.
31856 @subsubheading Example
31858 In the following example, the numbers that precede the commands are the
31859 @dfn{tokens} described in @ref{GDB/MI Command Syntax, ,@sc{gdb/mi}
31860 Command Syntax}. Notice how @sc{gdb/mi} returns the same tokens in its
31864 211-data-evaluate-expression A
31867 311-data-evaluate-expression &A
31868 311^done,value="0xefffeb7c"
31870 411-data-evaluate-expression A+3
31873 511-data-evaluate-expression "A + 3"
31879 @subheading The @code{-data-list-changed-registers} Command
31880 @findex -data-list-changed-registers
31882 @subsubheading Synopsis
31885 -data-list-changed-registers
31888 Display a list of the registers that have changed.
31890 @subsubheading @value{GDBN} Command
31892 @value{GDBN} doesn't have a direct analog for this command; @code{gdbtk}
31893 has the corresponding command @samp{gdb_changed_register_list}.
31895 @subsubheading Example
31897 On a PPC MBX board:
31905 *stopped,reason="breakpoint-hit",disp="keep",bkptno="1",frame=@{
31906 func="main",args=[],file="try.c",fullname="/home/foo/bar/try.c",
31907 line="5",arch="powerpc"@}
31909 -data-list-changed-registers
31910 ^done,changed-registers=["0","1","2","4","5","6","7","8","9",
31911 "10","11","13","14","15","16","17","18","19","20","21","22","23",
31912 "24","25","26","27","28","30","31","64","65","66","67","69"]
31917 @subheading The @code{-data-list-register-names} Command
31918 @findex -data-list-register-names
31920 @subsubheading Synopsis
31923 -data-list-register-names [ ( @var{regno} )+ ]
31926 Show a list of register names for the current target. If no arguments
31927 are given, it shows a list of the names of all the registers. If
31928 integer numbers are given as arguments, it will print a list of the
31929 names of the registers corresponding to the arguments. To ensure
31930 consistency between a register name and its number, the output list may
31931 include empty register names.
31933 @subsubheading @value{GDBN} Command
31935 @value{GDBN} does not have a command which corresponds to
31936 @samp{-data-list-register-names}. In @code{gdbtk} there is a
31937 corresponding command @samp{gdb_regnames}.
31939 @subsubheading Example
31941 For the PPC MBX board:
31944 -data-list-register-names
31945 ^done,register-names=["r0","r1","r2","r3","r4","r5","r6","r7",
31946 "r8","r9","r10","r11","r12","r13","r14","r15","r16","r17","r18",
31947 "r19","r20","r21","r22","r23","r24","r25","r26","r27","r28","r29",
31948 "r30","r31","f0","f1","f2","f3","f4","f5","f6","f7","f8","f9",
31949 "f10","f11","f12","f13","f14","f15","f16","f17","f18","f19","f20",
31950 "f21","f22","f23","f24","f25","f26","f27","f28","f29","f30","f31",
31951 "", "pc","ps","cr","lr","ctr","xer"]
31953 -data-list-register-names 1 2 3
31954 ^done,register-names=["r1","r2","r3"]
31958 @subheading The @code{-data-list-register-values} Command
31959 @findex -data-list-register-values
31961 @subsubheading Synopsis
31964 -data-list-register-values
31965 [ @code{--skip-unavailable} ] @var{fmt} [ ( @var{regno} )*]
31968 Display the registers' contents. The format according to which the
31969 registers' contents are to be returned is given by @var{fmt}, followed
31970 by an optional list of numbers specifying the registers to display. A
31971 missing list of numbers indicates that the contents of all the
31972 registers must be returned. The @code{--skip-unavailable} option
31973 indicates that only the available registers are to be returned.
31975 Allowed formats for @var{fmt} are:
31992 @subsubheading @value{GDBN} Command
31994 The corresponding @value{GDBN} commands are @samp{info reg}, @samp{info
31995 all-reg}, and (in @code{gdbtk}) @samp{gdb_fetch_registers}.
31997 @subsubheading Example
31999 For a PPC MBX board (note: line breaks are for readability only, they
32000 don't appear in the actual output):
32004 -data-list-register-values r 64 65
32005 ^done,register-values=[@{number="64",value="0xfe00a300"@},
32006 @{number="65",value="0x00029002"@}]
32008 -data-list-register-values x
32009 ^done,register-values=[@{number="0",value="0xfe0043c8"@},
32010 @{number="1",value="0x3fff88"@},@{number="2",value="0xfffffffe"@},
32011 @{number="3",value="0x0"@},@{number="4",value="0xa"@},
32012 @{number="5",value="0x3fff68"@},@{number="6",value="0x3fff58"@},
32013 @{number="7",value="0xfe011e98"@},@{number="8",value="0x2"@},
32014 @{number="9",value="0xfa202820"@},@{number="10",value="0xfa202808"@},
32015 @{number="11",value="0x1"@},@{number="12",value="0x0"@},
32016 @{number="13",value="0x4544"@},@{number="14",value="0xffdfffff"@},
32017 @{number="15",value="0xffffffff"@},@{number="16",value="0xfffffeff"@},
32018 @{number="17",value="0xefffffed"@},@{number="18",value="0xfffffffe"@},
32019 @{number="19",value="0xffffffff"@},@{number="20",value="0xffffffff"@},
32020 @{number="21",value="0xffffffff"@},@{number="22",value="0xfffffff7"@},
32021 @{number="23",value="0xffffffff"@},@{number="24",value="0xffffffff"@},
32022 @{number="25",value="0xffffffff"@},@{number="26",value="0xfffffffb"@},
32023 @{number="27",value="0xffffffff"@},@{number="28",value="0xf7bfffff"@},
32024 @{number="29",value="0x0"@},@{number="30",value="0xfe010000"@},
32025 @{number="31",value="0x0"@},@{number="32",value="0x0"@},
32026 @{number="33",value="0x0"@},@{number="34",value="0x0"@},
32027 @{number="35",value="0x0"@},@{number="36",value="0x0"@},
32028 @{number="37",value="0x0"@},@{number="38",value="0x0"@},
32029 @{number="39",value="0x0"@},@{number="40",value="0x0"@},
32030 @{number="41",value="0x0"@},@{number="42",value="0x0"@},
32031 @{number="43",value="0x0"@},@{number="44",value="0x0"@},
32032 @{number="45",value="0x0"@},@{number="46",value="0x0"@},
32033 @{number="47",value="0x0"@},@{number="48",value="0x0"@},
32034 @{number="49",value="0x0"@},@{number="50",value="0x0"@},
32035 @{number="51",value="0x0"@},@{number="52",value="0x0"@},
32036 @{number="53",value="0x0"@},@{number="54",value="0x0"@},
32037 @{number="55",value="0x0"@},@{number="56",value="0x0"@},
32038 @{number="57",value="0x0"@},@{number="58",value="0x0"@},
32039 @{number="59",value="0x0"@},@{number="60",value="0x0"@},
32040 @{number="61",value="0x0"@},@{number="62",value="0x0"@},
32041 @{number="63",value="0x0"@},@{number="64",value="0xfe00a300"@},
32042 @{number="65",value="0x29002"@},@{number="66",value="0x202f04b5"@},
32043 @{number="67",value="0xfe0043b0"@},@{number="68",value="0xfe00b3e4"@},
32044 @{number="69",value="0x20002b03"@}]
32049 @subheading The @code{-data-read-memory} Command
32050 @findex -data-read-memory
32052 This command is deprecated, use @code{-data-read-memory-bytes} instead.
32054 @subsubheading Synopsis
32057 -data-read-memory [ -o @var{byte-offset} ]
32058 @var{address} @var{word-format} @var{word-size}
32059 @var{nr-rows} @var{nr-cols} [ @var{aschar} ]
32066 @item @var{address}
32067 An expression specifying the address of the first memory word to be
32068 read. Complex expressions containing embedded white space should be
32069 quoted using the C convention.
32071 @item @var{word-format}
32072 The format to be used to print the memory words. The notation is the
32073 same as for @value{GDBN}'s @code{print} command (@pxref{Output Formats,
32076 @item @var{word-size}
32077 The size of each memory word in bytes.
32079 @item @var{nr-rows}
32080 The number of rows in the output table.
32082 @item @var{nr-cols}
32083 The number of columns in the output table.
32086 If present, indicates that each row should include an @sc{ascii} dump. The
32087 value of @var{aschar} is used as a padding character when a byte is not a
32088 member of the printable @sc{ascii} character set (printable @sc{ascii}
32089 characters are those whose code is between 32 and 126, inclusively).
32091 @item @var{byte-offset}
32092 An offset to add to the @var{address} before fetching memory.
32095 This command displays memory contents as a table of @var{nr-rows} by
32096 @var{nr-cols} words, each word being @var{word-size} bytes. In total,
32097 @code{@var{nr-rows} * @var{nr-cols} * @var{word-size}} bytes are read
32098 (returned as @samp{total-bytes}). Should less than the requested number
32099 of bytes be returned by the target, the missing words are identified
32100 using @samp{N/A}. The number of bytes read from the target is returned
32101 in @samp{nr-bytes} and the starting address used to read memory in
32104 The address of the next/previous row or page is available in
32105 @samp{next-row} and @samp{prev-row}, @samp{next-page} and
32108 @subsubheading @value{GDBN} Command
32110 The corresponding @value{GDBN} command is @samp{x}. @code{gdbtk} has
32111 @samp{gdb_get_mem} memory read command.
32113 @subsubheading Example
32115 Read six bytes of memory starting at @code{bytes+6} but then offset by
32116 @code{-6} bytes. Format as three rows of two columns. One byte per
32117 word. Display each word in hex.
32121 9-data-read-memory -o -6 -- bytes+6 x 1 3 2
32122 9^done,addr="0x00001390",nr-bytes="6",total-bytes="6",
32123 next-row="0x00001396",prev-row="0x0000138e",next-page="0x00001396",
32124 prev-page="0x0000138a",memory=[
32125 @{addr="0x00001390",data=["0x00","0x01"]@},
32126 @{addr="0x00001392",data=["0x02","0x03"]@},
32127 @{addr="0x00001394",data=["0x04","0x05"]@}]
32131 Read two bytes of memory starting at address @code{shorts + 64} and
32132 display as a single word formatted in decimal.
32136 5-data-read-memory shorts+64 d 2 1 1
32137 5^done,addr="0x00001510",nr-bytes="2",total-bytes="2",
32138 next-row="0x00001512",prev-row="0x0000150e",
32139 next-page="0x00001512",prev-page="0x0000150e",memory=[
32140 @{addr="0x00001510",data=["128"]@}]
32144 Read thirty two bytes of memory starting at @code{bytes+16} and format
32145 as eight rows of four columns. Include a string encoding with @samp{x}
32146 used as the non-printable character.
32150 4-data-read-memory bytes+16 x 1 8 4 x
32151 4^done,addr="0x000013a0",nr-bytes="32",total-bytes="32",
32152 next-row="0x000013c0",prev-row="0x0000139c",
32153 next-page="0x000013c0",prev-page="0x00001380",memory=[
32154 @{addr="0x000013a0",data=["0x10","0x11","0x12","0x13"],ascii="xxxx"@},
32155 @{addr="0x000013a4",data=["0x14","0x15","0x16","0x17"],ascii="xxxx"@},
32156 @{addr="0x000013a8",data=["0x18","0x19","0x1a","0x1b"],ascii="xxxx"@},
32157 @{addr="0x000013ac",data=["0x1c","0x1d","0x1e","0x1f"],ascii="xxxx"@},
32158 @{addr="0x000013b0",data=["0x20","0x21","0x22","0x23"],ascii=" !\"#"@},
32159 @{addr="0x000013b4",data=["0x24","0x25","0x26","0x27"],ascii="$%&'"@},
32160 @{addr="0x000013b8",data=["0x28","0x29","0x2a","0x2b"],ascii="()*+"@},
32161 @{addr="0x000013bc",data=["0x2c","0x2d","0x2e","0x2f"],ascii=",-./"@}]
32165 @subheading The @code{-data-read-memory-bytes} Command
32166 @findex -data-read-memory-bytes
32168 @subsubheading Synopsis
32171 -data-read-memory-bytes [ -o @var{offset} ]
32172 @var{address} @var{count}
32179 @item @var{address}
32180 An expression specifying the address of the first addressable memory unit
32181 to be read. Complex expressions containing embedded white space should be
32182 quoted using the C convention.
32185 The number of addressable memory units to read. This should be an integer
32189 The offset relative to @var{address} at which to start reading. This
32190 should be an integer literal. This option is provided so that a frontend
32191 is not required to first evaluate address and then perform address
32192 arithmetics itself.
32196 This command attempts to read all accessible memory regions in the
32197 specified range. First, all regions marked as unreadable in the memory
32198 map (if one is defined) will be skipped. @xref{Memory Region
32199 Attributes}. Second, @value{GDBN} will attempt to read the remaining
32200 regions. For each one, if reading full region results in an errors,
32201 @value{GDBN} will try to read a subset of the region.
32203 In general, every single memory unit in the region may be readable or not,
32204 and the only way to read every readable unit is to try a read at
32205 every address, which is not practical. Therefore, @value{GDBN} will
32206 attempt to read all accessible memory units at either beginning or the end
32207 of the region, using a binary division scheme. This heuristic works
32208 well for reading accross a memory map boundary. Note that if a region
32209 has a readable range that is neither at the beginning or the end,
32210 @value{GDBN} will not read it.
32212 The result record (@pxref{GDB/MI Result Records}) that is output of
32213 the command includes a field named @samp{memory} whose content is a
32214 list of tuples. Each tuple represent a successfully read memory block
32215 and has the following fields:
32219 The start address of the memory block, as hexadecimal literal.
32222 The end address of the memory block, as hexadecimal literal.
32225 The offset of the memory block, as hexadecimal literal, relative to
32226 the start address passed to @code{-data-read-memory-bytes}.
32229 The contents of the memory block, in hex.
32235 @subsubheading @value{GDBN} Command
32237 The corresponding @value{GDBN} command is @samp{x}.
32239 @subsubheading Example
32243 -data-read-memory-bytes &a 10
32244 ^done,memory=[@{begin="0xbffff154",offset="0x00000000",
32246 contents="01000000020000000300"@}]
32251 @subheading The @code{-data-write-memory-bytes} Command
32252 @findex -data-write-memory-bytes
32254 @subsubheading Synopsis
32257 -data-write-memory-bytes @var{address} @var{contents}
32258 -data-write-memory-bytes @var{address} @var{contents} @r{[}@var{count}@r{]}
32265 @item @var{address}
32266 An expression specifying the address of the first addressable memory unit
32267 to be written. Complex expressions containing embedded white space should
32268 be quoted using the C convention.
32270 @item @var{contents}
32271 The hex-encoded data to write. It is an error if @var{contents} does
32272 not represent an integral number of addressable memory units.
32275 Optional argument indicating the number of addressable memory units to be
32276 written. If @var{count} is greater than @var{contents}' length,
32277 @value{GDBN} will repeatedly write @var{contents} until it fills
32278 @var{count} memory units.
32282 @subsubheading @value{GDBN} Command
32284 There's no corresponding @value{GDBN} command.
32286 @subsubheading Example
32290 -data-write-memory-bytes &a "aabbccdd"
32297 -data-write-memory-bytes &a "aabbccdd" 16e
32302 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
32303 @node GDB/MI Tracepoint Commands
32304 @section @sc{gdb/mi} Tracepoint Commands
32306 The commands defined in this section implement MI support for
32307 tracepoints. For detailed introduction, see @ref{Tracepoints}.
32309 @subheading The @code{-trace-find} Command
32310 @findex -trace-find
32312 @subsubheading Synopsis
32315 -trace-find @var{mode} [@var{parameters}@dots{}]
32318 Find a trace frame using criteria defined by @var{mode} and
32319 @var{parameters}. The following table lists permissible
32320 modes and their parameters. For details of operation, see @ref{tfind}.
32325 No parameters are required. Stops examining trace frames.
32328 An integer is required as parameter. Selects tracepoint frame with
32331 @item tracepoint-number
32332 An integer is required as parameter. Finds next
32333 trace frame that corresponds to tracepoint with the specified number.
32336 An address is required as parameter. Finds
32337 next trace frame that corresponds to any tracepoint at the specified
32340 @item pc-inside-range
32341 Two addresses are required as parameters. Finds next trace
32342 frame that corresponds to a tracepoint at an address inside the
32343 specified range. Both bounds are considered to be inside the range.
32345 @item pc-outside-range
32346 Two addresses are required as parameters. Finds
32347 next trace frame that corresponds to a tracepoint at an address outside
32348 the specified range. Both bounds are considered to be inside the range.
32351 Line specification is required as parameter. @xref{Specify Location}.
32352 Finds next trace frame that corresponds to a tracepoint at
32353 the specified location.
32357 If @samp{none} was passed as @var{mode}, the response does not
32358 have fields. Otherwise, the response may have the following fields:
32362 This field has either @samp{0} or @samp{1} as the value, depending
32363 on whether a matching tracepoint was found.
32366 The index of the found traceframe. This field is present iff
32367 the @samp{found} field has value of @samp{1}.
32370 The index of the found tracepoint. This field is present iff
32371 the @samp{found} field has value of @samp{1}.
32374 The information about the frame corresponding to the found trace
32375 frame. This field is present only if a trace frame was found.
32376 @xref{GDB/MI Frame Information}, for description of this field.
32380 @subsubheading @value{GDBN} Command
32382 The corresponding @value{GDBN} command is @samp{tfind}.
32384 @subheading -trace-define-variable
32385 @findex -trace-define-variable
32387 @subsubheading Synopsis
32390 -trace-define-variable @var{name} [ @var{value} ]
32393 Create trace variable @var{name} if it does not exist. If
32394 @var{value} is specified, sets the initial value of the specified
32395 trace variable to that value. Note that the @var{name} should start
32396 with the @samp{$} character.
32398 @subsubheading @value{GDBN} Command
32400 The corresponding @value{GDBN} command is @samp{tvariable}.
32402 @subheading The @code{-trace-frame-collected} Command
32403 @findex -trace-frame-collected
32405 @subsubheading Synopsis
32408 -trace-frame-collected
32409 [--var-print-values @var{var_pval}]
32410 [--comp-print-values @var{comp_pval}]
32411 [--registers-format @var{regformat}]
32412 [--memory-contents]
32415 This command returns the set of collected objects, register names,
32416 trace state variable names, memory ranges and computed expressions
32417 that have been collected at a particular trace frame. The optional
32418 parameters to the command affect the output format in different ways.
32419 See the output description table below for more details.
32421 The reported names can be used in the normal manner to create
32422 varobjs and inspect the objects themselves. The items returned by
32423 this command are categorized so that it is clear which is a variable,
32424 which is a register, which is a trace state variable, which is a
32425 memory range and which is a computed expression.
32427 For instance, if the actions were
32429 collect myVar, myArray[myIndex], myObj.field, myPtr->field, myCount + 2
32430 collect *(int*)0xaf02bef0@@40
32434 the object collected in its entirety would be @code{myVar}. The
32435 object @code{myArray} would be partially collected, because only the
32436 element at index @code{myIndex} would be collected. The remaining
32437 objects would be computed expressions.
32439 An example output would be:
32443 -trace-frame-collected
32445 explicit-variables=[@{name="myVar",value="1"@}],
32446 computed-expressions=[@{name="myArray[myIndex]",value="0"@},
32447 @{name="myObj.field",value="0"@},
32448 @{name="myPtr->field",value="1"@},
32449 @{name="myCount + 2",value="3"@},
32450 @{name="$tvar1 + 1",value="43970027"@}],
32451 registers=[@{number="0",value="0x7fe2c6e79ec8"@},
32452 @{number="1",value="0x0"@},
32453 @{number="2",value="0x4"@},
32455 @{number="125",value="0x0"@}],
32456 tvars=[@{name="$tvar1",current="43970026"@}],
32457 memory=[@{address="0x0000000000602264",length="4"@},
32458 @{address="0x0000000000615bc0",length="4"@}]
32465 @item explicit-variables
32466 The set of objects that have been collected in their entirety (as
32467 opposed to collecting just a few elements of an array or a few struct
32468 members). For each object, its name and value are printed.
32469 The @code{--var-print-values} option affects how or whether the value
32470 field is output. If @var{var_pval} is 0, then print only the names;
32471 if it is 1, print also their values; and if it is 2, print the name,
32472 type and value for simple data types, and the name and type for
32473 arrays, structures and unions.
32475 @item computed-expressions
32476 The set of computed expressions that have been collected at the
32477 current trace frame. The @code{--comp-print-values} option affects
32478 this set like the @code{--var-print-values} option affects the
32479 @code{explicit-variables} set. See above.
32482 The registers that have been collected at the current trace frame.
32483 For each register collected, the name and current value are returned.
32484 The value is formatted according to the @code{--registers-format}
32485 option. See the @command{-data-list-register-values} command for a
32486 list of the allowed formats. The default is @samp{x}.
32489 The trace state variables that have been collected at the current
32490 trace frame. For each trace state variable collected, the name and
32491 current value are returned.
32494 The set of memory ranges that have been collected at the current trace
32495 frame. Its content is a list of tuples. Each tuple represents a
32496 collected memory range and has the following fields:
32500 The start address of the memory range, as hexadecimal literal.
32503 The length of the memory range, as decimal literal.
32506 The contents of the memory block, in hex. This field is only present
32507 if the @code{--memory-contents} option is specified.
32513 @subsubheading @value{GDBN} Command
32515 There is no corresponding @value{GDBN} command.
32517 @subsubheading Example
32519 @subheading -trace-list-variables
32520 @findex -trace-list-variables
32522 @subsubheading Synopsis
32525 -trace-list-variables
32528 Return a table of all defined trace variables. Each element of the
32529 table has the following fields:
32533 The name of the trace variable. This field is always present.
32536 The initial value. This is a 64-bit signed integer. This
32537 field is always present.
32540 The value the trace variable has at the moment. This is a 64-bit
32541 signed integer. This field is absent iff current value is
32542 not defined, for example if the trace was never run, or is
32547 @subsubheading @value{GDBN} Command
32549 The corresponding @value{GDBN} command is @samp{tvariables}.
32551 @subsubheading Example
32555 -trace-list-variables
32556 ^done,trace-variables=@{nr_rows="1",nr_cols="3",
32557 hdr=[@{width="15",alignment="-1",col_name="name",colhdr="Name"@},
32558 @{width="11",alignment="-1",col_name="initial",colhdr="Initial"@},
32559 @{width="11",alignment="-1",col_name="current",colhdr="Current"@}],
32560 body=[variable=@{name="$trace_timestamp",initial="0"@}
32561 variable=@{name="$foo",initial="10",current="15"@}]@}
32565 @subheading -trace-save
32566 @findex -trace-save
32568 @subsubheading Synopsis
32571 -trace-save [ -r ] [ -ctf ] @var{filename}
32574 Saves the collected trace data to @var{filename}. Without the
32575 @samp{-r} option, the data is downloaded from the target and saved
32576 in a local file. With the @samp{-r} option the target is asked
32577 to perform the save.
32579 By default, this command will save the trace in the tfile format. You can
32580 supply the optional @samp{-ctf} argument to save it the CTF format. See
32581 @ref{Trace Files} for more information about CTF.
32583 @subsubheading @value{GDBN} Command
32585 The corresponding @value{GDBN} command is @samp{tsave}.
32588 @subheading -trace-start
32589 @findex -trace-start
32591 @subsubheading Synopsis
32597 Starts a tracing experiment. The result of this command does not
32600 @subsubheading @value{GDBN} Command
32602 The corresponding @value{GDBN} command is @samp{tstart}.
32604 @subheading -trace-status
32605 @findex -trace-status
32607 @subsubheading Synopsis
32613 Obtains the status of a tracing experiment. The result may include
32614 the following fields:
32619 May have a value of either @samp{0}, when no tracing operations are
32620 supported, @samp{1}, when all tracing operations are supported, or
32621 @samp{file} when examining trace file. In the latter case, examining
32622 of trace frame is possible but new tracing experiement cannot be
32623 started. This field is always present.
32626 May have a value of either @samp{0} or @samp{1} depending on whether
32627 tracing experiement is in progress on target. This field is present
32628 if @samp{supported} field is not @samp{0}.
32631 Report the reason why the tracing was stopped last time. This field
32632 may be absent iff tracing was never stopped on target yet. The
32633 value of @samp{request} means the tracing was stopped as result of
32634 the @code{-trace-stop} command. The value of @samp{overflow} means
32635 the tracing buffer is full. The value of @samp{disconnection} means
32636 tracing was automatically stopped when @value{GDBN} has disconnected.
32637 The value of @samp{passcount} means tracing was stopped when a
32638 tracepoint was passed a maximal number of times for that tracepoint.
32639 This field is present if @samp{supported} field is not @samp{0}.
32641 @item stopping-tracepoint
32642 The number of tracepoint whose passcount as exceeded. This field is
32643 present iff the @samp{stop-reason} field has the value of
32647 @itemx frames-created
32648 The @samp{frames} field is a count of the total number of trace frames
32649 in the trace buffer, while @samp{frames-created} is the total created
32650 during the run, including ones that were discarded, such as when a
32651 circular trace buffer filled up. Both fields are optional.
32655 These fields tell the current size of the tracing buffer and the
32656 remaining space. These fields are optional.
32659 The value of the circular trace buffer flag. @code{1} means that the
32660 trace buffer is circular and old trace frames will be discarded if
32661 necessary to make room, @code{0} means that the trace buffer is linear
32665 The value of the disconnected tracing flag. @code{1} means that
32666 tracing will continue after @value{GDBN} disconnects, @code{0} means
32667 that the trace run will stop.
32670 The filename of the trace file being examined. This field is
32671 optional, and only present when examining a trace file.
32675 @subsubheading @value{GDBN} Command
32677 The corresponding @value{GDBN} command is @samp{tstatus}.
32679 @subheading -trace-stop
32680 @findex -trace-stop
32682 @subsubheading Synopsis
32688 Stops a tracing experiment. The result of this command has the same
32689 fields as @code{-trace-status}, except that the @samp{supported} and
32690 @samp{running} fields are not output.
32692 @subsubheading @value{GDBN} Command
32694 The corresponding @value{GDBN} command is @samp{tstop}.
32697 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
32698 @node GDB/MI Symbol Query
32699 @section @sc{gdb/mi} Symbol Query Commands
32703 @subheading The @code{-symbol-info-address} Command
32704 @findex -symbol-info-address
32706 @subsubheading Synopsis
32709 -symbol-info-address @var{symbol}
32712 Describe where @var{symbol} is stored.
32714 @subsubheading @value{GDBN} Command
32716 The corresponding @value{GDBN} command is @samp{info address}.
32718 @subsubheading Example
32722 @subheading The @code{-symbol-info-file} Command
32723 @findex -symbol-info-file
32725 @subsubheading Synopsis
32731 Show the file for the symbol.
32733 @subsubheading @value{GDBN} Command
32735 There's no equivalent @value{GDBN} command. @code{gdbtk} has
32736 @samp{gdb_find_file}.
32738 @subsubheading Example
32742 @subheading The @code{-symbol-info-function} Command
32743 @findex -symbol-info-function
32745 @subsubheading Synopsis
32748 -symbol-info-function
32751 Show which function the symbol lives in.
32753 @subsubheading @value{GDBN} Command
32755 @samp{gdb_get_function} in @code{gdbtk}.
32757 @subsubheading Example
32761 @subheading The @code{-symbol-info-line} Command
32762 @findex -symbol-info-line
32764 @subsubheading Synopsis
32770 Show the core addresses of the code for a source line.
32772 @subsubheading @value{GDBN} Command
32774 The corresponding @value{GDBN} command is @samp{info line}.
32775 @code{gdbtk} has the @samp{gdb_get_line} and @samp{gdb_get_file} commands.
32777 @subsubheading Example
32781 @subheading The @code{-symbol-info-symbol} Command
32782 @findex -symbol-info-symbol
32784 @subsubheading Synopsis
32787 -symbol-info-symbol @var{addr}
32790 Describe what symbol is at location @var{addr}.
32792 @subsubheading @value{GDBN} Command
32794 The corresponding @value{GDBN} command is @samp{info symbol}.
32796 @subsubheading Example
32800 @subheading The @code{-symbol-list-functions} Command
32801 @findex -symbol-list-functions
32803 @subsubheading Synopsis
32806 -symbol-list-functions
32809 List the functions in the executable.
32811 @subsubheading @value{GDBN} Command
32813 @samp{info functions} in @value{GDBN}, @samp{gdb_listfunc} and
32814 @samp{gdb_search} in @code{gdbtk}.
32816 @subsubheading Example
32821 @subheading The @code{-symbol-list-lines} Command
32822 @findex -symbol-list-lines
32824 @subsubheading Synopsis
32827 -symbol-list-lines @var{filename}
32830 Print the list of lines that contain code and their associated program
32831 addresses for the given source filename. The entries are sorted in
32832 ascending PC order.
32834 @subsubheading @value{GDBN} Command
32836 There is no corresponding @value{GDBN} command.
32838 @subsubheading Example
32841 -symbol-list-lines basics.c
32842 ^done,lines=[@{pc="0x08048554",line="7"@},@{pc="0x0804855a",line="8"@}]
32848 @subheading The @code{-symbol-list-types} Command
32849 @findex -symbol-list-types
32851 @subsubheading Synopsis
32857 List all the type names.
32859 @subsubheading @value{GDBN} Command
32861 The corresponding commands are @samp{info types} in @value{GDBN},
32862 @samp{gdb_search} in @code{gdbtk}.
32864 @subsubheading Example
32868 @subheading The @code{-symbol-list-variables} Command
32869 @findex -symbol-list-variables
32871 @subsubheading Synopsis
32874 -symbol-list-variables
32877 List all the global and static variable names.
32879 @subsubheading @value{GDBN} Command
32881 @samp{info variables} in @value{GDBN}, @samp{gdb_search} in @code{gdbtk}.
32883 @subsubheading Example
32887 @subheading The @code{-symbol-locate} Command
32888 @findex -symbol-locate
32890 @subsubheading Synopsis
32896 @subsubheading @value{GDBN} Command
32898 @samp{gdb_loc} in @code{gdbtk}.
32900 @subsubheading Example
32904 @subheading The @code{-symbol-type} Command
32905 @findex -symbol-type
32907 @subsubheading Synopsis
32910 -symbol-type @var{variable}
32913 Show type of @var{variable}.
32915 @subsubheading @value{GDBN} Command
32917 The corresponding @value{GDBN} command is @samp{ptype}, @code{gdbtk} has
32918 @samp{gdb_obj_variable}.
32920 @subsubheading Example
32925 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
32926 @node GDB/MI File Commands
32927 @section @sc{gdb/mi} File Commands
32929 This section describes the GDB/MI commands to specify executable file names
32930 and to read in and obtain symbol table information.
32932 @subheading The @code{-file-exec-and-symbols} Command
32933 @findex -file-exec-and-symbols
32935 @subsubheading Synopsis
32938 -file-exec-and-symbols @var{file}
32941 Specify the executable file to be debugged. This file is the one from
32942 which the symbol table is also read. If no file is specified, the
32943 command clears the executable and symbol information. If breakpoints
32944 are set when using this command with no arguments, @value{GDBN} will produce
32945 error messages. Otherwise, no output is produced, except a completion
32948 @subsubheading @value{GDBN} Command
32950 The corresponding @value{GDBN} command is @samp{file}.
32952 @subsubheading Example
32956 -file-exec-and-symbols /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx
32962 @subheading The @code{-file-exec-file} Command
32963 @findex -file-exec-file
32965 @subsubheading Synopsis
32968 -file-exec-file @var{file}
32971 Specify the executable file to be debugged. Unlike
32972 @samp{-file-exec-and-symbols}, the symbol table is @emph{not} read
32973 from this file. If used without argument, @value{GDBN} clears the information
32974 about the executable file. No output is produced, except a completion
32977 @subsubheading @value{GDBN} Command
32979 The corresponding @value{GDBN} command is @samp{exec-file}.
32981 @subsubheading Example
32985 -file-exec-file /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx
32992 @subheading The @code{-file-list-exec-sections} Command
32993 @findex -file-list-exec-sections
32995 @subsubheading Synopsis
32998 -file-list-exec-sections
33001 List the sections of the current executable file.
33003 @subsubheading @value{GDBN} Command
33005 The @value{GDBN} command @samp{info file} shows, among the rest, the same
33006 information as this command. @code{gdbtk} has a corresponding command
33007 @samp{gdb_load_info}.
33009 @subsubheading Example
33014 @subheading The @code{-file-list-exec-source-file} Command
33015 @findex -file-list-exec-source-file
33017 @subsubheading Synopsis
33020 -file-list-exec-source-file
33023 List the line number, the current source file, and the absolute path
33024 to the current source file for the current executable. The macro
33025 information field has a value of @samp{1} or @samp{0} depending on
33026 whether or not the file includes preprocessor macro information.
33028 @subsubheading @value{GDBN} Command
33030 The @value{GDBN} equivalent is @samp{info source}
33032 @subsubheading Example
33036 123-file-list-exec-source-file
33037 123^done,line="1",file="foo.c",fullname="/home/bar/foo.c,macro-info="1"
33042 @subheading The @code{-file-list-exec-source-files} Command
33043 @findex -file-list-exec-source-files
33045 @subsubheading Synopsis
33048 -file-list-exec-source-files
33051 List the source files for the current executable.
33053 It will always output both the filename and fullname (absolute file
33054 name) of a source file.
33056 @subsubheading @value{GDBN} Command
33058 The @value{GDBN} equivalent is @samp{info sources}.
33059 @code{gdbtk} has an analogous command @samp{gdb_listfiles}.
33061 @subsubheading Example
33064 -file-list-exec-source-files
33066 @{file=foo.c,fullname=/home/foo.c@},
33067 @{file=/home/bar.c,fullname=/home/bar.c@},
33068 @{file=gdb_could_not_find_fullpath.c@}]
33072 @subheading The @code{-file-list-shared-libraries} Command
33073 @findex -file-list-shared-libraries
33075 @subsubheading Synopsis
33078 -file-list-shared-libraries [ @var{regexp} ]
33081 List the shared libraries in the program.
33082 With a regular expression @var{regexp}, only those libraries whose
33083 names match @var{regexp} are listed.
33085 @subsubheading @value{GDBN} Command
33087 The corresponding @value{GDBN} command is @samp{info shared}. The fields
33088 have a similar meaning to the @code{=library-loaded} notification.
33089 The @code{ranges} field specifies the multiple segments belonging to this
33090 library. Each range has the following fields:
33094 The address defining the inclusive lower bound of the segment.
33096 The address defining the exclusive upper bound of the segment.
33099 @subsubheading Example
33102 -file-list-exec-source-files
33103 ^done,shared-libraries=[
33104 @{id="/lib/libfoo.so",target-name="/lib/libfoo.so",host-name="/lib/libfoo.so",symbols-loaded="1",thread-group="i1",ranges=[@{from="0x72815989",to="0x728162c0"@}]@},
33105 @{id="/lib/libbar.so",target-name="/lib/libbar.so",host-name="/lib/libbar.so",symbols-loaded="1",thread-group="i1",ranges=[@{from="0x76ee48c0",to="0x76ee9160"@}]@}]
33111 @subheading The @code{-file-list-symbol-files} Command
33112 @findex -file-list-symbol-files
33114 @subsubheading Synopsis
33117 -file-list-symbol-files
33122 @subsubheading @value{GDBN} Command
33124 The corresponding @value{GDBN} command is @samp{info file} (part of it).
33126 @subsubheading Example
33131 @subheading The @code{-file-symbol-file} Command
33132 @findex -file-symbol-file
33134 @subsubheading Synopsis
33137 -file-symbol-file @var{file}
33140 Read symbol table info from the specified @var{file} argument. When
33141 used without arguments, clears @value{GDBN}'s symbol table info. No output is
33142 produced, except for a completion notification.
33144 @subsubheading @value{GDBN} Command
33146 The corresponding @value{GDBN} command is @samp{symbol-file}.
33148 @subsubheading Example
33152 -file-symbol-file /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx
33158 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
33159 @node GDB/MI Memory Overlay Commands
33160 @section @sc{gdb/mi} Memory Overlay Commands
33162 The memory overlay commands are not implemented.
33164 @c @subheading -overlay-auto
33166 @c @subheading -overlay-list-mapping-state
33168 @c @subheading -overlay-list-overlays
33170 @c @subheading -overlay-map
33172 @c @subheading -overlay-off
33174 @c @subheading -overlay-on
33176 @c @subheading -overlay-unmap
33178 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
33179 @node GDB/MI Signal Handling Commands
33180 @section @sc{gdb/mi} Signal Handling Commands
33182 Signal handling commands are not implemented.
33184 @c @subheading -signal-handle
33186 @c @subheading -signal-list-handle-actions
33188 @c @subheading -signal-list-signal-types
33192 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
33193 @node GDB/MI Target Manipulation
33194 @section @sc{gdb/mi} Target Manipulation Commands
33197 @subheading The @code{-target-attach} Command
33198 @findex -target-attach
33200 @subsubheading Synopsis
33203 -target-attach @var{pid} | @var{gid} | @var{file}
33206 Attach to a process @var{pid} or a file @var{file} outside of
33207 @value{GDBN}, or a thread group @var{gid}. If attaching to a thread
33208 group, the id previously returned by
33209 @samp{-list-thread-groups --available} must be used.
33211 @subsubheading @value{GDBN} Command
33213 The corresponding @value{GDBN} command is @samp{attach}.
33215 @subsubheading Example
33219 =thread-created,id="1"
33220 *stopped,thread-id="1",frame=@{addr="0xb7f7e410",func="bar",args=[]@}
33226 @subheading The @code{-target-compare-sections} Command
33227 @findex -target-compare-sections
33229 @subsubheading Synopsis
33232 -target-compare-sections [ @var{section} ]
33235 Compare data of section @var{section} on target to the exec file.
33236 Without the argument, all sections are compared.
33238 @subsubheading @value{GDBN} Command
33240 The @value{GDBN} equivalent is @samp{compare-sections}.
33242 @subsubheading Example
33247 @subheading The @code{-target-detach} Command
33248 @findex -target-detach
33250 @subsubheading Synopsis
33253 -target-detach [ @var{pid} | @var{gid} ]
33256 Detach from the remote target which normally resumes its execution.
33257 If either @var{pid} or @var{gid} is specified, detaches from either
33258 the specified process, or specified thread group. There's no output.
33260 @subsubheading @value{GDBN} Command
33262 The corresponding @value{GDBN} command is @samp{detach}.
33264 @subsubheading Example
33274 @subheading The @code{-target-disconnect} Command
33275 @findex -target-disconnect
33277 @subsubheading Synopsis
33283 Disconnect from the remote target. There's no output and the target is
33284 generally not resumed.
33286 @subsubheading @value{GDBN} Command
33288 The corresponding @value{GDBN} command is @samp{disconnect}.
33290 @subsubheading Example
33300 @subheading The @code{-target-download} Command
33301 @findex -target-download
33303 @subsubheading Synopsis
33309 Loads the executable onto the remote target.
33310 It prints out an update message every half second, which includes the fields:
33314 The name of the section.
33316 The size of what has been sent so far for that section.
33318 The size of the section.
33320 The total size of what was sent so far (the current and the previous sections).
33322 The size of the overall executable to download.
33326 Each message is sent as status record (@pxref{GDB/MI Output Syntax, ,
33327 @sc{gdb/mi} Output Syntax}).
33329 In addition, it prints the name and size of the sections, as they are
33330 downloaded. These messages include the following fields:
33334 The name of the section.
33336 The size of the section.
33338 The size of the overall executable to download.
33342 At the end, a summary is printed.
33344 @subsubheading @value{GDBN} Command
33346 The corresponding @value{GDBN} command is @samp{load}.
33348 @subsubheading Example
33350 Note: each status message appears on a single line. Here the messages
33351 have been broken down so that they can fit onto a page.
33356 +download,@{section=".text",section-size="6668",total-size="9880"@}
33357 +download,@{section=".text",section-sent="512",section-size="6668",
33358 total-sent="512",total-size="9880"@}
33359 +download,@{section=".text",section-sent="1024",section-size="6668",
33360 total-sent="1024",total-size="9880"@}
33361 +download,@{section=".text",section-sent="1536",section-size="6668",
33362 total-sent="1536",total-size="9880"@}
33363 +download,@{section=".text",section-sent="2048",section-size="6668",
33364 total-sent="2048",total-size="9880"@}
33365 +download,@{section=".text",section-sent="2560",section-size="6668",
33366 total-sent="2560",total-size="9880"@}
33367 +download,@{section=".text",section-sent="3072",section-size="6668",
33368 total-sent="3072",total-size="9880"@}
33369 +download,@{section=".text",section-sent="3584",section-size="6668",
33370 total-sent="3584",total-size="9880"@}
33371 +download,@{section=".text",section-sent="4096",section-size="6668",
33372 total-sent="4096",total-size="9880"@}
33373 +download,@{section=".text",section-sent="4608",section-size="6668",
33374 total-sent="4608",total-size="9880"@}
33375 +download,@{section=".text",section-sent="5120",section-size="6668",
33376 total-sent="5120",total-size="9880"@}
33377 +download,@{section=".text",section-sent="5632",section-size="6668",
33378 total-sent="5632",total-size="9880"@}
33379 +download,@{section=".text",section-sent="6144",section-size="6668",
33380 total-sent="6144",total-size="9880"@}
33381 +download,@{section=".text",section-sent="6656",section-size="6668",
33382 total-sent="6656",total-size="9880"@}
33383 +download,@{section=".init",section-size="28",total-size="9880"@}
33384 +download,@{section=".fini",section-size="28",total-size="9880"@}
33385 +download,@{section=".data",section-size="3156",total-size="9880"@}
33386 +download,@{section=".data",section-sent="512",section-size="3156",
33387 total-sent="7236",total-size="9880"@}
33388 +download,@{section=".data",section-sent="1024",section-size="3156",
33389 total-sent="7748",total-size="9880"@}
33390 +download,@{section=".data",section-sent="1536",section-size="3156",
33391 total-sent="8260",total-size="9880"@}
33392 +download,@{section=".data",section-sent="2048",section-size="3156",
33393 total-sent="8772",total-size="9880"@}
33394 +download,@{section=".data",section-sent="2560",section-size="3156",
33395 total-sent="9284",total-size="9880"@}
33396 +download,@{section=".data",section-sent="3072",section-size="3156",
33397 total-sent="9796",total-size="9880"@}
33398 ^done,address="0x10004",load-size="9880",transfer-rate="6586",
33405 @subheading The @code{-target-exec-status} Command
33406 @findex -target-exec-status
33408 @subsubheading Synopsis
33411 -target-exec-status
33414 Provide information on the state of the target (whether it is running or
33415 not, for instance).
33417 @subsubheading @value{GDBN} Command
33419 There's no equivalent @value{GDBN} command.
33421 @subsubheading Example
33425 @subheading The @code{-target-list-available-targets} Command
33426 @findex -target-list-available-targets
33428 @subsubheading Synopsis
33431 -target-list-available-targets
33434 List the possible targets to connect to.
33436 @subsubheading @value{GDBN} Command
33438 The corresponding @value{GDBN} command is @samp{help target}.
33440 @subsubheading Example
33444 @subheading The @code{-target-list-current-targets} Command
33445 @findex -target-list-current-targets
33447 @subsubheading Synopsis
33450 -target-list-current-targets
33453 Describe the current target.
33455 @subsubheading @value{GDBN} Command
33457 The corresponding information is printed by @samp{info file} (among
33460 @subsubheading Example
33464 @subheading The @code{-target-list-parameters} Command
33465 @findex -target-list-parameters
33467 @subsubheading Synopsis
33470 -target-list-parameters
33476 @subsubheading @value{GDBN} Command
33480 @subsubheading Example
33483 @subheading The @code{-target-flash-erase} Command
33484 @findex -target-flash-erase
33486 @subsubheading Synopsis
33489 -target-flash-erase
33492 Erases all known flash memory regions on the target.
33494 The corresponding @value{GDBN} command is @samp{flash-erase}.
33496 The output is a list of flash regions that have been erased, with starting
33497 addresses and memory region sizes.
33501 -target-flash-erase
33502 ^done,erased-regions=@{address="0x0",size="0x40000"@}
33506 @subheading The @code{-target-select} Command
33507 @findex -target-select
33509 @subsubheading Synopsis
33512 -target-select @var{type} @var{parameters @dots{}}
33515 Connect @value{GDBN} to the remote target. This command takes two args:
33519 The type of target, for instance @samp{remote}, etc.
33520 @item @var{parameters}
33521 Device names, host names and the like. @xref{Target Commands, ,
33522 Commands for Managing Targets}, for more details.
33525 The output is a connection notification, followed by the address at
33526 which the target program is, in the following form:
33529 ^connected,addr="@var{address}",func="@var{function name}",
33530 args=[@var{arg list}]
33533 @subsubheading @value{GDBN} Command
33535 The corresponding @value{GDBN} command is @samp{target}.
33537 @subsubheading Example
33541 -target-select remote /dev/ttya
33542 ^connected,addr="0xfe00a300",func="??",args=[]
33546 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
33547 @node GDB/MI File Transfer Commands
33548 @section @sc{gdb/mi} File Transfer Commands
33551 @subheading The @code{-target-file-put} Command
33552 @findex -target-file-put
33554 @subsubheading Synopsis
33557 -target-file-put @var{hostfile} @var{targetfile}
33560 Copy file @var{hostfile} from the host system (the machine running
33561 @value{GDBN}) to @var{targetfile} on the target system.
33563 @subsubheading @value{GDBN} Command
33565 The corresponding @value{GDBN} command is @samp{remote put}.
33567 @subsubheading Example
33571 -target-file-put localfile remotefile
33577 @subheading The @code{-target-file-get} Command
33578 @findex -target-file-get
33580 @subsubheading Synopsis
33583 -target-file-get @var{targetfile} @var{hostfile}
33586 Copy file @var{targetfile} from the target system to @var{hostfile}
33587 on the host system.
33589 @subsubheading @value{GDBN} Command
33591 The corresponding @value{GDBN} command is @samp{remote get}.
33593 @subsubheading Example
33597 -target-file-get remotefile localfile
33603 @subheading The @code{-target-file-delete} Command
33604 @findex -target-file-delete
33606 @subsubheading Synopsis
33609 -target-file-delete @var{targetfile}
33612 Delete @var{targetfile} from the target system.
33614 @subsubheading @value{GDBN} Command
33616 The corresponding @value{GDBN} command is @samp{remote delete}.
33618 @subsubheading Example
33622 -target-file-delete remotefile
33628 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
33629 @node GDB/MI Ada Exceptions Commands
33630 @section Ada Exceptions @sc{gdb/mi} Commands
33632 @subheading The @code{-info-ada-exceptions} Command
33633 @findex -info-ada-exceptions
33635 @subsubheading Synopsis
33638 -info-ada-exceptions [ @var{regexp}]
33641 List all Ada exceptions defined within the program being debugged.
33642 With a regular expression @var{regexp}, only those exceptions whose
33643 names match @var{regexp} are listed.
33645 @subsubheading @value{GDBN} Command
33647 The corresponding @value{GDBN} command is @samp{info exceptions}.
33649 @subsubheading Result
33651 The result is a table of Ada exceptions. The following columns are
33652 defined for each exception:
33656 The name of the exception.
33659 The address of the exception.
33663 @subsubheading Example
33666 -info-ada-exceptions aint
33667 ^done,ada-exceptions=@{nr_rows="2",nr_cols="2",
33668 hdr=[@{width="1",alignment="-1",col_name="name",colhdr="Name"@},
33669 @{width="1",alignment="-1",col_name="address",colhdr="Address"@}],
33670 body=[@{name="constraint_error",address="0x0000000000613da0"@},
33671 @{name="const.aint_global_e",address="0x0000000000613b00"@}]@}
33674 @subheading Catching Ada Exceptions
33676 The commands describing how to ask @value{GDBN} to stop when a program
33677 raises an exception are described at @ref{Ada Exception GDB/MI
33678 Catchpoint Commands}.
33681 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
33682 @node GDB/MI Support Commands
33683 @section @sc{gdb/mi} Support Commands
33685 Since new commands and features get regularly added to @sc{gdb/mi},
33686 some commands are available to help front-ends query the debugger
33687 about support for these capabilities. Similarly, it is also possible
33688 to query @value{GDBN} about target support of certain features.
33690 @subheading The @code{-info-gdb-mi-command} Command
33691 @cindex @code{-info-gdb-mi-command}
33692 @findex -info-gdb-mi-command
33694 @subsubheading Synopsis
33697 -info-gdb-mi-command @var{cmd_name}
33700 Query support for the @sc{gdb/mi} command named @var{cmd_name}.
33702 Note that the dash (@code{-}) starting all @sc{gdb/mi} commands
33703 is technically not part of the command name (@pxref{GDB/MI Input
33704 Syntax}), and thus should be omitted in @var{cmd_name}. However,
33705 for ease of use, this command also accepts the form with the leading
33708 @subsubheading @value{GDBN} Command
33710 There is no corresponding @value{GDBN} command.
33712 @subsubheading Result
33714 The result is a tuple. There is currently only one field:
33718 This field is equal to @code{"true"} if the @sc{gdb/mi} command exists,
33719 @code{"false"} otherwise.
33723 @subsubheading Example
33725 Here is an example where the @sc{gdb/mi} command does not exist:
33728 -info-gdb-mi-command unsupported-command
33729 ^done,command=@{exists="false"@}
33733 And here is an example where the @sc{gdb/mi} command is known
33737 -info-gdb-mi-command symbol-list-lines
33738 ^done,command=@{exists="true"@}
33741 @subheading The @code{-list-features} Command
33742 @findex -list-features
33743 @cindex supported @sc{gdb/mi} features, list
33745 Returns a list of particular features of the MI protocol that
33746 this version of gdb implements. A feature can be a command,
33747 or a new field in an output of some command, or even an
33748 important bugfix. While a frontend can sometimes detect presence
33749 of a feature at runtime, it is easier to perform detection at debugger
33752 The command returns a list of strings, with each string naming an
33753 available feature. Each returned string is just a name, it does not
33754 have any internal structure. The list of possible feature names
33760 (gdb) -list-features
33761 ^done,result=["feature1","feature2"]
33764 The current list of features is:
33767 @item frozen-varobjs
33768 Indicates support for the @code{-var-set-frozen} command, as well
33769 as possible presense of the @code{frozen} field in the output
33770 of @code{-varobj-create}.
33771 @item pending-breakpoints
33772 Indicates support for the @option{-f} option to the @code{-break-insert}
33775 Indicates Python scripting support, Python-based
33776 pretty-printing commands, and possible presence of the
33777 @samp{display_hint} field in the output of @code{-var-list-children}
33779 Indicates support for the @code{-thread-info} command.
33780 @item data-read-memory-bytes
33781 Indicates support for the @code{-data-read-memory-bytes} and the
33782 @code{-data-write-memory-bytes} commands.
33783 @item breakpoint-notifications
33784 Indicates that changes to breakpoints and breakpoints created via the
33785 CLI will be announced via async records.
33786 @item ada-task-info
33787 Indicates support for the @code{-ada-task-info} command.
33788 @item language-option
33789 Indicates that all @sc{gdb/mi} commands accept the @option{--language}
33790 option (@pxref{Context management}).
33791 @item info-gdb-mi-command
33792 Indicates support for the @code{-info-gdb-mi-command} command.
33793 @item undefined-command-error-code
33794 Indicates support for the "undefined-command" error code in error result
33795 records, produced when trying to execute an undefined @sc{gdb/mi} command
33796 (@pxref{GDB/MI Result Records}).
33797 @item exec-run-start-option
33798 Indicates that the @code{-exec-run} command supports the @option{--start}
33799 option (@pxref{GDB/MI Program Execution}).
33800 @item data-disassemble-a-option
33801 Indicates that the @code{-data-disassemble} command supports the @option{-a}
33802 option (@pxref{GDB/MI Data Manipulation}).
33805 @subheading The @code{-list-target-features} Command
33806 @findex -list-target-features
33808 Returns a list of particular features that are supported by the
33809 target. Those features affect the permitted MI commands, but
33810 unlike the features reported by the @code{-list-features} command, the
33811 features depend on which target GDB is using at the moment. Whenever
33812 a target can change, due to commands such as @code{-target-select},
33813 @code{-target-attach} or @code{-exec-run}, the list of target features
33814 may change, and the frontend should obtain it again.
33818 (gdb) -list-target-features
33819 ^done,result=["async"]
33822 The current list of features is:
33826 Indicates that the target is capable of asynchronous command
33827 execution, which means that @value{GDBN} will accept further commands
33828 while the target is running.
33831 Indicates that the target is capable of reverse execution.
33832 @xref{Reverse Execution}, for more information.
33836 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
33837 @node GDB/MI Miscellaneous Commands
33838 @section Miscellaneous @sc{gdb/mi} Commands
33840 @c @subheading -gdb-complete
33842 @subheading The @code{-gdb-exit} Command
33845 @subsubheading Synopsis
33851 Exit @value{GDBN} immediately.
33853 @subsubheading @value{GDBN} Command
33855 Approximately corresponds to @samp{quit}.
33857 @subsubheading Example
33867 @subheading The @code{-exec-abort} Command
33868 @findex -exec-abort
33870 @subsubheading Synopsis
33876 Kill the inferior running program.
33878 @subsubheading @value{GDBN} Command
33880 The corresponding @value{GDBN} command is @samp{kill}.
33882 @subsubheading Example
33887 @subheading The @code{-gdb-set} Command
33890 @subsubheading Synopsis
33896 Set an internal @value{GDBN} variable.
33897 @c IS THIS A DOLLAR VARIABLE? OR SOMETHING LIKE ANNOTATE ?????
33899 @subsubheading @value{GDBN} Command
33901 The corresponding @value{GDBN} command is @samp{set}.
33903 @subsubheading Example
33913 @subheading The @code{-gdb-show} Command
33916 @subsubheading Synopsis
33922 Show the current value of a @value{GDBN} variable.
33924 @subsubheading @value{GDBN} Command
33926 The corresponding @value{GDBN} command is @samp{show}.
33928 @subsubheading Example
33937 @c @subheading -gdb-source
33940 @subheading The @code{-gdb-version} Command
33941 @findex -gdb-version
33943 @subsubheading Synopsis
33949 Show version information for @value{GDBN}. Used mostly in testing.
33951 @subsubheading @value{GDBN} Command
33953 The @value{GDBN} equivalent is @samp{show version}. @value{GDBN} by
33954 default shows this information when you start an interactive session.
33956 @subsubheading Example
33958 @c This example modifies the actual output from GDB to avoid overfull
33964 ~Copyright 2000 Free Software Foundation, Inc.
33965 ~GDB is free software, covered by the GNU General Public License, and
33966 ~you are welcome to change it and/or distribute copies of it under
33967 ~ certain conditions.
33968 ~Type "show copying" to see the conditions.
33969 ~There is absolutely no warranty for GDB. Type "show warranty" for
33971 ~This GDB was configured as
33972 "--host=sparc-sun-solaris2.5.1 --target=ppc-eabi".
33977 @subheading The @code{-list-thread-groups} Command
33978 @findex -list-thread-groups
33980 @subheading Synopsis
33983 -list-thread-groups [ --available ] [ --recurse 1 ] [ @var{group} ... ]
33986 Lists thread groups (@pxref{Thread groups}). When a single thread
33987 group is passed as the argument, lists the children of that group.
33988 When several thread group are passed, lists information about those
33989 thread groups. Without any parameters, lists information about all
33990 top-level thread groups.
33992 Normally, thread groups that are being debugged are reported.
33993 With the @samp{--available} option, @value{GDBN} reports thread groups
33994 available on the target.
33996 The output of this command may have either a @samp{threads} result or
33997 a @samp{groups} result. The @samp{thread} result has a list of tuples
33998 as value, with each tuple describing a thread (@pxref{GDB/MI Thread
33999 Information}). The @samp{groups} result has a list of tuples as value,
34000 each tuple describing a thread group. If top-level groups are
34001 requested (that is, no parameter is passed), or when several groups
34002 are passed, the output always has a @samp{groups} result. The format
34003 of the @samp{group} result is described below.
34005 To reduce the number of roundtrips it's possible to list thread groups
34006 together with their children, by passing the @samp{--recurse} option
34007 and the recursion depth. Presently, only recursion depth of 1 is
34008 permitted. If this option is present, then every reported thread group
34009 will also include its children, either as @samp{group} or
34010 @samp{threads} field.
34012 In general, any combination of option and parameters is permitted, with
34013 the following caveats:
34017 When a single thread group is passed, the output will typically
34018 be the @samp{threads} result. Because threads may not contain
34019 anything, the @samp{recurse} option will be ignored.
34022 When the @samp{--available} option is passed, limited information may
34023 be available. In particular, the list of threads of a process might
34024 be inaccessible. Further, specifying specific thread groups might
34025 not give any performance advantage over listing all thread groups.
34026 The frontend should assume that @samp{-list-thread-groups --available}
34027 is always an expensive operation and cache the results.
34031 The @samp{groups} result is a list of tuples, where each tuple may
34032 have the following fields:
34036 Identifier of the thread group. This field is always present.
34037 The identifier is an opaque string; frontends should not try to
34038 convert it to an integer, even though it might look like one.
34041 The type of the thread group. At present, only @samp{process} is a
34045 The target-specific process identifier. This field is only present
34046 for thread groups of type @samp{process} and only if the process exists.
34049 The exit code of this group's last exited thread, formatted in octal.
34050 This field is only present for thread groups of type @samp{process} and
34051 only if the process is not running.
34054 The number of children this thread group has. This field may be
34055 absent for an available thread group.
34058 This field has a list of tuples as value, each tuple describing a
34059 thread. It may be present if the @samp{--recurse} option is
34060 specified, and it's actually possible to obtain the threads.
34063 This field is a list of integers, each identifying a core that one
34064 thread of the group is running on. This field may be absent if
34065 such information is not available.
34068 The name of the executable file that corresponds to this thread group.
34069 The field is only present for thread groups of type @samp{process},
34070 and only if there is a corresponding executable file.
34074 @subheading Example
34078 -list-thread-groups
34079 ^done,groups=[@{id="17",type="process",pid="yyy",num_children="2"@}]
34080 -list-thread-groups 17
34081 ^done,threads=[@{id="2",target-id="Thread 0xb7e14b90 (LWP 21257)",
34082 frame=@{level="0",addr="0xffffe410",func="__kernel_vsyscall",args=[]@},state="running"@},
34083 @{id="1",target-id="Thread 0xb7e156b0 (LWP 21254)",
34084 frame=@{level="0",addr="0x0804891f",func="foo",args=[@{name="i",value="10"@}],
34085 file="/tmp/a.c",fullname="/tmp/a.c",line="158",arch="i386:x86_64"@},state="running"@}]]
34086 -list-thread-groups --available
34087 ^done,groups=[@{id="17",type="process",pid="yyy",num_children="2",cores=[1,2]@}]
34088 -list-thread-groups --available --recurse 1
34089 ^done,groups=[@{id="17", types="process",pid="yyy",num_children="2",cores=[1,2],
34090 threads=[@{id="1",target-id="Thread 0xb7e14b90",cores=[1]@},
34091 @{id="2",target-id="Thread 0xb7e14b90",cores=[2]@}]@},..]
34092 -list-thread-groups --available --recurse 1 17 18
34093 ^done,groups=[@{id="17", types="process",pid="yyy",num_children="2",cores=[1,2],
34094 threads=[@{id="1",target-id="Thread 0xb7e14b90",cores=[1]@},
34095 @{id="2",target-id="Thread 0xb7e14b90",cores=[2]@}]@},...]
34098 @subheading The @code{-info-os} Command
34101 @subsubheading Synopsis
34104 -info-os [ @var{type} ]
34107 If no argument is supplied, the command returns a table of available
34108 operating-system-specific information types. If one of these types is
34109 supplied as an argument @var{type}, then the command returns a table
34110 of data of that type.
34112 The types of information available depend on the target operating
34115 @subsubheading @value{GDBN} Command
34117 The corresponding @value{GDBN} command is @samp{info os}.
34119 @subsubheading Example
34121 When run on a @sc{gnu}/Linux system, the output will look something
34127 ^done,OSDataTable=@{nr_rows="10",nr_cols="3",
34128 hdr=[@{width="10",alignment="-1",col_name="col0",colhdr="Type"@},
34129 @{width="10",alignment="-1",col_name="col1",colhdr="Description"@},
34130 @{width="10",alignment="-1",col_name="col2",colhdr="Title"@}],
34131 body=[item=@{col0="cpus",col1="Listing of all cpus/cores on the system",
34133 item=@{col0="files",col1="Listing of all file descriptors",
34134 col2="File descriptors"@},
34135 item=@{col0="modules",col1="Listing of all loaded kernel modules",
34136 col2="Kernel modules"@},
34137 item=@{col0="msg",col1="Listing of all message queues",
34138 col2="Message queues"@},
34139 item=@{col0="processes",col1="Listing of all processes",
34140 col2="Processes"@},
34141 item=@{col0="procgroups",col1="Listing of all process groups",
34142 col2="Process groups"@},
34143 item=@{col0="semaphores",col1="Listing of all semaphores",
34144 col2="Semaphores"@},
34145 item=@{col0="shm",col1="Listing of all shared-memory regions",
34146 col2="Shared-memory regions"@},
34147 item=@{col0="sockets",col1="Listing of all internet-domain sockets",
34149 item=@{col0="threads",col1="Listing of all threads",
34153 ^done,OSDataTable=@{nr_rows="190",nr_cols="4",
34154 hdr=[@{width="10",alignment="-1",col_name="col0",colhdr="pid"@},
34155 @{width="10",alignment="-1",col_name="col1",colhdr="user"@},
34156 @{width="10",alignment="-1",col_name="col2",colhdr="command"@},
34157 @{width="10",alignment="-1",col_name="col3",colhdr="cores"@}],
34158 body=[item=@{col0="1",col1="root",col2="/sbin/init",col3="0"@},
34159 item=@{col0="2",col1="root",col2="[kthreadd]",col3="1"@},
34160 item=@{col0="3",col1="root",col2="[ksoftirqd/0]",col3="0"@},
34162 item=@{col0="26446",col1="stan",col2="bash",col3="0"@},
34163 item=@{col0="28152",col1="stan",col2="bash",col3="1"@}]@}
34167 (Note that the MI output here includes a @code{"Title"} column that
34168 does not appear in command-line @code{info os}; this column is useful
34169 for MI clients that want to enumerate the types of data, such as in a
34170 popup menu, but is needless clutter on the command line, and
34171 @code{info os} omits it.)
34173 @subheading The @code{-add-inferior} Command
34174 @findex -add-inferior
34176 @subheading Synopsis
34182 Creates a new inferior (@pxref{Inferiors and Programs}). The created
34183 inferior is not associated with any executable. Such association may
34184 be established with the @samp{-file-exec-and-symbols} command
34185 (@pxref{GDB/MI File Commands}). The command response has a single
34186 field, @samp{inferior}, whose value is the identifier of the
34187 thread group corresponding to the new inferior.
34189 @subheading Example
34194 ^done,inferior="i3"
34197 @subheading The @code{-interpreter-exec} Command
34198 @findex -interpreter-exec
34200 @subheading Synopsis
34203 -interpreter-exec @var{interpreter} @var{command}
34205 @anchor{-interpreter-exec}
34207 Execute the specified @var{command} in the given @var{interpreter}.
34209 @subheading @value{GDBN} Command
34211 The corresponding @value{GDBN} command is @samp{interpreter-exec}.
34213 @subheading Example
34217 -interpreter-exec console "break main"
34218 &"During symbol reading, couldn't parse type; debugger out of date?.\n"
34219 &"During symbol reading, bad structure-type format.\n"
34220 ~"Breakpoint 1 at 0x8074fc6: file ../../src/gdb/main.c, line 743.\n"
34225 @subheading The @code{-inferior-tty-set} Command
34226 @findex -inferior-tty-set
34228 @subheading Synopsis
34231 -inferior-tty-set /dev/pts/1
34234 Set terminal for future runs of the program being debugged.
34236 @subheading @value{GDBN} Command
34238 The corresponding @value{GDBN} command is @samp{set inferior-tty} /dev/pts/1.
34240 @subheading Example
34244 -inferior-tty-set /dev/pts/1
34249 @subheading The @code{-inferior-tty-show} Command
34250 @findex -inferior-tty-show
34252 @subheading Synopsis
34258 Show terminal for future runs of program being debugged.
34260 @subheading @value{GDBN} Command
34262 The corresponding @value{GDBN} command is @samp{show inferior-tty}.
34264 @subheading Example
34268 -inferior-tty-set /dev/pts/1
34272 ^done,inferior_tty_terminal="/dev/pts/1"
34276 @subheading The @code{-enable-timings} Command
34277 @findex -enable-timings
34279 @subheading Synopsis
34282 -enable-timings [yes | no]
34285 Toggle the printing of the wallclock, user and system times for an MI
34286 command as a field in its output. This command is to help frontend
34287 developers optimize the performance of their code. No argument is
34288 equivalent to @samp{yes}.
34290 @subheading @value{GDBN} Command
34294 @subheading Example
34302 ^done,bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
34303 addr="0x080484ed",func="main",file="myprog.c",
34304 fullname="/home/nickrob/myprog.c",line="73",thread-groups=["i1"],
34306 time=@{wallclock="0.05185",user="0.00800",system="0.00000"@}
34314 *stopped,reason="breakpoint-hit",disp="keep",bkptno="1",thread-id="0",
34315 frame=@{addr="0x080484ed",func="main",args=[@{name="argc",value="1"@},
34316 @{name="argv",value="0xbfb60364"@}],file="myprog.c",
34317 fullname="/home/nickrob/myprog.c",line="73",arch="i386:x86_64"@}
34322 @chapter @value{GDBN} Annotations
34324 This chapter describes annotations in @value{GDBN}. Annotations were
34325 designed to interface @value{GDBN} to graphical user interfaces or other
34326 similar programs which want to interact with @value{GDBN} at a
34327 relatively high level.
34329 The annotation mechanism has largely been superseded by @sc{gdb/mi}
34333 This is Edition @value{EDITION}, @value{DATE}.
34337 * Annotations Overview:: What annotations are; the general syntax.
34338 * Server Prefix:: Issuing a command without affecting user state.
34339 * Prompting:: Annotations marking @value{GDBN}'s need for input.
34340 * Errors:: Annotations for error messages.
34341 * Invalidation:: Some annotations describe things now invalid.
34342 * Annotations for Running::
34343 Whether the program is running, how it stopped, etc.
34344 * Source Annotations:: Annotations describing source code.
34347 @node Annotations Overview
34348 @section What is an Annotation?
34349 @cindex annotations
34351 Annotations start with a newline character, two @samp{control-z}
34352 characters, and the name of the annotation. If there is no additional
34353 information associated with this annotation, the name of the annotation
34354 is followed immediately by a newline. If there is additional
34355 information, the name of the annotation is followed by a space, the
34356 additional information, and a newline. The additional information
34357 cannot contain newline characters.
34359 Any output not beginning with a newline and two @samp{control-z}
34360 characters denotes literal output from @value{GDBN}. Currently there is
34361 no need for @value{GDBN} to output a newline followed by two
34362 @samp{control-z} characters, but if there was such a need, the
34363 annotations could be extended with an @samp{escape} annotation which
34364 means those three characters as output.
34366 The annotation @var{level}, which is specified using the
34367 @option{--annotate} command line option (@pxref{Mode Options}), controls
34368 how much information @value{GDBN} prints together with its prompt,
34369 values of expressions, source lines, and other types of output. Level 0
34370 is for no annotations, level 1 is for use when @value{GDBN} is run as a
34371 subprocess of @sc{gnu} Emacs, level 3 is the maximum annotation suitable
34372 for programs that control @value{GDBN}, and level 2 annotations have
34373 been made obsolete (@pxref{Limitations, , Limitations of the Annotation
34374 Interface, annotate, GDB's Obsolete Annotations}).
34377 @kindex set annotate
34378 @item set annotate @var{level}
34379 The @value{GDBN} command @code{set annotate} sets the level of
34380 annotations to the specified @var{level}.
34382 @item show annotate
34383 @kindex show annotate
34384 Show the current annotation level.
34387 This chapter describes level 3 annotations.
34389 A simple example of starting up @value{GDBN} with annotations is:
34392 $ @kbd{gdb --annotate=3}
34394 Copyright 2003 Free Software Foundation, Inc.
34395 GDB is free software, covered by the GNU General Public License,
34396 and you are welcome to change it and/or distribute copies of it
34397 under certain conditions.
34398 Type "show copying" to see the conditions.
34399 There is absolutely no warranty for GDB. Type "show warranty"
34401 This GDB was configured as "i386-pc-linux-gnu"
34412 Here @samp{quit} is input to @value{GDBN}; the rest is output from
34413 @value{GDBN}. The three lines beginning @samp{^Z^Z} (where @samp{^Z}
34414 denotes a @samp{control-z} character) are annotations; the rest is
34415 output from @value{GDBN}.
34417 @node Server Prefix
34418 @section The Server Prefix
34419 @cindex server prefix
34421 If you prefix a command with @samp{server } then it will not affect
34422 the command history, nor will it affect @value{GDBN}'s notion of which
34423 command to repeat if @key{RET} is pressed on a line by itself. This
34424 means that commands can be run behind a user's back by a front-end in
34425 a transparent manner.
34427 The @code{server } prefix does not affect the recording of values into
34428 the value history; to print a value without recording it into the
34429 value history, use the @code{output} command instead of the
34430 @code{print} command.
34432 Using this prefix also disables confirmation requests
34433 (@pxref{confirmation requests}).
34436 @section Annotation for @value{GDBN} Input
34438 @cindex annotations for prompts
34439 When @value{GDBN} prompts for input, it annotates this fact so it is possible
34440 to know when to send output, when the output from a given command is
34443 Different kinds of input each have a different @dfn{input type}. Each
34444 input type has three annotations: a @code{pre-} annotation, which
34445 denotes the beginning of any prompt which is being output, a plain
34446 annotation, which denotes the end of the prompt, and then a @code{post-}
34447 annotation which denotes the end of any echo which may (or may not) be
34448 associated with the input. For example, the @code{prompt} input type
34449 features the following annotations:
34457 The input types are
34460 @findex pre-prompt annotation
34461 @findex prompt annotation
34462 @findex post-prompt annotation
34464 When @value{GDBN} is prompting for a command (the main @value{GDBN} prompt).
34466 @findex pre-commands annotation
34467 @findex commands annotation
34468 @findex post-commands annotation
34470 When @value{GDBN} prompts for a set of commands, like in the @code{commands}
34471 command. The annotations are repeated for each command which is input.
34473 @findex pre-overload-choice annotation
34474 @findex overload-choice annotation
34475 @findex post-overload-choice annotation
34476 @item overload-choice
34477 When @value{GDBN} wants the user to select between various overloaded functions.
34479 @findex pre-query annotation
34480 @findex query annotation
34481 @findex post-query annotation
34483 When @value{GDBN} wants the user to confirm a potentially dangerous operation.
34485 @findex pre-prompt-for-continue annotation
34486 @findex prompt-for-continue annotation
34487 @findex post-prompt-for-continue annotation
34488 @item prompt-for-continue
34489 When @value{GDBN} is asking the user to press return to continue. Note: Don't
34490 expect this to work well; instead use @code{set height 0} to disable
34491 prompting. This is because the counting of lines is buggy in the
34492 presence of annotations.
34497 @cindex annotations for errors, warnings and interrupts
34499 @findex quit annotation
34504 This annotation occurs right before @value{GDBN} responds to an interrupt.
34506 @findex error annotation
34511 This annotation occurs right before @value{GDBN} responds to an error.
34513 Quit and error annotations indicate that any annotations which @value{GDBN} was
34514 in the middle of may end abruptly. For example, if a
34515 @code{value-history-begin} annotation is followed by a @code{error}, one
34516 cannot expect to receive the matching @code{value-history-end}. One
34517 cannot expect not to receive it either, however; an error annotation
34518 does not necessarily mean that @value{GDBN} is immediately returning all the way
34521 @findex error-begin annotation
34522 A quit or error annotation may be preceded by
34528 Any output between that and the quit or error annotation is the error
34531 Warning messages are not yet annotated.
34532 @c If we want to change that, need to fix warning(), type_error(),
34533 @c range_error(), and possibly other places.
34536 @section Invalidation Notices
34538 @cindex annotations for invalidation messages
34539 The following annotations say that certain pieces of state may have
34543 @findex frames-invalid annotation
34544 @item ^Z^Zframes-invalid
34546 The frames (for example, output from the @code{backtrace} command) may
34549 @findex breakpoints-invalid annotation
34550 @item ^Z^Zbreakpoints-invalid
34552 The breakpoints may have changed. For example, the user just added or
34553 deleted a breakpoint.
34556 @node Annotations for Running
34557 @section Running the Program
34558 @cindex annotations for running programs
34560 @findex starting annotation
34561 @findex stopping annotation
34562 When the program starts executing due to a @value{GDBN} command such as
34563 @code{step} or @code{continue},
34569 is output. When the program stops,
34575 is output. Before the @code{stopped} annotation, a variety of
34576 annotations describe how the program stopped.
34579 @findex exited annotation
34580 @item ^Z^Zexited @var{exit-status}
34581 The program exited, and @var{exit-status} is the exit status (zero for
34582 successful exit, otherwise nonzero).
34584 @findex signalled annotation
34585 @findex signal-name annotation
34586 @findex signal-name-end annotation
34587 @findex signal-string annotation
34588 @findex signal-string-end annotation
34589 @item ^Z^Zsignalled
34590 The program exited with a signal. After the @code{^Z^Zsignalled}, the
34591 annotation continues:
34597 ^Z^Zsignal-name-end
34601 ^Z^Zsignal-string-end
34606 where @var{name} is the name of the signal, such as @code{SIGILL} or
34607 @code{SIGSEGV}, and @var{string} is the explanation of the signal, such
34608 as @code{Illegal Instruction} or @code{Segmentation fault}. The arguments
34609 @var{intro-text}, @var{middle-text}, and @var{end-text} are for the
34610 user's benefit and have no particular format.
34612 @findex signal annotation
34614 The syntax of this annotation is just like @code{signalled}, but @value{GDBN} is
34615 just saying that the program received the signal, not that it was
34616 terminated with it.
34618 @findex breakpoint annotation
34619 @item ^Z^Zbreakpoint @var{number}
34620 The program hit breakpoint number @var{number}.
34622 @findex watchpoint annotation
34623 @item ^Z^Zwatchpoint @var{number}
34624 The program hit watchpoint number @var{number}.
34627 @node Source Annotations
34628 @section Displaying Source
34629 @cindex annotations for source display
34631 @findex source annotation
34632 The following annotation is used instead of displaying source code:
34635 ^Z^Zsource @var{filename}:@var{line}:@var{character}:@var{middle}:@var{addr}
34638 where @var{filename} is an absolute file name indicating which source
34639 file, @var{line} is the line number within that file (where 1 is the
34640 first line in the file), @var{character} is the character position
34641 within the file (where 0 is the first character in the file) (for most
34642 debug formats this will necessarily point to the beginning of a line),
34643 @var{middle} is @samp{middle} if @var{addr} is in the middle of the
34644 line, or @samp{beg} if @var{addr} is at the beginning of the line, and
34645 @var{addr} is the address in the target program associated with the
34646 source which is being displayed. The @var{addr} is in the form @samp{0x}
34647 followed by one or more lowercase hex digits (note that this does not
34648 depend on the language).
34650 @node JIT Interface
34651 @chapter JIT Compilation Interface
34652 @cindex just-in-time compilation
34653 @cindex JIT compilation interface
34655 This chapter documents @value{GDBN}'s @dfn{just-in-time} (JIT) compilation
34656 interface. A JIT compiler is a program or library that generates native
34657 executable code at runtime and executes it, usually in order to achieve good
34658 performance while maintaining platform independence.
34660 Programs that use JIT compilation are normally difficult to debug because
34661 portions of their code are generated at runtime, instead of being loaded from
34662 object files, which is where @value{GDBN} normally finds the program's symbols
34663 and debug information. In order to debug programs that use JIT compilation,
34664 @value{GDBN} has an interface that allows the program to register in-memory
34665 symbol files with @value{GDBN} at runtime.
34667 If you are using @value{GDBN} to debug a program that uses this interface, then
34668 it should work transparently so long as you have not stripped the binary. If
34669 you are developing a JIT compiler, then the interface is documented in the rest
34670 of this chapter. At this time, the only known client of this interface is the
34673 Broadly speaking, the JIT interface mirrors the dynamic loader interface. The
34674 JIT compiler communicates with @value{GDBN} by writing data into a global
34675 variable and calling a fuction at a well-known symbol. When @value{GDBN}
34676 attaches, it reads a linked list of symbol files from the global variable to
34677 find existing code, and puts a breakpoint in the function so that it can find
34678 out about additional code.
34681 * Declarations:: Relevant C struct declarations
34682 * Registering Code:: Steps to register code
34683 * Unregistering Code:: Steps to unregister code
34684 * Custom Debug Info:: Emit debug information in a custom format
34688 @section JIT Declarations
34690 These are the relevant struct declarations that a C program should include to
34691 implement the interface:
34701 struct jit_code_entry
34703 struct jit_code_entry *next_entry;
34704 struct jit_code_entry *prev_entry;
34705 const char *symfile_addr;
34706 uint64_t symfile_size;
34709 struct jit_descriptor
34712 /* This type should be jit_actions_t, but we use uint32_t
34713 to be explicit about the bitwidth. */
34714 uint32_t action_flag;
34715 struct jit_code_entry *relevant_entry;
34716 struct jit_code_entry *first_entry;
34719 /* GDB puts a breakpoint in this function. */
34720 void __attribute__((noinline)) __jit_debug_register_code() @{ @};
34722 /* Make sure to specify the version statically, because the
34723 debugger may check the version before we can set it. */
34724 struct jit_descriptor __jit_debug_descriptor = @{ 1, 0, 0, 0 @};
34727 If the JIT is multi-threaded, then it is important that the JIT synchronize any
34728 modifications to this global data properly, which can easily be done by putting
34729 a global mutex around modifications to these structures.
34731 @node Registering Code
34732 @section Registering Code
34734 To register code with @value{GDBN}, the JIT should follow this protocol:
34738 Generate an object file in memory with symbols and other desired debug
34739 information. The file must include the virtual addresses of the sections.
34742 Create a code entry for the file, which gives the start and size of the symbol
34746 Add it to the linked list in the JIT descriptor.
34749 Point the relevant_entry field of the descriptor at the entry.
34752 Set @code{action_flag} to @code{JIT_REGISTER} and call
34753 @code{__jit_debug_register_code}.
34756 When @value{GDBN} is attached and the breakpoint fires, @value{GDBN} uses the
34757 @code{relevant_entry} pointer so it doesn't have to walk the list looking for
34758 new code. However, the linked list must still be maintained in order to allow
34759 @value{GDBN} to attach to a running process and still find the symbol files.
34761 @node Unregistering Code
34762 @section Unregistering Code
34764 If code is freed, then the JIT should use the following protocol:
34768 Remove the code entry corresponding to the code from the linked list.
34771 Point the @code{relevant_entry} field of the descriptor at the code entry.
34774 Set @code{action_flag} to @code{JIT_UNREGISTER} and call
34775 @code{__jit_debug_register_code}.
34778 If the JIT frees or recompiles code without unregistering it, then @value{GDBN}
34779 and the JIT will leak the memory used for the associated symbol files.
34781 @node Custom Debug Info
34782 @section Custom Debug Info
34783 @cindex custom JIT debug info
34784 @cindex JIT debug info reader
34786 Generating debug information in platform-native file formats (like ELF
34787 or COFF) may be an overkill for JIT compilers; especially if all the
34788 debug info is used for is displaying a meaningful backtrace. The
34789 issue can be resolved by having the JIT writers decide on a debug info
34790 format and also provide a reader that parses the debug info generated
34791 by the JIT compiler. This section gives a brief overview on writing
34792 such a parser. More specific details can be found in the source file
34793 @file{gdb/jit-reader.in}, which is also installed as a header at
34794 @file{@var{includedir}/gdb/jit-reader.h} for easy inclusion.
34796 The reader is implemented as a shared object (so this functionality is
34797 not available on platforms which don't allow loading shared objects at
34798 runtime). Two @value{GDBN} commands, @code{jit-reader-load} and
34799 @code{jit-reader-unload} are provided, to be used to load and unload
34800 the readers from a preconfigured directory. Once loaded, the shared
34801 object is used the parse the debug information emitted by the JIT
34805 * Using JIT Debug Info Readers:: How to use supplied readers correctly
34806 * Writing JIT Debug Info Readers:: Creating a debug-info reader
34809 @node Using JIT Debug Info Readers
34810 @subsection Using JIT Debug Info Readers
34811 @kindex jit-reader-load
34812 @kindex jit-reader-unload
34814 Readers can be loaded and unloaded using the @code{jit-reader-load}
34815 and @code{jit-reader-unload} commands.
34818 @item jit-reader-load @var{reader}
34819 Load the JIT reader named @var{reader}, which is a shared
34820 object specified as either an absolute or a relative file name. In
34821 the latter case, @value{GDBN} will try to load the reader from a
34822 pre-configured directory, usually @file{@var{libdir}/gdb/} on a UNIX
34823 system (here @var{libdir} is the system library directory, often
34824 @file{/usr/local/lib}).
34826 Only one reader can be active at a time; trying to load a second
34827 reader when one is already loaded will result in @value{GDBN}
34828 reporting an error. A new JIT reader can be loaded by first unloading
34829 the current one using @code{jit-reader-unload} and then invoking
34830 @code{jit-reader-load}.
34832 @item jit-reader-unload
34833 Unload the currently loaded JIT reader.
34837 @node Writing JIT Debug Info Readers
34838 @subsection Writing JIT Debug Info Readers
34839 @cindex writing JIT debug info readers
34841 As mentioned, a reader is essentially a shared object conforming to a
34842 certain ABI. This ABI is described in @file{jit-reader.h}.
34844 @file{jit-reader.h} defines the structures, macros and functions
34845 required to write a reader. It is installed (along with
34846 @value{GDBN}), in @file{@var{includedir}/gdb} where @var{includedir} is
34847 the system include directory.
34849 Readers need to be released under a GPL compatible license. A reader
34850 can be declared as released under such a license by placing the macro
34851 @code{GDB_DECLARE_GPL_COMPATIBLE_READER} in a source file.
34853 The entry point for readers is the symbol @code{gdb_init_reader},
34854 which is expected to be a function with the prototype
34856 @findex gdb_init_reader
34858 extern struct gdb_reader_funcs *gdb_init_reader (void);
34861 @cindex @code{struct gdb_reader_funcs}
34863 @code{struct gdb_reader_funcs} contains a set of pointers to callback
34864 functions. These functions are executed to read the debug info
34865 generated by the JIT compiler (@code{read}), to unwind stack frames
34866 (@code{unwind}) and to create canonical frame IDs
34867 (@code{get_Frame_id}). It also has a callback that is called when the
34868 reader is being unloaded (@code{destroy}). The struct looks like this
34871 struct gdb_reader_funcs
34873 /* Must be set to GDB_READER_INTERFACE_VERSION. */
34874 int reader_version;
34876 /* For use by the reader. */
34879 gdb_read_debug_info *read;
34880 gdb_unwind_frame *unwind;
34881 gdb_get_frame_id *get_frame_id;
34882 gdb_destroy_reader *destroy;
34886 @cindex @code{struct gdb_symbol_callbacks}
34887 @cindex @code{struct gdb_unwind_callbacks}
34889 The callbacks are provided with another set of callbacks by
34890 @value{GDBN} to do their job. For @code{read}, these callbacks are
34891 passed in a @code{struct gdb_symbol_callbacks} and for @code{unwind}
34892 and @code{get_frame_id}, in a @code{struct gdb_unwind_callbacks}.
34893 @code{struct gdb_symbol_callbacks} has callbacks to create new object
34894 files and new symbol tables inside those object files. @code{struct
34895 gdb_unwind_callbacks} has callbacks to read registers off the current
34896 frame and to write out the values of the registers in the previous
34897 frame. Both have a callback (@code{target_read}) to read bytes off the
34898 target's address space.
34900 @node In-Process Agent
34901 @chapter In-Process Agent
34902 @cindex debugging agent
34903 The traditional debugging model is conceptually low-speed, but works fine,
34904 because most bugs can be reproduced in debugging-mode execution. However,
34905 as multi-core or many-core processors are becoming mainstream, and
34906 multi-threaded programs become more and more popular, there should be more
34907 and more bugs that only manifest themselves at normal-mode execution, for
34908 example, thread races, because debugger's interference with the program's
34909 timing may conceal the bugs. On the other hand, in some applications,
34910 it is not feasible for the debugger to interrupt the program's execution
34911 long enough for the developer to learn anything helpful about its behavior.
34912 If the program's correctness depends on its real-time behavior, delays
34913 introduced by a debugger might cause the program to fail, even when the
34914 code itself is correct. It is useful to be able to observe the program's
34915 behavior without interrupting it.
34917 Therefore, traditional debugging model is too intrusive to reproduce
34918 some bugs. In order to reduce the interference with the program, we can
34919 reduce the number of operations performed by debugger. The
34920 @dfn{In-Process Agent}, a shared library, is running within the same
34921 process with inferior, and is able to perform some debugging operations
34922 itself. As a result, debugger is only involved when necessary, and
34923 performance of debugging can be improved accordingly. Note that
34924 interference with program can be reduced but can't be removed completely,
34925 because the in-process agent will still stop or slow down the program.
34927 The in-process agent can interpret and execute Agent Expressions
34928 (@pxref{Agent Expressions}) during performing debugging operations. The
34929 agent expressions can be used for different purposes, such as collecting
34930 data in tracepoints, and condition evaluation in breakpoints.
34932 @anchor{Control Agent}
34933 You can control whether the in-process agent is used as an aid for
34934 debugging with the following commands:
34937 @kindex set agent on
34939 Causes the in-process agent to perform some operations on behalf of the
34940 debugger. Just which operations requested by the user will be done
34941 by the in-process agent depends on the its capabilities. For example,
34942 if you request to evaluate breakpoint conditions in the in-process agent,
34943 and the in-process agent has such capability as well, then breakpoint
34944 conditions will be evaluated in the in-process agent.
34946 @kindex set agent off
34947 @item set agent off
34948 Disables execution of debugging operations by the in-process agent. All
34949 of the operations will be performed by @value{GDBN}.
34953 Display the current setting of execution of debugging operations by
34954 the in-process agent.
34958 * In-Process Agent Protocol::
34961 @node In-Process Agent Protocol
34962 @section In-Process Agent Protocol
34963 @cindex in-process agent protocol
34965 The in-process agent is able to communicate with both @value{GDBN} and
34966 GDBserver (@pxref{In-Process Agent}). This section documents the protocol
34967 used for communications between @value{GDBN} or GDBserver and the IPA.
34968 In general, @value{GDBN} or GDBserver sends commands
34969 (@pxref{IPA Protocol Commands}) and data to in-process agent, and then
34970 in-process agent replies back with the return result of the command, or
34971 some other information. The data sent to in-process agent is composed
34972 of primitive data types, such as 4-byte or 8-byte type, and composite
34973 types, which are called objects (@pxref{IPA Protocol Objects}).
34976 * IPA Protocol Objects::
34977 * IPA Protocol Commands::
34980 @node IPA Protocol Objects
34981 @subsection IPA Protocol Objects
34982 @cindex ipa protocol objects
34984 The commands sent to and results received from agent may contain some
34985 complex data types called @dfn{objects}.
34987 The in-process agent is running on the same machine with @value{GDBN}
34988 or GDBserver, so it doesn't have to handle as much differences between
34989 two ends as remote protocol (@pxref{Remote Protocol}) tries to handle.
34990 However, there are still some differences of two ends in two processes:
34994 word size. On some 64-bit machines, @value{GDBN} or GDBserver can be
34995 compiled as a 64-bit executable, while in-process agent is a 32-bit one.
34997 ABI. Some machines may have multiple types of ABI, @value{GDBN} or
34998 GDBserver is compiled with one, and in-process agent is compiled with
35002 Here are the IPA Protocol Objects:
35006 agent expression object. It represents an agent expression
35007 (@pxref{Agent Expressions}).
35008 @anchor{agent expression object}
35010 tracepoint action object. It represents a tracepoint action
35011 (@pxref{Tracepoint Actions,,Tracepoint Action Lists}) to collect registers,
35012 memory, static trace data and to evaluate expression.
35013 @anchor{tracepoint action object}
35015 tracepoint object. It represents a tracepoint (@pxref{Tracepoints}).
35016 @anchor{tracepoint object}
35020 The following table describes important attributes of each IPA protocol
35023 @multitable @columnfractions .30 .20 .50
35024 @headitem Name @tab Size @tab Description
35025 @item @emph{agent expression object} @tab @tab
35026 @item length @tab 4 @tab length of bytes code
35027 @item byte code @tab @var{length} @tab contents of byte code
35028 @item @emph{tracepoint action for collecting memory} @tab @tab
35029 @item 'M' @tab 1 @tab type of tracepoint action
35030 @item addr @tab 8 @tab if @var{basereg} is @samp{-1}, @var{addr} is the
35031 address of the lowest byte to collect, otherwise @var{addr} is the offset
35032 of @var{basereg} for memory collecting.
35033 @item len @tab 8 @tab length of memory for collecting
35034 @item basereg @tab 4 @tab the register number containing the starting
35035 memory address for collecting.
35036 @item @emph{tracepoint action for collecting registers} @tab @tab
35037 @item 'R' @tab 1 @tab type of tracepoint action
35038 @item @emph{tracepoint action for collecting static trace data} @tab @tab
35039 @item 'L' @tab 1 @tab type of tracepoint action
35040 @item @emph{tracepoint action for expression evaluation} @tab @tab
35041 @item 'X' @tab 1 @tab type of tracepoint action
35042 @item agent expression @tab length of @tab @ref{agent expression object}
35043 @item @emph{tracepoint object} @tab @tab
35044 @item number @tab 4 @tab number of tracepoint
35045 @item address @tab 8 @tab address of tracepoint inserted on
35046 @item type @tab 4 @tab type of tracepoint
35047 @item enabled @tab 1 @tab enable or disable of tracepoint
35048 @item step_count @tab 8 @tab step
35049 @item pass_count @tab 8 @tab pass
35050 @item numactions @tab 4 @tab number of tracepoint actions
35051 @item hit count @tab 8 @tab hit count
35052 @item trace frame usage @tab 8 @tab trace frame usage
35053 @item compiled_cond @tab 8 @tab compiled condition
35054 @item orig_size @tab 8 @tab orig size
35055 @item condition @tab 4 if condition is NULL otherwise length of
35056 @ref{agent expression object}
35057 @tab zero if condition is NULL, otherwise is
35058 @ref{agent expression object}
35059 @item actions @tab variable
35060 @tab numactions number of @ref{tracepoint action object}
35063 @node IPA Protocol Commands
35064 @subsection IPA Protocol Commands
35065 @cindex ipa protocol commands
35067 The spaces in each command are delimiters to ease reading this commands
35068 specification. They don't exist in real commands.
35072 @item FastTrace:@var{tracepoint_object} @var{gdb_jump_pad_head}
35073 Installs a new fast tracepoint described by @var{tracepoint_object}
35074 (@pxref{tracepoint object}). The @var{gdb_jump_pad_head}, 8-byte long, is the
35075 head of @dfn{jumppad}, which is used to jump to data collection routine
35080 @item OK @var{target_address} @var{gdb_jump_pad_head} @var{fjump_size} @var{fjump}
35081 @var{target_address} is address of tracepoint in the inferior.
35082 The @var{gdb_jump_pad_head} is updated head of jumppad. Both of
35083 @var{target_address} and @var{gdb_jump_pad_head} are 8-byte long.
35084 The @var{fjump} contains a sequence of instructions jump to jumppad entry.
35085 The @var{fjump_size}, 4-byte long, is the size of @var{fjump}.
35092 Closes the in-process agent. This command is sent when @value{GDBN} or GDBserver
35093 is about to kill inferiors.
35101 @item probe_marker_at:@var{address}
35102 Asks in-process agent to probe the marker at @var{address}.
35109 @item unprobe_marker_at:@var{address}
35110 Asks in-process agent to unprobe the marker at @var{address}.
35114 @chapter Reporting Bugs in @value{GDBN}
35115 @cindex bugs in @value{GDBN}
35116 @cindex reporting bugs in @value{GDBN}
35118 Your bug reports play an essential role in making @value{GDBN} reliable.
35120 Reporting a bug may help you by bringing a solution to your problem, or it
35121 may not. But in any case the principal function of a bug report is to help
35122 the entire community by making the next version of @value{GDBN} work better. Bug
35123 reports are your contribution to the maintenance of @value{GDBN}.
35125 In order for a bug report to serve its purpose, you must include the
35126 information that enables us to fix the bug.
35129 * Bug Criteria:: Have you found a bug?
35130 * Bug Reporting:: How to report bugs
35134 @section Have You Found a Bug?
35135 @cindex bug criteria
35137 If you are not sure whether you have found a bug, here are some guidelines:
35140 @cindex fatal signal
35141 @cindex debugger crash
35142 @cindex crash of debugger
35144 If the debugger gets a fatal signal, for any input whatever, that is a
35145 @value{GDBN} bug. Reliable debuggers never crash.
35147 @cindex error on valid input
35149 If @value{GDBN} produces an error message for valid input, that is a
35150 bug. (Note that if you're cross debugging, the problem may also be
35151 somewhere in the connection to the target.)
35153 @cindex invalid input
35155 If @value{GDBN} does not produce an error message for invalid input,
35156 that is a bug. However, you should note that your idea of
35157 ``invalid input'' might be our idea of ``an extension'' or ``support
35158 for traditional practice''.
35161 If you are an experienced user of debugging tools, your suggestions
35162 for improvement of @value{GDBN} are welcome in any case.
35165 @node Bug Reporting
35166 @section How to Report Bugs
35167 @cindex bug reports
35168 @cindex @value{GDBN} bugs, reporting
35170 A number of companies and individuals offer support for @sc{gnu} products.
35171 If you obtained @value{GDBN} from a support organization, we recommend you
35172 contact that organization first.
35174 You can find contact information for many support companies and
35175 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
35177 @c should add a web page ref...
35180 @ifset BUGURL_DEFAULT
35181 In any event, we also recommend that you submit bug reports for
35182 @value{GDBN}. The preferred method is to submit them directly using
35183 @uref{http://www.gnu.org/software/gdb/bugs/, @value{GDBN}'s Bugs web
35184 page}. Alternatively, the @email{bug-gdb@@gnu.org, e-mail gateway} can
35187 @strong{Do not send bug reports to @samp{info-gdb}, or to
35188 @samp{help-gdb}, or to any newsgroups.} Most users of @value{GDBN} do
35189 not want to receive bug reports. Those that do have arranged to receive
35192 The mailing list @samp{bug-gdb} has a newsgroup @samp{gnu.gdb.bug} which
35193 serves as a repeater. The mailing list and the newsgroup carry exactly
35194 the same messages. Often people think of posting bug reports to the
35195 newsgroup instead of mailing them. This appears to work, but it has one
35196 problem which can be crucial: a newsgroup posting often lacks a mail
35197 path back to the sender. Thus, if we need to ask for more information,
35198 we may be unable to reach you. For this reason, it is better to send
35199 bug reports to the mailing list.
35201 @ifclear BUGURL_DEFAULT
35202 In any event, we also recommend that you submit bug reports for
35203 @value{GDBN} to @value{BUGURL}.
35207 The fundamental principle of reporting bugs usefully is this:
35208 @strong{report all the facts}. If you are not sure whether to state a
35209 fact or leave it out, state it!
35211 Often people omit facts because they think they know what causes the
35212 problem and assume that some details do not matter. Thus, you might
35213 assume that the name of the variable you use in an example does not matter.
35214 Well, probably it does not, but one cannot be sure. Perhaps the bug is a
35215 stray memory reference which happens to fetch from the location where that
35216 name is stored in memory; perhaps, if the name were different, the contents
35217 of that location would fool the debugger into doing the right thing despite
35218 the bug. Play it safe and give a specific, complete example. That is the
35219 easiest thing for you to do, and the most helpful.
35221 Keep in mind that the purpose of a bug report is to enable us to fix the
35222 bug. It may be that the bug has been reported previously, but neither
35223 you nor we can know that unless your bug report is complete and
35226 Sometimes people give a few sketchy facts and ask, ``Does this ring a
35227 bell?'' Those bug reports are useless, and we urge everyone to
35228 @emph{refuse to respond to them} except to chide the sender to report
35231 To enable us to fix the bug, you should include all these things:
35235 The version of @value{GDBN}. @value{GDBN} announces it if you start
35236 with no arguments; you can also print it at any time using @code{show
35239 Without this, we will not know whether there is any point in looking for
35240 the bug in the current version of @value{GDBN}.
35243 The type of machine you are using, and the operating system name and
35247 The details of the @value{GDBN} build-time configuration.
35248 @value{GDBN} shows these details if you invoke it with the
35249 @option{--configuration} command-line option, or if you type
35250 @code{show configuration} at @value{GDBN}'s prompt.
35253 What compiler (and its version) was used to compile @value{GDBN}---e.g.@:
35254 ``@value{GCC}--2.8.1''.
35257 What compiler (and its version) was used to compile the program you are
35258 debugging---e.g.@: ``@value{GCC}--2.8.1'', or ``HP92453-01 A.10.32.03 HP
35259 C Compiler''. For @value{NGCC}, you can say @kbd{@value{GCC} --version}
35260 to get this information; for other compilers, see the documentation for
35264 The command arguments you gave the compiler to compile your example and
35265 observe the bug. For example, did you use @samp{-O}? To guarantee
35266 you will not omit something important, list them all. A copy of the
35267 Makefile (or the output from make) is sufficient.
35269 If we were to try to guess the arguments, we would probably guess wrong
35270 and then we might not encounter the bug.
35273 A complete input script, and all necessary source files, that will
35277 A description of what behavior you observe that you believe is
35278 incorrect. For example, ``It gets a fatal signal.''
35280 Of course, if the bug is that @value{GDBN} gets a fatal signal, then we
35281 will certainly notice it. But if the bug is incorrect output, we might
35282 not notice unless it is glaringly wrong. You might as well not give us
35283 a chance to make a mistake.
35285 Even if the problem you experience is a fatal signal, you should still
35286 say so explicitly. Suppose something strange is going on, such as, your
35287 copy of @value{GDBN} is out of synch, or you have encountered a bug in
35288 the C library on your system. (This has happened!) Your copy might
35289 crash and ours would not. If you told us to expect a crash, then when
35290 ours fails to crash, we would know that the bug was not happening for
35291 us. If you had not told us to expect a crash, then we would not be able
35292 to draw any conclusion from our observations.
35295 @cindex recording a session script
35296 To collect all this information, you can use a session recording program
35297 such as @command{script}, which is available on many Unix systems.
35298 Just run your @value{GDBN} session inside @command{script} and then
35299 include the @file{typescript} file with your bug report.
35301 Another way to record a @value{GDBN} session is to run @value{GDBN}
35302 inside Emacs and then save the entire buffer to a file.
35305 If you wish to suggest changes to the @value{GDBN} source, send us context
35306 diffs. If you even discuss something in the @value{GDBN} source, refer to
35307 it by context, not by line number.
35309 The line numbers in our development sources will not match those in your
35310 sources. Your line numbers would convey no useful information to us.
35314 Here are some things that are not necessary:
35318 A description of the envelope of the bug.
35320 Often people who encounter a bug spend a lot of time investigating
35321 which changes to the input file will make the bug go away and which
35322 changes will not affect it.
35324 This is often time consuming and not very useful, because the way we
35325 will find the bug is by running a single example under the debugger
35326 with breakpoints, not by pure deduction from a series of examples.
35327 We recommend that you save your time for something else.
35329 Of course, if you can find a simpler example to report @emph{instead}
35330 of the original one, that is a convenience for us. Errors in the
35331 output will be easier to spot, running under the debugger will take
35332 less time, and so on.
35334 However, simplification is not vital; if you do not want to do this,
35335 report the bug anyway and send us the entire test case you used.
35338 A patch for the bug.
35340 A patch for the bug does help us if it is a good one. But do not omit
35341 the necessary information, such as the test case, on the assumption that
35342 a patch is all we need. We might see problems with your patch and decide
35343 to fix the problem another way, or we might not understand it at all.
35345 Sometimes with a program as complicated as @value{GDBN} it is very hard to
35346 construct an example that will make the program follow a certain path
35347 through the code. If you do not send us the example, we will not be able
35348 to construct one, so we will not be able to verify that the bug is fixed.
35350 And if we cannot understand what bug you are trying to fix, or why your
35351 patch should be an improvement, we will not install it. A test case will
35352 help us to understand.
35355 A guess about what the bug is or what it depends on.
35357 Such guesses are usually wrong. Even we cannot guess right about such
35358 things without first using the debugger to find the facts.
35361 @c The readline documentation is distributed with the readline code
35362 @c and consists of the two following files:
35365 @c Use -I with makeinfo to point to the appropriate directory,
35366 @c environment var TEXINPUTS with TeX.
35367 @ifclear SYSTEM_READLINE
35368 @include rluser.texi
35369 @include hsuser.texi
35373 @appendix In Memoriam
35375 The @value{GDBN} project mourns the loss of the following long-time
35380 Fred was a long-standing contributor to @value{GDBN} (1991-2006), and
35381 to Free Software in general. Outside of @value{GDBN}, he was known in
35382 the Amiga world for his series of Fish Disks, and the GeekGadget project.
35384 @item Michael Snyder
35385 Michael was one of the Global Maintainers of the @value{GDBN} project,
35386 with contributions recorded as early as 1996, until 2011. In addition
35387 to his day to day participation, he was a large driving force behind
35388 adding Reverse Debugging to @value{GDBN}.
35391 Beyond their technical contributions to the project, they were also
35392 enjoyable members of the Free Software Community. We will miss them.
35394 @node Formatting Documentation
35395 @appendix Formatting Documentation
35397 @cindex @value{GDBN} reference card
35398 @cindex reference card
35399 The @value{GDBN} 4 release includes an already-formatted reference card, ready
35400 for printing with PostScript or Ghostscript, in the @file{gdb}
35401 subdirectory of the main source directory@footnote{In
35402 @file{gdb-@value{GDBVN}/gdb/refcard.ps} of the version @value{GDBVN}
35403 release.}. If you can use PostScript or Ghostscript with your printer,
35404 you can print the reference card immediately with @file{refcard.ps}.
35406 The release also includes the source for the reference card. You
35407 can format it, using @TeX{}, by typing:
35413 The @value{GDBN} reference card is designed to print in @dfn{landscape}
35414 mode on US ``letter'' size paper;
35415 that is, on a sheet 11 inches wide by 8.5 inches
35416 high. You will need to specify this form of printing as an option to
35417 your @sc{dvi} output program.
35419 @cindex documentation
35421 All the documentation for @value{GDBN} comes as part of the machine-readable
35422 distribution. The documentation is written in Texinfo format, which is
35423 a documentation system that uses a single source file to produce both
35424 on-line information and a printed manual. You can use one of the Info
35425 formatting commands to create the on-line version of the documentation
35426 and @TeX{} (or @code{texi2roff}) to typeset the printed version.
35428 @value{GDBN} includes an already formatted copy of the on-line Info
35429 version of this manual in the @file{gdb} subdirectory. The main Info
35430 file is @file{gdb-@value{GDBVN}/gdb/gdb.info}, and it refers to
35431 subordinate files matching @samp{gdb.info*} in the same directory. If
35432 necessary, you can print out these files, or read them with any editor;
35433 but they are easier to read using the @code{info} subsystem in @sc{gnu}
35434 Emacs or the standalone @code{info} program, available as part of the
35435 @sc{gnu} Texinfo distribution.
35437 If you want to format these Info files yourself, you need one of the
35438 Info formatting programs, such as @code{texinfo-format-buffer} or
35441 If you have @code{makeinfo} installed, and are in the top level
35442 @value{GDBN} source directory (@file{gdb-@value{GDBVN}}, in the case of
35443 version @value{GDBVN}), you can make the Info file by typing:
35450 If you want to typeset and print copies of this manual, you need @TeX{},
35451 a program to print its @sc{dvi} output files, and @file{texinfo.tex}, the
35452 Texinfo definitions file.
35454 @TeX{} is a typesetting program; it does not print files directly, but
35455 produces output files called @sc{dvi} files. To print a typeset
35456 document, you need a program to print @sc{dvi} files. If your system
35457 has @TeX{} installed, chances are it has such a program. The precise
35458 command to use depends on your system; @kbd{lpr -d} is common; another
35459 (for PostScript devices) is @kbd{dvips}. The @sc{dvi} print command may
35460 require a file name without any extension or a @samp{.dvi} extension.
35462 @TeX{} also requires a macro definitions file called
35463 @file{texinfo.tex}. This file tells @TeX{} how to typeset a document
35464 written in Texinfo format. On its own, @TeX{} cannot either read or
35465 typeset a Texinfo file. @file{texinfo.tex} is distributed with GDB
35466 and is located in the @file{gdb-@var{version-number}/texinfo}
35469 If you have @TeX{} and a @sc{dvi} printer program installed, you can
35470 typeset and print this manual. First switch to the @file{gdb}
35471 subdirectory of the main source directory (for example, to
35472 @file{gdb-@value{GDBVN}/gdb}) and type:
35478 Then give @file{gdb.dvi} to your @sc{dvi} printing program.
35480 @node Installing GDB
35481 @appendix Installing @value{GDBN}
35482 @cindex installation
35485 * Requirements:: Requirements for building @value{GDBN}
35486 * Running Configure:: Invoking the @value{GDBN} @file{configure} script
35487 * Separate Objdir:: Compiling @value{GDBN} in another directory
35488 * Config Names:: Specifying names for hosts and targets
35489 * Configure Options:: Summary of options for configure
35490 * System-wide configuration:: Having a system-wide init file
35494 @section Requirements for Building @value{GDBN}
35495 @cindex building @value{GDBN}, requirements for
35497 Building @value{GDBN} requires various tools and packages to be available.
35498 Other packages will be used only if they are found.
35500 @heading Tools/Packages Necessary for Building @value{GDBN}
35502 @item C@t{++}11 compiler
35503 @value{GDBN} is written in C@t{++}11. It should be buildable with any
35504 recent C@t{++}11 compiler, e.g.@: GCC.
35507 @value{GDBN}'s build system relies on features only found in the GNU
35508 make program. Other variants of @code{make} will not work.
35511 @heading Tools/Packages Optional for Building @value{GDBN}
35515 @value{GDBN} can use the Expat XML parsing library. This library may be
35516 included with your operating system distribution; if it is not, you
35517 can get the latest version from @url{http://expat.sourceforge.net}.
35518 The @file{configure} script will search for this library in several
35519 standard locations; if it is installed in an unusual path, you can
35520 use the @option{--with-libexpat-prefix} option to specify its location.
35526 Remote protocol memory maps (@pxref{Memory Map Format})
35528 Target descriptions (@pxref{Target Descriptions})
35530 Remote shared library lists (@xref{Library List Format},
35531 or alternatively @pxref{Library List Format for SVR4 Targets})
35533 MS-Windows shared libraries (@pxref{Shared Libraries})
35535 Traceframe info (@pxref{Traceframe Info Format})
35537 Branch trace (@pxref{Branch Trace Format},
35538 @pxref{Branch Trace Configuration Format})
35542 @value{GDBN} can be scripted using GNU Guile. @xref{Guile}. By
35543 default, @value{GDBN} will be compiled if the Guile libraries are
35544 installed and are found by @file{configure}. You can use the
35545 @code{--with-guile} option to request Guile, and pass either the Guile
35546 version number or the file name of the relevant @code{pkg-config}
35547 program to choose a particular version of Guile.
35550 @value{GDBN}'s features related to character sets (@pxref{Character
35551 Sets}) require a functioning @code{iconv} implementation. If you are
35552 on a GNU system, then this is provided by the GNU C Library. Some
35553 other systems also provide a working @code{iconv}.
35555 If @value{GDBN} is using the @code{iconv} program which is installed
35556 in a non-standard place, you will need to tell @value{GDBN} where to
35557 find it. This is done with @option{--with-iconv-bin} which specifies
35558 the directory that contains the @code{iconv} program. This program is
35559 run in order to make a list of the available character sets.
35561 On systems without @code{iconv}, you can install GNU Libiconv. If
35562 Libiconv is installed in a standard place, @value{GDBN} will
35563 automatically use it if it is needed. If you have previously
35564 installed Libiconv in a non-standard place, you can use the
35565 @option{--with-libiconv-prefix} option to @file{configure}.
35567 @value{GDBN}'s top-level @file{configure} and @file{Makefile} will
35568 arrange to build Libiconv if a directory named @file{libiconv} appears
35569 in the top-most source directory. If Libiconv is built this way, and
35570 if the operating system does not provide a suitable @code{iconv}
35571 implementation, then the just-built library will automatically be used
35572 by @value{GDBN}. One easy way to set this up is to download GNU
35573 Libiconv, unpack it inside the top-level directory of the @value{GDBN}
35574 source tree, and then rename the directory holding the Libiconv source
35575 code to @samp{libiconv}.
35578 @value{GDBN} can support debugging sections that are compressed with
35579 the LZMA library. @xref{MiniDebugInfo}. If this library is not
35580 included with your operating system, you can find it in the xz package
35581 at @url{http://tukaani.org/xz/}. If the LZMA library is available in
35582 the usual place, then the @file{configure} script will use it
35583 automatically. If it is installed in an unusual path, you can use the
35584 @option{--with-lzma-prefix} option to specify its location.
35588 @value{GDBN} can use the GNU MPFR multiple-precision floating-point
35589 library. This library may be included with your operating system
35590 distribution; if it is not, you can get the latest version from
35591 @url{http://www.mpfr.org}. The @file{configure} script will search
35592 for this library in several standard locations; if it is installed
35593 in an unusual path, you can use the @option{--with-libmpfr-prefix}
35594 option to specify its location.
35596 GNU MPFR is used to emulate target floating-point arithmetic during
35597 expression evaluation when the target uses different floating-point
35598 formats than the host. If GNU MPFR it is not available, @value{GDBN}
35599 will fall back to using host floating-point arithmetic.
35602 @value{GDBN} can be scripted using Python language. @xref{Python}.
35603 By default, @value{GDBN} will be compiled if the Python libraries are
35604 installed and are found by @file{configure}. You can use the
35605 @code{--with-python} option to request Python, and pass either the
35606 file name of the relevant @code{python} executable, or the name of the
35607 directory in which Python is installed, to choose a particular
35608 installation of Python.
35611 @cindex compressed debug sections
35612 @value{GDBN} will use the @samp{zlib} library, if available, to read
35613 compressed debug sections. Some linkers, such as GNU gold, are capable
35614 of producing binaries with compressed debug sections. If @value{GDBN}
35615 is compiled with @samp{zlib}, it will be able to read the debug
35616 information in such binaries.
35618 The @samp{zlib} library is likely included with your operating system
35619 distribution; if it is not, you can get the latest version from
35620 @url{http://zlib.net}.
35623 @node Running Configure
35624 @section Invoking the @value{GDBN} @file{configure} Script
35625 @cindex configuring @value{GDBN}
35626 @value{GDBN} comes with a @file{configure} script that automates the process
35627 of preparing @value{GDBN} for installation; you can then use @code{make} to
35628 build the @code{gdb} program.
35630 @c irrelevant in info file; it's as current as the code it lives with.
35631 @footnote{If you have a more recent version of @value{GDBN} than @value{GDBVN},
35632 look at the @file{README} file in the sources; we may have improved the
35633 installation procedures since publishing this manual.}
35636 The @value{GDBN} distribution includes all the source code you need for
35637 @value{GDBN} in a single directory, whose name is usually composed by
35638 appending the version number to @samp{gdb}.
35640 For example, the @value{GDBN} version @value{GDBVN} distribution is in the
35641 @file{gdb-@value{GDBVN}} directory. That directory contains:
35644 @item gdb-@value{GDBVN}/configure @r{(and supporting files)}
35645 script for configuring @value{GDBN} and all its supporting libraries
35647 @item gdb-@value{GDBVN}/gdb
35648 the source specific to @value{GDBN} itself
35650 @item gdb-@value{GDBVN}/bfd
35651 source for the Binary File Descriptor library
35653 @item gdb-@value{GDBVN}/include
35654 @sc{gnu} include files
35656 @item gdb-@value{GDBVN}/libiberty
35657 source for the @samp{-liberty} free software library
35659 @item gdb-@value{GDBVN}/opcodes
35660 source for the library of opcode tables and disassemblers
35662 @item gdb-@value{GDBVN}/readline
35663 source for the @sc{gnu} command-line interface
35666 There may be other subdirectories as well.
35668 The simplest way to configure and build @value{GDBN} is to run @file{configure}
35669 from the @file{gdb-@var{version-number}} source directory, which in
35670 this example is the @file{gdb-@value{GDBVN}} directory.
35672 First switch to the @file{gdb-@var{version-number}} source directory
35673 if you are not already in it; then run @file{configure}. Pass the
35674 identifier for the platform on which @value{GDBN} will run as an
35680 cd gdb-@value{GDBVN}
35685 Running @samp{configure} and then running @code{make} builds the
35686 included supporting libraries, then @code{gdb} itself. The configured
35687 source files, and the binaries, are left in the corresponding source
35691 @file{configure} is a Bourne-shell (@code{/bin/sh}) script; if your
35692 system does not recognize this automatically when you run a different
35693 shell, you may need to run @code{sh} on it explicitly:
35699 You should run the @file{configure} script from the top directory in the
35700 source tree, the @file{gdb-@var{version-number}} directory. If you run
35701 @file{configure} from one of the subdirectories, you will configure only
35702 that subdirectory. That is usually not what you want. In particular,
35703 if you run the first @file{configure} from the @file{gdb} subdirectory
35704 of the @file{gdb-@var{version-number}} directory, you will omit the
35705 configuration of @file{bfd}, @file{readline}, and other sibling
35706 directories of the @file{gdb} subdirectory. This leads to build errors
35707 about missing include files such as @file{bfd/bfd.h}.
35709 You can install @code{@value{GDBN}} anywhere. The best way to do this
35710 is to pass the @code{--prefix} option to @code{configure}, and then
35711 install it with @code{make install}.
35713 @node Separate Objdir
35714 @section Compiling @value{GDBN} in Another Directory
35716 If you want to run @value{GDBN} versions for several host or target machines,
35717 you need a different @code{gdb} compiled for each combination of
35718 host and target. @file{configure} is designed to make this easy by
35719 allowing you to generate each configuration in a separate subdirectory,
35720 rather than in the source directory. If your @code{make} program
35721 handles the @samp{VPATH} feature (@sc{gnu} @code{make} does), running
35722 @code{make} in each of these directories builds the @code{gdb}
35723 program specified there.
35725 To build @code{gdb} in a separate directory, run @file{configure}
35726 with the @samp{--srcdir} option to specify where to find the source.
35727 (You also need to specify a path to find @file{configure}
35728 itself from your working directory. If the path to @file{configure}
35729 would be the same as the argument to @samp{--srcdir}, you can leave out
35730 the @samp{--srcdir} option; it is assumed.)
35732 For example, with version @value{GDBVN}, you can build @value{GDBN} in a
35733 separate directory for a Sun 4 like this:
35737 cd gdb-@value{GDBVN}
35740 ../gdb-@value{GDBVN}/configure
35745 When @file{configure} builds a configuration using a remote source
35746 directory, it creates a tree for the binaries with the same structure
35747 (and using the same names) as the tree under the source directory. In
35748 the example, you'd find the Sun 4 library @file{libiberty.a} in the
35749 directory @file{gdb-sun4/libiberty}, and @value{GDBN} itself in
35750 @file{gdb-sun4/gdb}.
35752 Make sure that your path to the @file{configure} script has just one
35753 instance of @file{gdb} in it. If your path to @file{configure} looks
35754 like @file{../gdb-@value{GDBVN}/gdb/configure}, you are configuring only
35755 one subdirectory of @value{GDBN}, not the whole package. This leads to
35756 build errors about missing include files such as @file{bfd/bfd.h}.
35758 One popular reason to build several @value{GDBN} configurations in separate
35759 directories is to configure @value{GDBN} for cross-compiling (where
35760 @value{GDBN} runs on one machine---the @dfn{host}---while debugging
35761 programs that run on another machine---the @dfn{target}).
35762 You specify a cross-debugging target by
35763 giving the @samp{--target=@var{target}} option to @file{configure}.
35765 When you run @code{make} to build a program or library, you must run
35766 it in a configured directory---whatever directory you were in when you
35767 called @file{configure} (or one of its subdirectories).
35769 The @code{Makefile} that @file{configure} generates in each source
35770 directory also runs recursively. If you type @code{make} in a source
35771 directory such as @file{gdb-@value{GDBVN}} (or in a separate configured
35772 directory configured with @samp{--srcdir=@var{dirname}/gdb-@value{GDBVN}}), you
35773 will build all the required libraries, and then build GDB.
35775 When you have multiple hosts or targets configured in separate
35776 directories, you can run @code{make} on them in parallel (for example,
35777 if they are NFS-mounted on each of the hosts); they will not interfere
35781 @section Specifying Names for Hosts and Targets
35783 The specifications used for hosts and targets in the @file{configure}
35784 script are based on a three-part naming scheme, but some short predefined
35785 aliases are also supported. The full naming scheme encodes three pieces
35786 of information in the following pattern:
35789 @var{architecture}-@var{vendor}-@var{os}
35792 For example, you can use the alias @code{sun4} as a @var{host} argument,
35793 or as the value for @var{target} in a @code{--target=@var{target}}
35794 option. The equivalent full name is @samp{sparc-sun-sunos4}.
35796 The @file{configure} script accompanying @value{GDBN} does not provide
35797 any query facility to list all supported host and target names or
35798 aliases. @file{configure} calls the Bourne shell script
35799 @code{config.sub} to map abbreviations to full names; you can read the
35800 script, if you wish, or you can use it to test your guesses on
35801 abbreviations---for example:
35804 % sh config.sub i386-linux
35806 % sh config.sub alpha-linux
35807 alpha-unknown-linux-gnu
35808 % sh config.sub hp9k700
35810 % sh config.sub sun4
35811 sparc-sun-sunos4.1.1
35812 % sh config.sub sun3
35813 m68k-sun-sunos4.1.1
35814 % sh config.sub i986v
35815 Invalid configuration `i986v': machine `i986v' not recognized
35819 @code{config.sub} is also distributed in the @value{GDBN} source
35820 directory (@file{gdb-@value{GDBVN}}, for version @value{GDBVN}).
35822 @node Configure Options
35823 @section @file{configure} Options
35825 Here is a summary of the @file{configure} options and arguments that
35826 are most often useful for building @value{GDBN}. @file{configure}
35827 also has several other options not listed here. @inforef{Running
35828 configure scripts,,autoconf.info}, for a full
35829 explanation of @file{configure}.
35832 configure @r{[}--help@r{]}
35833 @r{[}--prefix=@var{dir}@r{]}
35834 @r{[}--exec-prefix=@var{dir}@r{]}
35835 @r{[}--srcdir=@var{dirname}@r{]}
35836 @r{[}--target=@var{target}@r{]}
35840 You may introduce options with a single @samp{-} rather than
35841 @samp{--} if you prefer; but you may abbreviate option names if you use
35846 Display a quick summary of how to invoke @file{configure}.
35848 @item --prefix=@var{dir}
35849 Configure the source to install programs and files under directory
35852 @item --exec-prefix=@var{dir}
35853 Configure the source to install programs under directory
35856 @c avoid splitting the warning from the explanation:
35858 @item --srcdir=@var{dirname}
35859 Use this option to make configurations in directories separate from the
35860 @value{GDBN} source directories. Among other things, you can use this to
35861 build (or maintain) several configurations simultaneously, in separate
35862 directories. @file{configure} writes configuration-specific files in
35863 the current directory, but arranges for them to use the source in the
35864 directory @var{dirname}. @file{configure} creates directories under
35865 the working directory in parallel to the source directories below
35868 @item --target=@var{target}
35869 Configure @value{GDBN} for cross-debugging programs running on the specified
35870 @var{target}. Without this option, @value{GDBN} is configured to debug
35871 programs that run on the same machine (@var{host}) as @value{GDBN} itself.
35873 There is no convenient way to generate a list of all available
35874 targets. Also see the @code{--enable-targets} option, below.
35877 There are many other options that are specific to @value{GDBN}. This
35878 lists just the most common ones; there are some very specialized
35879 options not described here.
35882 @item --enable-targets=@r{[}@var{target}@r{]}@dots{}
35883 @itemx --enable-targets=all
35884 Configure @value{GDBN} for cross-debugging programs running on the
35885 specified list of targets. The special value @samp{all} configures
35886 @value{GDBN} for debugging programs running on any target it supports.
35888 @item --with-gdb-datadir=@var{path}
35889 Set the @value{GDBN}-specific data directory. @value{GDBN} will look
35890 here for certain supporting files or scripts. This defaults to the
35891 @file{gdb} subdirectory of @samp{datadi} (which can be set using
35894 @item --with-relocated-sources=@var{dir}
35895 Sets up the default source path substitution rule so that directory
35896 names recorded in debug information will be automatically adjusted for
35897 any directory under @var{dir}. @var{dir} should be a subdirectory of
35898 @value{GDBN}'s configured prefix, the one mentioned in the
35899 @code{--prefix} or @code{--exec-prefix} options to configure. This
35900 option is useful if GDB is supposed to be moved to a different place
35903 @item --enable-64-bit-bfd
35904 Enable 64-bit support in BFD on 32-bit hosts.
35906 @item --disable-gdbmi
35907 Build @value{GDBN} without the GDB/MI machine interface
35911 Build @value{GDBN} with the text-mode full-screen user interface
35912 (TUI). Requires a curses library (ncurses and cursesX are also
35915 @item --with-curses
35916 Use the curses library instead of the termcap library, for text-mode
35917 terminal operations.
35919 @item --with-libunwind-ia64
35920 Use the libunwind library for unwinding function call stack on ia64
35921 target platforms. See http://www.nongnu.org/libunwind/index.html for
35924 @item --with-system-readline
35925 Use the readline library installed on the host, rather than the
35926 library supplied as part of @value{GDBN}.
35928 @item --with-system-zlib
35929 Use the zlib library installed on the host, rather than the library
35930 supplied as part of @value{GDBN}.
35933 Build @value{GDBN} with Expat, a library for XML parsing. (Done by
35934 default if libexpat is installed and found at configure time.) This
35935 library is used to read XML files supplied with @value{GDBN}. If it
35936 is unavailable, some features, such as remote protocol memory maps,
35937 target descriptions, and shared library lists, that are based on XML
35938 files, will not be available in @value{GDBN}. If your host does not
35939 have libexpat installed, you can get the latest version from
35940 `http://expat.sourceforge.net'.
35942 @item --with-libiconv-prefix@r{[}=@var{dir}@r{]}
35944 Build @value{GDBN} with GNU libiconv, a character set encoding
35945 conversion library. This is not done by default, as on GNU systems
35946 the @code{iconv} that is built in to the C library is sufficient. If
35947 your host does not have a working @code{iconv}, you can get the latest
35948 version of GNU iconv from `https://www.gnu.org/software/libiconv/'.
35950 @value{GDBN}'s build system also supports building GNU libiconv as
35951 part of the overall build. @xref{Requirements}.
35954 Build @value{GDBN} with LZMA, a compression library. (Done by default
35955 if liblzma is installed and found at configure time.) LZMA is used by
35956 @value{GDBN}'s "mini debuginfo" feature, which is only useful on
35957 platforms using the ELF object file format. If your host does not
35958 have liblzma installed, you can get the latest version from
35959 `https://tukaani.org/xz/'.
35962 Build @value{GDBN} with GNU MPFR, a library for multiple-precision
35963 floating-point computation with correct rounding. (Done by default if
35964 GNU MPFR is installed and found at configure time.) This library is
35965 used to emulate target floating-point arithmetic during expression
35966 evaluation when the target uses different floating-point formats than
35967 the host. If GNU MPFR is not available, @value{GDBN} will fall back
35968 to using host floating-point arithmetic. If your host does not have
35969 GNU MPFR installed, you can get the latest version from
35970 `http://www.mpfr.org'.
35972 @item --with-python@r{[}=@var{python}@r{]}
35973 Build @value{GDBN} with Python scripting support. (Done by default if
35974 libpython is present and found at configure time.) Python makes
35975 @value{GDBN} scripting much more powerful than the restricted CLI
35976 scripting language. If your host does not have Python installed, you
35977 can find it on `http://www.python.org/download/'. The oldest version
35978 of Python supported by GDB is 2.6. The optional argument @var{python}
35979 is used to find the Python headers and libraries. It can be either
35980 the name of a Python executable, or the name of the directory in which
35981 Python is installed.
35983 @item --with-guile[=GUILE]'
35984 Build @value{GDBN} with GNU Guile scripting support. (Done by default
35985 if libguile is present and found at configure time.) If your host
35986 does not have Guile installed, you can find it at
35987 `https://www.gnu.org/software/guile/'. The optional argument GUILE
35988 can be a version number, which will cause @code{configure} to try to
35989 use that version of Guile; or the file name of a @code{pkg-config}
35990 executable, which will be queried to find the information needed to
35991 compile and link against Guile.
35993 @item --without-included-regex
35994 Don't use the regex library included with @value{GDBN} (as part of the
35995 libiberty library). This is the default on hosts with version 2 of
35998 @item --with-sysroot=@var{dir}
35999 Use @var{dir} as the default system root directory for libraries whose
36000 file names begin with @file{/lib}' or @file{/usr/lib'}. (The value of
36001 @var{dir} can be modified at run time by using the @command{set
36002 sysroot} command.) If @var{dir} is under the @value{GDBN} configured
36003 prefix (set with @code{--prefix} or @code{--exec-prefix options}, the
36004 default system root will be automatically adjusted if and when
36005 @value{GDBN} is moved to a different location.
36007 @item --with-system-gdbinit=@var{file}
36008 Configure @value{GDBN} to automatically load a system-wide init file.
36009 @var{file} should be an absolute file name. If @var{file} is in a
36010 directory under the configured prefix, and @value{GDBN} is moved to
36011 another location after being built, the location of the system-wide
36012 init file will be adjusted accordingly.
36014 @item --enable-build-warnings
36015 When building the @value{GDBN} sources, ask the compiler to warn about
36016 any code which looks even vaguely suspicious. It passes many
36017 different warning flags, depending on the exact version of the
36018 compiler you are using.
36020 @item --enable-werror
36021 Treat compiler warnings as werrors. It adds the @code{-Werror} flag
36022 to the compiler, which will fail the compilation if the compiler
36023 outputs any warning messages.
36025 @item --enable-ubsan
36026 Enable the GCC undefined behavior sanitizer. This is disabled by
36027 default, but passing @code{--enable-ubsan=yes} or
36028 @code{--enable-ubsan=auto} to @code{configure} will enable it. The
36029 undefined behavior sanitizer checks for C@t{++} undefined behavior.
36030 It has a performance cost, so if you are looking at @value{GDBN}'s
36031 performance, you should disable it. The undefined behavior sanitizer
36032 was first introduced in GCC 4.9.
36035 @node System-wide configuration
36036 @section System-wide configuration and settings
36037 @cindex system-wide init file
36039 @value{GDBN} can be configured to have a system-wide init file;
36040 this file will be read and executed at startup (@pxref{Startup, , What
36041 @value{GDBN} does during startup}).
36043 Here is the corresponding configure option:
36046 @item --with-system-gdbinit=@var{file}
36047 Specify that the default location of the system-wide init file is
36051 If @value{GDBN} has been configured with the option @option{--prefix=$prefix},
36052 it may be subject to relocation. Two possible cases:
36056 If the default location of this init file contains @file{$prefix},
36057 it will be subject to relocation. Suppose that the configure options
36058 are @option{--prefix=$prefix --with-system-gdbinit=$prefix/etc/gdbinit};
36059 if @value{GDBN} is moved from @file{$prefix} to @file{$install}, the system
36060 init file is looked for as @file{$install/etc/gdbinit} instead of
36061 @file{$prefix/etc/gdbinit}.
36064 By contrast, if the default location does not contain the prefix,
36065 it will not be relocated. E.g.@: if @value{GDBN} has been configured with
36066 @option{--prefix=/usr/local --with-system-gdbinit=/usr/share/gdb/gdbinit},
36067 then @value{GDBN} will always look for @file{/usr/share/gdb/gdbinit},
36068 wherever @value{GDBN} is installed.
36071 If the configured location of the system-wide init file (as given by the
36072 @option{--with-system-gdbinit} option at configure time) is in the
36073 data-directory (as specified by @option{--with-gdb-datadir} at configure
36074 time) or in one of its subdirectories, then @value{GDBN} will look for the
36075 system-wide init file in the directory specified by the
36076 @option{--data-directory} command-line option.
36077 Note that the system-wide init file is only read once, during @value{GDBN}
36078 initialization. If the data-directory is changed after @value{GDBN} has
36079 started with the @code{set data-directory} command, the file will not be
36083 * System-wide Configuration Scripts:: Installed System-wide Configuration Scripts
36086 @node System-wide Configuration Scripts
36087 @subsection Installed System-wide Configuration Scripts
36088 @cindex system-wide configuration scripts
36090 The @file{system-gdbinit} directory, located inside the data-directory
36091 (as specified by @option{--with-gdb-datadir} at configure time) contains
36092 a number of scripts which can be used as system-wide init files. To
36093 automatically source those scripts at startup, @value{GDBN} should be
36094 configured with @option{--with-system-gdbinit}. Otherwise, any user
36095 should be able to source them by hand as needed.
36097 The following scripts are currently available:
36100 @item @file{elinos.py}
36102 @cindex ELinOS system-wide configuration script
36103 This script is useful when debugging a program on an ELinOS target.
36104 It takes advantage of the environment variables defined in a standard
36105 ELinOS environment in order to determine the location of the system
36106 shared libraries, and then sets the @samp{solib-absolute-prefix}
36107 and @samp{solib-search-path} variables appropriately.
36109 @item @file{wrs-linux.py}
36110 @pindex wrs-linux.py
36111 @cindex Wind River Linux system-wide configuration script
36112 This script is useful when debugging a program on a target running
36113 Wind River Linux. It expects the @env{ENV_PREFIX} to be set to
36114 the host-side sysroot used by the target system.
36118 @node Maintenance Commands
36119 @appendix Maintenance Commands
36120 @cindex maintenance commands
36121 @cindex internal commands
36123 In addition to commands intended for @value{GDBN} users, @value{GDBN}
36124 includes a number of commands intended for @value{GDBN} developers,
36125 that are not documented elsewhere in this manual. These commands are
36126 provided here for reference. (For commands that turn on debugging
36127 messages, see @ref{Debugging Output}.)
36130 @kindex maint agent
36131 @kindex maint agent-eval
36132 @item maint agent @r{[}-at @var{location}@r{,}@r{]} @var{expression}
36133 @itemx maint agent-eval @r{[}-at @var{location}@r{,}@r{]} @var{expression}
36134 Translate the given @var{expression} into remote agent bytecodes.
36135 This command is useful for debugging the Agent Expression mechanism
36136 (@pxref{Agent Expressions}). The @samp{agent} version produces an
36137 expression useful for data collection, such as by tracepoints, while
36138 @samp{maint agent-eval} produces an expression that evaluates directly
36139 to a result. For instance, a collection expression for @code{globa +
36140 globb} will include bytecodes to record four bytes of memory at each
36141 of the addresses of @code{globa} and @code{globb}, while discarding
36142 the result of the addition, while an evaluation expression will do the
36143 addition and return the sum.
36144 If @code{-at} is given, generate remote agent bytecode for @var{location}.
36145 If not, generate remote agent bytecode for current frame PC address.
36147 @kindex maint agent-printf
36148 @item maint agent-printf @var{format},@var{expr},...
36149 Translate the given format string and list of argument expressions
36150 into remote agent bytecodes and display them as a disassembled list.
36151 This command is useful for debugging the agent version of dynamic
36152 printf (@pxref{Dynamic Printf}).
36154 @kindex maint info breakpoints
36155 @item @anchor{maint info breakpoints}maint info breakpoints
36156 Using the same format as @samp{info breakpoints}, display both the
36157 breakpoints you've set explicitly, and those @value{GDBN} is using for
36158 internal purposes. Internal breakpoints are shown with negative
36159 breakpoint numbers. The type column identifies what kind of breakpoint
36164 Normal, explicitly set breakpoint.
36167 Normal, explicitly set watchpoint.
36170 Internal breakpoint, used to handle correctly stepping through
36171 @code{longjmp} calls.
36173 @item longjmp resume
36174 Internal breakpoint at the target of a @code{longjmp}.
36177 Temporary internal breakpoint used by the @value{GDBN} @code{until} command.
36180 Temporary internal breakpoint used by the @value{GDBN} @code{finish} command.
36183 Shared library events.
36187 @kindex maint info btrace
36188 @item maint info btrace
36189 Pint information about raw branch tracing data.
36191 @kindex maint btrace packet-history
36192 @item maint btrace packet-history
36193 Print the raw branch trace packets that are used to compute the
36194 execution history for the @samp{record btrace} command. Both the
36195 information and the format in which it is printed depend on the btrace
36200 For the BTS recording format, print a list of blocks of sequential
36201 code. For each block, the following information is printed:
36205 Newer blocks have higher numbers. The oldest block has number zero.
36206 @item Lowest @samp{PC}
36207 @item Highest @samp{PC}
36211 For the Intel Processor Trace recording format, print a list of
36212 Intel Processor Trace packets. For each packet, the following
36213 information is printed:
36216 @item Packet number
36217 Newer packets have higher numbers. The oldest packet has number zero.
36219 The packet's offset in the trace stream.
36220 @item Packet opcode and payload
36224 @kindex maint btrace clear-packet-history
36225 @item maint btrace clear-packet-history
36226 Discards the cached packet history printed by the @samp{maint btrace
36227 packet-history} command. The history will be computed again when
36230 @kindex maint btrace clear
36231 @item maint btrace clear
36232 Discard the branch trace data. The data will be fetched anew and the
36233 branch trace will be recomputed when needed.
36235 This implicitly truncates the branch trace to a single branch trace
36236 buffer. When updating branch trace incrementally, the branch trace
36237 available to @value{GDBN} may be bigger than a single branch trace
36240 @kindex maint set btrace pt skip-pad
36241 @item maint set btrace pt skip-pad
36242 @kindex maint show btrace pt skip-pad
36243 @item maint show btrace pt skip-pad
36244 Control whether @value{GDBN} will skip PAD packets when computing the
36247 @kindex set displaced-stepping
36248 @kindex show displaced-stepping
36249 @cindex displaced stepping support
36250 @cindex out-of-line single-stepping
36251 @item set displaced-stepping
36252 @itemx show displaced-stepping
36253 Control whether or not @value{GDBN} will do @dfn{displaced stepping}
36254 if the target supports it. Displaced stepping is a way to single-step
36255 over breakpoints without removing them from the inferior, by executing
36256 an out-of-line copy of the instruction that was originally at the
36257 breakpoint location. It is also known as out-of-line single-stepping.
36260 @item set displaced-stepping on
36261 If the target architecture supports it, @value{GDBN} will use
36262 displaced stepping to step over breakpoints.
36264 @item set displaced-stepping off
36265 @value{GDBN} will not use displaced stepping to step over breakpoints,
36266 even if such is supported by the target architecture.
36268 @cindex non-stop mode, and @samp{set displaced-stepping}
36269 @item set displaced-stepping auto
36270 This is the default mode. @value{GDBN} will use displaced stepping
36271 only if non-stop mode is active (@pxref{Non-Stop Mode}) and the target
36272 architecture supports displaced stepping.
36275 @kindex maint check-psymtabs
36276 @item maint check-psymtabs
36277 Check the consistency of currently expanded psymtabs versus symtabs.
36278 Use this to check, for example, whether a symbol is in one but not the other.
36280 @kindex maint check-symtabs
36281 @item maint check-symtabs
36282 Check the consistency of currently expanded symtabs.
36284 @kindex maint expand-symtabs
36285 @item maint expand-symtabs [@var{regexp}]
36286 Expand symbol tables.
36287 If @var{regexp} is specified, only expand symbol tables for file
36288 names matching @var{regexp}.
36290 @kindex maint set catch-demangler-crashes
36291 @kindex maint show catch-demangler-crashes
36292 @cindex demangler crashes
36293 @item maint set catch-demangler-crashes [on|off]
36294 @itemx maint show catch-demangler-crashes
36295 Control whether @value{GDBN} should attempt to catch crashes in the
36296 symbol name demangler. The default is to attempt to catch crashes.
36297 If enabled, the first time a crash is caught, a core file is created,
36298 the offending symbol is displayed and the user is presented with the
36299 option to terminate the current session.
36301 @kindex maint cplus first_component
36302 @item maint cplus first_component @var{name}
36303 Print the first C@t{++} class/namespace component of @var{name}.
36305 @kindex maint cplus namespace
36306 @item maint cplus namespace
36307 Print the list of possible C@t{++} namespaces.
36309 @kindex maint deprecate
36310 @kindex maint undeprecate
36311 @cindex deprecated commands
36312 @item maint deprecate @var{command} @r{[}@var{replacement}@r{]}
36313 @itemx maint undeprecate @var{command}
36314 Deprecate or undeprecate the named @var{command}. Deprecated commands
36315 cause @value{GDBN} to issue a warning when you use them. The optional
36316 argument @var{replacement} says which newer command should be used in
36317 favor of the deprecated one; if it is given, @value{GDBN} will mention
36318 the replacement as part of the warning.
36320 @kindex maint dump-me
36321 @item maint dump-me
36322 @cindex @code{SIGQUIT} signal, dump core of @value{GDBN}
36323 Cause a fatal signal in the debugger and force it to dump its core.
36324 This is supported only on systems which support aborting a program
36325 with the @code{SIGQUIT} signal.
36327 @kindex maint internal-error
36328 @kindex maint internal-warning
36329 @kindex maint demangler-warning
36330 @cindex demangler crashes
36331 @item maint internal-error @r{[}@var{message-text}@r{]}
36332 @itemx maint internal-warning @r{[}@var{message-text}@r{]}
36333 @itemx maint demangler-warning @r{[}@var{message-text}@r{]}
36335 Cause @value{GDBN} to call the internal function @code{internal_error},
36336 @code{internal_warning} or @code{demangler_warning} and hence behave
36337 as though an internal problem has been detected. In addition to
36338 reporting the internal problem, these functions give the user the
36339 opportunity to either quit @value{GDBN} or (for @code{internal_error}
36340 and @code{internal_warning}) create a core file of the current
36341 @value{GDBN} session.
36343 These commands take an optional parameter @var{message-text} that is
36344 used as the text of the error or warning message.
36346 Here's an example of using @code{internal-error}:
36349 (@value{GDBP}) @kbd{maint internal-error testing, 1, 2}
36350 @dots{}/maint.c:121: internal-error: testing, 1, 2
36351 A problem internal to GDB has been detected. Further
36352 debugging may prove unreliable.
36353 Quit this debugging session? (y or n) @kbd{n}
36354 Create a core file? (y or n) @kbd{n}
36358 @cindex @value{GDBN} internal error
36359 @cindex internal errors, control of @value{GDBN} behavior
36360 @cindex demangler crashes
36362 @kindex maint set internal-error
36363 @kindex maint show internal-error
36364 @kindex maint set internal-warning
36365 @kindex maint show internal-warning
36366 @kindex maint set demangler-warning
36367 @kindex maint show demangler-warning
36368 @item maint set internal-error @var{action} [ask|yes|no]
36369 @itemx maint show internal-error @var{action}
36370 @itemx maint set internal-warning @var{action} [ask|yes|no]
36371 @itemx maint show internal-warning @var{action}
36372 @itemx maint set demangler-warning @var{action} [ask|yes|no]
36373 @itemx maint show demangler-warning @var{action}
36374 When @value{GDBN} reports an internal problem (error or warning) it
36375 gives the user the opportunity to both quit @value{GDBN} and create a
36376 core file of the current @value{GDBN} session. These commands let you
36377 override the default behaviour for each particular @var{action},
36378 described in the table below.
36382 You can specify that @value{GDBN} should always (yes) or never (no)
36383 quit. The default is to ask the user what to do.
36386 You can specify that @value{GDBN} should always (yes) or never (no)
36387 create a core file. The default is to ask the user what to do. Note
36388 that there is no @code{corefile} option for @code{demangler-warning}:
36389 demangler warnings always create a core file and this cannot be
36393 @kindex maint packet
36394 @item maint packet @var{text}
36395 If @value{GDBN} is talking to an inferior via the serial protocol,
36396 then this command sends the string @var{text} to the inferior, and
36397 displays the response packet. @value{GDBN} supplies the initial
36398 @samp{$} character, the terminating @samp{#} character, and the
36401 @kindex maint print architecture
36402 @item maint print architecture @r{[}@var{file}@r{]}
36403 Print the entire architecture configuration. The optional argument
36404 @var{file} names the file where the output goes.
36406 @kindex maint print c-tdesc @r{[}@var{file}@r{]}
36407 @item maint print c-tdesc
36408 Print the target description (@pxref{Target Descriptions}) as
36409 a C source file. By default, the target description is for the current
36410 target, but if the optional argument @var{file} is provided, that file
36411 is used to produce the description. The @var{file} should be an XML
36412 document, of the form described in @ref{Target Description Format}.
36413 The created source file is built into @value{GDBN} when @value{GDBN} is
36414 built again. This command is used by developers after they add or
36415 modify XML target descriptions.
36417 @kindex maint check xml-descriptions
36418 @item maint check xml-descriptions @var{dir}
36419 Check that the target descriptions dynamically created by @value{GDBN}
36420 equal the descriptions created from XML files found in @var{dir}.
36422 @anchor{maint check libthread-db}
36423 @kindex maint check libthread-db
36424 @item maint check libthread-db
36425 Run integrity checks on the current inferior's thread debugging
36426 library. This exercises all @code{libthread_db} functionality used by
36427 @value{GDBN} on GNU/Linux systems, and by extension also exercises the
36428 @code{proc_service} functions provided by @value{GDBN} that
36429 @code{libthread_db} uses. Note that parts of the test may be skipped
36430 on some platforms when debugging core files.
36432 @kindex maint print dummy-frames
36433 @item maint print dummy-frames
36434 Prints the contents of @value{GDBN}'s internal dummy-frame stack.
36437 (@value{GDBP}) @kbd{b add}
36439 (@value{GDBP}) @kbd{print add(2,3)}
36440 Breakpoint 2, add (a=2, b=3) at @dots{}
36442 The program being debugged stopped while in a function called from GDB.
36444 (@value{GDBP}) @kbd{maint print dummy-frames}
36445 0xa8206d8: id=@{stack=0xbfffe734,code=0xbfffe73f,!special@}, ptid=process 9353
36449 Takes an optional file parameter.
36451 @kindex maint print registers
36452 @kindex maint print raw-registers
36453 @kindex maint print cooked-registers
36454 @kindex maint print register-groups
36455 @kindex maint print remote-registers
36456 @item maint print registers @r{[}@var{file}@r{]}
36457 @itemx maint print raw-registers @r{[}@var{file}@r{]}
36458 @itemx maint print cooked-registers @r{[}@var{file}@r{]}
36459 @itemx maint print register-groups @r{[}@var{file}@r{]}
36460 @itemx maint print remote-registers @r{[}@var{file}@r{]}
36461 Print @value{GDBN}'s internal register data structures.
36463 The command @code{maint print raw-registers} includes the contents of
36464 the raw register cache; the command @code{maint print
36465 cooked-registers} includes the (cooked) value of all registers,
36466 including registers which aren't available on the target nor visible
36467 to user; the command @code{maint print register-groups} includes the
36468 groups that each register is a member of; and the command @code{maint
36469 print remote-registers} includes the remote target's register numbers
36470 and offsets in the `G' packets.
36472 These commands take an optional parameter, a file name to which to
36473 write the information.
36475 @kindex maint print reggroups
36476 @item maint print reggroups @r{[}@var{file}@r{]}
36477 Print @value{GDBN}'s internal register group data structures. The
36478 optional argument @var{file} tells to what file to write the
36481 The register groups info looks like this:
36484 (@value{GDBP}) @kbd{maint print reggroups}
36497 This command forces @value{GDBN} to flush its internal register cache.
36499 @kindex maint print objfiles
36500 @cindex info for known object files
36501 @item maint print objfiles @r{[}@var{regexp}@r{]}
36502 Print a dump of all known object files.
36503 If @var{regexp} is specified, only print object files whose names
36504 match @var{regexp}. For each object file, this command prints its name,
36505 address in memory, and all of its psymtabs and symtabs.
36507 @kindex maint print user-registers
36508 @cindex user registers
36509 @item maint print user-registers
36510 List all currently available @dfn{user registers}. User registers
36511 typically provide alternate names for actual hardware registers. They
36512 include the four ``standard'' registers @code{$fp}, @code{$pc},
36513 @code{$sp}, and @code{$ps}. @xref{standard registers}. User
36514 registers can be used in expressions in the same way as the canonical
36515 register names, but only the latter are listed by the @code{info
36516 registers} and @code{maint print registers} commands.
36518 @kindex maint print section-scripts
36519 @cindex info for known .debug_gdb_scripts-loaded scripts
36520 @item maint print section-scripts [@var{regexp}]
36521 Print a dump of scripts specified in the @code{.debug_gdb_section} section.
36522 If @var{regexp} is specified, only print scripts loaded by object files
36523 matching @var{regexp}.
36524 For each script, this command prints its name as specified in the objfile,
36525 and the full path if known.
36526 @xref{dotdebug_gdb_scripts section}.
36528 @kindex maint print statistics
36529 @cindex bcache statistics
36530 @item maint print statistics
36531 This command prints, for each object file in the program, various data
36532 about that object file followed by the byte cache (@dfn{bcache})
36533 statistics for the object file. The objfile data includes the number
36534 of minimal, partial, full, and stabs symbols, the number of types
36535 defined by the objfile, the number of as yet unexpanded psym tables,
36536 the number of line tables and string tables, and the amount of memory
36537 used by the various tables. The bcache statistics include the counts,
36538 sizes, and counts of duplicates of all and unique objects, max,
36539 average, and median entry size, total memory used and its overhead and
36540 savings, and various measures of the hash table size and chain
36543 @kindex maint print target-stack
36544 @cindex target stack description
36545 @item maint print target-stack
36546 A @dfn{target} is an interface between the debugger and a particular
36547 kind of file or process. Targets can be stacked in @dfn{strata},
36548 so that more than one target can potentially respond to a request.
36549 In particular, memory accesses will walk down the stack of targets
36550 until they find a target that is interested in handling that particular
36553 This command prints a short description of each layer that was pushed on
36554 the @dfn{target stack}, starting from the top layer down to the bottom one.
36556 @kindex maint print type
36557 @cindex type chain of a data type
36558 @item maint print type @var{expr}
36559 Print the type chain for a type specified by @var{expr}. The argument
36560 can be either a type name or a symbol. If it is a symbol, the type of
36561 that symbol is described. The type chain produced by this command is
36562 a recursive definition of the data type as stored in @value{GDBN}'s
36563 data structures, including its flags and contained types.
36565 @kindex maint selftest
36567 @item maint selftest @r{[}@var{filter}@r{]}
36568 Run any self tests that were compiled in to @value{GDBN}. This will
36569 print a message showing how many tests were run, and how many failed.
36570 If a @var{filter} is passed, only the tests with @var{filter} in their
36573 @kindex "maint info selftests"
36575 @item maint info selftests
36576 List the selftests compiled in to @value{GDBN}.
36578 @kindex maint set dwarf always-disassemble
36579 @kindex maint show dwarf always-disassemble
36580 @item maint set dwarf always-disassemble
36581 @item maint show dwarf always-disassemble
36582 Control the behavior of @code{info address} when using DWARF debugging
36585 The default is @code{off}, which means that @value{GDBN} should try to
36586 describe a variable's location in an easily readable format. When
36587 @code{on}, @value{GDBN} will instead display the DWARF location
36588 expression in an assembly-like format. Note that some locations are
36589 too complex for @value{GDBN} to describe simply; in this case you will
36590 always see the disassembly form.
36592 Here is an example of the resulting disassembly:
36595 (gdb) info addr argc
36596 Symbol "argc" is a complex DWARF expression:
36600 For more information on these expressions, see
36601 @uref{http://www.dwarfstd.org/, the DWARF standard}.
36603 @kindex maint set dwarf max-cache-age
36604 @kindex maint show dwarf max-cache-age
36605 @item maint set dwarf max-cache-age
36606 @itemx maint show dwarf max-cache-age
36607 Control the DWARF compilation unit cache.
36609 @cindex DWARF compilation units cache
36610 In object files with inter-compilation-unit references, such as those
36611 produced by the GCC option @samp{-feliminate-dwarf2-dups}, the DWARF
36612 reader needs to frequently refer to previously read compilation units.
36613 This setting controls how long a compilation unit will remain in the
36614 cache if it is not referenced. A higher limit means that cached
36615 compilation units will be stored in memory longer, and more total
36616 memory will be used. Setting it to zero disables caching, which will
36617 slow down @value{GDBN} startup, but reduce memory consumption.
36619 @kindex maint set dwarf unwinders
36620 @kindex maint show dwarf unwinders
36621 @item maint set dwarf unwinders
36622 @itemx maint show dwarf unwinders
36623 Control use of the DWARF frame unwinders.
36625 @cindex DWARF frame unwinders
36626 Many targets that support DWARF debugging use @value{GDBN}'s DWARF
36627 frame unwinders to build the backtrace. Many of these targets will
36628 also have a second mechanism for building the backtrace for use in
36629 cases where DWARF information is not available, this second mechanism
36630 is often an analysis of a function's prologue.
36632 In order to extend testing coverage of the second level stack
36633 unwinding mechanisms it is helpful to be able to disable the DWARF
36634 stack unwinders, this can be done with this switch.
36636 In normal use of @value{GDBN} disabling the DWARF unwinders is not
36637 advisable, there are cases that are better handled through DWARF than
36638 prologue analysis, and the debug experience is likely to be better
36639 with the DWARF frame unwinders enabled.
36641 If DWARF frame unwinders are not supported for a particular target
36642 architecture, then enabling this flag does not cause them to be used.
36643 @kindex maint set profile
36644 @kindex maint show profile
36645 @cindex profiling GDB
36646 @item maint set profile
36647 @itemx maint show profile
36648 Control profiling of @value{GDBN}.
36650 Profiling will be disabled until you use the @samp{maint set profile}
36651 command to enable it. When you enable profiling, the system will begin
36652 collecting timing and execution count data; when you disable profiling or
36653 exit @value{GDBN}, the results will be written to a log file. Remember that
36654 if you use profiling, @value{GDBN} will overwrite the profiling log file
36655 (often called @file{gmon.out}). If you have a record of important profiling
36656 data in a @file{gmon.out} file, be sure to move it to a safe location.
36658 Configuring with @samp{--enable-profiling} arranges for @value{GDBN} to be
36659 compiled with the @samp{-pg} compiler option.
36661 @kindex maint set show-debug-regs
36662 @kindex maint show show-debug-regs
36663 @cindex hardware debug registers
36664 @item maint set show-debug-regs
36665 @itemx maint show show-debug-regs
36666 Control whether to show variables that mirror the hardware debug
36667 registers. Use @code{on} to enable, @code{off} to disable. If
36668 enabled, the debug registers values are shown when @value{GDBN} inserts or
36669 removes a hardware breakpoint or watchpoint, and when the inferior
36670 triggers a hardware-assisted breakpoint or watchpoint.
36672 @kindex maint set show-all-tib
36673 @kindex maint show show-all-tib
36674 @item maint set show-all-tib
36675 @itemx maint show show-all-tib
36676 Control whether to show all non zero areas within a 1k block starting
36677 at thread local base, when using the @samp{info w32 thread-information-block}
36680 @kindex maint set target-async
36681 @kindex maint show target-async
36682 @item maint set target-async
36683 @itemx maint show target-async
36684 This controls whether @value{GDBN} targets operate in synchronous or
36685 asynchronous mode (@pxref{Background Execution}). Normally the
36686 default is asynchronous, if it is available; but this can be changed
36687 to more easily debug problems occurring only in synchronous mode.
36689 @kindex maint set target-non-stop @var{mode} [on|off|auto]
36690 @kindex maint show target-non-stop
36691 @item maint set target-non-stop
36692 @itemx maint show target-non-stop
36694 This controls whether @value{GDBN} targets always operate in non-stop
36695 mode even if @code{set non-stop} is @code{off} (@pxref{Non-Stop
36696 Mode}). The default is @code{auto}, meaning non-stop mode is enabled
36697 if supported by the target.
36700 @item maint set target-non-stop auto
36701 This is the default mode. @value{GDBN} controls the target in
36702 non-stop mode if the target supports it.
36704 @item maint set target-non-stop on
36705 @value{GDBN} controls the target in non-stop mode even if the target
36706 does not indicate support.
36708 @item maint set target-non-stop off
36709 @value{GDBN} does not control the target in non-stop mode even if the
36710 target supports it.
36713 @kindex maint set per-command
36714 @kindex maint show per-command
36715 @item maint set per-command
36716 @itemx maint show per-command
36717 @cindex resources used by commands
36719 @value{GDBN} can display the resources used by each command.
36720 This is useful in debugging performance problems.
36723 @item maint set per-command space [on|off]
36724 @itemx maint show per-command space
36725 Enable or disable the printing of the memory used by GDB for each command.
36726 If enabled, @value{GDBN} will display how much memory each command
36727 took, following the command's own output.
36728 This can also be requested by invoking @value{GDBN} with the
36729 @option{--statistics} command-line switch (@pxref{Mode Options}).
36731 @item maint set per-command time [on|off]
36732 @itemx maint show per-command time
36733 Enable or disable the printing of the execution time of @value{GDBN}
36735 If enabled, @value{GDBN} will display how much time it
36736 took to execute each command, following the command's own output.
36737 Both CPU time and wallclock time are printed.
36738 Printing both is useful when trying to determine whether the cost is
36739 CPU or, e.g., disk/network latency.
36740 Note that the CPU time printed is for @value{GDBN} only, it does not include
36741 the execution time of the inferior because there's no mechanism currently
36742 to compute how much time was spent by @value{GDBN} and how much time was
36743 spent by the program been debugged.
36744 This can also be requested by invoking @value{GDBN} with the
36745 @option{--statistics} command-line switch (@pxref{Mode Options}).
36747 @item maint set per-command symtab [on|off]
36748 @itemx maint show per-command symtab
36749 Enable or disable the printing of basic symbol table statistics
36751 If enabled, @value{GDBN} will display the following information:
36755 number of symbol tables
36757 number of primary symbol tables
36759 number of blocks in the blockvector
36763 @kindex maint set check-libthread-db
36764 @kindex maint show check-libthread-db
36765 @item maint set check-libthread-db [on|off]
36766 @itemx maint show check-libthread-db
36767 Control whether @value{GDBN} should run integrity checks on inferior
36768 specific thread debugging libraries as they are loaded. The default
36769 is not to perform such checks. If any check fails @value{GDBN} will
36770 unload the library and continue searching for a suitable candidate as
36771 described in @ref{set libthread-db-search-path}. For more information
36772 about the tests, see @ref{maint check libthread-db}.
36774 @kindex maint space
36775 @cindex memory used by commands
36776 @item maint space @var{value}
36777 An alias for @code{maint set per-command space}.
36778 A non-zero value enables it, zero disables it.
36781 @cindex time of command execution
36782 @item maint time @var{value}
36783 An alias for @code{maint set per-command time}.
36784 A non-zero value enables it, zero disables it.
36786 @kindex maint translate-address
36787 @item maint translate-address @r{[}@var{section}@r{]} @var{addr}
36788 Find the symbol stored at the location specified by the address
36789 @var{addr} and an optional section name @var{section}. If found,
36790 @value{GDBN} prints the name of the closest symbol and an offset from
36791 the symbol's location to the specified address. This is similar to
36792 the @code{info address} command (@pxref{Symbols}), except that this
36793 command also allows to find symbols in other sections.
36795 If section was not specified, the section in which the symbol was found
36796 is also printed. For dynamically linked executables, the name of
36797 executable or shared library containing the symbol is printed as well.
36801 The following command is useful for non-interactive invocations of
36802 @value{GDBN}, such as in the test suite.
36805 @item set watchdog @var{nsec}
36806 @kindex set watchdog
36807 @cindex watchdog timer
36808 @cindex timeout for commands
36809 Set the maximum number of seconds @value{GDBN} will wait for the
36810 target operation to finish. If this time expires, @value{GDBN}
36811 reports and error and the command is aborted.
36813 @item show watchdog
36814 Show the current setting of the target wait timeout.
36817 @node Remote Protocol
36818 @appendix @value{GDBN} Remote Serial Protocol
36823 * Stop Reply Packets::
36824 * General Query Packets::
36825 * Architecture-Specific Protocol Details::
36826 * Tracepoint Packets::
36827 * Host I/O Packets::
36829 * Notification Packets::
36830 * Remote Non-Stop::
36831 * Packet Acknowledgment::
36833 * File-I/O Remote Protocol Extension::
36834 * Library List Format::
36835 * Library List Format for SVR4 Targets::
36836 * Memory Map Format::
36837 * Thread List Format::
36838 * Traceframe Info Format::
36839 * Branch Trace Format::
36840 * Branch Trace Configuration Format::
36846 There may be occasions when you need to know something about the
36847 protocol---for example, if there is only one serial port to your target
36848 machine, you might want your program to do something special if it
36849 recognizes a packet meant for @value{GDBN}.
36851 In the examples below, @samp{->} and @samp{<-} are used to indicate
36852 transmitted and received data, respectively.
36854 @cindex protocol, @value{GDBN} remote serial
36855 @cindex serial protocol, @value{GDBN} remote
36856 @cindex remote serial protocol
36857 All @value{GDBN} commands and responses (other than acknowledgments
36858 and notifications, see @ref{Notification Packets}) are sent as a
36859 @var{packet}. A @var{packet} is introduced with the character
36860 @samp{$}, the actual @var{packet-data}, and the terminating character
36861 @samp{#} followed by a two-digit @var{checksum}:
36864 @code{$}@var{packet-data}@code{#}@var{checksum}
36868 @cindex checksum, for @value{GDBN} remote
36870 The two-digit @var{checksum} is computed as the modulo 256 sum of all
36871 characters between the leading @samp{$} and the trailing @samp{#} (an
36872 eight bit unsigned checksum).
36874 Implementors should note that prior to @value{GDBN} 5.0 the protocol
36875 specification also included an optional two-digit @var{sequence-id}:
36878 @code{$}@var{sequence-id}@code{:}@var{packet-data}@code{#}@var{checksum}
36881 @cindex sequence-id, for @value{GDBN} remote
36883 That @var{sequence-id} was appended to the acknowledgment. @value{GDBN}
36884 has never output @var{sequence-id}s. Stubs that handle packets added
36885 since @value{GDBN} 5.0 must not accept @var{sequence-id}.
36887 When either the host or the target machine receives a packet, the first
36888 response expected is an acknowledgment: either @samp{+} (to indicate
36889 the package was received correctly) or @samp{-} (to request
36893 -> @code{$}@var{packet-data}@code{#}@var{checksum}
36898 The @samp{+}/@samp{-} acknowledgments can be disabled
36899 once a connection is established.
36900 @xref{Packet Acknowledgment}, for details.
36902 The host (@value{GDBN}) sends @var{command}s, and the target (the
36903 debugging stub incorporated in your program) sends a @var{response}. In
36904 the case of step and continue @var{command}s, the response is only sent
36905 when the operation has completed, and the target has again stopped all
36906 threads in all attached processes. This is the default all-stop mode
36907 behavior, but the remote protocol also supports @value{GDBN}'s non-stop
36908 execution mode; see @ref{Remote Non-Stop}, for details.
36910 @var{packet-data} consists of a sequence of characters with the
36911 exception of @samp{#} and @samp{$} (see @samp{X} packet for additional
36914 @cindex remote protocol, field separator
36915 Fields within the packet should be separated using @samp{,} @samp{;} or
36916 @samp{:}. Except where otherwise noted all numbers are represented in
36917 @sc{hex} with leading zeros suppressed.
36919 Implementors should note that prior to @value{GDBN} 5.0, the character
36920 @samp{:} could not appear as the third character in a packet (as it
36921 would potentially conflict with the @var{sequence-id}).
36923 @cindex remote protocol, binary data
36924 @anchor{Binary Data}
36925 Binary data in most packets is encoded either as two hexadecimal
36926 digits per byte of binary data. This allowed the traditional remote
36927 protocol to work over connections which were only seven-bit clean.
36928 Some packets designed more recently assume an eight-bit clean
36929 connection, and use a more efficient encoding to send and receive
36932 The binary data representation uses @code{7d} (@sc{ascii} @samp{@}})
36933 as an escape character. Any escaped byte is transmitted as the escape
36934 character followed by the original character XORed with @code{0x20}.
36935 For example, the byte @code{0x7d} would be transmitted as the two
36936 bytes @code{0x7d 0x5d}. The bytes @code{0x23} (@sc{ascii} @samp{#}),
36937 @code{0x24} (@sc{ascii} @samp{$}), and @code{0x7d} (@sc{ascii}
36938 @samp{@}}) must always be escaped. Responses sent by the stub
36939 must also escape @code{0x2a} (@sc{ascii} @samp{*}), so that it
36940 is not interpreted as the start of a run-length encoded sequence
36943 Response @var{data} can be run-length encoded to save space.
36944 Run-length encoding replaces runs of identical characters with one
36945 instance of the repeated character, followed by a @samp{*} and a
36946 repeat count. The repeat count is itself sent encoded, to avoid
36947 binary characters in @var{data}: a value of @var{n} is sent as
36948 @code{@var{n}+29}. For a repeat count greater or equal to 3, this
36949 produces a printable @sc{ascii} character, e.g.@: a space (@sc{ascii}
36950 code 32) for a repeat count of 3. (This is because run-length
36951 encoding starts to win for counts 3 or more.) Thus, for example,
36952 @samp{0* } is a run-length encoding of ``0000'': the space character
36953 after @samp{*} means repeat the leading @code{0} @w{@code{32 - 29 =
36956 The printable characters @samp{#} and @samp{$} or with a numeric value
36957 greater than 126 must not be used. Runs of six repeats (@samp{#}) or
36958 seven repeats (@samp{$}) can be expanded using a repeat count of only
36959 five (@samp{"}). For example, @samp{00000000} can be encoded as
36962 The error response returned for some packets includes a two character
36963 error number. That number is not well defined.
36965 @cindex empty response, for unsupported packets
36966 For any @var{command} not supported by the stub, an empty response
36967 (@samp{$#00}) should be returned. That way it is possible to extend the
36968 protocol. A newer @value{GDBN} can tell if a packet is supported based
36971 At a minimum, a stub is required to support the @samp{g} and @samp{G}
36972 commands for register access, and the @samp{m} and @samp{M} commands
36973 for memory access. Stubs that only control single-threaded targets
36974 can implement run control with the @samp{c} (continue), and @samp{s}
36975 (step) commands. Stubs that support multi-threading targets should
36976 support the @samp{vCont} command. All other commands are optional.
36981 The following table provides a complete list of all currently defined
36982 @var{command}s and their corresponding response @var{data}.
36983 @xref{File-I/O Remote Protocol Extension}, for details about the File
36984 I/O extension of the remote protocol.
36986 Each packet's description has a template showing the packet's overall
36987 syntax, followed by an explanation of the packet's meaning. We
36988 include spaces in some of the templates for clarity; these are not
36989 part of the packet's syntax. No @value{GDBN} packet uses spaces to
36990 separate its components. For example, a template like @samp{foo
36991 @var{bar} @var{baz}} describes a packet beginning with the three ASCII
36992 bytes @samp{foo}, followed by a @var{bar}, followed directly by a
36993 @var{baz}. @value{GDBN} does not transmit a space character between the
36994 @samp{foo} and the @var{bar}, or between the @var{bar} and the
36997 @cindex @var{thread-id}, in remote protocol
36998 @anchor{thread-id syntax}
36999 Several packets and replies include a @var{thread-id} field to identify
37000 a thread. Normally these are positive numbers with a target-specific
37001 interpretation, formatted as big-endian hex strings. A @var{thread-id}
37002 can also be a literal @samp{-1} to indicate all threads, or @samp{0} to
37005 In addition, the remote protocol supports a multiprocess feature in
37006 which the @var{thread-id} syntax is extended to optionally include both
37007 process and thread ID fields, as @samp{p@var{pid}.@var{tid}}.
37008 The @var{pid} (process) and @var{tid} (thread) components each have the
37009 format described above: a positive number with target-specific
37010 interpretation formatted as a big-endian hex string, literal @samp{-1}
37011 to indicate all processes or threads (respectively), or @samp{0} to
37012 indicate an arbitrary process or thread. Specifying just a process, as
37013 @samp{p@var{pid}}, is equivalent to @samp{p@var{pid}.-1}. It is an
37014 error to specify all processes but a specific thread, such as
37015 @samp{p-1.@var{tid}}. Note that the @samp{p} prefix is @emph{not} used
37016 for those packets and replies explicitly documented to include a process
37017 ID, rather than a @var{thread-id}.
37019 The multiprocess @var{thread-id} syntax extensions are only used if both
37020 @value{GDBN} and the stub report support for the @samp{multiprocess}
37021 feature using @samp{qSupported}. @xref{multiprocess extensions}, for
37024 Note that all packet forms beginning with an upper- or lower-case
37025 letter, other than those described here, are reserved for future use.
37027 Here are the packet descriptions.
37032 @cindex @samp{!} packet
37033 @anchor{extended mode}
37034 Enable extended mode. In extended mode, the remote server is made
37035 persistent. The @samp{R} packet is used to restart the program being
37041 The remote target both supports and has enabled extended mode.
37045 @cindex @samp{?} packet
37047 Indicate the reason the target halted. The reply is the same as for
37048 step and continue. This packet has a special interpretation when the
37049 target is in non-stop mode; see @ref{Remote Non-Stop}.
37052 @xref{Stop Reply Packets}, for the reply specifications.
37054 @item A @var{arglen},@var{argnum},@var{arg},@dots{}
37055 @cindex @samp{A} packet
37056 Initialized @code{argv[]} array passed into program. @var{arglen}
37057 specifies the number of bytes in the hex encoded byte stream
37058 @var{arg}. See @code{gdbserver} for more details.
37063 The arguments were set.
37069 @cindex @samp{b} packet
37070 (Don't use this packet; its behavior is not well-defined.)
37071 Change the serial line speed to @var{baud}.
37073 JTC: @emph{When does the transport layer state change? When it's
37074 received, or after the ACK is transmitted. In either case, there are
37075 problems if the command or the acknowledgment packet is dropped.}
37077 Stan: @emph{If people really wanted to add something like this, and get
37078 it working for the first time, they ought to modify ser-unix.c to send
37079 some kind of out-of-band message to a specially-setup stub and have the
37080 switch happen "in between" packets, so that from remote protocol's point
37081 of view, nothing actually happened.}
37083 @item B @var{addr},@var{mode}
37084 @cindex @samp{B} packet
37085 Set (@var{mode} is @samp{S}) or clear (@var{mode} is @samp{C}) a
37086 breakpoint at @var{addr}.
37088 Don't use this packet. Use the @samp{Z} and @samp{z} packets instead
37089 (@pxref{insert breakpoint or watchpoint packet}).
37091 @cindex @samp{bc} packet
37094 Backward continue. Execute the target system in reverse. No parameter.
37095 @xref{Reverse Execution}, for more information.
37098 @xref{Stop Reply Packets}, for the reply specifications.
37100 @cindex @samp{bs} packet
37103 Backward single step. Execute one instruction in reverse. No parameter.
37104 @xref{Reverse Execution}, for more information.
37107 @xref{Stop Reply Packets}, for the reply specifications.
37109 @item c @r{[}@var{addr}@r{]}
37110 @cindex @samp{c} packet
37111 Continue at @var{addr}, which is the address to resume. If @var{addr}
37112 is omitted, resume at current address.
37114 This packet is deprecated for multi-threading support. @xref{vCont
37118 @xref{Stop Reply Packets}, for the reply specifications.
37120 @item C @var{sig}@r{[};@var{addr}@r{]}
37121 @cindex @samp{C} packet
37122 Continue with signal @var{sig} (hex signal number). If
37123 @samp{;@var{addr}} is omitted, resume at same address.
37125 This packet is deprecated for multi-threading support. @xref{vCont
37129 @xref{Stop Reply Packets}, for the reply specifications.
37132 @cindex @samp{d} packet
37135 Don't use this packet; instead, define a general set packet
37136 (@pxref{General Query Packets}).
37140 @cindex @samp{D} packet
37141 The first form of the packet is used to detach @value{GDBN} from the
37142 remote system. It is sent to the remote target
37143 before @value{GDBN} disconnects via the @code{detach} command.
37145 The second form, including a process ID, is used when multiprocess
37146 protocol extensions are enabled (@pxref{multiprocess extensions}), to
37147 detach only a specific process. The @var{pid} is specified as a
37148 big-endian hex string.
37158 @item F @var{RC},@var{EE},@var{CF};@var{XX}
37159 @cindex @samp{F} packet
37160 A reply from @value{GDBN} to an @samp{F} packet sent by the target.
37161 This is part of the File-I/O protocol extension. @xref{File-I/O
37162 Remote Protocol Extension}, for the specification.
37165 @anchor{read registers packet}
37166 @cindex @samp{g} packet
37167 Read general registers.
37171 @item @var{XX@dots{}}
37172 Each byte of register data is described by two hex digits. The bytes
37173 with the register are transmitted in target byte order. The size of
37174 each register and their position within the @samp{g} packet are
37175 determined by the @value{GDBN} internal gdbarch functions
37176 @code{DEPRECATED_REGISTER_RAW_SIZE} and @code{gdbarch_register_name}.
37178 When reading registers from a trace frame (@pxref{Analyze Collected
37179 Data,,Using the Collected Data}), the stub may also return a string of
37180 literal @samp{x}'s in place of the register data digits, to indicate
37181 that the corresponding register has not been collected, thus its value
37182 is unavailable. For example, for an architecture with 4 registers of
37183 4 bytes each, the following reply indicates to @value{GDBN} that
37184 registers 0 and 2 have not been collected, while registers 1 and 3
37185 have been collected, and both have zero value:
37189 <- @code{xxxxxxxx00000000xxxxxxxx00000000}
37196 @item G @var{XX@dots{}}
37197 @cindex @samp{G} packet
37198 Write general registers. @xref{read registers packet}, for a
37199 description of the @var{XX@dots{}} data.
37209 @item H @var{op} @var{thread-id}
37210 @cindex @samp{H} packet
37211 Set thread for subsequent operations (@samp{m}, @samp{M}, @samp{g},
37212 @samp{G}, et.al.). Depending on the operation to be performed, @var{op}
37213 should be @samp{c} for step and continue operations (note that this
37214 is deprecated, supporting the @samp{vCont} command is a better
37215 option), and @samp{g} for other operations. The thread designator
37216 @var{thread-id} has the format and interpretation described in
37217 @ref{thread-id syntax}.
37228 @c 'H': How restrictive (or permissive) is the thread model. If a
37229 @c thread is selected and stopped, are other threads allowed
37230 @c to continue to execute? As I mentioned above, I think the
37231 @c semantics of each command when a thread is selected must be
37232 @c described. For example:
37234 @c 'g': If the stub supports threads and a specific thread is
37235 @c selected, returns the register block from that thread;
37236 @c otherwise returns current registers.
37238 @c 'G' If the stub supports threads and a specific thread is
37239 @c selected, sets the registers of the register block of
37240 @c that thread; otherwise sets current registers.
37242 @item i @r{[}@var{addr}@r{[},@var{nnn}@r{]]}
37243 @anchor{cycle step packet}
37244 @cindex @samp{i} packet
37245 Step the remote target by a single clock cycle. If @samp{,@var{nnn}} is
37246 present, cycle step @var{nnn} cycles. If @var{addr} is present, cycle
37247 step starting at that address.
37250 @cindex @samp{I} packet
37251 Signal, then cycle step. @xref{step with signal packet}. @xref{cycle
37255 @cindex @samp{k} packet
37258 The exact effect of this packet is not specified.
37260 For a bare-metal target, it may power cycle or reset the target
37261 system. For that reason, the @samp{k} packet has no reply.
37263 For a single-process target, it may kill that process if possible.
37265 A multiple-process target may choose to kill just one process, or all
37266 that are under @value{GDBN}'s control. For more precise control, use
37267 the vKill packet (@pxref{vKill packet}).
37269 If the target system immediately closes the connection in response to
37270 @samp{k}, @value{GDBN} does not consider the lack of packet
37271 acknowledgment to be an error, and assumes the kill was successful.
37273 If connected using @kbd{target extended-remote}, and the target does
37274 not close the connection in response to a kill request, @value{GDBN}
37275 probes the target state as if a new connection was opened
37276 (@pxref{? packet}).
37278 @item m @var{addr},@var{length}
37279 @cindex @samp{m} packet
37280 Read @var{length} addressable memory units starting at address @var{addr}
37281 (@pxref{addressable memory unit}). Note that @var{addr} may not be aligned to
37282 any particular boundary.
37284 The stub need not use any particular size or alignment when gathering
37285 data from memory for the response; even if @var{addr} is word-aligned
37286 and @var{length} is a multiple of the word size, the stub is free to
37287 use byte accesses, or not. For this reason, this packet may not be
37288 suitable for accessing memory-mapped I/O devices.
37289 @cindex alignment of remote memory accesses
37290 @cindex size of remote memory accesses
37291 @cindex memory, alignment and size of remote accesses
37295 @item @var{XX@dots{}}
37296 Memory contents; each byte is transmitted as a two-digit hexadecimal number.
37297 The reply may contain fewer addressable memory units than requested if the
37298 server was able to read only part of the region of memory.
37303 @item M @var{addr},@var{length}:@var{XX@dots{}}
37304 @cindex @samp{M} packet
37305 Write @var{length} addressable memory units starting at address @var{addr}
37306 (@pxref{addressable memory unit}). The data is given by @var{XX@dots{}}; each
37307 byte is transmitted as a two-digit hexadecimal number.
37314 for an error (this includes the case where only part of the data was
37319 @cindex @samp{p} packet
37320 Read the value of register @var{n}; @var{n} is in hex.
37321 @xref{read registers packet}, for a description of how the returned
37322 register value is encoded.
37326 @item @var{XX@dots{}}
37327 the register's value
37331 Indicating an unrecognized @var{query}.
37334 @item P @var{n@dots{}}=@var{r@dots{}}
37335 @anchor{write register packet}
37336 @cindex @samp{P} packet
37337 Write register @var{n@dots{}} with value @var{r@dots{}}. The register
37338 number @var{n} is in hexadecimal, and @var{r@dots{}} contains two hex
37339 digits for each byte in the register (target byte order).
37349 @item q @var{name} @var{params}@dots{}
37350 @itemx Q @var{name} @var{params}@dots{}
37351 @cindex @samp{q} packet
37352 @cindex @samp{Q} packet
37353 General query (@samp{q}) and set (@samp{Q}). These packets are
37354 described fully in @ref{General Query Packets}.
37357 @cindex @samp{r} packet
37358 Reset the entire system.
37360 Don't use this packet; use the @samp{R} packet instead.
37363 @cindex @samp{R} packet
37364 Restart the program being debugged. The @var{XX}, while needed, is ignored.
37365 This packet is only available in extended mode (@pxref{extended mode}).
37367 The @samp{R} packet has no reply.
37369 @item s @r{[}@var{addr}@r{]}
37370 @cindex @samp{s} packet
37371 Single step, resuming at @var{addr}. If
37372 @var{addr} is omitted, resume at same address.
37374 This packet is deprecated for multi-threading support. @xref{vCont
37378 @xref{Stop Reply Packets}, for the reply specifications.
37380 @item S @var{sig}@r{[};@var{addr}@r{]}
37381 @anchor{step with signal packet}
37382 @cindex @samp{S} packet
37383 Step with signal. This is analogous to the @samp{C} packet, but
37384 requests a single-step, rather than a normal resumption of execution.
37386 This packet is deprecated for multi-threading support. @xref{vCont
37390 @xref{Stop Reply Packets}, for the reply specifications.
37392 @item t @var{addr}:@var{PP},@var{MM}
37393 @cindex @samp{t} packet
37394 Search backwards starting at address @var{addr} for a match with pattern
37395 @var{PP} and mask @var{MM}, both of which are are 4 byte long.
37396 There must be at least 3 digits in @var{addr}.
37398 @item T @var{thread-id}
37399 @cindex @samp{T} packet
37400 Find out if the thread @var{thread-id} is alive. @xref{thread-id syntax}.
37405 thread is still alive
37411 Packets starting with @samp{v} are identified by a multi-letter name,
37412 up to the first @samp{;} or @samp{?} (or the end of the packet).
37414 @item vAttach;@var{pid}
37415 @cindex @samp{vAttach} packet
37416 Attach to a new process with the specified process ID @var{pid}.
37417 The process ID is a
37418 hexadecimal integer identifying the process. In all-stop mode, all
37419 threads in the attached process are stopped; in non-stop mode, it may be
37420 attached without being stopped if that is supported by the target.
37422 @c In non-stop mode, on a successful vAttach, the stub should set the
37423 @c current thread to a thread of the newly-attached process. After
37424 @c attaching, GDB queries for the attached process's thread ID with qC.
37425 @c Also note that, from a user perspective, whether or not the
37426 @c target is stopped on attach in non-stop mode depends on whether you
37427 @c use the foreground or background version of the attach command, not
37428 @c on what vAttach does; GDB does the right thing with respect to either
37429 @c stopping or restarting threads.
37431 This packet is only available in extended mode (@pxref{extended mode}).
37437 @item @r{Any stop packet}
37438 for success in all-stop mode (@pxref{Stop Reply Packets})
37440 for success in non-stop mode (@pxref{Remote Non-Stop})
37443 @item vCont@r{[};@var{action}@r{[}:@var{thread-id}@r{]]}@dots{}
37444 @cindex @samp{vCont} packet
37445 @anchor{vCont packet}
37446 Resume the inferior, specifying different actions for each thread.
37448 For each inferior thread, the leftmost action with a matching
37449 @var{thread-id} is applied. Threads that don't match any action
37450 remain in their current state. Thread IDs are specified using the
37451 syntax described in @ref{thread-id syntax}. If multiprocess
37452 extensions (@pxref{multiprocess extensions}) are supported, actions
37453 can be specified to match all threads in a process by using the
37454 @samp{p@var{pid}.-1} form of the @var{thread-id}. An action with no
37455 @var{thread-id} matches all threads. Specifying no actions is an
37458 Currently supported actions are:
37464 Continue with signal @var{sig}. The signal @var{sig} should be two hex digits.
37468 Step with signal @var{sig}. The signal @var{sig} should be two hex digits.
37471 @item r @var{start},@var{end}
37472 Step once, and then keep stepping as long as the thread stops at
37473 addresses between @var{start} (inclusive) and @var{end} (exclusive).
37474 The remote stub reports a stop reply when either the thread goes out
37475 of the range or is stopped due to an unrelated reason, such as hitting
37476 a breakpoint. @xref{range stepping}.
37478 If the range is empty (@var{start} == @var{end}), then the action
37479 becomes equivalent to the @samp{s} action. In other words,
37480 single-step once, and report the stop (even if the stepped instruction
37481 jumps to @var{start}).
37483 (A stop reply may be sent at any point even if the PC is still within
37484 the stepping range; for example, it is valid to implement this packet
37485 in a degenerate way as a single instruction step operation.)
37489 The optional argument @var{addr} normally associated with the
37490 @samp{c}, @samp{C}, @samp{s}, and @samp{S} packets is
37491 not supported in @samp{vCont}.
37493 The @samp{t} action is only relevant in non-stop mode
37494 (@pxref{Remote Non-Stop}) and may be ignored by the stub otherwise.
37495 A stop reply should be generated for any affected thread not already stopped.
37496 When a thread is stopped by means of a @samp{t} action,
37497 the corresponding stop reply should indicate that the thread has stopped with
37498 signal @samp{0}, regardless of whether the target uses some other signal
37499 as an implementation detail.
37501 The server must ignore @samp{c}, @samp{C}, @samp{s}, @samp{S}, and
37502 @samp{r} actions for threads that are already running. Conversely,
37503 the server must ignore @samp{t} actions for threads that are already
37506 @emph{Note:} In non-stop mode, a thread is considered running until
37507 @value{GDBN} acknowleges an asynchronous stop notification for it with
37508 the @samp{vStopped} packet (@pxref{Remote Non-Stop}).
37510 The stub must support @samp{vCont} if it reports support for
37511 multiprocess extensions (@pxref{multiprocess extensions}).
37514 @xref{Stop Reply Packets}, for the reply specifications.
37517 @cindex @samp{vCont?} packet
37518 Request a list of actions supported by the @samp{vCont} packet.
37522 @item vCont@r{[};@var{action}@dots{}@r{]}
37523 The @samp{vCont} packet is supported. Each @var{action} is a supported
37524 command in the @samp{vCont} packet.
37526 The @samp{vCont} packet is not supported.
37529 @anchor{vCtrlC packet}
37531 @cindex @samp{vCtrlC} packet
37532 Interrupt remote target as if a control-C was pressed on the remote
37533 terminal. This is the equivalent to reacting to the @code{^C}
37534 (@samp{\003}, the control-C character) character in all-stop mode
37535 while the target is running, except this works in non-stop mode.
37536 @xref{interrupting remote targets}, for more info on the all-stop
37547 @item vFile:@var{operation}:@var{parameter}@dots{}
37548 @cindex @samp{vFile} packet
37549 Perform a file operation on the target system. For details,
37550 see @ref{Host I/O Packets}.
37552 @item vFlashErase:@var{addr},@var{length}
37553 @cindex @samp{vFlashErase} packet
37554 Direct the stub to erase @var{length} bytes of flash starting at
37555 @var{addr}. The region may enclose any number of flash blocks, but
37556 its start and end must fall on block boundaries, as indicated by the
37557 flash block size appearing in the memory map (@pxref{Memory Map
37558 Format}). @value{GDBN} groups flash memory programming operations
37559 together, and sends a @samp{vFlashDone} request after each group; the
37560 stub is allowed to delay erase operation until the @samp{vFlashDone}
37561 packet is received.
37571 @item vFlashWrite:@var{addr}:@var{XX@dots{}}
37572 @cindex @samp{vFlashWrite} packet
37573 Direct the stub to write data to flash address @var{addr}. The data
37574 is passed in binary form using the same encoding as for the @samp{X}
37575 packet (@pxref{Binary Data}). The memory ranges specified by
37576 @samp{vFlashWrite} packets preceding a @samp{vFlashDone} packet must
37577 not overlap, and must appear in order of increasing addresses
37578 (although @samp{vFlashErase} packets for higher addresses may already
37579 have been received; the ordering is guaranteed only between
37580 @samp{vFlashWrite} packets). If a packet writes to an address that was
37581 neither erased by a preceding @samp{vFlashErase} packet nor by some other
37582 target-specific method, the results are unpredictable.
37590 for vFlashWrite addressing non-flash memory
37596 @cindex @samp{vFlashDone} packet
37597 Indicate to the stub that flash programming operation is finished.
37598 The stub is permitted to delay or batch the effects of a group of
37599 @samp{vFlashErase} and @samp{vFlashWrite} packets until a
37600 @samp{vFlashDone} packet is received. The contents of the affected
37601 regions of flash memory are unpredictable until the @samp{vFlashDone}
37602 request is completed.
37604 @item vKill;@var{pid}
37605 @cindex @samp{vKill} packet
37606 @anchor{vKill packet}
37607 Kill the process with the specified process ID @var{pid}, which is a
37608 hexadecimal integer identifying the process. This packet is used in
37609 preference to @samp{k} when multiprocess protocol extensions are
37610 supported; see @ref{multiprocess extensions}.
37620 @item vMustReplyEmpty
37621 @cindex @samp{vMustReplyEmpty} packet
37622 The correct reply to an unknown @samp{v} packet is to return the empty
37623 string, however, some older versions of @command{gdbserver} would
37624 incorrectly return @samp{OK} for unknown @samp{v} packets.
37626 The @samp{vMustReplyEmpty} is used as a feature test to check how
37627 @command{gdbserver} handles unknown packets, it is important that this
37628 packet be handled in the same way as other unknown @samp{v} packets.
37629 If this packet is handled differently to other unknown @samp{v}
37630 packets then it is possile that @value{GDBN} may run into problems in
37631 other areas, specifically around use of @samp{vFile:setfs:}.
37633 @item vRun;@var{filename}@r{[};@var{argument}@r{]}@dots{}
37634 @cindex @samp{vRun} packet
37635 Run the program @var{filename}, passing it each @var{argument} on its
37636 command line. The file and arguments are hex-encoded strings. If
37637 @var{filename} is an empty string, the stub may use a default program
37638 (e.g.@: the last program run). The program is created in the stopped
37641 @c FIXME: What about non-stop mode?
37643 This packet is only available in extended mode (@pxref{extended mode}).
37649 @item @r{Any stop packet}
37650 for success (@pxref{Stop Reply Packets})
37654 @cindex @samp{vStopped} packet
37655 @xref{Notification Packets}.
37657 @item X @var{addr},@var{length}:@var{XX@dots{}}
37659 @cindex @samp{X} packet
37660 Write data to memory, where the data is transmitted in binary.
37661 Memory is specified by its address @var{addr} and number of addressable memory
37662 units @var{length} (@pxref{addressable memory unit});
37663 @samp{@var{XX}@dots{}} is binary data (@pxref{Binary Data}).
37673 @item z @var{type},@var{addr},@var{kind}
37674 @itemx Z @var{type},@var{addr},@var{kind}
37675 @anchor{insert breakpoint or watchpoint packet}
37676 @cindex @samp{z} packet
37677 @cindex @samp{Z} packets
37678 Insert (@samp{Z}) or remove (@samp{z}) a @var{type} breakpoint or
37679 watchpoint starting at address @var{address} of kind @var{kind}.
37681 Each breakpoint and watchpoint packet @var{type} is documented
37684 @emph{Implementation notes: A remote target shall return an empty string
37685 for an unrecognized breakpoint or watchpoint packet @var{type}. A
37686 remote target shall support either both or neither of a given
37687 @samp{Z@var{type}@dots{}} and @samp{z@var{type}@dots{}} packet pair. To
37688 avoid potential problems with duplicate packets, the operations should
37689 be implemented in an idempotent way.}
37691 @item z0,@var{addr},@var{kind}
37692 @itemx Z0,@var{addr},@var{kind}@r{[};@var{cond_list}@dots{}@r{]}@r{[};cmds:@var{persist},@var{cmd_list}@dots{}@r{]}
37693 @cindex @samp{z0} packet
37694 @cindex @samp{Z0} packet
37695 Insert (@samp{Z0}) or remove (@samp{z0}) a software breakpoint at address
37696 @var{addr} of type @var{kind}.
37698 A software breakpoint is implemented by replacing the instruction at
37699 @var{addr} with a software breakpoint or trap instruction. The
37700 @var{kind} is target-specific and typically indicates the size of the
37701 breakpoint in bytes that should be inserted. E.g., the @sc{arm} and
37702 @sc{mips} can insert either a 2 or 4 byte breakpoint. Some
37703 architectures have additional meanings for @var{kind}
37704 (@pxref{Architecture-Specific Protocol Details}); if no
37705 architecture-specific value is being used, it should be @samp{0}.
37706 @var{kind} is hex-encoded. @var{cond_list} is an optional list of
37707 conditional expressions in bytecode form that should be evaluated on
37708 the target's side. These are the conditions that should be taken into
37709 consideration when deciding if the breakpoint trigger should be
37710 reported back to @value{GDBN}.
37712 See also the @samp{swbreak} stop reason (@pxref{swbreak stop reason})
37713 for how to best report a software breakpoint event to @value{GDBN}.
37715 The @var{cond_list} parameter is comprised of a series of expressions,
37716 concatenated without separators. Each expression has the following form:
37720 @item X @var{len},@var{expr}
37721 @var{len} is the length of the bytecode expression and @var{expr} is the
37722 actual conditional expression in bytecode form.
37726 The optional @var{cmd_list} parameter introduces commands that may be
37727 run on the target, rather than being reported back to @value{GDBN}.
37728 The parameter starts with a numeric flag @var{persist}; if the flag is
37729 nonzero, then the breakpoint may remain active and the commands
37730 continue to be run even when @value{GDBN} disconnects from the target.
37731 Following this flag is a series of expressions concatenated with no
37732 separators. Each expression has the following form:
37736 @item X @var{len},@var{expr}
37737 @var{len} is the length of the bytecode expression and @var{expr} is the
37738 actual commands expression in bytecode form.
37742 @emph{Implementation note: It is possible for a target to copy or move
37743 code that contains software breakpoints (e.g., when implementing
37744 overlays). The behavior of this packet, in the presence of such a
37745 target, is not defined.}
37757 @item z1,@var{addr},@var{kind}
37758 @itemx Z1,@var{addr},@var{kind}@r{[};@var{cond_list}@dots{}@r{]}@r{[};cmds:@var{persist},@var{cmd_list}@dots{}@r{]}
37759 @cindex @samp{z1} packet
37760 @cindex @samp{Z1} packet
37761 Insert (@samp{Z1}) or remove (@samp{z1}) a hardware breakpoint at
37762 address @var{addr}.
37764 A hardware breakpoint is implemented using a mechanism that is not
37765 dependent on being able to modify the target's memory. The
37766 @var{kind}, @var{cond_list}, and @var{cmd_list} arguments have the
37767 same meaning as in @samp{Z0} packets.
37769 @emph{Implementation note: A hardware breakpoint is not affected by code
37782 @item z2,@var{addr},@var{kind}
37783 @itemx Z2,@var{addr},@var{kind}
37784 @cindex @samp{z2} packet
37785 @cindex @samp{Z2} packet
37786 Insert (@samp{Z2}) or remove (@samp{z2}) a write watchpoint at @var{addr}.
37787 The number of bytes to watch is specified by @var{kind}.
37799 @item z3,@var{addr},@var{kind}
37800 @itemx Z3,@var{addr},@var{kind}
37801 @cindex @samp{z3} packet
37802 @cindex @samp{Z3} packet
37803 Insert (@samp{Z3}) or remove (@samp{z3}) a read watchpoint at @var{addr}.
37804 The number of bytes to watch is specified by @var{kind}.
37816 @item z4,@var{addr},@var{kind}
37817 @itemx Z4,@var{addr},@var{kind}
37818 @cindex @samp{z4} packet
37819 @cindex @samp{Z4} packet
37820 Insert (@samp{Z4}) or remove (@samp{z4}) an access watchpoint at @var{addr}.
37821 The number of bytes to watch is specified by @var{kind}.
37835 @node Stop Reply Packets
37836 @section Stop Reply Packets
37837 @cindex stop reply packets
37839 The @samp{C}, @samp{c}, @samp{S}, @samp{s}, @samp{vCont},
37840 @samp{vAttach}, @samp{vRun}, @samp{vStopped}, and @samp{?} packets can
37841 receive any of the below as a reply. Except for @samp{?}
37842 and @samp{vStopped}, that reply is only returned
37843 when the target halts. In the below the exact meaning of @dfn{signal
37844 number} is defined by the header @file{include/gdb/signals.h} in the
37845 @value{GDBN} source code.
37847 In non-stop mode, the server will simply reply @samp{OK} to commands
37848 such as @samp{vCont}; any stop will be the subject of a future
37849 notification. @xref{Remote Non-Stop}.
37851 As in the description of request packets, we include spaces in the
37852 reply templates for clarity; these are not part of the reply packet's
37853 syntax. No @value{GDBN} stop reply packet uses spaces to separate its
37859 The program received signal number @var{AA} (a two-digit hexadecimal
37860 number). This is equivalent to a @samp{T} response with no
37861 @var{n}:@var{r} pairs.
37863 @item T @var{AA} @var{n1}:@var{r1};@var{n2}:@var{r2};@dots{}
37864 @cindex @samp{T} packet reply
37865 The program received signal number @var{AA} (a two-digit hexadecimal
37866 number). This is equivalent to an @samp{S} response, except that the
37867 @samp{@var{n}:@var{r}} pairs can carry values of important registers
37868 and other information directly in the stop reply packet, reducing
37869 round-trip latency. Single-step and breakpoint traps are reported
37870 this way. Each @samp{@var{n}:@var{r}} pair is interpreted as follows:
37874 If @var{n} is a hexadecimal number, it is a register number, and the
37875 corresponding @var{r} gives that register's value. The data @var{r} is a
37876 series of bytes in target byte order, with each byte given by a
37877 two-digit hex number.
37880 If @var{n} is @samp{thread}, then @var{r} is the @var{thread-id} of
37881 the stopped thread, as specified in @ref{thread-id syntax}.
37884 If @var{n} is @samp{core}, then @var{r} is the hexadecimal number of
37885 the core on which the stop event was detected.
37888 If @var{n} is a recognized @dfn{stop reason}, it describes a more
37889 specific event that stopped the target. The currently defined stop
37890 reasons are listed below. The @var{aa} should be @samp{05}, the trap
37891 signal. At most one stop reason should be present.
37894 Otherwise, @value{GDBN} should ignore this @samp{@var{n}:@var{r}} pair
37895 and go on to the next; this allows us to extend the protocol in the
37899 The currently defined stop reasons are:
37905 The packet indicates a watchpoint hit, and @var{r} is the data address, in
37908 @item syscall_entry
37909 @itemx syscall_return
37910 The packet indicates a syscall entry or return, and @var{r} is the
37911 syscall number, in hex.
37913 @cindex shared library events, remote reply
37915 The packet indicates that the loaded libraries have changed.
37916 @value{GDBN} should use @samp{qXfer:libraries:read} to fetch a new
37917 list of loaded libraries. The @var{r} part is ignored.
37919 @cindex replay log events, remote reply
37921 The packet indicates that the target cannot continue replaying
37922 logged execution events, because it has reached the end (or the
37923 beginning when executing backward) of the log. The value of @var{r}
37924 will be either @samp{begin} or @samp{end}. @xref{Reverse Execution},
37925 for more information.
37928 @anchor{swbreak stop reason}
37929 The packet indicates a software breakpoint instruction was executed,
37930 irrespective of whether it was @value{GDBN} that planted the
37931 breakpoint or the breakpoint is hardcoded in the program. The @var{r}
37932 part must be left empty.
37934 On some architectures, such as x86, at the architecture level, when a
37935 breakpoint instruction executes the program counter points at the
37936 breakpoint address plus an offset. On such targets, the stub is
37937 responsible for adjusting the PC to point back at the breakpoint
37940 This packet should not be sent by default; older @value{GDBN} versions
37941 did not support it. @value{GDBN} requests it, by supplying an
37942 appropriate @samp{qSupported} feature (@pxref{qSupported}). The
37943 remote stub must also supply the appropriate @samp{qSupported} feature
37944 indicating support.
37946 This packet is required for correct non-stop mode operation.
37949 The packet indicates the target stopped for a hardware breakpoint.
37950 The @var{r} part must be left empty.
37952 The same remarks about @samp{qSupported} and non-stop mode above
37955 @cindex fork events, remote reply
37957 The packet indicates that @code{fork} was called, and @var{r}
37958 is the thread ID of the new child process. Refer to
37959 @ref{thread-id syntax} for the format of the @var{thread-id}
37960 field. This packet is only applicable to targets that support
37963 This packet should not be sent by default; older @value{GDBN} versions
37964 did not support it. @value{GDBN} requests it, by supplying an
37965 appropriate @samp{qSupported} feature (@pxref{qSupported}). The
37966 remote stub must also supply the appropriate @samp{qSupported} feature
37967 indicating support.
37969 @cindex vfork events, remote reply
37971 The packet indicates that @code{vfork} was called, and @var{r}
37972 is the thread ID of the new child process. Refer to
37973 @ref{thread-id syntax} for the format of the @var{thread-id}
37974 field. This packet is only applicable to targets that support
37977 This packet should not be sent by default; older @value{GDBN} versions
37978 did not support it. @value{GDBN} requests it, by supplying an
37979 appropriate @samp{qSupported} feature (@pxref{qSupported}). The
37980 remote stub must also supply the appropriate @samp{qSupported} feature
37981 indicating support.
37983 @cindex vforkdone events, remote reply
37985 The packet indicates that a child process created by a vfork
37986 has either called @code{exec} or terminated, so that the
37987 address spaces of the parent and child process are no longer
37988 shared. The @var{r} part is ignored. This packet is only
37989 applicable to targets that support vforkdone events.
37991 This packet should not be sent by default; older @value{GDBN} versions
37992 did not support it. @value{GDBN} requests it, by supplying an
37993 appropriate @samp{qSupported} feature (@pxref{qSupported}). The
37994 remote stub must also supply the appropriate @samp{qSupported} feature
37995 indicating support.
37997 @cindex exec events, remote reply
37999 The packet indicates that @code{execve} was called, and @var{r}
38000 is the absolute pathname of the file that was executed, in hex.
38001 This packet is only applicable to targets that support exec events.
38003 This packet should not be sent by default; older @value{GDBN} versions
38004 did not support it. @value{GDBN} requests it, by supplying an
38005 appropriate @samp{qSupported} feature (@pxref{qSupported}). The
38006 remote stub must also supply the appropriate @samp{qSupported} feature
38007 indicating support.
38009 @cindex thread create event, remote reply
38010 @anchor{thread create event}
38012 The packet indicates that the thread was just created. The new thread
38013 is stopped until @value{GDBN} sets it running with a resumption packet
38014 (@pxref{vCont packet}). This packet should not be sent by default;
38015 @value{GDBN} requests it with the @ref{QThreadEvents} packet. See
38016 also the @samp{w} (@pxref{thread exit event}) remote reply below. The
38017 @var{r} part is ignored.
38022 @itemx W @var{AA} ; process:@var{pid}
38023 The process exited, and @var{AA} is the exit status. This is only
38024 applicable to certain targets.
38026 The second form of the response, including the process ID of the
38027 exited process, can be used only when @value{GDBN} has reported
38028 support for multiprocess protocol extensions; see @ref{multiprocess
38029 extensions}. Both @var{AA} and @var{pid} are formatted as big-endian
38033 @itemx X @var{AA} ; process:@var{pid}
38034 The process terminated with signal @var{AA}.
38036 The second form of the response, including the process ID of the
38037 terminated process, can be used only when @value{GDBN} has reported
38038 support for multiprocess protocol extensions; see @ref{multiprocess
38039 extensions}. Both @var{AA} and @var{pid} are formatted as big-endian
38042 @anchor{thread exit event}
38043 @cindex thread exit event, remote reply
38044 @item w @var{AA} ; @var{tid}
38046 The thread exited, and @var{AA} is the exit status. This response
38047 should not be sent by default; @value{GDBN} requests it with the
38048 @ref{QThreadEvents} packet. See also @ref{thread create event} above.
38049 @var{AA} is formatted as a big-endian hex string.
38052 There are no resumed threads left in the target. In other words, even
38053 though the process is alive, the last resumed thread has exited. For
38054 example, say the target process has two threads: thread 1 and thread
38055 2. The client leaves thread 1 stopped, and resumes thread 2, which
38056 subsequently exits. At this point, even though the process is still
38057 alive, and thus no @samp{W} stop reply is sent, no thread is actually
38058 executing either. The @samp{N} stop reply thus informs the client
38059 that it can stop waiting for stop replies. This packet should not be
38060 sent by default; older @value{GDBN} versions did not support it.
38061 @value{GDBN} requests it, by supplying an appropriate
38062 @samp{qSupported} feature (@pxref{qSupported}). The remote stub must
38063 also supply the appropriate @samp{qSupported} feature indicating
38066 @item O @var{XX}@dots{}
38067 @samp{@var{XX}@dots{}} is hex encoding of @sc{ascii} data, to be
38068 written as the program's console output. This can happen at any time
38069 while the program is running and the debugger should continue to wait
38070 for @samp{W}, @samp{T}, etc. This reply is not permitted in non-stop mode.
38072 @item F @var{call-id},@var{parameter}@dots{}
38073 @var{call-id} is the identifier which says which host system call should
38074 be called. This is just the name of the function. Translation into the
38075 correct system call is only applicable as it's defined in @value{GDBN}.
38076 @xref{File-I/O Remote Protocol Extension}, for a list of implemented
38079 @samp{@var{parameter}@dots{}} is a list of parameters as defined for
38080 this very system call.
38082 The target replies with this packet when it expects @value{GDBN} to
38083 call a host system call on behalf of the target. @value{GDBN} replies
38084 with an appropriate @samp{F} packet and keeps up waiting for the next
38085 reply packet from the target. The latest @samp{C}, @samp{c}, @samp{S}
38086 or @samp{s} action is expected to be continued. @xref{File-I/O Remote
38087 Protocol Extension}, for more details.
38091 @node General Query Packets
38092 @section General Query Packets
38093 @cindex remote query requests
38095 Packets starting with @samp{q} are @dfn{general query packets};
38096 packets starting with @samp{Q} are @dfn{general set packets}. General
38097 query and set packets are a semi-unified form for retrieving and
38098 sending information to and from the stub.
38100 The initial letter of a query or set packet is followed by a name
38101 indicating what sort of thing the packet applies to. For example,
38102 @value{GDBN} may use a @samp{qSymbol} packet to exchange symbol
38103 definitions with the stub. These packet names follow some
38108 The name must not contain commas, colons or semicolons.
38110 Most @value{GDBN} query and set packets have a leading upper case
38113 The names of custom vendor packets should use a company prefix, in
38114 lower case, followed by a period. For example, packets designed at
38115 the Acme Corporation might begin with @samp{qacme.foo} (for querying
38116 foos) or @samp{Qacme.bar} (for setting bars).
38119 The name of a query or set packet should be separated from any
38120 parameters by a @samp{:}; the parameters themselves should be
38121 separated by @samp{,} or @samp{;}. Stubs must be careful to match the
38122 full packet name, and check for a separator or the end of the packet,
38123 in case two packet names share a common prefix. New packets should not begin
38124 with @samp{qC}, @samp{qP}, or @samp{qL}@footnote{The @samp{qP} and @samp{qL}
38125 packets predate these conventions, and have arguments without any terminator
38126 for the packet name; we suspect they are in widespread use in places that
38127 are difficult to upgrade. The @samp{qC} packet has no arguments, but some
38128 existing stubs (e.g.@: RedBoot) are known to not check for the end of the
38131 Like the descriptions of the other packets, each description here
38132 has a template showing the packet's overall syntax, followed by an
38133 explanation of the packet's meaning. We include spaces in some of the
38134 templates for clarity; these are not part of the packet's syntax. No
38135 @value{GDBN} packet uses spaces to separate its components.
38137 Here are the currently defined query and set packets:
38143 Turn on or off the agent as a helper to perform some debugging operations
38144 delegated from @value{GDBN} (@pxref{Control Agent}).
38146 @item QAllow:@var{op}:@var{val}@dots{}
38147 @cindex @samp{QAllow} packet
38148 Specify which operations @value{GDBN} expects to request of the
38149 target, as a semicolon-separated list of operation name and value
38150 pairs. Possible values for @var{op} include @samp{WriteReg},
38151 @samp{WriteMem}, @samp{InsertBreak}, @samp{InsertTrace},
38152 @samp{InsertFastTrace}, and @samp{Stop}. @var{val} is either 0,
38153 indicating that @value{GDBN} will not request the operation, or 1,
38154 indicating that it may. (The target can then use this to set up its
38155 own internals optimally, for instance if the debugger never expects to
38156 insert breakpoints, it may not need to install its own trap handler.)
38159 @cindex current thread, remote request
38160 @cindex @samp{qC} packet
38161 Return the current thread ID.
38165 @item QC @var{thread-id}
38166 Where @var{thread-id} is a thread ID as documented in
38167 @ref{thread-id syntax}.
38168 @item @r{(anything else)}
38169 Any other reply implies the old thread ID.
38172 @item qCRC:@var{addr},@var{length}
38173 @cindex CRC of memory block, remote request
38174 @cindex @samp{qCRC} packet
38175 @anchor{qCRC packet}
38176 Compute the CRC checksum of a block of memory using CRC-32 defined in
38177 IEEE 802.3. The CRC is computed byte at a time, taking the most
38178 significant bit of each byte first. The initial pattern code
38179 @code{0xffffffff} is used to ensure leading zeros affect the CRC.
38181 @emph{Note:} This is the same CRC used in validating separate debug
38182 files (@pxref{Separate Debug Files, , Debugging Information in Separate
38183 Files}). However the algorithm is slightly different. When validating
38184 separate debug files, the CRC is computed taking the @emph{least}
38185 significant bit of each byte first, and the final result is inverted to
38186 detect trailing zeros.
38191 An error (such as memory fault)
38192 @item C @var{crc32}
38193 The specified memory region's checksum is @var{crc32}.
38196 @item QDisableRandomization:@var{value}
38197 @cindex disable address space randomization, remote request
38198 @cindex @samp{QDisableRandomization} packet
38199 Some target operating systems will randomize the virtual address space
38200 of the inferior process as a security feature, but provide a feature
38201 to disable such randomization, e.g.@: to allow for a more deterministic
38202 debugging experience. On such systems, this packet with a @var{value}
38203 of 1 directs the target to disable address space randomization for
38204 processes subsequently started via @samp{vRun} packets, while a packet
38205 with a @var{value} of 0 tells the target to enable address space
38208 This packet is only available in extended mode (@pxref{extended mode}).
38213 The request succeeded.
38216 An error occurred. The error number @var{nn} is given as hex digits.
38219 An empty reply indicates that @samp{QDisableRandomization} is not supported
38223 This packet is not probed by default; the remote stub must request it,
38224 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
38225 This should only be done on targets that actually support disabling
38226 address space randomization.
38228 @item QStartupWithShell:@var{value}
38229 @cindex startup with shell, remote request
38230 @cindex @samp{QStartupWithShell} packet
38231 On UNIX-like targets, it is possible to start the inferior using a
38232 shell program. This is the default behavior on both @value{GDBN} and
38233 @command{gdbserver} (@pxref{set startup-with-shell}). This packet is
38234 used to inform @command{gdbserver} whether it should start the
38235 inferior using a shell or not.
38237 If @var{value} is @samp{0}, @command{gdbserver} will not use a shell
38238 to start the inferior. If @var{value} is @samp{1},
38239 @command{gdbserver} will use a shell to start the inferior. All other
38240 values are considered an error.
38242 This packet is only available in extended mode (@pxref{extended
38248 The request succeeded.
38251 An error occurred. The error number @var{nn} is given as hex digits.
38254 This packet is not probed by default; the remote stub must request it,
38255 by supplying an appropriate @samp{qSupported} response
38256 (@pxref{qSupported}). This should only be done on targets that
38257 actually support starting the inferior using a shell.
38259 Use of this packet is controlled by the @code{set startup-with-shell}
38260 command; @pxref{set startup-with-shell}.
38262 @item QEnvironmentHexEncoded:@var{hex-value}
38263 @anchor{QEnvironmentHexEncoded}
38264 @cindex set environment variable, remote request
38265 @cindex @samp{QEnvironmentHexEncoded} packet
38266 On UNIX-like targets, it is possible to set environment variables that
38267 will be passed to the inferior during the startup process. This
38268 packet is used to inform @command{gdbserver} of an environment
38269 variable that has been defined by the user on @value{GDBN} (@pxref{set
38272 The packet is composed by @var{hex-value}, an hex encoded
38273 representation of the @var{name=value} format representing an
38274 environment variable. The name of the environment variable is
38275 represented by @var{name}, and the value to be assigned to the
38276 environment variable is represented by @var{value}. If the variable
38277 has no value (i.e., the value is @code{null}), then @var{value} will
38280 This packet is only available in extended mode (@pxref{extended
38286 The request succeeded.
38289 This packet is not probed by default; the remote stub must request it,
38290 by supplying an appropriate @samp{qSupported} response
38291 (@pxref{qSupported}). This should only be done on targets that
38292 actually support passing environment variables to the starting
38295 This packet is related to the @code{set environment} command;
38296 @pxref{set environment}.
38298 @item QEnvironmentUnset:@var{hex-value}
38299 @anchor{QEnvironmentUnset}
38300 @cindex unset environment variable, remote request
38301 @cindex @samp{QEnvironmentUnset} packet
38302 On UNIX-like targets, it is possible to unset environment variables
38303 before starting the inferior in the remote target. This packet is
38304 used to inform @command{gdbserver} of an environment variable that has
38305 been unset by the user on @value{GDBN} (@pxref{unset environment}).
38307 The packet is composed by @var{hex-value}, an hex encoded
38308 representation of the name of the environment variable to be unset.
38310 This packet is only available in extended mode (@pxref{extended
38316 The request succeeded.
38319 This packet is not probed by default; the remote stub must request it,
38320 by supplying an appropriate @samp{qSupported} response
38321 (@pxref{qSupported}). This should only be done on targets that
38322 actually support passing environment variables to the starting
38325 This packet is related to the @code{unset environment} command;
38326 @pxref{unset environment}.
38328 @item QEnvironmentReset
38329 @anchor{QEnvironmentReset}
38330 @cindex reset environment, remote request
38331 @cindex @samp{QEnvironmentReset} packet
38332 On UNIX-like targets, this packet is used to reset the state of
38333 environment variables in the remote target before starting the
38334 inferior. In this context, reset means unsetting all environment
38335 variables that were previously set by the user (i.e., were not
38336 initially present in the environment). It is sent to
38337 @command{gdbserver} before the @samp{QEnvironmentHexEncoded}
38338 (@pxref{QEnvironmentHexEncoded}) and the @samp{QEnvironmentUnset}
38339 (@pxref{QEnvironmentUnset}) packets.
38341 This packet is only available in extended mode (@pxref{extended
38347 The request succeeded.
38350 This packet is not probed by default; the remote stub must request it,
38351 by supplying an appropriate @samp{qSupported} response
38352 (@pxref{qSupported}). This should only be done on targets that
38353 actually support passing environment variables to the starting
38356 @item QSetWorkingDir:@r{[}@var{directory}@r{]}
38357 @anchor{QSetWorkingDir packet}
38358 @cindex set working directory, remote request
38359 @cindex @samp{QSetWorkingDir} packet
38360 This packet is used to inform the remote server of the intended
38361 current working directory for programs that are going to be executed.
38363 The packet is composed by @var{directory}, an hex encoded
38364 representation of the directory that the remote inferior will use as
38365 its current working directory. If @var{directory} is an empty string,
38366 the remote server should reset the inferior's current working
38367 directory to its original, empty value.
38369 This packet is only available in extended mode (@pxref{extended
38375 The request succeeded.
38379 @itemx qsThreadInfo
38380 @cindex list active threads, remote request
38381 @cindex @samp{qfThreadInfo} packet
38382 @cindex @samp{qsThreadInfo} packet
38383 Obtain a list of all active thread IDs from the target (OS). Since there
38384 may be too many active threads to fit into one reply packet, this query
38385 works iteratively: it may require more than one query/reply sequence to
38386 obtain the entire list of threads. The first query of the sequence will
38387 be the @samp{qfThreadInfo} query; subsequent queries in the
38388 sequence will be the @samp{qsThreadInfo} query.
38390 NOTE: This packet replaces the @samp{qL} query (see below).
38394 @item m @var{thread-id}
38396 @item m @var{thread-id},@var{thread-id}@dots{}
38397 a comma-separated list of thread IDs
38399 (lower case letter @samp{L}) denotes end of list.
38402 In response to each query, the target will reply with a list of one or
38403 more thread IDs, separated by commas.
38404 @value{GDBN} will respond to each reply with a request for more thread
38405 ids (using the @samp{qs} form of the query), until the target responds
38406 with @samp{l} (lower-case ell, for @dfn{last}).
38407 Refer to @ref{thread-id syntax}, for the format of the @var{thread-id}
38410 @emph{Note: @value{GDBN} will send the @code{qfThreadInfo} query during the
38411 initial connection with the remote target, and the very first thread ID
38412 mentioned in the reply will be stopped by @value{GDBN} in a subsequent
38413 message. Therefore, the stub should ensure that the first thread ID in
38414 the @code{qfThreadInfo} reply is suitable for being stopped by @value{GDBN}.}
38416 @item qGetTLSAddr:@var{thread-id},@var{offset},@var{lm}
38417 @cindex get thread-local storage address, remote request
38418 @cindex @samp{qGetTLSAddr} packet
38419 Fetch the address associated with thread local storage specified
38420 by @var{thread-id}, @var{offset}, and @var{lm}.
38422 @var{thread-id} is the thread ID associated with the
38423 thread for which to fetch the TLS address. @xref{thread-id syntax}.
38425 @var{offset} is the (big endian, hex encoded) offset associated with the
38426 thread local variable. (This offset is obtained from the debug
38427 information associated with the variable.)
38429 @var{lm} is the (big endian, hex encoded) OS/ABI-specific encoding of the
38430 load module associated with the thread local storage. For example,
38431 a @sc{gnu}/Linux system will pass the link map address of the shared
38432 object associated with the thread local storage under consideration.
38433 Other operating environments may choose to represent the load module
38434 differently, so the precise meaning of this parameter will vary.
38438 @item @var{XX}@dots{}
38439 Hex encoded (big endian) bytes representing the address of the thread
38440 local storage requested.
38443 An error occurred. The error number @var{nn} is given as hex digits.
38446 An empty reply indicates that @samp{qGetTLSAddr} is not supported by the stub.
38449 @item qGetTIBAddr:@var{thread-id}
38450 @cindex get thread information block address
38451 @cindex @samp{qGetTIBAddr} packet
38452 Fetch address of the Windows OS specific Thread Information Block.
38454 @var{thread-id} is the thread ID associated with the thread.
38458 @item @var{XX}@dots{}
38459 Hex encoded (big endian) bytes representing the linear address of the
38460 thread information block.
38463 An error occured. This means that either the thread was not found, or the
38464 address could not be retrieved.
38467 An empty reply indicates that @samp{qGetTIBAddr} is not supported by the stub.
38470 @item qL @var{startflag} @var{threadcount} @var{nextthread}
38471 Obtain thread information from RTOS. Where: @var{startflag} (one hex
38472 digit) is one to indicate the first query and zero to indicate a
38473 subsequent query; @var{threadcount} (two hex digits) is the maximum
38474 number of threads the response packet can contain; and @var{nextthread}
38475 (eight hex digits), for subsequent queries (@var{startflag} is zero), is
38476 returned in the response as @var{argthread}.
38478 Don't use this packet; use the @samp{qfThreadInfo} query instead (see above).
38482 @item qM @var{count} @var{done} @var{argthread} @var{thread}@dots{}
38483 Where: @var{count} (two hex digits) is the number of threads being
38484 returned; @var{done} (one hex digit) is zero to indicate more threads
38485 and one indicates no further threads; @var{argthreadid} (eight hex
38486 digits) is @var{nextthread} from the request packet; @var{thread}@dots{}
38487 is a sequence of thread IDs, @var{threadid} (eight hex
38488 digits), from the target. See @code{remote.c:parse_threadlist_response()}.
38492 @cindex section offsets, remote request
38493 @cindex @samp{qOffsets} packet
38494 Get section offsets that the target used when relocating the downloaded
38499 @item Text=@var{xxx};Data=@var{yyy}@r{[};Bss=@var{zzz}@r{]}
38500 Relocate the @code{Text} section by @var{xxx} from its original address.
38501 Relocate the @code{Data} section by @var{yyy} from its original address.
38502 If the object file format provides segment information (e.g.@: @sc{elf}
38503 @samp{PT_LOAD} program headers), @value{GDBN} will relocate entire
38504 segments by the supplied offsets.
38506 @emph{Note: while a @code{Bss} offset may be included in the response,
38507 @value{GDBN} ignores this and instead applies the @code{Data} offset
38508 to the @code{Bss} section.}
38510 @item TextSeg=@var{xxx}@r{[};DataSeg=@var{yyy}@r{]}
38511 Relocate the first segment of the object file, which conventionally
38512 contains program code, to a starting address of @var{xxx}. If
38513 @samp{DataSeg} is specified, relocate the second segment, which
38514 conventionally contains modifiable data, to a starting address of
38515 @var{yyy}. @value{GDBN} will report an error if the object file
38516 does not contain segment information, or does not contain at least
38517 as many segments as mentioned in the reply. Extra segments are
38518 kept at fixed offsets relative to the last relocated segment.
38521 @item qP @var{mode} @var{thread-id}
38522 @cindex thread information, remote request
38523 @cindex @samp{qP} packet
38524 Returns information on @var{thread-id}. Where: @var{mode} is a hex
38525 encoded 32 bit mode; @var{thread-id} is a thread ID
38526 (@pxref{thread-id syntax}).
38528 Don't use this packet; use the @samp{qThreadExtraInfo} query instead
38531 Reply: see @code{remote.c:remote_unpack_thread_info_response()}.
38535 @cindex non-stop mode, remote request
38536 @cindex @samp{QNonStop} packet
38538 Enter non-stop (@samp{QNonStop:1}) or all-stop (@samp{QNonStop:0}) mode.
38539 @xref{Remote Non-Stop}, for more information.
38544 The request succeeded.
38547 An error occurred. The error number @var{nn} is given as hex digits.
38550 An empty reply indicates that @samp{QNonStop} is not supported by
38554 This packet is not probed by default; the remote stub must request it,
38555 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
38556 Use of this packet is controlled by the @code{set non-stop} command;
38557 @pxref{Non-Stop Mode}.
38559 @item QCatchSyscalls:1 @r{[};@var{sysno}@r{]}@dots{}
38560 @itemx QCatchSyscalls:0
38561 @cindex catch syscalls from inferior, remote request
38562 @cindex @samp{QCatchSyscalls} packet
38563 @anchor{QCatchSyscalls}
38564 Enable (@samp{QCatchSyscalls:1}) or disable (@samp{QCatchSyscalls:0})
38565 catching syscalls from the inferior process.
38567 For @samp{QCatchSyscalls:1}, each listed syscall @var{sysno} (encoded
38568 in hex) should be reported to @value{GDBN}. If no syscall @var{sysno}
38569 is listed, every system call should be reported.
38571 Note that if a syscall not in the list is reported, @value{GDBN} will
38572 still filter the event according to its own list from all corresponding
38573 @code{catch syscall} commands. However, it is more efficient to only
38574 report the requested syscalls.
38576 Multiple @samp{QCatchSyscalls:1} packets do not combine; any earlier
38577 @samp{QCatchSyscalls:1} list is completely replaced by the new list.
38579 If the inferior process execs, the state of @samp{QCatchSyscalls} is
38580 kept for the new process too. On targets where exec may affect syscall
38581 numbers, for example with exec between 32 and 64-bit processes, the
38582 client should send a new packet with the new syscall list.
38587 The request succeeded.
38590 An error occurred. @var{nn} are hex digits.
38593 An empty reply indicates that @samp{QCatchSyscalls} is not supported by
38597 Use of this packet is controlled by the @code{set remote catch-syscalls}
38598 command (@pxref{Remote Configuration, set remote catch-syscalls}).
38599 This packet is not probed by default; the remote stub must request it,
38600 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
38602 @item QPassSignals: @var{signal} @r{[};@var{signal}@r{]}@dots{}
38603 @cindex pass signals to inferior, remote request
38604 @cindex @samp{QPassSignals} packet
38605 @anchor{QPassSignals}
38606 Each listed @var{signal} should be passed directly to the inferior process.
38607 Signals are numbered identically to continue packets and stop replies
38608 (@pxref{Stop Reply Packets}). Each @var{signal} list item should be
38609 strictly greater than the previous item. These signals do not need to stop
38610 the inferior, or be reported to @value{GDBN}. All other signals should be
38611 reported to @value{GDBN}. Multiple @samp{QPassSignals} packets do not
38612 combine; any earlier @samp{QPassSignals} list is completely replaced by the
38613 new list. This packet improves performance when using @samp{handle
38614 @var{signal} nostop noprint pass}.
38619 The request succeeded.
38622 An error occurred. The error number @var{nn} is given as hex digits.
38625 An empty reply indicates that @samp{QPassSignals} is not supported by
38629 Use of this packet is controlled by the @code{set remote pass-signals}
38630 command (@pxref{Remote Configuration, set remote pass-signals}).
38631 This packet is not probed by default; the remote stub must request it,
38632 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
38634 @item QProgramSignals: @var{signal} @r{[};@var{signal}@r{]}@dots{}
38635 @cindex signals the inferior may see, remote request
38636 @cindex @samp{QProgramSignals} packet
38637 @anchor{QProgramSignals}
38638 Each listed @var{signal} may be delivered to the inferior process.
38639 Others should be silently discarded.
38641 In some cases, the remote stub may need to decide whether to deliver a
38642 signal to the program or not without @value{GDBN} involvement. One
38643 example of that is while detaching --- the program's threads may have
38644 stopped for signals that haven't yet had a chance of being reported to
38645 @value{GDBN}, and so the remote stub can use the signal list specified
38646 by this packet to know whether to deliver or ignore those pending
38649 This does not influence whether to deliver a signal as requested by a
38650 resumption packet (@pxref{vCont packet}).
38652 Signals are numbered identically to continue packets and stop replies
38653 (@pxref{Stop Reply Packets}). Each @var{signal} list item should be
38654 strictly greater than the previous item. Multiple
38655 @samp{QProgramSignals} packets do not combine; any earlier
38656 @samp{QProgramSignals} list is completely replaced by the new list.
38661 The request succeeded.
38664 An error occurred. The error number @var{nn} is given as hex digits.
38667 An empty reply indicates that @samp{QProgramSignals} is not supported
38671 Use of this packet is controlled by the @code{set remote program-signals}
38672 command (@pxref{Remote Configuration, set remote program-signals}).
38673 This packet is not probed by default; the remote stub must request it,
38674 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
38676 @anchor{QThreadEvents}
38677 @item QThreadEvents:1
38678 @itemx QThreadEvents:0
38679 @cindex thread create/exit events, remote request
38680 @cindex @samp{QThreadEvents} packet
38682 Enable (@samp{QThreadEvents:1}) or disable (@samp{QThreadEvents:0})
38683 reporting of thread create and exit events. @xref{thread create
38684 event}, for the reply specifications. For example, this is used in
38685 non-stop mode when @value{GDBN} stops a set of threads and
38686 synchronously waits for the their corresponding stop replies. Without
38687 exit events, if one of the threads exits, @value{GDBN} would hang
38688 forever not knowing that it should no longer expect a stop for that
38689 same thread. @value{GDBN} does not enable this feature unless the
38690 stub reports that it supports it by including @samp{QThreadEvents+} in
38691 its @samp{qSupported} reply.
38696 The request succeeded.
38699 An error occurred. The error number @var{nn} is given as hex digits.
38702 An empty reply indicates that @samp{QThreadEvents} is not supported by
38706 Use of this packet is controlled by the @code{set remote thread-events}
38707 command (@pxref{Remote Configuration, set remote thread-events}).
38709 @item qRcmd,@var{command}
38710 @cindex execute remote command, remote request
38711 @cindex @samp{qRcmd} packet
38712 @var{command} (hex encoded) is passed to the local interpreter for
38713 execution. Invalid commands should be reported using the output
38714 string. Before the final result packet, the target may also respond
38715 with a number of intermediate @samp{O@var{output}} console output
38716 packets. @emph{Implementors should note that providing access to a
38717 stubs's interpreter may have security implications}.
38722 A command response with no output.
38724 A command response with the hex encoded output string @var{OUTPUT}.
38726 Indicate a badly formed request.
38728 An empty reply indicates that @samp{qRcmd} is not recognized.
38731 (Note that the @code{qRcmd} packet's name is separated from the
38732 command by a @samp{,}, not a @samp{:}, contrary to the naming
38733 conventions above. Please don't use this packet as a model for new
38736 @item qSearch:memory:@var{address};@var{length};@var{search-pattern}
38737 @cindex searching memory, in remote debugging
38739 @cindex @samp{qSearch:memory} packet
38741 @cindex @samp{qSearch memory} packet
38742 @anchor{qSearch memory}
38743 Search @var{length} bytes at @var{address} for @var{search-pattern}.
38744 Both @var{address} and @var{length} are encoded in hex;
38745 @var{search-pattern} is a sequence of bytes, also hex encoded.
38750 The pattern was not found.
38752 The pattern was found at @var{address}.
38754 A badly formed request or an error was encountered while searching memory.
38756 An empty reply indicates that @samp{qSearch:memory} is not recognized.
38759 @item QStartNoAckMode
38760 @cindex @samp{QStartNoAckMode} packet
38761 @anchor{QStartNoAckMode}
38762 Request that the remote stub disable the normal @samp{+}/@samp{-}
38763 protocol acknowledgments (@pxref{Packet Acknowledgment}).
38768 The stub has switched to no-acknowledgment mode.
38769 @value{GDBN} acknowledges this reponse,
38770 but neither the stub nor @value{GDBN} shall send or expect further
38771 @samp{+}/@samp{-} acknowledgments in the current connection.
38773 An empty reply indicates that the stub does not support no-acknowledgment mode.
38776 @item qSupported @r{[}:@var{gdbfeature} @r{[};@var{gdbfeature}@r{]}@dots{} @r{]}
38777 @cindex supported packets, remote query
38778 @cindex features of the remote protocol
38779 @cindex @samp{qSupported} packet
38780 @anchor{qSupported}
38781 Tell the remote stub about features supported by @value{GDBN}, and
38782 query the stub for features it supports. This packet allows
38783 @value{GDBN} and the remote stub to take advantage of each others'
38784 features. @samp{qSupported} also consolidates multiple feature probes
38785 at startup, to improve @value{GDBN} performance---a single larger
38786 packet performs better than multiple smaller probe packets on
38787 high-latency links. Some features may enable behavior which must not
38788 be on by default, e.g.@: because it would confuse older clients or
38789 stubs. Other features may describe packets which could be
38790 automatically probed for, but are not. These features must be
38791 reported before @value{GDBN} will use them. This ``default
38792 unsupported'' behavior is not appropriate for all packets, but it
38793 helps to keep the initial connection time under control with new
38794 versions of @value{GDBN} which support increasing numbers of packets.
38798 @item @var{stubfeature} @r{[};@var{stubfeature}@r{]}@dots{}
38799 The stub supports or does not support each returned @var{stubfeature},
38800 depending on the form of each @var{stubfeature} (see below for the
38803 An empty reply indicates that @samp{qSupported} is not recognized,
38804 or that no features needed to be reported to @value{GDBN}.
38807 The allowed forms for each feature (either a @var{gdbfeature} in the
38808 @samp{qSupported} packet, or a @var{stubfeature} in the response)
38812 @item @var{name}=@var{value}
38813 The remote protocol feature @var{name} is supported, and associated
38814 with the specified @var{value}. The format of @var{value} depends
38815 on the feature, but it must not include a semicolon.
38817 The remote protocol feature @var{name} is supported, and does not
38818 need an associated value.
38820 The remote protocol feature @var{name} is not supported.
38822 The remote protocol feature @var{name} may be supported, and
38823 @value{GDBN} should auto-detect support in some other way when it is
38824 needed. This form will not be used for @var{gdbfeature} notifications,
38825 but may be used for @var{stubfeature} responses.
38828 Whenever the stub receives a @samp{qSupported} request, the
38829 supplied set of @value{GDBN} features should override any previous
38830 request. This allows @value{GDBN} to put the stub in a known
38831 state, even if the stub had previously been communicating with
38832 a different version of @value{GDBN}.
38834 The following values of @var{gdbfeature} (for the packet sent by @value{GDBN})
38839 This feature indicates whether @value{GDBN} supports multiprocess
38840 extensions to the remote protocol. @value{GDBN} does not use such
38841 extensions unless the stub also reports that it supports them by
38842 including @samp{multiprocess+} in its @samp{qSupported} reply.
38843 @xref{multiprocess extensions}, for details.
38846 This feature indicates that @value{GDBN} supports the XML target
38847 description. If the stub sees @samp{xmlRegisters=} with target
38848 specific strings separated by a comma, it will report register
38852 This feature indicates whether @value{GDBN} supports the
38853 @samp{qRelocInsn} packet (@pxref{Tracepoint Packets,,Relocate
38854 instruction reply packet}).
38857 This feature indicates whether @value{GDBN} supports the swbreak stop
38858 reason in stop replies. @xref{swbreak stop reason}, for details.
38861 This feature indicates whether @value{GDBN} supports the hwbreak stop
38862 reason in stop replies. @xref{swbreak stop reason}, for details.
38865 This feature indicates whether @value{GDBN} supports fork event
38866 extensions to the remote protocol. @value{GDBN} does not use such
38867 extensions unless the stub also reports that it supports them by
38868 including @samp{fork-events+} in its @samp{qSupported} reply.
38871 This feature indicates whether @value{GDBN} supports vfork event
38872 extensions to the remote protocol. @value{GDBN} does not use such
38873 extensions unless the stub also reports that it supports them by
38874 including @samp{vfork-events+} in its @samp{qSupported} reply.
38877 This feature indicates whether @value{GDBN} supports exec event
38878 extensions to the remote protocol. @value{GDBN} does not use such
38879 extensions unless the stub also reports that it supports them by
38880 including @samp{exec-events+} in its @samp{qSupported} reply.
38882 @item vContSupported
38883 This feature indicates whether @value{GDBN} wants to know the
38884 supported actions in the reply to @samp{vCont?} packet.
38887 Stubs should ignore any unknown values for
38888 @var{gdbfeature}. Any @value{GDBN} which sends a @samp{qSupported}
38889 packet supports receiving packets of unlimited length (earlier
38890 versions of @value{GDBN} may reject overly long responses). Additional values
38891 for @var{gdbfeature} may be defined in the future to let the stub take
38892 advantage of new features in @value{GDBN}, e.g.@: incompatible
38893 improvements in the remote protocol---the @samp{multiprocess} feature is
38894 an example of such a feature. The stub's reply should be independent
38895 of the @var{gdbfeature} entries sent by @value{GDBN}; first @value{GDBN}
38896 describes all the features it supports, and then the stub replies with
38897 all the features it supports.
38899 Similarly, @value{GDBN} will silently ignore unrecognized stub feature
38900 responses, as long as each response uses one of the standard forms.
38902 Some features are flags. A stub which supports a flag feature
38903 should respond with a @samp{+} form response. Other features
38904 require values, and the stub should respond with an @samp{=}
38907 Each feature has a default value, which @value{GDBN} will use if
38908 @samp{qSupported} is not available or if the feature is not mentioned
38909 in the @samp{qSupported} response. The default values are fixed; a
38910 stub is free to omit any feature responses that match the defaults.
38912 Not all features can be probed, but for those which can, the probing
38913 mechanism is useful: in some cases, a stub's internal
38914 architecture may not allow the protocol layer to know some information
38915 about the underlying target in advance. This is especially common in
38916 stubs which may be configured for multiple targets.
38918 These are the currently defined stub features and their properties:
38920 @multitable @columnfractions 0.35 0.2 0.12 0.2
38921 @c NOTE: The first row should be @headitem, but we do not yet require
38922 @c a new enough version of Texinfo (4.7) to use @headitem.
38924 @tab Value Required
38928 @item @samp{PacketSize}
38933 @item @samp{qXfer:auxv:read}
38938 @item @samp{qXfer:btrace:read}
38943 @item @samp{qXfer:btrace-conf:read}
38948 @item @samp{qXfer:exec-file:read}
38953 @item @samp{qXfer:features:read}
38958 @item @samp{qXfer:libraries:read}
38963 @item @samp{qXfer:libraries-svr4:read}
38968 @item @samp{augmented-libraries-svr4-read}
38973 @item @samp{qXfer:memory-map:read}
38978 @item @samp{qXfer:sdata:read}
38983 @item @samp{qXfer:spu:read}
38988 @item @samp{qXfer:spu:write}
38993 @item @samp{qXfer:siginfo:read}
38998 @item @samp{qXfer:siginfo:write}
39003 @item @samp{qXfer:threads:read}
39008 @item @samp{qXfer:traceframe-info:read}
39013 @item @samp{qXfer:uib:read}
39018 @item @samp{qXfer:fdpic:read}
39023 @item @samp{Qbtrace:off}
39028 @item @samp{Qbtrace:bts}
39033 @item @samp{Qbtrace:pt}
39038 @item @samp{Qbtrace-conf:bts:size}
39043 @item @samp{Qbtrace-conf:pt:size}
39048 @item @samp{QNonStop}
39053 @item @samp{QCatchSyscalls}
39058 @item @samp{QPassSignals}
39063 @item @samp{QStartNoAckMode}
39068 @item @samp{multiprocess}
39073 @item @samp{ConditionalBreakpoints}
39078 @item @samp{ConditionalTracepoints}
39083 @item @samp{ReverseContinue}
39088 @item @samp{ReverseStep}
39093 @item @samp{TracepointSource}
39098 @item @samp{QAgent}
39103 @item @samp{QAllow}
39108 @item @samp{QDisableRandomization}
39113 @item @samp{EnableDisableTracepoints}
39118 @item @samp{QTBuffer:size}
39123 @item @samp{tracenz}
39128 @item @samp{BreakpointCommands}
39133 @item @samp{swbreak}
39138 @item @samp{hwbreak}
39143 @item @samp{fork-events}
39148 @item @samp{vfork-events}
39153 @item @samp{exec-events}
39158 @item @samp{QThreadEvents}
39163 @item @samp{no-resumed}
39170 These are the currently defined stub features, in more detail:
39173 @cindex packet size, remote protocol
39174 @item PacketSize=@var{bytes}
39175 The remote stub can accept packets up to at least @var{bytes} in
39176 length. @value{GDBN} will send packets up to this size for bulk
39177 transfers, and will never send larger packets. This is a limit on the
39178 data characters in the packet, including the frame and checksum.
39179 There is no trailing NUL byte in a remote protocol packet; if the stub
39180 stores packets in a NUL-terminated format, it should allow an extra
39181 byte in its buffer for the NUL. If this stub feature is not supported,
39182 @value{GDBN} guesses based on the size of the @samp{g} packet response.
39184 @item qXfer:auxv:read
39185 The remote stub understands the @samp{qXfer:auxv:read} packet
39186 (@pxref{qXfer auxiliary vector read}).
39188 @item qXfer:btrace:read
39189 The remote stub understands the @samp{qXfer:btrace:read}
39190 packet (@pxref{qXfer btrace read}).
39192 @item qXfer:btrace-conf:read
39193 The remote stub understands the @samp{qXfer:btrace-conf:read}
39194 packet (@pxref{qXfer btrace-conf read}).
39196 @item qXfer:exec-file:read
39197 The remote stub understands the @samp{qXfer:exec-file:read} packet
39198 (@pxref{qXfer executable filename read}).
39200 @item qXfer:features:read
39201 The remote stub understands the @samp{qXfer:features:read} packet
39202 (@pxref{qXfer target description read}).
39204 @item qXfer:libraries:read
39205 The remote stub understands the @samp{qXfer:libraries:read} packet
39206 (@pxref{qXfer library list read}).
39208 @item qXfer:libraries-svr4:read
39209 The remote stub understands the @samp{qXfer:libraries-svr4:read} packet
39210 (@pxref{qXfer svr4 library list read}).
39212 @item augmented-libraries-svr4-read
39213 The remote stub understands the augmented form of the
39214 @samp{qXfer:libraries-svr4:read} packet
39215 (@pxref{qXfer svr4 library list read}).
39217 @item qXfer:memory-map:read
39218 The remote stub understands the @samp{qXfer:memory-map:read} packet
39219 (@pxref{qXfer memory map read}).
39221 @item qXfer:sdata:read
39222 The remote stub understands the @samp{qXfer:sdata:read} packet
39223 (@pxref{qXfer sdata read}).
39225 @item qXfer:spu:read
39226 The remote stub understands the @samp{qXfer:spu:read} packet
39227 (@pxref{qXfer spu read}).
39229 @item qXfer:spu:write
39230 The remote stub understands the @samp{qXfer:spu:write} packet
39231 (@pxref{qXfer spu write}).
39233 @item qXfer:siginfo:read
39234 The remote stub understands the @samp{qXfer:siginfo:read} packet
39235 (@pxref{qXfer siginfo read}).
39237 @item qXfer:siginfo:write
39238 The remote stub understands the @samp{qXfer:siginfo:write} packet
39239 (@pxref{qXfer siginfo write}).
39241 @item qXfer:threads:read
39242 The remote stub understands the @samp{qXfer:threads:read} packet
39243 (@pxref{qXfer threads read}).
39245 @item qXfer:traceframe-info:read
39246 The remote stub understands the @samp{qXfer:traceframe-info:read}
39247 packet (@pxref{qXfer traceframe info read}).
39249 @item qXfer:uib:read
39250 The remote stub understands the @samp{qXfer:uib:read}
39251 packet (@pxref{qXfer unwind info block}).
39253 @item qXfer:fdpic:read
39254 The remote stub understands the @samp{qXfer:fdpic:read}
39255 packet (@pxref{qXfer fdpic loadmap read}).
39258 The remote stub understands the @samp{QNonStop} packet
39259 (@pxref{QNonStop}).
39261 @item QCatchSyscalls
39262 The remote stub understands the @samp{QCatchSyscalls} packet
39263 (@pxref{QCatchSyscalls}).
39266 The remote stub understands the @samp{QPassSignals} packet
39267 (@pxref{QPassSignals}).
39269 @item QStartNoAckMode
39270 The remote stub understands the @samp{QStartNoAckMode} packet and
39271 prefers to operate in no-acknowledgment mode. @xref{Packet Acknowledgment}.
39274 @anchor{multiprocess extensions}
39275 @cindex multiprocess extensions, in remote protocol
39276 The remote stub understands the multiprocess extensions to the remote
39277 protocol syntax. The multiprocess extensions affect the syntax of
39278 thread IDs in both packets and replies (@pxref{thread-id syntax}), and
39279 add process IDs to the @samp{D} packet and @samp{W} and @samp{X}
39280 replies. Note that reporting this feature indicates support for the
39281 syntactic extensions only, not that the stub necessarily supports
39282 debugging of more than one process at a time. The stub must not use
39283 multiprocess extensions in packet replies unless @value{GDBN} has also
39284 indicated it supports them in its @samp{qSupported} request.
39286 @item qXfer:osdata:read
39287 The remote stub understands the @samp{qXfer:osdata:read} packet
39288 ((@pxref{qXfer osdata read}).
39290 @item ConditionalBreakpoints
39291 The target accepts and implements evaluation of conditional expressions
39292 defined for breakpoints. The target will only report breakpoint triggers
39293 when such conditions are true (@pxref{Conditions, ,Break Conditions}).
39295 @item ConditionalTracepoints
39296 The remote stub accepts and implements conditional expressions defined
39297 for tracepoints (@pxref{Tracepoint Conditions}).
39299 @item ReverseContinue
39300 The remote stub accepts and implements the reverse continue packet
39304 The remote stub accepts and implements the reverse step packet
39307 @item TracepointSource
39308 The remote stub understands the @samp{QTDPsrc} packet that supplies
39309 the source form of tracepoint definitions.
39312 The remote stub understands the @samp{QAgent} packet.
39315 The remote stub understands the @samp{QAllow} packet.
39317 @item QDisableRandomization
39318 The remote stub understands the @samp{QDisableRandomization} packet.
39320 @item StaticTracepoint
39321 @cindex static tracepoints, in remote protocol
39322 The remote stub supports static tracepoints.
39324 @item InstallInTrace
39325 @anchor{install tracepoint in tracing}
39326 The remote stub supports installing tracepoint in tracing.
39328 @item EnableDisableTracepoints
39329 The remote stub supports the @samp{QTEnable} (@pxref{QTEnable}) and
39330 @samp{QTDisable} (@pxref{QTDisable}) packets that allow tracepoints
39331 to be enabled and disabled while a trace experiment is running.
39333 @item QTBuffer:size
39334 The remote stub supports the @samp{QTBuffer:size} (@pxref{QTBuffer-size})
39335 packet that allows to change the size of the trace buffer.
39338 @cindex string tracing, in remote protocol
39339 The remote stub supports the @samp{tracenz} bytecode for collecting strings.
39340 See @ref{Bytecode Descriptions} for details about the bytecode.
39342 @item BreakpointCommands
39343 @cindex breakpoint commands, in remote protocol
39344 The remote stub supports running a breakpoint's command list itself,
39345 rather than reporting the hit to @value{GDBN}.
39348 The remote stub understands the @samp{Qbtrace:off} packet.
39351 The remote stub understands the @samp{Qbtrace:bts} packet.
39354 The remote stub understands the @samp{Qbtrace:pt} packet.
39356 @item Qbtrace-conf:bts:size
39357 The remote stub understands the @samp{Qbtrace-conf:bts:size} packet.
39359 @item Qbtrace-conf:pt:size
39360 The remote stub understands the @samp{Qbtrace-conf:pt:size} packet.
39363 The remote stub reports the @samp{swbreak} stop reason for memory
39367 The remote stub reports the @samp{hwbreak} stop reason for hardware
39371 The remote stub reports the @samp{fork} stop reason for fork events.
39374 The remote stub reports the @samp{vfork} stop reason for vfork events
39375 and vforkdone events.
39378 The remote stub reports the @samp{exec} stop reason for exec events.
39380 @item vContSupported
39381 The remote stub reports the supported actions in the reply to
39382 @samp{vCont?} packet.
39384 @item QThreadEvents
39385 The remote stub understands the @samp{QThreadEvents} packet.
39388 The remote stub reports the @samp{N} stop reply.
39393 @cindex symbol lookup, remote request
39394 @cindex @samp{qSymbol} packet
39395 Notify the target that @value{GDBN} is prepared to serve symbol lookup
39396 requests. Accept requests from the target for the values of symbols.
39401 The target does not need to look up any (more) symbols.
39402 @item qSymbol:@var{sym_name}
39403 The target requests the value of symbol @var{sym_name} (hex encoded).
39404 @value{GDBN} may provide the value by using the
39405 @samp{qSymbol:@var{sym_value}:@var{sym_name}} message, described
39409 @item qSymbol:@var{sym_value}:@var{sym_name}
39410 Set the value of @var{sym_name} to @var{sym_value}.
39412 @var{sym_name} (hex encoded) is the name of a symbol whose value the
39413 target has previously requested.
39415 @var{sym_value} (hex) is the value for symbol @var{sym_name}. If
39416 @value{GDBN} cannot supply a value for @var{sym_name}, then this field
39422 The target does not need to look up any (more) symbols.
39423 @item qSymbol:@var{sym_name}
39424 The target requests the value of a new symbol @var{sym_name} (hex
39425 encoded). @value{GDBN} will continue to supply the values of symbols
39426 (if available), until the target ceases to request them.
39431 @itemx QTDisconnected
39438 @itemx qTMinFTPILen
39440 @xref{Tracepoint Packets}.
39442 @item qThreadExtraInfo,@var{thread-id}
39443 @cindex thread attributes info, remote request
39444 @cindex @samp{qThreadExtraInfo} packet
39445 Obtain from the target OS a printable string description of thread
39446 attributes for the thread @var{thread-id}; see @ref{thread-id syntax},
39447 for the forms of @var{thread-id}. This
39448 string may contain anything that the target OS thinks is interesting
39449 for @value{GDBN} to tell the user about the thread. The string is
39450 displayed in @value{GDBN}'s @code{info threads} display. Some
39451 examples of possible thread extra info strings are @samp{Runnable}, or
39452 @samp{Blocked on Mutex}.
39456 @item @var{XX}@dots{}
39457 Where @samp{@var{XX}@dots{}} is a hex encoding of @sc{ascii} data,
39458 comprising the printable string containing the extra information about
39459 the thread's attributes.
39462 (Note that the @code{qThreadExtraInfo} packet's name is separated from
39463 the command by a @samp{,}, not a @samp{:}, contrary to the naming
39464 conventions above. Please don't use this packet as a model for new
39483 @xref{Tracepoint Packets}.
39485 @item qXfer:@var{object}:read:@var{annex}:@var{offset},@var{length}
39486 @cindex read special object, remote request
39487 @cindex @samp{qXfer} packet
39488 @anchor{qXfer read}
39489 Read uninterpreted bytes from the target's special data area
39490 identified by the keyword @var{object}. Request @var{length} bytes
39491 starting at @var{offset} bytes into the data. The content and
39492 encoding of @var{annex} is specific to @var{object}; it can supply
39493 additional details about what data to access.
39498 Data @var{data} (@pxref{Binary Data}) has been read from the
39499 target. There may be more data at a higher address (although
39500 it is permitted to return @samp{m} even for the last valid
39501 block of data, as long as at least one byte of data was read).
39502 It is possible for @var{data} to have fewer bytes than the @var{length} in the
39506 Data @var{data} (@pxref{Binary Data}) has been read from the target.
39507 There is no more data to be read. It is possible for @var{data} to
39508 have fewer bytes than the @var{length} in the request.
39511 The @var{offset} in the request is at the end of the data.
39512 There is no more data to be read.
39515 The request was malformed, or @var{annex} was invalid.
39518 The offset was invalid, or there was an error encountered reading the data.
39519 The @var{nn} part is a hex-encoded @code{errno} value.
39522 An empty reply indicates the @var{object} string was not recognized by
39523 the stub, or that the object does not support reading.
39526 Here are the specific requests of this form defined so far. All the
39527 @samp{qXfer:@var{object}:read:@dots{}} requests use the same reply
39528 formats, listed above.
39531 @item qXfer:auxv:read::@var{offset},@var{length}
39532 @anchor{qXfer auxiliary vector read}
39533 Access the target's @dfn{auxiliary vector}. @xref{OS Information,
39534 auxiliary vector}. Note @var{annex} must be empty.
39536 This packet is not probed by default; the remote stub must request it,
39537 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
39539 @item qXfer:btrace:read:@var{annex}:@var{offset},@var{length}
39540 @anchor{qXfer btrace read}
39542 Return a description of the current branch trace.
39543 @xref{Branch Trace Format}. The annex part of the generic @samp{qXfer}
39544 packet may have one of the following values:
39548 Returns all available branch trace.
39551 Returns all available branch trace if the branch trace changed since
39552 the last read request.
39555 Returns the new branch trace since the last read request. Adds a new
39556 block to the end of the trace that begins at zero and ends at the source
39557 location of the first branch in the trace buffer. This extra block is
39558 used to stitch traces together.
39560 If the trace buffer overflowed, returns an error indicating the overflow.
39563 This packet is not probed by default; the remote stub must request it
39564 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
39566 @item qXfer:btrace-conf:read::@var{offset},@var{length}
39567 @anchor{qXfer btrace-conf read}
39569 Return a description of the current branch trace configuration.
39570 @xref{Branch Trace Configuration Format}.
39572 This packet is not probed by default; the remote stub must request it
39573 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
39575 @item qXfer:exec-file:read:@var{annex}:@var{offset},@var{length}
39576 @anchor{qXfer executable filename read}
39577 Return the full absolute name of the file that was executed to create
39578 a process running on the remote system. The annex specifies the
39579 numeric process ID of the process to query, encoded as a hexadecimal
39580 number. If the annex part is empty the remote stub should return the
39581 filename corresponding to the currently executing process.
39583 This packet is not probed by default; the remote stub must request it,
39584 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
39586 @item qXfer:features:read:@var{annex}:@var{offset},@var{length}
39587 @anchor{qXfer target description read}
39588 Access the @dfn{target description}. @xref{Target Descriptions}. The
39589 annex specifies which XML document to access. The main description is
39590 always loaded from the @samp{target.xml} annex.
39592 This packet is not probed by default; the remote stub must request it,
39593 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
39595 @item qXfer:libraries:read:@var{annex}:@var{offset},@var{length}
39596 @anchor{qXfer library list read}
39597 Access the target's list of loaded libraries. @xref{Library List Format}.
39598 The annex part of the generic @samp{qXfer} packet must be empty
39599 (@pxref{qXfer read}).
39601 Targets which maintain a list of libraries in the program's memory do
39602 not need to implement this packet; it is designed for platforms where
39603 the operating system manages the list of loaded libraries.
39605 This packet is not probed by default; the remote stub must request it,
39606 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
39608 @item qXfer:libraries-svr4:read:@var{annex}:@var{offset},@var{length}
39609 @anchor{qXfer svr4 library list read}
39610 Access the target's list of loaded libraries when the target is an SVR4
39611 platform. @xref{Library List Format for SVR4 Targets}. The annex part
39612 of the generic @samp{qXfer} packet must be empty unless the remote
39613 stub indicated it supports the augmented form of this packet
39614 by supplying an appropriate @samp{qSupported} response
39615 (@pxref{qXfer read}, @ref{qSupported}).
39617 This packet is optional for better performance on SVR4 targets.
39618 @value{GDBN} uses memory read packets to read the SVR4 library list otherwise.
39620 This packet is not probed by default; the remote stub must request it,
39621 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
39623 If the remote stub indicates it supports the augmented form of this
39624 packet then the annex part of the generic @samp{qXfer} packet may
39625 contain a semicolon-separated list of @samp{@var{name}=@var{value}}
39626 arguments. The currently supported arguments are:
39629 @item start=@var{address}
39630 A hexadecimal number specifying the address of the @samp{struct
39631 link_map} to start reading the library list from. If unset or zero
39632 then the first @samp{struct link_map} in the library list will be
39633 chosen as the starting point.
39635 @item prev=@var{address}
39636 A hexadecimal number specifying the address of the @samp{struct
39637 link_map} immediately preceding the @samp{struct link_map}
39638 specified by the @samp{start} argument. If unset or zero then
39639 the remote stub will expect that no @samp{struct link_map}
39640 exists prior to the starting point.
39644 Arguments that are not understood by the remote stub will be silently
39647 @item qXfer:memory-map:read::@var{offset},@var{length}
39648 @anchor{qXfer memory map read}
39649 Access the target's @dfn{memory-map}. @xref{Memory Map Format}. The
39650 annex part of the generic @samp{qXfer} packet must be empty
39651 (@pxref{qXfer read}).
39653 This packet is not probed by default; the remote stub must request it,
39654 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
39656 @item qXfer:sdata:read::@var{offset},@var{length}
39657 @anchor{qXfer sdata read}
39659 Read contents of the extra collected static tracepoint marker
39660 information. The annex part of the generic @samp{qXfer} packet must
39661 be empty (@pxref{qXfer read}). @xref{Tracepoint Actions,,Tracepoint
39664 This packet is not probed by default; the remote stub must request it,
39665 by supplying an appropriate @samp{qSupported} response
39666 (@pxref{qSupported}).
39668 @item qXfer:siginfo:read::@var{offset},@var{length}
39669 @anchor{qXfer siginfo read}
39670 Read contents of the extra signal information on the target
39671 system. The annex part of the generic @samp{qXfer} packet must be
39672 empty (@pxref{qXfer read}).
39674 This packet is not probed by default; the remote stub must request it,
39675 by supplying an appropriate @samp{qSupported} response
39676 (@pxref{qSupported}).
39678 @item qXfer:spu:read:@var{annex}:@var{offset},@var{length}
39679 @anchor{qXfer spu read}
39680 Read contents of an @code{spufs} file on the target system. The
39681 annex specifies which file to read; it must be of the form
39682 @file{@var{id}/@var{name}}, where @var{id} specifies an SPU context ID
39683 in the target process, and @var{name} identifes the @code{spufs} file
39684 in that context to be accessed.
39686 This packet is not probed by default; the remote stub must request it,
39687 by supplying an appropriate @samp{qSupported} response
39688 (@pxref{qSupported}).
39690 @item qXfer:threads:read::@var{offset},@var{length}
39691 @anchor{qXfer threads read}
39692 Access the list of threads on target. @xref{Thread List Format}. The
39693 annex part of the generic @samp{qXfer} packet must be empty
39694 (@pxref{qXfer read}).
39696 This packet is not probed by default; the remote stub must request it,
39697 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
39699 @item qXfer:traceframe-info:read::@var{offset},@var{length}
39700 @anchor{qXfer traceframe info read}
39702 Return a description of the current traceframe's contents.
39703 @xref{Traceframe Info Format}. The annex part of the generic
39704 @samp{qXfer} packet must be empty (@pxref{qXfer read}).
39706 This packet is not probed by default; the remote stub must request it,
39707 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
39709 @item qXfer:uib:read:@var{pc}:@var{offset},@var{length}
39710 @anchor{qXfer unwind info block}
39712 Return the unwind information block for @var{pc}. This packet is used
39713 on OpenVMS/ia64 to ask the kernel unwind information.
39715 This packet is not probed by default.
39717 @item qXfer:fdpic:read:@var{annex}:@var{offset},@var{length}
39718 @anchor{qXfer fdpic loadmap read}
39719 Read contents of @code{loadmap}s on the target system. The
39720 annex, either @samp{exec} or @samp{interp}, specifies which @code{loadmap},
39721 executable @code{loadmap} or interpreter @code{loadmap} to read.
39723 This packet is not probed by default; the remote stub must request it,
39724 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
39726 @item qXfer:osdata:read::@var{offset},@var{length}
39727 @anchor{qXfer osdata read}
39728 Access the target's @dfn{operating system information}.
39729 @xref{Operating System Information}.
39733 @item qXfer:@var{object}:write:@var{annex}:@var{offset}:@var{data}@dots{}
39734 @cindex write data into object, remote request
39735 @anchor{qXfer write}
39736 Write uninterpreted bytes into the target's special data area
39737 identified by the keyword @var{object}, starting at @var{offset} bytes
39738 into the data. The binary-encoded data (@pxref{Binary Data}) to be
39739 written is given by @var{data}@dots{}. The content and encoding of @var{annex}
39740 is specific to @var{object}; it can supply additional details about what data
39746 @var{nn} (hex encoded) is the number of bytes written.
39747 This may be fewer bytes than supplied in the request.
39750 The request was malformed, or @var{annex} was invalid.
39753 The offset was invalid, or there was an error encountered writing the data.
39754 The @var{nn} part is a hex-encoded @code{errno} value.
39757 An empty reply indicates the @var{object} string was not
39758 recognized by the stub, or that the object does not support writing.
39761 Here are the specific requests of this form defined so far. All the
39762 @samp{qXfer:@var{object}:write:@dots{}} requests use the same reply
39763 formats, listed above.
39766 @item qXfer:siginfo:write::@var{offset}:@var{data}@dots{}
39767 @anchor{qXfer siginfo write}
39768 Write @var{data} to the extra signal information on the target system.
39769 The annex part of the generic @samp{qXfer} packet must be
39770 empty (@pxref{qXfer write}).
39772 This packet is not probed by default; the remote stub must request it,
39773 by supplying an appropriate @samp{qSupported} response
39774 (@pxref{qSupported}).
39776 @item qXfer:spu:write:@var{annex}:@var{offset}:@var{data}@dots{}
39777 @anchor{qXfer spu write}
39778 Write @var{data} to an @code{spufs} file on the target system. The
39779 annex specifies which file to write; it must be of the form
39780 @file{@var{id}/@var{name}}, where @var{id} specifies an SPU context ID
39781 in the target process, and @var{name} identifes the @code{spufs} file
39782 in that context to be accessed.
39784 This packet is not probed by default; the remote stub must request it,
39785 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
39788 @item qXfer:@var{object}:@var{operation}:@dots{}
39789 Requests of this form may be added in the future. When a stub does
39790 not recognize the @var{object} keyword, or its support for
39791 @var{object} does not recognize the @var{operation} keyword, the stub
39792 must respond with an empty packet.
39794 @item qAttached:@var{pid}
39795 @cindex query attached, remote request
39796 @cindex @samp{qAttached} packet
39797 Return an indication of whether the remote server attached to an
39798 existing process or created a new process. When the multiprocess
39799 protocol extensions are supported (@pxref{multiprocess extensions}),
39800 @var{pid} is an integer in hexadecimal format identifying the target
39801 process. Otherwise, @value{GDBN} will omit the @var{pid} field and
39802 the query packet will be simplified as @samp{qAttached}.
39804 This query is used, for example, to know whether the remote process
39805 should be detached or killed when a @value{GDBN} session is ended with
39806 the @code{quit} command.
39811 The remote server attached to an existing process.
39813 The remote server created a new process.
39815 A badly formed request or an error was encountered.
39819 Enable branch tracing for the current thread using Branch Trace Store.
39824 Branch tracing has been enabled.
39826 A badly formed request or an error was encountered.
39830 Enable branch tracing for the current thread using Intel Processor Trace.
39835 Branch tracing has been enabled.
39837 A badly formed request or an error was encountered.
39841 Disable branch tracing for the current thread.
39846 Branch tracing has been disabled.
39848 A badly formed request or an error was encountered.
39851 @item Qbtrace-conf:bts:size=@var{value}
39852 Set the requested ring buffer size for new threads that use the
39853 btrace recording method in bts format.
39858 The ring buffer size has been set.
39860 A badly formed request or an error was encountered.
39863 @item Qbtrace-conf:pt:size=@var{value}
39864 Set the requested ring buffer size for new threads that use the
39865 btrace recording method in pt format.
39870 The ring buffer size has been set.
39872 A badly formed request or an error was encountered.
39877 @node Architecture-Specific Protocol Details
39878 @section Architecture-Specific Protocol Details
39880 This section describes how the remote protocol is applied to specific
39881 target architectures. Also see @ref{Standard Target Features}, for
39882 details of XML target descriptions for each architecture.
39885 * ARM-Specific Protocol Details::
39886 * MIPS-Specific Protocol Details::
39889 @node ARM-Specific Protocol Details
39890 @subsection @acronym{ARM}-specific Protocol Details
39893 * ARM Breakpoint Kinds::
39896 @node ARM Breakpoint Kinds
39897 @subsubsection @acronym{ARM} Breakpoint Kinds
39898 @cindex breakpoint kinds, @acronym{ARM}
39900 These breakpoint kinds are defined for the @samp{Z0} and @samp{Z1} packets.
39905 16-bit Thumb mode breakpoint.
39908 32-bit Thumb mode (Thumb-2) breakpoint.
39911 32-bit @acronym{ARM} mode breakpoint.
39915 @node MIPS-Specific Protocol Details
39916 @subsection @acronym{MIPS}-specific Protocol Details
39919 * MIPS Register packet Format::
39920 * MIPS Breakpoint Kinds::
39923 @node MIPS Register packet Format
39924 @subsubsection @acronym{MIPS} Register Packet Format
39925 @cindex register packet format, @acronym{MIPS}
39927 The following @code{g}/@code{G} packets have previously been defined.
39928 In the below, some thirty-two bit registers are transferred as
39929 sixty-four bits. Those registers should be zero/sign extended (which?)
39930 to fill the space allocated. Register bytes are transferred in target
39931 byte order. The two nibbles within a register byte are transferred
39932 most-significant -- least-significant.
39937 All registers are transferred as thirty-two bit quantities in the order:
39938 32 general-purpose; sr; lo; hi; bad; cause; pc; 32 floating-point
39939 registers; fsr; fir; fp.
39942 All registers are transferred as sixty-four bit quantities (including
39943 thirty-two bit registers such as @code{sr}). The ordering is the same
39948 @node MIPS Breakpoint Kinds
39949 @subsubsection @acronym{MIPS} Breakpoint Kinds
39950 @cindex breakpoint kinds, @acronym{MIPS}
39952 These breakpoint kinds are defined for the @samp{Z0} and @samp{Z1} packets.
39957 16-bit @acronym{MIPS16} mode breakpoint.
39960 16-bit @acronym{microMIPS} mode breakpoint.
39963 32-bit standard @acronym{MIPS} mode breakpoint.
39966 32-bit @acronym{microMIPS} mode breakpoint.
39970 @node Tracepoint Packets
39971 @section Tracepoint Packets
39972 @cindex tracepoint packets
39973 @cindex packets, tracepoint
39975 Here we describe the packets @value{GDBN} uses to implement
39976 tracepoints (@pxref{Tracepoints}).
39980 @item QTDP:@var{n}:@var{addr}:@var{ena}:@var{step}:@var{pass}[:F@var{flen}][:X@var{len},@var{bytes}]@r{[}-@r{]}
39981 @cindex @samp{QTDP} packet
39982 Create a new tracepoint, number @var{n}, at @var{addr}. If @var{ena}
39983 is @samp{E}, then the tracepoint is enabled; if it is @samp{D}, then
39984 the tracepoint is disabled. The @var{step} gives the tracepoint's step
39985 count, and @var{pass} gives its pass count. If an @samp{F} is present,
39986 then the tracepoint is to be a fast tracepoint, and the @var{flen} is
39987 the number of bytes that the target should copy elsewhere to make room
39988 for the tracepoint. If an @samp{X} is present, it introduces a
39989 tracepoint condition, which consists of a hexadecimal length, followed
39990 by a comma and hex-encoded bytes, in a manner similar to action
39991 encodings as described below. If the trailing @samp{-} is present,
39992 further @samp{QTDP} packets will follow to specify this tracepoint's
39998 The packet was understood and carried out.
40000 @xref{Tracepoint Packets,,Relocate instruction reply packet}.
40002 The packet was not recognized.
40005 @item QTDP:-@var{n}:@var{addr}:@r{[}S@r{]}@var{action}@dots{}@r{[}-@r{]}
40006 Define actions to be taken when a tracepoint is hit. The @var{n} and
40007 @var{addr} must be the same as in the initial @samp{QTDP} packet for
40008 this tracepoint. This packet may only be sent immediately after
40009 another @samp{QTDP} packet that ended with a @samp{-}. If the
40010 trailing @samp{-} is present, further @samp{QTDP} packets will follow,
40011 specifying more actions for this tracepoint.
40013 In the series of action packets for a given tracepoint, at most one
40014 can have an @samp{S} before its first @var{action}. If such a packet
40015 is sent, it and the following packets define ``while-stepping''
40016 actions. Any prior packets define ordinary actions --- that is, those
40017 taken when the tracepoint is first hit. If no action packet has an
40018 @samp{S}, then all the packets in the series specify ordinary
40019 tracepoint actions.
40021 The @samp{@var{action}@dots{}} portion of the packet is a series of
40022 actions, concatenated without separators. Each action has one of the
40028 Collect the registers whose bits are set in @var{mask},
40029 a hexadecimal number whose @var{i}'th bit is set if register number
40030 @var{i} should be collected. (The least significant bit is numbered
40031 zero.) Note that @var{mask} may be any number of digits long; it may
40032 not fit in a 32-bit word.
40034 @item M @var{basereg},@var{offset},@var{len}
40035 Collect @var{len} bytes of memory starting at the address in register
40036 number @var{basereg}, plus @var{offset}. If @var{basereg} is
40037 @samp{-1}, then the range has a fixed address: @var{offset} is the
40038 address of the lowest byte to collect. The @var{basereg},
40039 @var{offset}, and @var{len} parameters are all unsigned hexadecimal
40040 values (the @samp{-1} value for @var{basereg} is a special case).
40042 @item X @var{len},@var{expr}
40043 Evaluate @var{expr}, whose length is @var{len}, and collect memory as
40044 it directs. The agent expression @var{expr} is as described in
40045 @ref{Agent Expressions}. Each byte of the expression is encoded as a
40046 two-digit hex number in the packet; @var{len} is the number of bytes
40047 in the expression (and thus one-half the number of hex digits in the
40052 Any number of actions may be packed together in a single @samp{QTDP}
40053 packet, as long as the packet does not exceed the maximum packet
40054 length (400 bytes, for many stubs). There may be only one @samp{R}
40055 action per tracepoint, and it must precede any @samp{M} or @samp{X}
40056 actions. Any registers referred to by @samp{M} and @samp{X} actions
40057 must be collected by a preceding @samp{R} action. (The
40058 ``while-stepping'' actions are treated as if they were attached to a
40059 separate tracepoint, as far as these restrictions are concerned.)
40064 The packet was understood and carried out.
40066 @xref{Tracepoint Packets,,Relocate instruction reply packet}.
40068 The packet was not recognized.
40071 @item QTDPsrc:@var{n}:@var{addr}:@var{type}:@var{start}:@var{slen}:@var{bytes}
40072 @cindex @samp{QTDPsrc} packet
40073 Specify a source string of tracepoint @var{n} at address @var{addr}.
40074 This is useful to get accurate reproduction of the tracepoints
40075 originally downloaded at the beginning of the trace run. The @var{type}
40076 is the name of the tracepoint part, such as @samp{cond} for the
40077 tracepoint's conditional expression (see below for a list of types), while
40078 @var{bytes} is the string, encoded in hexadecimal.
40080 @var{start} is the offset of the @var{bytes} within the overall source
40081 string, while @var{slen} is the total length of the source string.
40082 This is intended for handling source strings that are longer than will
40083 fit in a single packet.
40084 @c Add detailed example when this info is moved into a dedicated
40085 @c tracepoint descriptions section.
40087 The available string types are @samp{at} for the location,
40088 @samp{cond} for the conditional, and @samp{cmd} for an action command.
40089 @value{GDBN} sends a separate packet for each command in the action
40090 list, in the same order in which the commands are stored in the list.
40092 The target does not need to do anything with source strings except
40093 report them back as part of the replies to the @samp{qTfP}/@samp{qTsP}
40096 Although this packet is optional, and @value{GDBN} will only send it
40097 if the target replies with @samp{TracepointSource} @xref{General
40098 Query Packets}, it makes both disconnected tracing and trace files
40099 much easier to use. Otherwise the user must be careful that the
40100 tracepoints in effect while looking at trace frames are identical to
40101 the ones in effect during the trace run; even a small discrepancy
40102 could cause @samp{tdump} not to work, or a particular trace frame not
40105 @item QTDV:@var{n}:@var{value}:@var{builtin}:@var{name}
40106 @cindex define trace state variable, remote request
40107 @cindex @samp{QTDV} packet
40108 Create a new trace state variable, number @var{n}, with an initial
40109 value of @var{value}, which is a 64-bit signed integer. Both @var{n}
40110 and @var{value} are encoded as hexadecimal values. @value{GDBN} has
40111 the option of not using this packet for initial values of zero; the
40112 target should simply create the trace state variables as they are
40113 mentioned in expressions. The value @var{builtin} should be 1 (one)
40114 if the trace state variable is builtin and 0 (zero) if it is not builtin.
40115 @value{GDBN} only sets @var{builtin} to 1 if a previous @samp{qTfV} or
40116 @samp{qTsV} packet had it set. The contents of @var{name} is the
40117 hex-encoded name (without the leading @samp{$}) of the trace state
40120 @item QTFrame:@var{n}
40121 @cindex @samp{QTFrame} packet
40122 Select the @var{n}'th tracepoint frame from the buffer, and use the
40123 register and memory contents recorded there to answer subsequent
40124 request packets from @value{GDBN}.
40126 A successful reply from the stub indicates that the stub has found the
40127 requested frame. The response is a series of parts, concatenated
40128 without separators, describing the frame we selected. Each part has
40129 one of the following forms:
40133 The selected frame is number @var{n} in the trace frame buffer;
40134 @var{f} is a hexadecimal number. If @var{f} is @samp{-1}, then there
40135 was no frame matching the criteria in the request packet.
40138 The selected trace frame records a hit of tracepoint number @var{t};
40139 @var{t} is a hexadecimal number.
40143 @item QTFrame:pc:@var{addr}
40144 Like @samp{QTFrame:@var{n}}, but select the first tracepoint frame after the
40145 currently selected frame whose PC is @var{addr};
40146 @var{addr} is a hexadecimal number.
40148 @item QTFrame:tdp:@var{t}
40149 Like @samp{QTFrame:@var{n}}, but select the first tracepoint frame after the
40150 currently selected frame that is a hit of tracepoint @var{t}; @var{t}
40151 is a hexadecimal number.
40153 @item QTFrame:range:@var{start}:@var{end}
40154 Like @samp{QTFrame:@var{n}}, but select the first tracepoint frame after the
40155 currently selected frame whose PC is between @var{start} (inclusive)
40156 and @var{end} (inclusive); @var{start} and @var{end} are hexadecimal
40159 @item QTFrame:outside:@var{start}:@var{end}
40160 Like @samp{QTFrame:range:@var{start}:@var{end}}, but select the first
40161 frame @emph{outside} the given range of addresses (exclusive).
40164 @cindex @samp{qTMinFTPILen} packet
40165 This packet requests the minimum length of instruction at which a fast
40166 tracepoint (@pxref{Set Tracepoints}) may be placed. For instance, on
40167 the 32-bit x86 architecture, it is possible to use a 4-byte jump, but
40168 it depends on the target system being able to create trampolines in
40169 the first 64K of memory, which might or might not be possible for that
40170 system. So the reply to this packet will be 4 if it is able to
40177 The minimum instruction length is currently unknown.
40179 The minimum instruction length is @var{length}, where @var{length}
40180 is a hexadecimal number greater or equal to 1. A reply
40181 of 1 means that a fast tracepoint may be placed on any instruction
40182 regardless of size.
40184 An error has occurred.
40186 An empty reply indicates that the request is not supported by the stub.
40190 @cindex @samp{QTStart} packet
40191 Begin the tracepoint experiment. Begin collecting data from
40192 tracepoint hits in the trace frame buffer. This packet supports the
40193 @samp{qRelocInsn} reply (@pxref{Tracepoint Packets,,Relocate
40194 instruction reply packet}).
40197 @cindex @samp{QTStop} packet
40198 End the tracepoint experiment. Stop collecting trace frames.
40200 @item QTEnable:@var{n}:@var{addr}
40202 @cindex @samp{QTEnable} packet
40203 Enable tracepoint @var{n} at address @var{addr} in a started tracepoint
40204 experiment. If the tracepoint was previously disabled, then collection
40205 of data from it will resume.
40207 @item QTDisable:@var{n}:@var{addr}
40209 @cindex @samp{QTDisable} packet
40210 Disable tracepoint @var{n} at address @var{addr} in a started tracepoint
40211 experiment. No more data will be collected from the tracepoint unless
40212 @samp{QTEnable:@var{n}:@var{addr}} is subsequently issued.
40215 @cindex @samp{QTinit} packet
40216 Clear the table of tracepoints, and empty the trace frame buffer.
40218 @item QTro:@var{start1},@var{end1}:@var{start2},@var{end2}:@dots{}
40219 @cindex @samp{QTro} packet
40220 Establish the given ranges of memory as ``transparent''. The stub
40221 will answer requests for these ranges from memory's current contents,
40222 if they were not collected as part of the tracepoint hit.
40224 @value{GDBN} uses this to mark read-only regions of memory, like those
40225 containing program code. Since these areas never change, they should
40226 still have the same contents they did when the tracepoint was hit, so
40227 there's no reason for the stub to refuse to provide their contents.
40229 @item QTDisconnected:@var{value}
40230 @cindex @samp{QTDisconnected} packet
40231 Set the choice to what to do with the tracing run when @value{GDBN}
40232 disconnects from the target. A @var{value} of 1 directs the target to
40233 continue the tracing run, while 0 tells the target to stop tracing if
40234 @value{GDBN} is no longer in the picture.
40237 @cindex @samp{qTStatus} packet
40238 Ask the stub if there is a trace experiment running right now.
40240 The reply has the form:
40244 @item T@var{running}@r{[};@var{field}@r{]}@dots{}
40245 @var{running} is a single digit @code{1} if the trace is presently
40246 running, or @code{0} if not. It is followed by semicolon-separated
40247 optional fields that an agent may use to report additional status.
40251 If the trace is not running, the agent may report any of several
40252 explanations as one of the optional fields:
40257 No trace has been run yet.
40259 @item tstop[:@var{text}]:0
40260 The trace was stopped by a user-originated stop command. The optional
40261 @var{text} field is a user-supplied string supplied as part of the
40262 stop command (for instance, an explanation of why the trace was
40263 stopped manually). It is hex-encoded.
40266 The trace stopped because the trace buffer filled up.
40268 @item tdisconnected:0
40269 The trace stopped because @value{GDBN} disconnected from the target.
40271 @item tpasscount:@var{tpnum}
40272 The trace stopped because tracepoint @var{tpnum} exceeded its pass count.
40274 @item terror:@var{text}:@var{tpnum}
40275 The trace stopped because tracepoint @var{tpnum} had an error. The
40276 string @var{text} is available to describe the nature of the error
40277 (for instance, a divide by zero in the condition expression); it
40281 The trace stopped for some other reason.
40285 Additional optional fields supply statistical and other information.
40286 Although not required, they are extremely useful for users monitoring
40287 the progress of a trace run. If a trace has stopped, and these
40288 numbers are reported, they must reflect the state of the just-stopped
40293 @item tframes:@var{n}
40294 The number of trace frames in the buffer.
40296 @item tcreated:@var{n}
40297 The total number of trace frames created during the run. This may
40298 be larger than the trace frame count, if the buffer is circular.
40300 @item tsize:@var{n}
40301 The total size of the trace buffer, in bytes.
40303 @item tfree:@var{n}
40304 The number of bytes still unused in the buffer.
40306 @item circular:@var{n}
40307 The value of the circular trace buffer flag. @code{1} means that the
40308 trace buffer is circular and old trace frames will be discarded if
40309 necessary to make room, @code{0} means that the trace buffer is linear
40312 @item disconn:@var{n}
40313 The value of the disconnected tracing flag. @code{1} means that
40314 tracing will continue after @value{GDBN} disconnects, @code{0} means
40315 that the trace run will stop.
40319 @item qTP:@var{tp}:@var{addr}
40320 @cindex tracepoint status, remote request
40321 @cindex @samp{qTP} packet
40322 Ask the stub for the current state of tracepoint number @var{tp} at
40323 address @var{addr}.
40327 @item V@var{hits}:@var{usage}
40328 The tracepoint has been hit @var{hits} times so far during the trace
40329 run, and accounts for @var{usage} in the trace buffer. Note that
40330 @code{while-stepping} steps are not counted as separate hits, but the
40331 steps' space consumption is added into the usage number.
40335 @item qTV:@var{var}
40336 @cindex trace state variable value, remote request
40337 @cindex @samp{qTV} packet
40338 Ask the stub for the value of the trace state variable number @var{var}.
40343 The value of the variable is @var{value}. This will be the current
40344 value of the variable if the user is examining a running target, or a
40345 saved value if the variable was collected in the trace frame that the
40346 user is looking at. Note that multiple requests may result in
40347 different reply values, such as when requesting values while the
40348 program is running.
40351 The value of the variable is unknown. This would occur, for example,
40352 if the user is examining a trace frame in which the requested variable
40357 @cindex @samp{qTfP} packet
40359 @cindex @samp{qTsP} packet
40360 These packets request data about tracepoints that are being used by
40361 the target. @value{GDBN} sends @code{qTfP} to get the first piece
40362 of data, and multiple @code{qTsP} to get additional pieces. Replies
40363 to these packets generally take the form of the @code{QTDP} packets
40364 that define tracepoints. (FIXME add detailed syntax)
40367 @cindex @samp{qTfV} packet
40369 @cindex @samp{qTsV} packet
40370 These packets request data about trace state variables that are on the
40371 target. @value{GDBN} sends @code{qTfV} to get the first vari of data,
40372 and multiple @code{qTsV} to get additional variables. Replies to
40373 these packets follow the syntax of the @code{QTDV} packets that define
40374 trace state variables.
40380 @cindex @samp{qTfSTM} packet
40381 @cindex @samp{qTsSTM} packet
40382 These packets request data about static tracepoint markers that exist
40383 in the target program. @value{GDBN} sends @code{qTfSTM} to get the
40384 first piece of data, and multiple @code{qTsSTM} to get additional
40385 pieces. Replies to these packets take the following form:
40389 @item m @var{address}:@var{id}:@var{extra}
40391 @item m @var{address}:@var{id}:@var{extra},@var{address}:@var{id}:@var{extra}@dots{}
40392 a comma-separated list of markers
40394 (lower case letter @samp{L}) denotes end of list.
40396 An error occurred. The error number @var{nn} is given as hex digits.
40398 An empty reply indicates that the request is not supported by the
40402 The @var{address} is encoded in hex;
40403 @var{id} and @var{extra} are strings encoded in hex.
40405 In response to each query, the target will reply with a list of one or
40406 more markers, separated by commas. @value{GDBN} will respond to each
40407 reply with a request for more markers (using the @samp{qs} form of the
40408 query), until the target responds with @samp{l} (lower-case ell, for
40411 @item qTSTMat:@var{address}
40413 @cindex @samp{qTSTMat} packet
40414 This packets requests data about static tracepoint markers in the
40415 target program at @var{address}. Replies to this packet follow the
40416 syntax of the @samp{qTfSTM} and @code{qTsSTM} packets that list static
40417 tracepoint markers.
40419 @item QTSave:@var{filename}
40420 @cindex @samp{QTSave} packet
40421 This packet directs the target to save trace data to the file name
40422 @var{filename} in the target's filesystem. The @var{filename} is encoded
40423 as a hex string; the interpretation of the file name (relative vs
40424 absolute, wild cards, etc) is up to the target.
40426 @item qTBuffer:@var{offset},@var{len}
40427 @cindex @samp{qTBuffer} packet
40428 Return up to @var{len} bytes of the current contents of trace buffer,
40429 starting at @var{offset}. The trace buffer is treated as if it were
40430 a contiguous collection of traceframes, as per the trace file format.
40431 The reply consists as many hex-encoded bytes as the target can deliver
40432 in a packet; it is not an error to return fewer than were asked for.
40433 A reply consisting of just @code{l} indicates that no bytes are
40436 @item QTBuffer:circular:@var{value}
40437 This packet directs the target to use a circular trace buffer if
40438 @var{value} is 1, or a linear buffer if the value is 0.
40440 @item QTBuffer:size:@var{size}
40441 @anchor{QTBuffer-size}
40442 @cindex @samp{QTBuffer size} packet
40443 This packet directs the target to make the trace buffer be of size
40444 @var{size} if possible. A value of @code{-1} tells the target to
40445 use whatever size it prefers.
40447 @item QTNotes:@r{[}@var{type}:@var{text}@r{]}@r{[};@var{type}:@var{text}@r{]}@dots{}
40448 @cindex @samp{QTNotes} packet
40449 This packet adds optional textual notes to the trace run. Allowable
40450 types include @code{user}, @code{notes}, and @code{tstop}, the
40451 @var{text} fields are arbitrary strings, hex-encoded.
40455 @subsection Relocate instruction reply packet
40456 When installing fast tracepoints in memory, the target may need to
40457 relocate the instruction currently at the tracepoint address to a
40458 different address in memory. For most instructions, a simple copy is
40459 enough, but, for example, call instructions that implicitly push the
40460 return address on the stack, and relative branches or other
40461 PC-relative instructions require offset adjustment, so that the effect
40462 of executing the instruction at a different address is the same as if
40463 it had executed in the original location.
40465 In response to several of the tracepoint packets, the target may also
40466 respond with a number of intermediate @samp{qRelocInsn} request
40467 packets before the final result packet, to have @value{GDBN} handle
40468 this relocation operation. If a packet supports this mechanism, its
40469 documentation will explicitly say so. See for example the above
40470 descriptions for the @samp{QTStart} and @samp{QTDP} packets. The
40471 format of the request is:
40474 @item qRelocInsn:@var{from};@var{to}
40476 This requests @value{GDBN} to copy instruction at address @var{from}
40477 to address @var{to}, possibly adjusted so that executing the
40478 instruction at @var{to} has the same effect as executing it at
40479 @var{from}. @value{GDBN} writes the adjusted instruction to target
40480 memory starting at @var{to}.
40485 @item qRelocInsn:@var{adjusted_size}
40486 Informs the stub the relocation is complete. The @var{adjusted_size} is
40487 the length in bytes of resulting relocated instruction sequence.
40489 A badly formed request was detected, or an error was encountered while
40490 relocating the instruction.
40493 @node Host I/O Packets
40494 @section Host I/O Packets
40495 @cindex Host I/O, remote protocol
40496 @cindex file transfer, remote protocol
40498 The @dfn{Host I/O} packets allow @value{GDBN} to perform I/O
40499 operations on the far side of a remote link. For example, Host I/O is
40500 used to upload and download files to a remote target with its own
40501 filesystem. Host I/O uses the same constant values and data structure
40502 layout as the target-initiated File-I/O protocol. However, the
40503 Host I/O packets are structured differently. The target-initiated
40504 protocol relies on target memory to store parameters and buffers.
40505 Host I/O requests are initiated by @value{GDBN}, and the
40506 target's memory is not involved. @xref{File-I/O Remote Protocol
40507 Extension}, for more details on the target-initiated protocol.
40509 The Host I/O request packets all encode a single operation along with
40510 its arguments. They have this format:
40514 @item vFile:@var{operation}: @var{parameter}@dots{}
40515 @var{operation} is the name of the particular request; the target
40516 should compare the entire packet name up to the second colon when checking
40517 for a supported operation. The format of @var{parameter} depends on
40518 the operation. Numbers are always passed in hexadecimal. Negative
40519 numbers have an explicit minus sign (i.e.@: two's complement is not
40520 used). Strings (e.g.@: filenames) are encoded as a series of
40521 hexadecimal bytes. The last argument to a system call may be a
40522 buffer of escaped binary data (@pxref{Binary Data}).
40526 The valid responses to Host I/O packets are:
40530 @item F @var{result} [, @var{errno}] [; @var{attachment}]
40531 @var{result} is the integer value returned by this operation, usually
40532 non-negative for success and -1 for errors. If an error has occured,
40533 @var{errno} will be included in the result specifying a
40534 value defined by the File-I/O protocol (@pxref{Errno Values}). For
40535 operations which return data, @var{attachment} supplies the data as a
40536 binary buffer. Binary buffers in response packets are escaped in the
40537 normal way (@pxref{Binary Data}). See the individual packet
40538 documentation for the interpretation of @var{result} and
40542 An empty response indicates that this operation is not recognized.
40546 These are the supported Host I/O operations:
40549 @item vFile:open: @var{filename}, @var{flags}, @var{mode}
40550 Open a file at @var{filename} and return a file descriptor for it, or
40551 return -1 if an error occurs. The @var{filename} is a string,
40552 @var{flags} is an integer indicating a mask of open flags
40553 (@pxref{Open Flags}), and @var{mode} is an integer indicating a mask
40554 of mode bits to use if the file is created (@pxref{mode_t Values}).
40555 @xref{open}, for details of the open flags and mode values.
40557 @item vFile:close: @var{fd}
40558 Close the open file corresponding to @var{fd} and return 0, or
40559 -1 if an error occurs.
40561 @item vFile:pread: @var{fd}, @var{count}, @var{offset}
40562 Read data from the open file corresponding to @var{fd}. Up to
40563 @var{count} bytes will be read from the file, starting at @var{offset}
40564 relative to the start of the file. The target may read fewer bytes;
40565 common reasons include packet size limits and an end-of-file
40566 condition. The number of bytes read is returned. Zero should only be
40567 returned for a successful read at the end of the file, or if
40568 @var{count} was zero.
40570 The data read should be returned as a binary attachment on success.
40571 If zero bytes were read, the response should include an empty binary
40572 attachment (i.e.@: a trailing semicolon). The return value is the
40573 number of target bytes read; the binary attachment may be longer if
40574 some characters were escaped.
40576 @item vFile:pwrite: @var{fd}, @var{offset}, @var{data}
40577 Write @var{data} (a binary buffer) to the open file corresponding
40578 to @var{fd}. Start the write at @var{offset} from the start of the
40579 file. Unlike many @code{write} system calls, there is no
40580 separate @var{count} argument; the length of @var{data} in the
40581 packet is used. @samp{vFile:write} returns the number of bytes written,
40582 which may be shorter than the length of @var{data}, or -1 if an
40585 @item vFile:fstat: @var{fd}
40586 Get information about the open file corresponding to @var{fd}.
40587 On success the information is returned as a binary attachment
40588 and the return value is the size of this attachment in bytes.
40589 If an error occurs the return value is -1. The format of the
40590 returned binary attachment is as described in @ref{struct stat}.
40592 @item vFile:unlink: @var{filename}
40593 Delete the file at @var{filename} on the target. Return 0,
40594 or -1 if an error occurs. The @var{filename} is a string.
40596 @item vFile:readlink: @var{filename}
40597 Read value of symbolic link @var{filename} on the target. Return
40598 the number of bytes read, or -1 if an error occurs.
40600 The data read should be returned as a binary attachment on success.
40601 If zero bytes were read, the response should include an empty binary
40602 attachment (i.e.@: a trailing semicolon). The return value is the
40603 number of target bytes read; the binary attachment may be longer if
40604 some characters were escaped.
40606 @item vFile:setfs: @var{pid}
40607 Select the filesystem on which @code{vFile} operations with
40608 @var{filename} arguments will operate. This is required for
40609 @value{GDBN} to be able to access files on remote targets where
40610 the remote stub does not share a common filesystem with the
40613 If @var{pid} is nonzero, select the filesystem as seen by process
40614 @var{pid}. If @var{pid} is zero, select the filesystem as seen by
40615 the remote stub. Return 0 on success, or -1 if an error occurs.
40616 If @code{vFile:setfs:} indicates success, the selected filesystem
40617 remains selected until the next successful @code{vFile:setfs:}
40623 @section Interrupts
40624 @cindex interrupts (remote protocol)
40625 @anchor{interrupting remote targets}
40627 In all-stop mode, when a program on the remote target is running,
40628 @value{GDBN} may attempt to interrupt it by sending a @samp{Ctrl-C},
40629 @code{BREAK} or a @code{BREAK} followed by @code{g}, control of which
40630 is specified via @value{GDBN}'s @samp{interrupt-sequence}.
40632 The precise meaning of @code{BREAK} is defined by the transport
40633 mechanism and may, in fact, be undefined. @value{GDBN} does not
40634 currently define a @code{BREAK} mechanism for any of the network
40635 interfaces except for TCP, in which case @value{GDBN} sends the
40636 @code{telnet} BREAK sequence.
40638 @samp{Ctrl-C}, on the other hand, is defined and implemented for all
40639 transport mechanisms. It is represented by sending the single byte
40640 @code{0x03} without any of the usual packet overhead described in
40641 the Overview section (@pxref{Overview}). When a @code{0x03} byte is
40642 transmitted as part of a packet, it is considered to be packet data
40643 and does @emph{not} represent an interrupt. E.g., an @samp{X} packet
40644 (@pxref{X packet}), used for binary downloads, may include an unescaped
40645 @code{0x03} as part of its packet.
40647 @code{BREAK} followed by @code{g} is also known as Magic SysRq g.
40648 When Linux kernel receives this sequence from serial port,
40649 it stops execution and connects to gdb.
40651 In non-stop mode, because packet resumptions are asynchronous
40652 (@pxref{vCont packet}), @value{GDBN} is always free to send a remote
40653 command to the remote stub, even when the target is running. For that
40654 reason, @value{GDBN} instead sends a regular packet (@pxref{vCtrlC
40655 packet}) with the usual packet framing instead of the single byte
40658 Stubs are not required to recognize these interrupt mechanisms and the
40659 precise meaning associated with receipt of the interrupt is
40660 implementation defined. If the target supports debugging of multiple
40661 threads and/or processes, it should attempt to interrupt all
40662 currently-executing threads and processes.
40663 If the stub is successful at interrupting the
40664 running program, it should send one of the stop
40665 reply packets (@pxref{Stop Reply Packets}) to @value{GDBN} as a result
40666 of successfully stopping the program in all-stop mode, and a stop reply
40667 for each stopped thread in non-stop mode.
40668 Interrupts received while the
40669 program is stopped are queued and the program will be interrupted when
40670 it is resumed next time.
40672 @node Notification Packets
40673 @section Notification Packets
40674 @cindex notification packets
40675 @cindex packets, notification
40677 The @value{GDBN} remote serial protocol includes @dfn{notifications},
40678 packets that require no acknowledgment. Both the GDB and the stub
40679 may send notifications (although the only notifications defined at
40680 present are sent by the stub). Notifications carry information
40681 without incurring the round-trip latency of an acknowledgment, and so
40682 are useful for low-impact communications where occasional packet loss
40685 A notification packet has the form @samp{% @var{data} #
40686 @var{checksum}}, where @var{data} is the content of the notification,
40687 and @var{checksum} is a checksum of @var{data}, computed and formatted
40688 as for ordinary @value{GDBN} packets. A notification's @var{data}
40689 never contains @samp{$}, @samp{%} or @samp{#} characters. Upon
40690 receiving a notification, the recipient sends no @samp{+} or @samp{-}
40691 to acknowledge the notification's receipt or to report its corruption.
40693 Every notification's @var{data} begins with a name, which contains no
40694 colon characters, followed by a colon character.
40696 Recipients should silently ignore corrupted notifications and
40697 notifications they do not understand. Recipients should restart
40698 timeout periods on receipt of a well-formed notification, whether or
40699 not they understand it.
40701 Senders should only send the notifications described here when this
40702 protocol description specifies that they are permitted. In the
40703 future, we may extend the protocol to permit existing notifications in
40704 new contexts; this rule helps older senders avoid confusing newer
40707 (Older versions of @value{GDBN} ignore bytes received until they see
40708 the @samp{$} byte that begins an ordinary packet, so new stubs may
40709 transmit notifications without fear of confusing older clients. There
40710 are no notifications defined for @value{GDBN} to send at the moment, but we
40711 assume that most older stubs would ignore them, as well.)
40713 Each notification is comprised of three parts:
40715 @item @var{name}:@var{event}
40716 The notification packet is sent by the side that initiates the
40717 exchange (currently, only the stub does that), with @var{event}
40718 carrying the specific information about the notification, and
40719 @var{name} specifying the name of the notification.
40721 The acknowledge sent by the other side, usually @value{GDBN}, to
40722 acknowledge the exchange and request the event.
40725 The purpose of an asynchronous notification mechanism is to report to
40726 @value{GDBN} that something interesting happened in the remote stub.
40728 The remote stub may send notification @var{name}:@var{event}
40729 at any time, but @value{GDBN} acknowledges the notification when
40730 appropriate. The notification event is pending before @value{GDBN}
40731 acknowledges. Only one notification at a time may be pending; if
40732 additional events occur before @value{GDBN} has acknowledged the
40733 previous notification, they must be queued by the stub for later
40734 synchronous transmission in response to @var{ack} packets from
40735 @value{GDBN}. Because the notification mechanism is unreliable,
40736 the stub is permitted to resend a notification if it believes
40737 @value{GDBN} may not have received it.
40739 Specifically, notifications may appear when @value{GDBN} is not
40740 otherwise reading input from the stub, or when @value{GDBN} is
40741 expecting to read a normal synchronous response or a
40742 @samp{+}/@samp{-} acknowledgment to a packet it has sent.
40743 Notification packets are distinct from any other communication from
40744 the stub so there is no ambiguity.
40746 After receiving a notification, @value{GDBN} shall acknowledge it by
40747 sending a @var{ack} packet as a regular, synchronous request to the
40748 stub. Such acknowledgment is not required to happen immediately, as
40749 @value{GDBN} is permitted to send other, unrelated packets to the
40750 stub first, which the stub should process normally.
40752 Upon receiving a @var{ack} packet, if the stub has other queued
40753 events to report to @value{GDBN}, it shall respond by sending a
40754 normal @var{event}. @value{GDBN} shall then send another @var{ack}
40755 packet to solicit further responses; again, it is permitted to send
40756 other, unrelated packets as well which the stub should process
40759 If the stub receives a @var{ack} packet and there are no additional
40760 @var{event} to report, the stub shall return an @samp{OK} response.
40761 At this point, @value{GDBN} has finished processing a notification
40762 and the stub has completed sending any queued events. @value{GDBN}
40763 won't accept any new notifications until the final @samp{OK} is
40764 received . If further notification events occur, the stub shall send
40765 a new notification, @value{GDBN} shall accept the notification, and
40766 the process shall be repeated.
40768 The process of asynchronous notification can be illustrated by the
40771 <- @code{%Stop:T0505:98e7ffbf;04:4ce6ffbf;08:b1b6e54c;thread:p7526.7526;core:0;}
40774 <- @code{T0505:68f37db7;04:40f37db7;08:63850408;thread:p7526.7528;core:0;}
40776 <- @code{T0505:68e3fdb6;04:40e3fdb6;08:63850408;thread:p7526.7529;core:0;}
40781 The following notifications are defined:
40782 @multitable @columnfractions 0.12 0.12 0.38 0.38
40791 @tab @var{reply}. The @var{reply} has the form of a stop reply, as
40792 described in @ref{Stop Reply Packets}. Refer to @ref{Remote Non-Stop},
40793 for information on how these notifications are acknowledged by
40795 @tab Report an asynchronous stop event in non-stop mode.
40799 @node Remote Non-Stop
40800 @section Remote Protocol Support for Non-Stop Mode
40802 @value{GDBN}'s remote protocol supports non-stop debugging of
40803 multi-threaded programs, as described in @ref{Non-Stop Mode}. If the stub
40804 supports non-stop mode, it should report that to @value{GDBN} by including
40805 @samp{QNonStop+} in its @samp{qSupported} response (@pxref{qSupported}).
40807 @value{GDBN} typically sends a @samp{QNonStop} packet only when
40808 establishing a new connection with the stub. Entering non-stop mode
40809 does not alter the state of any currently-running threads, but targets
40810 must stop all threads in any already-attached processes when entering
40811 all-stop mode. @value{GDBN} uses the @samp{?} packet as necessary to
40812 probe the target state after a mode change.
40814 In non-stop mode, when an attached process encounters an event that
40815 would otherwise be reported with a stop reply, it uses the
40816 asynchronous notification mechanism (@pxref{Notification Packets}) to
40817 inform @value{GDBN}. In contrast to all-stop mode, where all threads
40818 in all processes are stopped when a stop reply is sent, in non-stop
40819 mode only the thread reporting the stop event is stopped. That is,
40820 when reporting a @samp{S} or @samp{T} response to indicate completion
40821 of a step operation, hitting a breakpoint, or a fault, only the
40822 affected thread is stopped; any other still-running threads continue
40823 to run. When reporting a @samp{W} or @samp{X} response, all running
40824 threads belonging to other attached processes continue to run.
40826 In non-stop mode, the target shall respond to the @samp{?} packet as
40827 follows. First, any incomplete stop reply notification/@samp{vStopped}
40828 sequence in progress is abandoned. The target must begin a new
40829 sequence reporting stop events for all stopped threads, whether or not
40830 it has previously reported those events to @value{GDBN}. The first
40831 stop reply is sent as a synchronous reply to the @samp{?} packet, and
40832 subsequent stop replies are sent as responses to @samp{vStopped} packets
40833 using the mechanism described above. The target must not send
40834 asynchronous stop reply notifications until the sequence is complete.
40835 If all threads are running when the target receives the @samp{?} packet,
40836 or if the target is not attached to any process, it shall respond
40839 If the stub supports non-stop mode, it should also support the
40840 @samp{swbreak} stop reason if software breakpoints are supported, and
40841 the @samp{hwbreak} stop reason if hardware breakpoints are supported
40842 (@pxref{swbreak stop reason}). This is because given the asynchronous
40843 nature of non-stop mode, between the time a thread hits a breakpoint
40844 and the time the event is finally processed by @value{GDBN}, the
40845 breakpoint may have already been removed from the target. Due to
40846 this, @value{GDBN} needs to be able to tell whether a trap stop was
40847 caused by a delayed breakpoint event, which should be ignored, as
40848 opposed to a random trap signal, which should be reported to the user.
40849 Note the @samp{swbreak} feature implies that the target is responsible
40850 for adjusting the PC when a software breakpoint triggers, if
40851 necessary, such as on the x86 architecture.
40853 @node Packet Acknowledgment
40854 @section Packet Acknowledgment
40856 @cindex acknowledgment, for @value{GDBN} remote
40857 @cindex packet acknowledgment, for @value{GDBN} remote
40858 By default, when either the host or the target machine receives a packet,
40859 the first response expected is an acknowledgment: either @samp{+} (to indicate
40860 the package was received correctly) or @samp{-} (to request retransmission).
40861 This mechanism allows the @value{GDBN} remote protocol to operate over
40862 unreliable transport mechanisms, such as a serial line.
40864 In cases where the transport mechanism is itself reliable (such as a pipe or
40865 TCP connection), the @samp{+}/@samp{-} acknowledgments are redundant.
40866 It may be desirable to disable them in that case to reduce communication
40867 overhead, or for other reasons. This can be accomplished by means of the
40868 @samp{QStartNoAckMode} packet; @pxref{QStartNoAckMode}.
40870 When in no-acknowledgment mode, neither the stub nor @value{GDBN} shall send or
40871 expect @samp{+}/@samp{-} protocol acknowledgments. The packet
40872 and response format still includes the normal checksum, as described in
40873 @ref{Overview}, but the checksum may be ignored by the receiver.
40875 If the stub supports @samp{QStartNoAckMode} and prefers to operate in
40876 no-acknowledgment mode, it should report that to @value{GDBN}
40877 by including @samp{QStartNoAckMode+} in its response to @samp{qSupported};
40878 @pxref{qSupported}.
40879 If @value{GDBN} also supports @samp{QStartNoAckMode} and it has not been
40880 disabled via the @code{set remote noack-packet off} command
40881 (@pxref{Remote Configuration}),
40882 @value{GDBN} may then send a @samp{QStartNoAckMode} packet to the stub.
40883 Only then may the stub actually turn off packet acknowledgments.
40884 @value{GDBN} sends a final @samp{+} acknowledgment of the stub's @samp{OK}
40885 response, which can be safely ignored by the stub.
40887 Note that @code{set remote noack-packet} command only affects negotiation
40888 between @value{GDBN} and the stub when subsequent connections are made;
40889 it does not affect the protocol acknowledgment state for any current
40891 Since @samp{+}/@samp{-} acknowledgments are enabled by default when a
40892 new connection is established,
40893 there is also no protocol request to re-enable the acknowledgments
40894 for the current connection, once disabled.
40899 Example sequence of a target being re-started. Notice how the restart
40900 does not get any direct output:
40905 @emph{target restarts}
40908 <- @code{T001:1234123412341234}
40912 Example sequence of a target being stepped by a single instruction:
40915 -> @code{G1445@dots{}}
40920 <- @code{T001:1234123412341234}
40924 <- @code{1455@dots{}}
40928 @node File-I/O Remote Protocol Extension
40929 @section File-I/O Remote Protocol Extension
40930 @cindex File-I/O remote protocol extension
40933 * File-I/O Overview::
40934 * Protocol Basics::
40935 * The F Request Packet::
40936 * The F Reply Packet::
40937 * The Ctrl-C Message::
40939 * List of Supported Calls::
40940 * Protocol-specific Representation of Datatypes::
40942 * File-I/O Examples::
40945 @node File-I/O Overview
40946 @subsection File-I/O Overview
40947 @cindex file-i/o overview
40949 The @dfn{File I/O remote protocol extension} (short: File-I/O) allows the
40950 target to use the host's file system and console I/O to perform various
40951 system calls. System calls on the target system are translated into a
40952 remote protocol packet to the host system, which then performs the needed
40953 actions and returns a response packet to the target system.
40954 This simulates file system operations even on targets that lack file systems.
40956 The protocol is defined to be independent of both the host and target systems.
40957 It uses its own internal representation of datatypes and values. Both
40958 @value{GDBN} and the target's @value{GDBN} stub are responsible for
40959 translating the system-dependent value representations into the internal
40960 protocol representations when data is transmitted.
40962 The communication is synchronous. A system call is possible only when
40963 @value{GDBN} is waiting for a response from the @samp{C}, @samp{c}, @samp{S}
40964 or @samp{s} packets. While @value{GDBN} handles the request for a system call,
40965 the target is stopped to allow deterministic access to the target's
40966 memory. Therefore File-I/O is not interruptible by target signals. On
40967 the other hand, it is possible to interrupt File-I/O by a user interrupt
40968 (@samp{Ctrl-C}) within @value{GDBN}.
40970 The target's request to perform a host system call does not finish
40971 the latest @samp{C}, @samp{c}, @samp{S} or @samp{s} action. That means,
40972 after finishing the system call, the target returns to continuing the
40973 previous activity (continue, step). No additional continue or step
40974 request from @value{GDBN} is required.
40977 (@value{GDBP}) continue
40978 <- target requests 'system call X'
40979 target is stopped, @value{GDBN} executes system call
40980 -> @value{GDBN} returns result
40981 ... target continues, @value{GDBN} returns to wait for the target
40982 <- target hits breakpoint and sends a Txx packet
40985 The protocol only supports I/O on the console and to regular files on
40986 the host file system. Character or block special devices, pipes,
40987 named pipes, sockets or any other communication method on the host
40988 system are not supported by this protocol.
40990 File I/O is not supported in non-stop mode.
40992 @node Protocol Basics
40993 @subsection Protocol Basics
40994 @cindex protocol basics, file-i/o
40996 The File-I/O protocol uses the @code{F} packet as the request as well
40997 as reply packet. Since a File-I/O system call can only occur when
40998 @value{GDBN} is waiting for a response from the continuing or stepping target,
40999 the File-I/O request is a reply that @value{GDBN} has to expect as a result
41000 of a previous @samp{C}, @samp{c}, @samp{S} or @samp{s} packet.
41001 This @code{F} packet contains all information needed to allow @value{GDBN}
41002 to call the appropriate host system call:
41006 A unique identifier for the requested system call.
41009 All parameters to the system call. Pointers are given as addresses
41010 in the target memory address space. Pointers to strings are given as
41011 pointer/length pair. Numerical values are given as they are.
41012 Numerical control flags are given in a protocol-specific representation.
41016 At this point, @value{GDBN} has to perform the following actions.
41020 If the parameters include pointer values to data needed as input to a
41021 system call, @value{GDBN} requests this data from the target with a
41022 standard @code{m} packet request. This additional communication has to be
41023 expected by the target implementation and is handled as any other @code{m}
41027 @value{GDBN} translates all value from protocol representation to host
41028 representation as needed. Datatypes are coerced into the host types.
41031 @value{GDBN} calls the system call.
41034 It then coerces datatypes back to protocol representation.
41037 If the system call is expected to return data in buffer space specified
41038 by pointer parameters to the call, the data is transmitted to the
41039 target using a @code{M} or @code{X} packet. This packet has to be expected
41040 by the target implementation and is handled as any other @code{M} or @code{X}
41045 Eventually @value{GDBN} replies with another @code{F} packet which contains all
41046 necessary information for the target to continue. This at least contains
41053 @code{errno}, if has been changed by the system call.
41060 After having done the needed type and value coercion, the target continues
41061 the latest continue or step action.
41063 @node The F Request Packet
41064 @subsection The @code{F} Request Packet
41065 @cindex file-i/o request packet
41066 @cindex @code{F} request packet
41068 The @code{F} request packet has the following format:
41071 @item F@var{call-id},@var{parameter@dots{}}
41073 @var{call-id} is the identifier to indicate the host system call to be called.
41074 This is just the name of the function.
41076 @var{parameter@dots{}} are the parameters to the system call.
41077 Parameters are hexadecimal integer values, either the actual values in case
41078 of scalar datatypes, pointers to target buffer space in case of compound
41079 datatypes and unspecified memory areas, or pointer/length pairs in case
41080 of string parameters. These are appended to the @var{call-id} as a
41081 comma-delimited list. All values are transmitted in ASCII
41082 string representation, pointer/length pairs separated by a slash.
41088 @node The F Reply Packet
41089 @subsection The @code{F} Reply Packet
41090 @cindex file-i/o reply packet
41091 @cindex @code{F} reply packet
41093 The @code{F} reply packet has the following format:
41097 @item F@var{retcode},@var{errno},@var{Ctrl-C flag};@var{call-specific attachment}
41099 @var{retcode} is the return code of the system call as hexadecimal value.
41101 @var{errno} is the @code{errno} set by the call, in protocol-specific
41103 This parameter can be omitted if the call was successful.
41105 @var{Ctrl-C flag} is only sent if the user requested a break. In this
41106 case, @var{errno} must be sent as well, even if the call was successful.
41107 The @var{Ctrl-C flag} itself consists of the character @samp{C}:
41114 or, if the call was interrupted before the host call has been performed:
41121 assuming 4 is the protocol-specific representation of @code{EINTR}.
41126 @node The Ctrl-C Message
41127 @subsection The @samp{Ctrl-C} Message
41128 @cindex ctrl-c message, in file-i/o protocol
41130 If the @samp{Ctrl-C} flag is set in the @value{GDBN}
41131 reply packet (@pxref{The F Reply Packet}),
41132 the target should behave as if it had
41133 gotten a break message. The meaning for the target is ``system call
41134 interrupted by @code{SIGINT}''. Consequentially, the target should actually stop
41135 (as with a break message) and return to @value{GDBN} with a @code{T02}
41138 It's important for the target to know in which
41139 state the system call was interrupted. There are two possible cases:
41143 The system call hasn't been performed on the host yet.
41146 The system call on the host has been finished.
41150 These two states can be distinguished by the target by the value of the
41151 returned @code{errno}. If it's the protocol representation of @code{EINTR}, the system
41152 call hasn't been performed. This is equivalent to the @code{EINTR} handling
41153 on POSIX systems. In any other case, the target may presume that the
41154 system call has been finished --- successfully or not --- and should behave
41155 as if the break message arrived right after the system call.
41157 @value{GDBN} must behave reliably. If the system call has not been called
41158 yet, @value{GDBN} may send the @code{F} reply immediately, setting @code{EINTR} as
41159 @code{errno} in the packet. If the system call on the host has been finished
41160 before the user requests a break, the full action must be finished by
41161 @value{GDBN}. This requires sending @code{M} or @code{X} packets as necessary.
41162 The @code{F} packet may only be sent when either nothing has happened
41163 or the full action has been completed.
41166 @subsection Console I/O
41167 @cindex console i/o as part of file-i/o
41169 By default and if not explicitly closed by the target system, the file
41170 descriptors 0, 1 and 2 are connected to the @value{GDBN} console. Output
41171 on the @value{GDBN} console is handled as any other file output operation
41172 (@code{write(1, @dots{})} or @code{write(2, @dots{})}). Console input is handled
41173 by @value{GDBN} so that after the target read request from file descriptor
41174 0 all following typing is buffered until either one of the following
41179 The user types @kbd{Ctrl-c}. The behaviour is as explained above, and the
41181 system call is treated as finished.
41184 The user presses @key{RET}. This is treated as end of input with a trailing
41188 The user types @kbd{Ctrl-d}. This is treated as end of input. No trailing
41189 character (neither newline nor @samp{Ctrl-D}) is appended to the input.
41193 If the user has typed more characters than fit in the buffer given to
41194 the @code{read} call, the trailing characters are buffered in @value{GDBN} until
41195 either another @code{read(0, @dots{})} is requested by the target, or debugging
41196 is stopped at the user's request.
41199 @node List of Supported Calls
41200 @subsection List of Supported Calls
41201 @cindex list of supported file-i/o calls
41218 @unnumberedsubsubsec open
41219 @cindex open, file-i/o system call
41224 int open(const char *pathname, int flags);
41225 int open(const char *pathname, int flags, mode_t mode);
41229 @samp{Fopen,@var{pathptr}/@var{len},@var{flags},@var{mode}}
41232 @var{flags} is the bitwise @code{OR} of the following values:
41236 If the file does not exist it will be created. The host
41237 rules apply as far as file ownership and time stamps
41241 When used with @code{O_CREAT}, if the file already exists it is
41242 an error and open() fails.
41245 If the file already exists and the open mode allows
41246 writing (@code{O_RDWR} or @code{O_WRONLY} is given) it will be
41247 truncated to zero length.
41250 The file is opened in append mode.
41253 The file is opened for reading only.
41256 The file is opened for writing only.
41259 The file is opened for reading and writing.
41263 Other bits are silently ignored.
41267 @var{mode} is the bitwise @code{OR} of the following values:
41271 User has read permission.
41274 User has write permission.
41277 Group has read permission.
41280 Group has write permission.
41283 Others have read permission.
41286 Others have write permission.
41290 Other bits are silently ignored.
41293 @item Return value:
41294 @code{open} returns the new file descriptor or -1 if an error
41301 @var{pathname} already exists and @code{O_CREAT} and @code{O_EXCL} were used.
41304 @var{pathname} refers to a directory.
41307 The requested access is not allowed.
41310 @var{pathname} was too long.
41313 A directory component in @var{pathname} does not exist.
41316 @var{pathname} refers to a device, pipe, named pipe or socket.
41319 @var{pathname} refers to a file on a read-only filesystem and
41320 write access was requested.
41323 @var{pathname} is an invalid pointer value.
41326 No space on device to create the file.
41329 The process already has the maximum number of files open.
41332 The limit on the total number of files open on the system
41336 The call was interrupted by the user.
41342 @unnumberedsubsubsec close
41343 @cindex close, file-i/o system call
41352 @samp{Fclose,@var{fd}}
41354 @item Return value:
41355 @code{close} returns zero on success, or -1 if an error occurred.
41361 @var{fd} isn't a valid open file descriptor.
41364 The call was interrupted by the user.
41370 @unnumberedsubsubsec read
41371 @cindex read, file-i/o system call
41376 int read(int fd, void *buf, unsigned int count);
41380 @samp{Fread,@var{fd},@var{bufptr},@var{count}}
41382 @item Return value:
41383 On success, the number of bytes read is returned.
41384 Zero indicates end of file. If count is zero, read
41385 returns zero as well. On error, -1 is returned.
41391 @var{fd} is not a valid file descriptor or is not open for
41395 @var{bufptr} is an invalid pointer value.
41398 The call was interrupted by the user.
41404 @unnumberedsubsubsec write
41405 @cindex write, file-i/o system call
41410 int write(int fd, const void *buf, unsigned int count);
41414 @samp{Fwrite,@var{fd},@var{bufptr},@var{count}}
41416 @item Return value:
41417 On success, the number of bytes written are returned.
41418 Zero indicates nothing was written. On error, -1
41425 @var{fd} is not a valid file descriptor or is not open for
41429 @var{bufptr} is an invalid pointer value.
41432 An attempt was made to write a file that exceeds the
41433 host-specific maximum file size allowed.
41436 No space on device to write the data.
41439 The call was interrupted by the user.
41445 @unnumberedsubsubsec lseek
41446 @cindex lseek, file-i/o system call
41451 long lseek (int fd, long offset, int flag);
41455 @samp{Flseek,@var{fd},@var{offset},@var{flag}}
41457 @var{flag} is one of:
41461 The offset is set to @var{offset} bytes.
41464 The offset is set to its current location plus @var{offset}
41468 The offset is set to the size of the file plus @var{offset}
41472 @item Return value:
41473 On success, the resulting unsigned offset in bytes from
41474 the beginning of the file is returned. Otherwise, a
41475 value of -1 is returned.
41481 @var{fd} is not a valid open file descriptor.
41484 @var{fd} is associated with the @value{GDBN} console.
41487 @var{flag} is not a proper value.
41490 The call was interrupted by the user.
41496 @unnumberedsubsubsec rename
41497 @cindex rename, file-i/o system call
41502 int rename(const char *oldpath, const char *newpath);
41506 @samp{Frename,@var{oldpathptr}/@var{len},@var{newpathptr}/@var{len}}
41508 @item Return value:
41509 On success, zero is returned. On error, -1 is returned.
41515 @var{newpath} is an existing directory, but @var{oldpath} is not a
41519 @var{newpath} is a non-empty directory.
41522 @var{oldpath} or @var{newpath} is a directory that is in use by some
41526 An attempt was made to make a directory a subdirectory
41530 A component used as a directory in @var{oldpath} or new
41531 path is not a directory. Or @var{oldpath} is a directory
41532 and @var{newpath} exists but is not a directory.
41535 @var{oldpathptr} or @var{newpathptr} are invalid pointer values.
41538 No access to the file or the path of the file.
41542 @var{oldpath} or @var{newpath} was too long.
41545 A directory component in @var{oldpath} or @var{newpath} does not exist.
41548 The file is on a read-only filesystem.
41551 The device containing the file has no room for the new
41555 The call was interrupted by the user.
41561 @unnumberedsubsubsec unlink
41562 @cindex unlink, file-i/o system call
41567 int unlink(const char *pathname);
41571 @samp{Funlink,@var{pathnameptr}/@var{len}}
41573 @item Return value:
41574 On success, zero is returned. On error, -1 is returned.
41580 No access to the file or the path of the file.
41583 The system does not allow unlinking of directories.
41586 The file @var{pathname} cannot be unlinked because it's
41587 being used by another process.
41590 @var{pathnameptr} is an invalid pointer value.
41593 @var{pathname} was too long.
41596 A directory component in @var{pathname} does not exist.
41599 A component of the path is not a directory.
41602 The file is on a read-only filesystem.
41605 The call was interrupted by the user.
41611 @unnumberedsubsubsec stat/fstat
41612 @cindex fstat, file-i/o system call
41613 @cindex stat, file-i/o system call
41618 int stat(const char *pathname, struct stat *buf);
41619 int fstat(int fd, struct stat *buf);
41623 @samp{Fstat,@var{pathnameptr}/@var{len},@var{bufptr}}@*
41624 @samp{Ffstat,@var{fd},@var{bufptr}}
41626 @item Return value:
41627 On success, zero is returned. On error, -1 is returned.
41633 @var{fd} is not a valid open file.
41636 A directory component in @var{pathname} does not exist or the
41637 path is an empty string.
41640 A component of the path is not a directory.
41643 @var{pathnameptr} is an invalid pointer value.
41646 No access to the file or the path of the file.
41649 @var{pathname} was too long.
41652 The call was interrupted by the user.
41658 @unnumberedsubsubsec gettimeofday
41659 @cindex gettimeofday, file-i/o system call
41664 int gettimeofday(struct timeval *tv, void *tz);
41668 @samp{Fgettimeofday,@var{tvptr},@var{tzptr}}
41670 @item Return value:
41671 On success, 0 is returned, -1 otherwise.
41677 @var{tz} is a non-NULL pointer.
41680 @var{tvptr} and/or @var{tzptr} is an invalid pointer value.
41686 @unnumberedsubsubsec isatty
41687 @cindex isatty, file-i/o system call
41692 int isatty(int fd);
41696 @samp{Fisatty,@var{fd}}
41698 @item Return value:
41699 Returns 1 if @var{fd} refers to the @value{GDBN} console, 0 otherwise.
41705 The call was interrupted by the user.
41710 Note that the @code{isatty} call is treated as a special case: it returns
41711 1 to the target if the file descriptor is attached
41712 to the @value{GDBN} console, 0 otherwise. Implementing through system calls
41713 would require implementing @code{ioctl} and would be more complex than
41718 @unnumberedsubsubsec system
41719 @cindex system, file-i/o system call
41724 int system(const char *command);
41728 @samp{Fsystem,@var{commandptr}/@var{len}}
41730 @item Return value:
41731 If @var{len} is zero, the return value indicates whether a shell is
41732 available. A zero return value indicates a shell is not available.
41733 For non-zero @var{len}, the value returned is -1 on error and the
41734 return status of the command otherwise. Only the exit status of the
41735 command is returned, which is extracted from the host's @code{system}
41736 return value by calling @code{WEXITSTATUS(retval)}. In case
41737 @file{/bin/sh} could not be executed, 127 is returned.
41743 The call was interrupted by the user.
41748 @value{GDBN} takes over the full task of calling the necessary host calls
41749 to perform the @code{system} call. The return value of @code{system} on
41750 the host is simplified before it's returned
41751 to the target. Any termination signal information from the child process
41752 is discarded, and the return value consists
41753 entirely of the exit status of the called command.
41755 Due to security concerns, the @code{system} call is by default refused
41756 by @value{GDBN}. The user has to allow this call explicitly with the
41757 @code{set remote system-call-allowed 1} command.
41760 @item set remote system-call-allowed
41761 @kindex set remote system-call-allowed
41762 Control whether to allow the @code{system} calls in the File I/O
41763 protocol for the remote target. The default is zero (disabled).
41765 @item show remote system-call-allowed
41766 @kindex show remote system-call-allowed
41767 Show whether the @code{system} calls are allowed in the File I/O
41771 @node Protocol-specific Representation of Datatypes
41772 @subsection Protocol-specific Representation of Datatypes
41773 @cindex protocol-specific representation of datatypes, in file-i/o protocol
41776 * Integral Datatypes::
41778 * Memory Transfer::
41783 @node Integral Datatypes
41784 @unnumberedsubsubsec Integral Datatypes
41785 @cindex integral datatypes, in file-i/o protocol
41787 The integral datatypes used in the system calls are @code{int},
41788 @code{unsigned int}, @code{long}, @code{unsigned long},
41789 @code{mode_t}, and @code{time_t}.
41791 @code{int}, @code{unsigned int}, @code{mode_t} and @code{time_t} are
41792 implemented as 32 bit values in this protocol.
41794 @code{long} and @code{unsigned long} are implemented as 64 bit types.
41796 @xref{Limits}, for corresponding MIN and MAX values (similar to those
41797 in @file{limits.h}) to allow range checking on host and target.
41799 @code{time_t} datatypes are defined as seconds since the Epoch.
41801 All integral datatypes transferred as part of a memory read or write of a
41802 structured datatype e.g.@: a @code{struct stat} have to be given in big endian
41805 @node Pointer Values
41806 @unnumberedsubsubsec Pointer Values
41807 @cindex pointer values, in file-i/o protocol
41809 Pointers to target data are transmitted as they are. An exception
41810 is made for pointers to buffers for which the length isn't
41811 transmitted as part of the function call, namely strings. Strings
41812 are transmitted as a pointer/length pair, both as hex values, e.g.@:
41819 which is a pointer to data of length 18 bytes at position 0x1aaf.
41820 The length is defined as the full string length in bytes, including
41821 the trailing null byte. For example, the string @code{"hello world"}
41822 at address 0x123456 is transmitted as
41828 @node Memory Transfer
41829 @unnumberedsubsubsec Memory Transfer
41830 @cindex memory transfer, in file-i/o protocol
41832 Structured data which is transferred using a memory read or write (for
41833 example, a @code{struct stat}) is expected to be in a protocol-specific format
41834 with all scalar multibyte datatypes being big endian. Translation to
41835 this representation needs to be done both by the target before the @code{F}
41836 packet is sent, and by @value{GDBN} before
41837 it transfers memory to the target. Transferred pointers to structured
41838 data should point to the already-coerced data at any time.
41842 @unnumberedsubsubsec struct stat
41843 @cindex struct stat, in file-i/o protocol
41845 The buffer of type @code{struct stat} used by the target and @value{GDBN}
41846 is defined as follows:
41850 unsigned int st_dev; /* device */
41851 unsigned int st_ino; /* inode */
41852 mode_t st_mode; /* protection */
41853 unsigned int st_nlink; /* number of hard links */
41854 unsigned int st_uid; /* user ID of owner */
41855 unsigned int st_gid; /* group ID of owner */
41856 unsigned int st_rdev; /* device type (if inode device) */
41857 unsigned long st_size; /* total size, in bytes */
41858 unsigned long st_blksize; /* blocksize for filesystem I/O */
41859 unsigned long st_blocks; /* number of blocks allocated */
41860 time_t st_atime; /* time of last access */
41861 time_t st_mtime; /* time of last modification */
41862 time_t st_ctime; /* time of last change */
41866 The integral datatypes conform to the definitions given in the
41867 appropriate section (see @ref{Integral Datatypes}, for details) so this
41868 structure is of size 64 bytes.
41870 The values of several fields have a restricted meaning and/or
41876 A value of 0 represents a file, 1 the console.
41879 No valid meaning for the target. Transmitted unchanged.
41882 Valid mode bits are described in @ref{Constants}. Any other
41883 bits have currently no meaning for the target.
41888 No valid meaning for the target. Transmitted unchanged.
41893 These values have a host and file system dependent
41894 accuracy. Especially on Windows hosts, the file system may not
41895 support exact timing values.
41898 The target gets a @code{struct stat} of the above representation and is
41899 responsible for coercing it to the target representation before
41902 Note that due to size differences between the host, target, and protocol
41903 representations of @code{struct stat} members, these members could eventually
41904 get truncated on the target.
41906 @node struct timeval
41907 @unnumberedsubsubsec struct timeval
41908 @cindex struct timeval, in file-i/o protocol
41910 The buffer of type @code{struct timeval} used by the File-I/O protocol
41911 is defined as follows:
41915 time_t tv_sec; /* second */
41916 long tv_usec; /* microsecond */
41920 The integral datatypes conform to the definitions given in the
41921 appropriate section (see @ref{Integral Datatypes}, for details) so this
41922 structure is of size 8 bytes.
41925 @subsection Constants
41926 @cindex constants, in file-i/o protocol
41928 The following values are used for the constants inside of the
41929 protocol. @value{GDBN} and target are responsible for translating these
41930 values before and after the call as needed.
41941 @unnumberedsubsubsec Open Flags
41942 @cindex open flags, in file-i/o protocol
41944 All values are given in hexadecimal representation.
41956 @node mode_t Values
41957 @unnumberedsubsubsec mode_t Values
41958 @cindex mode_t values, in file-i/o protocol
41960 All values are given in octal representation.
41977 @unnumberedsubsubsec Errno Values
41978 @cindex errno values, in file-i/o protocol
41980 All values are given in decimal representation.
42005 @code{EUNKNOWN} is used as a fallback error value if a host system returns
42006 any error value not in the list of supported error numbers.
42009 @unnumberedsubsubsec Lseek Flags
42010 @cindex lseek flags, in file-i/o protocol
42019 @unnumberedsubsubsec Limits
42020 @cindex limits, in file-i/o protocol
42022 All values are given in decimal representation.
42025 INT_MIN -2147483648
42027 UINT_MAX 4294967295
42028 LONG_MIN -9223372036854775808
42029 LONG_MAX 9223372036854775807
42030 ULONG_MAX 18446744073709551615
42033 @node File-I/O Examples
42034 @subsection File-I/O Examples
42035 @cindex file-i/o examples
42037 Example sequence of a write call, file descriptor 3, buffer is at target
42038 address 0x1234, 6 bytes should be written:
42041 <- @code{Fwrite,3,1234,6}
42042 @emph{request memory read from target}
42045 @emph{return "6 bytes written"}
42049 Example sequence of a read call, file descriptor 3, buffer is at target
42050 address 0x1234, 6 bytes should be read:
42053 <- @code{Fread,3,1234,6}
42054 @emph{request memory write to target}
42055 -> @code{X1234,6:XXXXXX}
42056 @emph{return "6 bytes read"}
42060 Example sequence of a read call, call fails on the host due to invalid
42061 file descriptor (@code{EBADF}):
42064 <- @code{Fread,3,1234,6}
42068 Example sequence of a read call, user presses @kbd{Ctrl-c} before syscall on
42072 <- @code{Fread,3,1234,6}
42077 Example sequence of a read call, user presses @kbd{Ctrl-c} after syscall on
42081 <- @code{Fread,3,1234,6}
42082 -> @code{X1234,6:XXXXXX}
42086 @node Library List Format
42087 @section Library List Format
42088 @cindex library list format, remote protocol
42090 On some platforms, a dynamic loader (e.g.@: @file{ld.so}) runs in the
42091 same process as your application to manage libraries. In this case,
42092 @value{GDBN} can use the loader's symbol table and normal memory
42093 operations to maintain a list of shared libraries. On other
42094 platforms, the operating system manages loaded libraries.
42095 @value{GDBN} can not retrieve the list of currently loaded libraries
42096 through memory operations, so it uses the @samp{qXfer:libraries:read}
42097 packet (@pxref{qXfer library list read}) instead. The remote stub
42098 queries the target's operating system and reports which libraries
42101 The @samp{qXfer:libraries:read} packet returns an XML document which
42102 lists loaded libraries and their offsets. Each library has an
42103 associated name and one or more segment or section base addresses,
42104 which report where the library was loaded in memory.
42106 For the common case of libraries that are fully linked binaries, the
42107 library should have a list of segments. If the target supports
42108 dynamic linking of a relocatable object file, its library XML element
42109 should instead include a list of allocated sections. The segment or
42110 section bases are start addresses, not relocation offsets; they do not
42111 depend on the library's link-time base addresses.
42113 @value{GDBN} must be linked with the Expat library to support XML
42114 library lists. @xref{Expat}.
42116 A simple memory map, with one loaded library relocated by a single
42117 offset, looks like this:
42121 <library name="/lib/libc.so.6">
42122 <segment address="0x10000000"/>
42127 Another simple memory map, with one loaded library with three
42128 allocated sections (.text, .data, .bss), looks like this:
42132 <library name="sharedlib.o">
42133 <section address="0x10000000"/>
42134 <section address="0x20000000"/>
42135 <section address="0x30000000"/>
42140 The format of a library list is described by this DTD:
42143 <!-- library-list: Root element with versioning -->
42144 <!ELEMENT library-list (library)*>
42145 <!ATTLIST library-list version CDATA #FIXED "1.0">
42146 <!ELEMENT library (segment*, section*)>
42147 <!ATTLIST library name CDATA #REQUIRED>
42148 <!ELEMENT segment EMPTY>
42149 <!ATTLIST segment address CDATA #REQUIRED>
42150 <!ELEMENT section EMPTY>
42151 <!ATTLIST section address CDATA #REQUIRED>
42154 In addition, segments and section descriptors cannot be mixed within a
42155 single library element, and you must supply at least one segment or
42156 section for each library.
42158 @node Library List Format for SVR4 Targets
42159 @section Library List Format for SVR4 Targets
42160 @cindex library list format, remote protocol
42162 On SVR4 platforms @value{GDBN} can use the symbol table of a dynamic loader
42163 (e.g.@: @file{ld.so}) and normal memory operations to maintain a list of
42164 shared libraries. Still a special library list provided by this packet is
42165 more efficient for the @value{GDBN} remote protocol.
42167 The @samp{qXfer:libraries-svr4:read} packet returns an XML document which lists
42168 loaded libraries and their SVR4 linker parameters. For each library on SVR4
42169 target, the following parameters are reported:
42173 @code{name}, the absolute file name from the @code{l_name} field of
42174 @code{struct link_map}.
42176 @code{lm} with address of @code{struct link_map} used for TLS
42177 (Thread Local Storage) access.
42179 @code{l_addr}, the displacement as read from the field @code{l_addr} of
42180 @code{struct link_map}. For prelinked libraries this is not an absolute
42181 memory address. It is a displacement of absolute memory address against
42182 address the file was prelinked to during the library load.
42184 @code{l_ld}, which is memory address of the @code{PT_DYNAMIC} segment
42187 Additionally the single @code{main-lm} attribute specifies address of
42188 @code{struct link_map} used for the main executable. This parameter is used
42189 for TLS access and its presence is optional.
42191 @value{GDBN} must be linked with the Expat library to support XML
42192 SVR4 library lists. @xref{Expat}.
42194 A simple memory map, with two loaded libraries (which do not use prelink),
42198 <library-list-svr4 version="1.0" main-lm="0xe4f8f8">
42199 <library name="/lib/ld-linux.so.2" lm="0xe4f51c" l_addr="0xe2d000"
42201 <library name="/lib/libc.so.6" lm="0xe4fbe8" l_addr="0x154000"
42203 </library-list-svr>
42206 The format of an SVR4 library list is described by this DTD:
42209 <!-- library-list-svr4: Root element with versioning -->
42210 <!ELEMENT library-list-svr4 (library)*>
42211 <!ATTLIST library-list-svr4 version CDATA #FIXED "1.0">
42212 <!ATTLIST library-list-svr4 main-lm CDATA #IMPLIED>
42213 <!ELEMENT library EMPTY>
42214 <!ATTLIST library name CDATA #REQUIRED>
42215 <!ATTLIST library lm CDATA #REQUIRED>
42216 <!ATTLIST library l_addr CDATA #REQUIRED>
42217 <!ATTLIST library l_ld CDATA #REQUIRED>
42220 @node Memory Map Format
42221 @section Memory Map Format
42222 @cindex memory map format
42224 To be able to write into flash memory, @value{GDBN} needs to obtain a
42225 memory map from the target. This section describes the format of the
42228 The memory map is obtained using the @samp{qXfer:memory-map:read}
42229 (@pxref{qXfer memory map read}) packet and is an XML document that
42230 lists memory regions.
42232 @value{GDBN} must be linked with the Expat library to support XML
42233 memory maps. @xref{Expat}.
42235 The top-level structure of the document is shown below:
42238 <?xml version="1.0"?>
42239 <!DOCTYPE memory-map
42240 PUBLIC "+//IDN gnu.org//DTD GDB Memory Map V1.0//EN"
42241 "http://sourceware.org/gdb/gdb-memory-map.dtd">
42247 Each region can be either:
42252 A region of RAM starting at @var{addr} and extending for @var{length}
42256 <memory type="ram" start="@var{addr}" length="@var{length}"/>
42261 A region of read-only memory:
42264 <memory type="rom" start="@var{addr}" length="@var{length}"/>
42269 A region of flash memory, with erasure blocks @var{blocksize}
42273 <memory type="flash" start="@var{addr}" length="@var{length}">
42274 <property name="blocksize">@var{blocksize}</property>
42280 Regions must not overlap. @value{GDBN} assumes that areas of memory not covered
42281 by the memory map are RAM, and uses the ordinary @samp{M} and @samp{X}
42282 packets to write to addresses in such ranges.
42284 The formal DTD for memory map format is given below:
42287 <!-- ................................................... -->
42288 <!-- Memory Map XML DTD ................................ -->
42289 <!-- File: memory-map.dtd .............................. -->
42290 <!-- .................................... .............. -->
42291 <!-- memory-map.dtd -->
42292 <!-- memory-map: Root element with versioning -->
42293 <!ELEMENT memory-map (memory)*>
42294 <!ATTLIST memory-map version CDATA #FIXED "1.0.0">
42295 <!ELEMENT memory (property)*>
42296 <!-- memory: Specifies a memory region,
42297 and its type, or device. -->
42298 <!ATTLIST memory type (ram|rom|flash) #REQUIRED
42299 start CDATA #REQUIRED
42300 length CDATA #REQUIRED>
42301 <!-- property: Generic attribute tag -->
42302 <!ELEMENT property (#PCDATA | property)*>
42303 <!ATTLIST property name (blocksize) #REQUIRED>
42306 @node Thread List Format
42307 @section Thread List Format
42308 @cindex thread list format
42310 To efficiently update the list of threads and their attributes,
42311 @value{GDBN} issues the @samp{qXfer:threads:read} packet
42312 (@pxref{qXfer threads read}) and obtains the XML document with
42313 the following structure:
42316 <?xml version="1.0"?>
42318 <thread id="id" core="0" name="name">
42319 ... description ...
42324 Each @samp{thread} element must have the @samp{id} attribute that
42325 identifies the thread (@pxref{thread-id syntax}). The
42326 @samp{core} attribute, if present, specifies which processor core
42327 the thread was last executing on. The @samp{name} attribute, if
42328 present, specifies the human-readable name of the thread. The content
42329 of the of @samp{thread} element is interpreted as human-readable
42330 auxiliary information. The @samp{handle} attribute, if present,
42331 is a hex encoded representation of the thread handle.
42334 @node Traceframe Info Format
42335 @section Traceframe Info Format
42336 @cindex traceframe info format
42338 To be able to know which objects in the inferior can be examined when
42339 inspecting a tracepoint hit, @value{GDBN} needs to obtain the list of
42340 memory ranges, registers and trace state variables that have been
42341 collected in a traceframe.
42343 This list is obtained using the @samp{qXfer:traceframe-info:read}
42344 (@pxref{qXfer traceframe info read}) packet and is an XML document.
42346 @value{GDBN} must be linked with the Expat library to support XML
42347 traceframe info discovery. @xref{Expat}.
42349 The top-level structure of the document is shown below:
42352 <?xml version="1.0"?>
42353 <!DOCTYPE traceframe-info
42354 PUBLIC "+//IDN gnu.org//DTD GDB Memory Map V1.0//EN"
42355 "http://sourceware.org/gdb/gdb-traceframe-info.dtd">
42361 Each traceframe block can be either:
42366 A region of collected memory starting at @var{addr} and extending for
42367 @var{length} bytes from there:
42370 <memory start="@var{addr}" length="@var{length}"/>
42374 A block indicating trace state variable numbered @var{number} has been
42378 <tvar id="@var{number}"/>
42383 The formal DTD for the traceframe info format is given below:
42386 <!ELEMENT traceframe-info (memory | tvar)* >
42387 <!ATTLIST traceframe-info version CDATA #FIXED "1.0">
42389 <!ELEMENT memory EMPTY>
42390 <!ATTLIST memory start CDATA #REQUIRED
42391 length CDATA #REQUIRED>
42393 <!ATTLIST tvar id CDATA #REQUIRED>
42396 @node Branch Trace Format
42397 @section Branch Trace Format
42398 @cindex branch trace format
42400 In order to display the branch trace of an inferior thread,
42401 @value{GDBN} needs to obtain the list of branches. This list is
42402 represented as list of sequential code blocks that are connected via
42403 branches. The code in each block has been executed sequentially.
42405 This list is obtained using the @samp{qXfer:btrace:read}
42406 (@pxref{qXfer btrace read}) packet and is an XML document.
42408 @value{GDBN} must be linked with the Expat library to support XML
42409 traceframe info discovery. @xref{Expat}.
42411 The top-level structure of the document is shown below:
42414 <?xml version="1.0"?>
42416 PUBLIC "+//IDN gnu.org//DTD GDB Branch Trace V1.0//EN"
42417 "http://sourceware.org/gdb/gdb-btrace.dtd">
42426 A block of sequentially executed instructions starting at @var{begin}
42427 and ending at @var{end}:
42430 <block begin="@var{begin}" end="@var{end}"/>
42435 The formal DTD for the branch trace format is given below:
42438 <!ELEMENT btrace (block* | pt) >
42439 <!ATTLIST btrace version CDATA #FIXED "1.0">
42441 <!ELEMENT block EMPTY>
42442 <!ATTLIST block begin CDATA #REQUIRED
42443 end CDATA #REQUIRED>
42445 <!ELEMENT pt (pt-config?, raw?)>
42447 <!ELEMENT pt-config (cpu?)>
42449 <!ELEMENT cpu EMPTY>
42450 <!ATTLIST cpu vendor CDATA #REQUIRED
42451 family CDATA #REQUIRED
42452 model CDATA #REQUIRED
42453 stepping CDATA #REQUIRED>
42455 <!ELEMENT raw (#PCDATA)>
42458 @node Branch Trace Configuration Format
42459 @section Branch Trace Configuration Format
42460 @cindex branch trace configuration format
42462 For each inferior thread, @value{GDBN} can obtain the branch trace
42463 configuration using the @samp{qXfer:btrace-conf:read}
42464 (@pxref{qXfer btrace-conf read}) packet.
42466 The configuration describes the branch trace format and configuration
42467 settings for that format. The following information is described:
42471 This thread uses the @dfn{Branch Trace Store} (@acronym{BTS}) format.
42474 The size of the @acronym{BTS} ring buffer in bytes.
42477 This thread uses the @dfn{Intel Processor Trace} (@acronym{Intel
42481 The size of the @acronym{Intel PT} ring buffer in bytes.
42485 @value{GDBN} must be linked with the Expat library to support XML
42486 branch trace configuration discovery. @xref{Expat}.
42488 The formal DTD for the branch trace configuration format is given below:
42491 <!ELEMENT btrace-conf (bts?, pt?)>
42492 <!ATTLIST btrace-conf version CDATA #FIXED "1.0">
42494 <!ELEMENT bts EMPTY>
42495 <!ATTLIST bts size CDATA #IMPLIED>
42497 <!ELEMENT pt EMPTY>
42498 <!ATTLIST pt size CDATA #IMPLIED>
42501 @include agentexpr.texi
42503 @node Target Descriptions
42504 @appendix Target Descriptions
42505 @cindex target descriptions
42507 One of the challenges of using @value{GDBN} to debug embedded systems
42508 is that there are so many minor variants of each processor
42509 architecture in use. It is common practice for vendors to start with
42510 a standard processor core --- ARM, PowerPC, or @acronym{MIPS}, for example ---
42511 and then make changes to adapt it to a particular market niche. Some
42512 architectures have hundreds of variants, available from dozens of
42513 vendors. This leads to a number of problems:
42517 With so many different customized processors, it is difficult for
42518 the @value{GDBN} maintainers to keep up with the changes.
42520 Since individual variants may have short lifetimes or limited
42521 audiences, it may not be worthwhile to carry information about every
42522 variant in the @value{GDBN} source tree.
42524 When @value{GDBN} does support the architecture of the embedded system
42525 at hand, the task of finding the correct architecture name to give the
42526 @command{set architecture} command can be error-prone.
42529 To address these problems, the @value{GDBN} remote protocol allows a
42530 target system to not only identify itself to @value{GDBN}, but to
42531 actually describe its own features. This lets @value{GDBN} support
42532 processor variants it has never seen before --- to the extent that the
42533 descriptions are accurate, and that @value{GDBN} understands them.
42535 @value{GDBN} must be linked with the Expat library to support XML
42536 target descriptions. @xref{Expat}.
42539 * Retrieving Descriptions:: How descriptions are fetched from a target.
42540 * Target Description Format:: The contents of a target description.
42541 * Predefined Target Types:: Standard types available for target
42543 * Enum Target Types:: How to define enum target types.
42544 * Standard Target Features:: Features @value{GDBN} knows about.
42547 @node Retrieving Descriptions
42548 @section Retrieving Descriptions
42550 Target descriptions can be read from the target automatically, or
42551 specified by the user manually. The default behavior is to read the
42552 description from the target. @value{GDBN} retrieves it via the remote
42553 protocol using @samp{qXfer} requests (@pxref{General Query Packets,
42554 qXfer}). The @var{annex} in the @samp{qXfer} packet will be
42555 @samp{target.xml}. The contents of the @samp{target.xml} annex are an
42556 XML document, of the form described in @ref{Target Description
42559 Alternatively, you can specify a file to read for the target description.
42560 If a file is set, the target will not be queried. The commands to
42561 specify a file are:
42564 @cindex set tdesc filename
42565 @item set tdesc filename @var{path}
42566 Read the target description from @var{path}.
42568 @cindex unset tdesc filename
42569 @item unset tdesc filename
42570 Do not read the XML target description from a file. @value{GDBN}
42571 will use the description supplied by the current target.
42573 @cindex show tdesc filename
42574 @item show tdesc filename
42575 Show the filename to read for a target description, if any.
42579 @node Target Description Format
42580 @section Target Description Format
42581 @cindex target descriptions, XML format
42583 A target description annex is an @uref{http://www.w3.org/XML/, XML}
42584 document which complies with the Document Type Definition provided in
42585 the @value{GDBN} sources in @file{gdb/features/gdb-target.dtd}. This
42586 means you can use generally available tools like @command{xmllint} to
42587 check that your feature descriptions are well-formed and valid.
42588 However, to help people unfamiliar with XML write descriptions for
42589 their targets, we also describe the grammar here.
42591 Target descriptions can identify the architecture of the remote target
42592 and (for some architectures) provide information about custom register
42593 sets. They can also identify the OS ABI of the remote target.
42594 @value{GDBN} can use this information to autoconfigure for your
42595 target, or to warn you if you connect to an unsupported target.
42597 Here is a simple target description:
42600 <target version="1.0">
42601 <architecture>i386:x86-64</architecture>
42606 This minimal description only says that the target uses
42607 the x86-64 architecture.
42609 A target description has the following overall form, with [ ] marking
42610 optional elements and @dots{} marking repeatable elements. The elements
42611 are explained further below.
42614 <?xml version="1.0"?>
42615 <!DOCTYPE target SYSTEM "gdb-target.dtd">
42616 <target version="1.0">
42617 @r{[}@var{architecture}@r{]}
42618 @r{[}@var{osabi}@r{]}
42619 @r{[}@var{compatible}@r{]}
42620 @r{[}@var{feature}@dots{}@r{]}
42625 The description is generally insensitive to whitespace and line
42626 breaks, under the usual common-sense rules. The XML version
42627 declaration and document type declaration can generally be omitted
42628 (@value{GDBN} does not require them), but specifying them may be
42629 useful for XML validation tools. The @samp{version} attribute for
42630 @samp{<target>} may also be omitted, but we recommend
42631 including it; if future versions of @value{GDBN} use an incompatible
42632 revision of @file{gdb-target.dtd}, they will detect and report
42633 the version mismatch.
42635 @subsection Inclusion
42636 @cindex target descriptions, inclusion
42639 @cindex <xi:include>
42642 It can sometimes be valuable to split a target description up into
42643 several different annexes, either for organizational purposes, or to
42644 share files between different possible target descriptions. You can
42645 divide a description into multiple files by replacing any element of
42646 the target description with an inclusion directive of the form:
42649 <xi:include href="@var{document}"/>
42653 When @value{GDBN} encounters an element of this form, it will retrieve
42654 the named XML @var{document}, and replace the inclusion directive with
42655 the contents of that document. If the current description was read
42656 using @samp{qXfer}, then so will be the included document;
42657 @var{document} will be interpreted as the name of an annex. If the
42658 current description was read from a file, @value{GDBN} will look for
42659 @var{document} as a file in the same directory where it found the
42660 original description.
42662 @subsection Architecture
42663 @cindex <architecture>
42665 An @samp{<architecture>} element has this form:
42668 <architecture>@var{arch}</architecture>
42671 @var{arch} is one of the architectures from the set accepted by
42672 @code{set architecture} (@pxref{Targets, ,Specifying a Debugging Target}).
42675 @cindex @code{<osabi>}
42677 This optional field was introduced in @value{GDBN} version 7.0.
42678 Previous versions of @value{GDBN} ignore it.
42680 An @samp{<osabi>} element has this form:
42683 <osabi>@var{abi-name}</osabi>
42686 @var{abi-name} is an OS ABI name from the same selection accepted by
42687 @w{@code{set osabi}} (@pxref{ABI, ,Configuring the Current ABI}).
42689 @subsection Compatible Architecture
42690 @cindex @code{<compatible>}
42692 This optional field was introduced in @value{GDBN} version 7.0.
42693 Previous versions of @value{GDBN} ignore it.
42695 A @samp{<compatible>} element has this form:
42698 <compatible>@var{arch}</compatible>
42701 @var{arch} is one of the architectures from the set accepted by
42702 @code{set architecture} (@pxref{Targets, ,Specifying a Debugging Target}).
42704 A @samp{<compatible>} element is used to specify that the target
42705 is able to run binaries in some other than the main target architecture
42706 given by the @samp{<architecture>} element. For example, on the
42707 Cell Broadband Engine, the main architecture is @code{powerpc:common}
42708 or @code{powerpc:common64}, but the system is able to run binaries
42709 in the @code{spu} architecture as well. The way to describe this
42710 capability with @samp{<compatible>} is as follows:
42713 <architecture>powerpc:common</architecture>
42714 <compatible>spu</compatible>
42717 @subsection Features
42720 Each @samp{<feature>} describes some logical portion of the target
42721 system. Features are currently used to describe available CPU
42722 registers and the types of their contents. A @samp{<feature>} element
42726 <feature name="@var{name}">
42727 @r{[}@var{type}@dots{}@r{]}
42733 Each feature's name should be unique within the description. The name
42734 of a feature does not matter unless @value{GDBN} has some special
42735 knowledge of the contents of that feature; if it does, the feature
42736 should have its standard name. @xref{Standard Target Features}.
42740 Any register's value is a collection of bits which @value{GDBN} must
42741 interpret. The default interpretation is a two's complement integer,
42742 but other types can be requested by name in the register description.
42743 Some predefined types are provided by @value{GDBN} (@pxref{Predefined
42744 Target Types}), and the description can define additional composite
42747 Each type element must have an @samp{id} attribute, which gives
42748 a unique (within the containing @samp{<feature>}) name to the type.
42749 Types must be defined before they are used.
42752 Some targets offer vector registers, which can be treated as arrays
42753 of scalar elements. These types are written as @samp{<vector>} elements,
42754 specifying the array element type, @var{type}, and the number of elements,
42758 <vector id="@var{id}" type="@var{type}" count="@var{count}"/>
42762 If a register's value is usefully viewed in multiple ways, define it
42763 with a union type containing the useful representations. The
42764 @samp{<union>} element contains one or more @samp{<field>} elements,
42765 each of which has a @var{name} and a @var{type}:
42768 <union id="@var{id}">
42769 <field name="@var{name}" type="@var{type}"/>
42776 If a register's value is composed from several separate values, define
42777 it with either a structure type or a flags type.
42778 A flags type may only contain bitfields.
42779 A structure type may either contain only bitfields or contain no bitfields.
42780 If the value contains only bitfields, its total size in bytes must be
42783 Non-bitfield values have a @var{name} and @var{type}.
42786 <struct id="@var{id}">
42787 <field name="@var{name}" type="@var{type}"/>
42792 Both @var{name} and @var{type} values are required.
42793 No implicit padding is added.
42795 Bitfield values have a @var{name}, @var{start}, @var{end} and @var{type}.
42798 <struct id="@var{id}" size="@var{size}">
42799 <field name="@var{name}" start="@var{start}" end="@var{end}" type="@var{type}"/>
42805 <flags id="@var{id}" size="@var{size}">
42806 <field name="@var{name}" start="@var{start}" end="@var{end}" type="@var{type}"/>
42811 The @var{name} value is required.
42812 Bitfield values may be named with the empty string, @samp{""},
42813 in which case the field is ``filler'' and its value is not printed.
42814 Not all bits need to be specified, so ``filler'' fields are optional.
42816 The @var{start} and @var{end} values are required, and @var{type}
42818 The field's @var{start} must be less than or equal to its @var{end},
42819 and zero represents the least significant bit.
42821 The default value of @var{type} is @code{bool} for single bit fields,
42822 and an unsigned integer otherwise.
42824 Which to choose? Structures or flags?
42826 Registers defined with @samp{flags} have these advantages over
42827 defining them with @samp{struct}:
42831 Arithmetic may be performed on them as if they were integers.
42833 They are printed in a more readable fashion.
42836 Registers defined with @samp{struct} have one advantage over
42837 defining them with @samp{flags}:
42841 One can fetch individual fields like in @samp{C}.
42844 (gdb) print $my_struct_reg.field3
42850 @subsection Registers
42853 Each register is represented as an element with this form:
42856 <reg name="@var{name}"
42857 bitsize="@var{size}"
42858 @r{[}regnum="@var{num}"@r{]}
42859 @r{[}save-restore="@var{save-restore}"@r{]}
42860 @r{[}type="@var{type}"@r{]}
42861 @r{[}group="@var{group}"@r{]}/>
42865 The components are as follows:
42870 The register's name; it must be unique within the target description.
42873 The register's size, in bits.
42876 The register's number. If omitted, a register's number is one greater
42877 than that of the previous register (either in the current feature or in
42878 a preceding feature); the first register in the target description
42879 defaults to zero. This register number is used to read or write
42880 the register; e.g.@: it is used in the remote @code{p} and @code{P}
42881 packets, and registers appear in the @code{g} and @code{G} packets
42882 in order of increasing register number.
42885 Whether the register should be preserved across inferior function
42886 calls; this must be either @code{yes} or @code{no}. The default is
42887 @code{yes}, which is appropriate for most registers except for
42888 some system control registers; this is not related to the target's
42892 The type of the register. It may be a predefined type, a type
42893 defined in the current feature, or one of the special types @code{int}
42894 and @code{float}. @code{int} is an integer type of the correct size
42895 for @var{bitsize}, and @code{float} is a floating point type (in the
42896 architecture's normal floating point format) of the correct size for
42897 @var{bitsize}. The default is @code{int}.
42900 The register group to which this register belongs. It can be one of the
42901 standard register groups @code{general}, @code{float}, @code{vector} or an
42902 arbitrary string. Group names should be limited to alphanumeric characters.
42903 If a group name is made up of multiple words the words may be separated by
42904 hyphens; e.g.@: @code{special-group} or @code{ultra-special-group}. If no
42905 @var{group} is specified, @value{GDBN} will not display the register in
42906 @code{info registers}.
42910 @node Predefined Target Types
42911 @section Predefined Target Types
42912 @cindex target descriptions, predefined types
42914 Type definitions in the self-description can build up composite types
42915 from basic building blocks, but can not define fundamental types. Instead,
42916 standard identifiers are provided by @value{GDBN} for the fundamental
42917 types. The currently supported types are:
42922 Boolean type, occupying a single bit.
42930 Signed integer types holding the specified number of bits.
42938 Unsigned integer types holding the specified number of bits.
42942 Pointers to unspecified code and data. The program counter and
42943 any dedicated return address register may be marked as code
42944 pointers; printing a code pointer converts it into a symbolic
42945 address. The stack pointer and any dedicated address registers
42946 may be marked as data pointers.
42949 Single precision IEEE floating point.
42952 Double precision IEEE floating point.
42955 The 12-byte extended precision format used by ARM FPA registers.
42958 The 10-byte extended precision format used by x87 registers.
42961 32bit @sc{eflags} register used by x86.
42964 32bit @sc{mxcsr} register used by x86.
42968 @node Enum Target Types
42969 @section Enum Target Types
42970 @cindex target descriptions, enum types
42972 Enum target types are useful in @samp{struct} and @samp{flags}
42973 register descriptions. @xref{Target Description Format}.
42975 Enum types have a name, size and a list of name/value pairs.
42978 <enum id="@var{id}" size="@var{size}">
42979 <evalue name="@var{name}" value="@var{value}"/>
42984 Enums must be defined before they are used.
42987 <enum id="levels_type" size="4">
42988 <evalue name="low" value="0"/>
42989 <evalue name="high" value="1"/>
42991 <flags id="flags_type" size="4">
42992 <field name="X" start="0"/>
42993 <field name="LEVEL" start="1" end="1" type="levels_type"/>
42995 <reg name="flags" bitsize="32" type="flags_type"/>
42998 Given that description, a value of 3 for the @samp{flags} register
42999 would be printed as:
43002 (gdb) info register flags
43003 flags 0x3 [ X LEVEL=high ]
43006 @node Standard Target Features
43007 @section Standard Target Features
43008 @cindex target descriptions, standard features
43010 A target description must contain either no registers or all the
43011 target's registers. If the description contains no registers, then
43012 @value{GDBN} will assume a default register layout, selected based on
43013 the architecture. If the description contains any registers, the
43014 default layout will not be used; the standard registers must be
43015 described in the target description, in such a way that @value{GDBN}
43016 can recognize them.
43018 This is accomplished by giving specific names to feature elements
43019 which contain standard registers. @value{GDBN} will look for features
43020 with those names and verify that they contain the expected registers;
43021 if any known feature is missing required registers, or if any required
43022 feature is missing, @value{GDBN} will reject the target
43023 description. You can add additional registers to any of the
43024 standard features --- @value{GDBN} will display them just as if
43025 they were added to an unrecognized feature.
43027 This section lists the known features and their expected contents.
43028 Sample XML documents for these features are included in the
43029 @value{GDBN} source tree, in the directory @file{gdb/features}.
43031 Names recognized by @value{GDBN} should include the name of the
43032 company or organization which selected the name, and the overall
43033 architecture to which the feature applies; so e.g.@: the feature
43034 containing ARM core registers is named @samp{org.gnu.gdb.arm.core}.
43036 The names of registers are not case sensitive for the purpose
43037 of recognizing standard features, but @value{GDBN} will only display
43038 registers using the capitalization used in the description.
43041 * AArch64 Features::
43045 * MicroBlaze Features::
43049 * Nios II Features::
43050 * OpenRISC 1000 Features::
43051 * PowerPC Features::
43052 * RISC-V Features::
43053 * S/390 and System z Features::
43059 @node AArch64 Features
43060 @subsection AArch64 Features
43061 @cindex target descriptions, AArch64 features
43063 The @samp{org.gnu.gdb.aarch64.core} feature is required for AArch64
43064 targets. It should contain registers @samp{x0} through @samp{x30},
43065 @samp{sp}, @samp{pc}, and @samp{cpsr}.
43067 The @samp{org.gnu.gdb.aarch64.fpu} feature is optional. If present,
43068 it should contain registers @samp{v0} through @samp{v31}, @samp{fpsr},
43071 The @samp{org.gnu.gdb.aarch64.sve} feature is optional. If present,
43072 it should contain registers @samp{z0} through @samp{z31}, @samp{p0}
43073 through @samp{p15}, @samp{ffr} and @samp{vg}.
43076 @subsection ARC Features
43077 @cindex target descriptions, ARC Features
43079 ARC processors are highly configurable, so even core registers and their number
43080 are not completely predetermined. In addition flags and PC registers which are
43081 important to @value{GDBN} are not ``core'' registers in ARC. It is required
43082 that one of the core registers features is present.
43083 @samp{org.gnu.gdb.arc.aux-minimal} feature is mandatory.
43085 The @samp{org.gnu.gdb.arc.core.v2} feature is required for ARC EM and ARC HS
43086 targets with a normal register file. It should contain registers @samp{r0}
43087 through @samp{r25}, @samp{gp}, @samp{fp}, @samp{sp}, @samp{r30}, @samp{blink},
43088 @samp{lp_count} and @samp{pcl}. This feature may contain register @samp{ilink}
43089 and any of extension core registers @samp{r32} through @samp{r59/acch}.
43090 @samp{ilink} and extension core registers are not available to read/write, when
43091 debugging GNU/Linux applications, thus @samp{ilink} is made optional.
43093 The @samp{org.gnu.gdb.arc.core-reduced.v2} feature is required for ARC EM and
43094 ARC HS targets with a reduced register file. It should contain registers
43095 @samp{r0} through @samp{r3}, @samp{r10} through @samp{r15}, @samp{gp},
43096 @samp{fp}, @samp{sp}, @samp{r30}, @samp{blink}, @samp{lp_count} and @samp{pcl}.
43097 This feature may contain register @samp{ilink} and any of extension core
43098 registers @samp{r32} through @samp{r59/acch}.
43100 The @samp{org.gnu.gdb.arc.core.arcompact} feature is required for ARCompact
43101 targets with a normal register file. It should contain registers @samp{r0}
43102 through @samp{r25}, @samp{gp}, @samp{fp}, @samp{sp}, @samp{r30}, @samp{blink},
43103 @samp{lp_count} and @samp{pcl}. This feature may contain registers
43104 @samp{ilink1}, @samp{ilink2} and any of extension core registers @samp{r32}
43105 through @samp{r59/acch}. @samp{ilink1} and @samp{ilink2} and extension core
43106 registers are not available when debugging GNU/Linux applications. The only
43107 difference with @samp{org.gnu.gdb.arc.core.v2} feature is in the names of
43108 @samp{ilink1} and @samp{ilink2} registers and that @samp{r30} is mandatory in
43109 ARC v2, but @samp{ilink2} is optional on ARCompact.
43111 The @samp{org.gnu.gdb.arc.aux-minimal} feature is required for all ARC
43112 targets. It should contain registers @samp{pc} and @samp{status32}.
43115 @subsection ARM Features
43116 @cindex target descriptions, ARM features
43118 The @samp{org.gnu.gdb.arm.core} feature is required for non-M-profile
43120 It should contain registers @samp{r0} through @samp{r13}, @samp{sp},
43121 @samp{lr}, @samp{pc}, and @samp{cpsr}.
43123 For M-profile targets (e.g. Cortex-M3), the @samp{org.gnu.gdb.arm.core}
43124 feature is replaced by @samp{org.gnu.gdb.arm.m-profile}. It should contain
43125 registers @samp{r0} through @samp{r13}, @samp{sp}, @samp{lr}, @samp{pc},
43128 The @samp{org.gnu.gdb.arm.fpa} feature is optional. If present, it
43129 should contain registers @samp{f0} through @samp{f7} and @samp{fps}.
43131 The @samp{org.gnu.gdb.xscale.iwmmxt} feature is optional. If present,
43132 it should contain at least registers @samp{wR0} through @samp{wR15} and
43133 @samp{wCGR0} through @samp{wCGR3}. The @samp{wCID}, @samp{wCon},
43134 @samp{wCSSF}, and @samp{wCASF} registers are optional.
43136 The @samp{org.gnu.gdb.arm.vfp} feature is optional. If present, it
43137 should contain at least registers @samp{d0} through @samp{d15}. If
43138 they are present, @samp{d16} through @samp{d31} should also be included.
43139 @value{GDBN} will synthesize the single-precision registers from
43140 halves of the double-precision registers.
43142 The @samp{org.gnu.gdb.arm.neon} feature is optional. It does not
43143 need to contain registers; it instructs @value{GDBN} to display the
43144 VFP double-precision registers as vectors and to synthesize the
43145 quad-precision registers from pairs of double-precision registers.
43146 If this feature is present, @samp{org.gnu.gdb.arm.vfp} must also
43147 be present and include 32 double-precision registers.
43149 @node i386 Features
43150 @subsection i386 Features
43151 @cindex target descriptions, i386 features
43153 The @samp{org.gnu.gdb.i386.core} feature is required for i386/amd64
43154 targets. It should describe the following registers:
43158 @samp{eax} through @samp{edi} plus @samp{eip} for i386
43160 @samp{rax} through @samp{r15} plus @samp{rip} for amd64
43162 @samp{eflags}, @samp{cs}, @samp{ss}, @samp{ds}, @samp{es},
43163 @samp{fs}, @samp{gs}
43165 @samp{st0} through @samp{st7}
43167 @samp{fctrl}, @samp{fstat}, @samp{ftag}, @samp{fiseg}, @samp{fioff},
43168 @samp{foseg}, @samp{fooff} and @samp{fop}
43171 The register sets may be different, depending on the target.
43173 The @samp{org.gnu.gdb.i386.sse} feature is optional. It should
43174 describe registers:
43178 @samp{xmm0} through @samp{xmm7} for i386
43180 @samp{xmm0} through @samp{xmm15} for amd64
43185 The @samp{org.gnu.gdb.i386.avx} feature is optional and requires the
43186 @samp{org.gnu.gdb.i386.sse} feature. It should
43187 describe the upper 128 bits of @sc{ymm} registers:
43191 @samp{ymm0h} through @samp{ymm7h} for i386
43193 @samp{ymm0h} through @samp{ymm15h} for amd64
43196 The @samp{org.gnu.gdb.i386.mpx} is an optional feature representing Intel
43197 Memory Protection Extension (MPX). It should describe the following registers:
43201 @samp{bnd0raw} through @samp{bnd3raw} for i386 and amd64.
43203 @samp{bndcfgu} and @samp{bndstatus} for i386 and amd64.
43206 The @samp{org.gnu.gdb.i386.linux} feature is optional. It should
43207 describe a single register, @samp{orig_eax}.
43209 The @samp{org.gnu.gdb.i386.segments} feature is optional. It should
43210 describe two system registers: @samp{fs_base} and @samp{gs_base}.
43212 The @samp{org.gnu.gdb.i386.avx512} feature is optional and requires the
43213 @samp{org.gnu.gdb.i386.avx} feature. It should
43214 describe additional @sc{xmm} registers:
43218 @samp{xmm16h} through @samp{xmm31h}, only valid for amd64.
43221 It should describe the upper 128 bits of additional @sc{ymm} registers:
43225 @samp{ymm16h} through @samp{ymm31h}, only valid for amd64.
43229 describe the upper 256 bits of @sc{zmm} registers:
43233 @samp{zmm0h} through @samp{zmm7h} for i386.
43235 @samp{zmm0h} through @samp{zmm15h} for amd64.
43239 describe the additional @sc{zmm} registers:
43243 @samp{zmm16h} through @samp{zmm31h}, only valid for amd64.
43246 The @samp{org.gnu.gdb.i386.pkeys} feature is optional. It should
43247 describe a single register, @samp{pkru}. It is a 32-bit register
43248 valid for i386 and amd64.
43250 @node MicroBlaze Features
43251 @subsection MicroBlaze Features
43252 @cindex target descriptions, MicroBlaze features
43254 The @samp{org.gnu.gdb.microblaze.core} feature is required for MicroBlaze
43255 targets. It should contain registers @samp{r0} through @samp{r31},
43256 @samp{rpc}, @samp{rmsr}, @samp{rear}, @samp{resr}, @samp{rfsr}, @samp{rbtr},
43257 @samp{rpvr}, @samp{rpvr1} through @samp{rpvr11}, @samp{redr}, @samp{rpid},
43258 @samp{rzpr}, @samp{rtlbx}, @samp{rtlbsx}, @samp{rtlblo}, and @samp{rtlbhi}.
43260 The @samp{org.gnu.gdb.microblaze.stack-protect} feature is optional.
43261 If present, it should contain registers @samp{rshr} and @samp{rslr}
43263 @node MIPS Features
43264 @subsection @acronym{MIPS} Features
43265 @cindex target descriptions, @acronym{MIPS} features
43267 The @samp{org.gnu.gdb.mips.cpu} feature is required for @acronym{MIPS} targets.
43268 It should contain registers @samp{r0} through @samp{r31}, @samp{lo},
43269 @samp{hi}, and @samp{pc}. They may be 32-bit or 64-bit depending
43272 The @samp{org.gnu.gdb.mips.cp0} feature is also required. It should
43273 contain at least the @samp{status}, @samp{badvaddr}, and @samp{cause}
43274 registers. They may be 32-bit or 64-bit depending on the target.
43276 The @samp{org.gnu.gdb.mips.fpu} feature is currently required, though
43277 it may be optional in a future version of @value{GDBN}. It should
43278 contain registers @samp{f0} through @samp{f31}, @samp{fcsr}, and
43279 @samp{fir}. They may be 32-bit or 64-bit depending on the target.
43281 The @samp{org.gnu.gdb.mips.dsp} feature is optional. It should
43282 contain registers @samp{hi1} through @samp{hi3}, @samp{lo1} through
43283 @samp{lo3}, and @samp{dspctl}. The @samp{dspctl} register should
43284 be 32-bit and the rest may be 32-bit or 64-bit depending on the target.
43286 The @samp{org.gnu.gdb.mips.linux} feature is optional. It should
43287 contain a single register, @samp{restart}, which is used by the
43288 Linux kernel to control restartable syscalls.
43290 @node M68K Features
43291 @subsection M68K Features
43292 @cindex target descriptions, M68K features
43295 @item @samp{org.gnu.gdb.m68k.core}
43296 @itemx @samp{org.gnu.gdb.coldfire.core}
43297 @itemx @samp{org.gnu.gdb.fido.core}
43298 One of those features must be always present.
43299 The feature that is present determines which flavor of m68k is
43300 used. The feature that is present should contain registers
43301 @samp{d0} through @samp{d7}, @samp{a0} through @samp{a5}, @samp{fp},
43302 @samp{sp}, @samp{ps} and @samp{pc}.
43304 @item @samp{org.gnu.gdb.coldfire.fp}
43305 This feature is optional. If present, it should contain registers
43306 @samp{fp0} through @samp{fp7}, @samp{fpcontrol}, @samp{fpstatus} and
43310 @node NDS32 Features
43311 @subsection NDS32 Features
43312 @cindex target descriptions, NDS32 features
43314 The @samp{org.gnu.gdb.nds32.core} feature is required for NDS32
43315 targets. It should contain at least registers @samp{r0} through
43316 @samp{r10}, @samp{r15}, @samp{fp}, @samp{gp}, @samp{lp}, @samp{sp},
43319 The @samp{org.gnu.gdb.nds32.fpu} feature is optional. If present,
43320 it should contain 64-bit double-precision floating-point registers
43321 @samp{fd0} through @emph{fdN}, which should be @samp{fd3}, @samp{fd7},
43322 @samp{fd15}, or @samp{fd31} based on the FPU configuration implemented.
43324 @emph{Note:} The first sixteen 64-bit double-precision floating-point
43325 registers are overlapped with the thirty-two 32-bit single-precision
43326 floating-point registers. The 32-bit single-precision registers, if
43327 not being listed explicitly, will be synthesized from halves of the
43328 overlapping 64-bit double-precision registers. Listing 32-bit
43329 single-precision registers explicitly is deprecated, and the
43330 support to it could be totally removed some day.
43332 @node Nios II Features
43333 @subsection Nios II Features
43334 @cindex target descriptions, Nios II features
43336 The @samp{org.gnu.gdb.nios2.cpu} feature is required for Nios II
43337 targets. It should contain the 32 core registers (@samp{zero},
43338 @samp{at}, @samp{r2} through @samp{r23}, @samp{et} through @samp{ra}),
43339 @samp{pc}, and the 16 control registers (@samp{status} through
43342 @node OpenRISC 1000 Features
43343 @subsection Openrisc 1000 Features
43344 @cindex target descriptions, OpenRISC 1000 features
43346 The @samp{org.gnu.gdb.or1k.group0} feature is required for OpenRISC 1000
43347 targets. It should contain the 32 general purpose registers (@samp{r0}
43348 through @samp{r31}), @samp{ppc}, @samp{npc} and @samp{sr}.
43350 @node PowerPC Features
43351 @subsection PowerPC Features
43352 @cindex target descriptions, PowerPC features
43354 The @samp{org.gnu.gdb.power.core} feature is required for PowerPC
43355 targets. It should contain registers @samp{r0} through @samp{r31},
43356 @samp{pc}, @samp{msr}, @samp{cr}, @samp{lr}, @samp{ctr}, and
43357 @samp{xer}. They may be 32-bit or 64-bit depending on the target.
43359 The @samp{org.gnu.gdb.power.fpu} feature is optional. It should
43360 contain registers @samp{f0} through @samp{f31} and @samp{fpscr}.
43362 The @samp{org.gnu.gdb.power.altivec} feature is optional. It should
43363 contain registers @samp{vr0} through @samp{vr31}, @samp{vscr}, and
43364 @samp{vrsave}. @value{GDBN} will define pseudo-registers @samp{v0}
43365 through @samp{v31} as aliases for the corresponding @samp{vrX}
43368 The @samp{org.gnu.gdb.power.vsx} feature is optional. It should
43369 contain registers @samp{vs0h} through @samp{vs31h}. @value{GDBN} will
43370 combine these registers with the floating point registers (@samp{f0}
43371 through @samp{f31}) and the altivec registers (@samp{vr0} through
43372 @samp{vr31}) to present the 128-bit wide registers @samp{vs0} through
43373 @samp{vs63}, the set of vector-scalar registers for POWER7.
43374 Therefore, this feature requires both @samp{org.gnu.gdb.power.fpu} and
43375 @samp{org.gnu.gdb.power.altivec}.
43377 The @samp{org.gnu.gdb.power.spe} feature is optional. It should
43378 contain registers @samp{ev0h} through @samp{ev31h}, @samp{acc}, and
43379 @samp{spefscr}. SPE targets should provide 32-bit registers in
43380 @samp{org.gnu.gdb.power.core} and provide the upper halves in
43381 @samp{ev0h} through @samp{ev31h}. @value{GDBN} will combine
43382 these to present registers @samp{ev0} through @samp{ev31} to the
43385 The @samp{org.gnu.gdb.power.ppr} feature is optional. It should
43386 contain the 64-bit register @samp{ppr}.
43388 The @samp{org.gnu.gdb.power.dscr} feature is optional. It should
43389 contain the 64-bit register @samp{dscr}.
43391 The @samp{org.gnu.gdb.power.tar} feature is optional. It should
43392 contain the 64-bit register @samp{tar}.
43394 The @samp{org.gnu.gdb.power.ebb} feature is optional. It should
43395 contain registers @samp{bescr}, @samp{ebbhr} and @samp{ebbrr}, all
43398 The @samp{org.gnu.gdb.power.linux.pmu} feature is optional. It should
43399 contain registers @samp{mmcr0}, @samp{mmcr2}, @samp{siar}, @samp{sdar}
43400 and @samp{sier}, all 64-bit wide. This is the subset of the isa 2.07
43401 server PMU registers provided by @sc{gnu}/Linux.
43403 The @samp{org.gnu.gdb.power.htm.spr} feature is optional. It should
43404 contain registers @samp{tfhar}, @samp{texasr} and @samp{tfiar}, all
43407 The @samp{org.gnu.gdb.power.htm.core} feature is optional. It should
43408 contain the checkpointed general-purpose registers @samp{cr0} through
43409 @samp{cr31}, as well as the checkpointed registers @samp{clr} and
43410 @samp{cctr}. These registers may all be either 32-bit or 64-bit
43411 depending on the target. It should also contain the checkpointed
43412 registers @samp{ccr} and @samp{cxer}, which should both be 32-bit
43415 The @samp{org.gnu.gdb.power.htm.fpu} feature is optional. It should
43416 contain the checkpointed 64-bit floating-point registers @samp{cf0}
43417 through @samp{cf31}, as well as the checkpointed 64-bit register
43420 The @samp{org.gnu.gdb.power.htm.altivec} feature is optional. It
43421 should contain the checkpointed altivec registers @samp{cvr0} through
43422 @samp{cvr31}, all 128-bit wide. It should also contain the
43423 checkpointed registers @samp{cvscr} and @samp{cvrsave}, both 32-bit
43426 The @samp{org.gnu.gdb.power.htm.vsx} feature is optional. It should
43427 contain registers @samp{cvs0h} through @samp{cvs31h}. @value{GDBN}
43428 will combine these registers with the checkpointed floating point
43429 registers (@samp{cf0} through @samp{cf31}) and the checkpointed
43430 altivec registers (@samp{cvr0} through @samp{cvr31}) to present the
43431 128-bit wide checkpointed vector-scalar registers @samp{cvs0} through
43432 @samp{cvs63}. Therefore, this feature requires both
43433 @samp{org.gnu.gdb.power.htm.altivec} and
43434 @samp{org.gnu.gdb.power.htm.fpu}.
43436 The @samp{org.gnu.gdb.power.htm.ppr} feature is optional. It should
43437 contain the 64-bit checkpointed register @samp{cppr}.
43439 The @samp{org.gnu.gdb.power.htm.dscr} feature is optional. It should
43440 contain the 64-bit checkpointed register @samp{cdscr}.
43442 The @samp{org.gnu.gdb.power.htm.tar} feature is optional. It should
43443 contain the 64-bit checkpointed register @samp{ctar}.
43446 @node RISC-V Features
43447 @subsection RISC-V Features
43448 @cindex target descriptions, RISC-V Features
43450 The @samp{org.gnu.gdb.riscv.cpu} feature is required for RISC-V
43451 targets. It should contain the registers @samp{x0} through
43452 @samp{x31}, and @samp{pc}. Either the architectural names (@samp{x0},
43453 @samp{x1}, etc) can be used, or the ABI names (@samp{zero}, @samp{ra},
43456 The @samp{org.gnu.gdb.riscv.fpu} feature is optional. If present, it
43457 should contain registers @samp{f0} through @samp{f31}, @samp{fflags},
43458 @samp{frm}, and @samp{fcsr}. As with the cpu feature, either the
43459 architectural register names, or the ABI names can be used.
43461 The @samp{org.gnu.gdb.riscv.virtual} feature is optional. If present,
43462 it should contain registers that are not backed by real registers on
43463 the target, but are instead virtual, where the register value is
43464 derived from other target state. In many ways these are like
43465 @value{GDBN}s pseudo-registers, except implemented by the target.
43466 Currently the only register expected in this set is the one byte
43467 @samp{priv} register that contains the target's privilege level in the
43468 least significant two bits.
43470 The @samp{org.gnu.gdb.riscv.csr} feature is optional. If present, it
43471 should contain all of the target's standard CSRs. Standard CSRs are
43472 those defined in the RISC-V specification documents. There is some
43473 overlap between this feature and the fpu feature; the @samp{fflags},
43474 @samp{frm}, and @samp{fcsr} registers could be in either feature. The
43475 expectation is that these registers will be in the fpu feature if the
43476 target has floating point hardware, but can be moved into the csr
43477 feature if the target has the floating point control registers, but no
43478 other floating point hardware.
43480 @node S/390 and System z Features
43481 @subsection S/390 and System z Features
43482 @cindex target descriptions, S/390 features
43483 @cindex target descriptions, System z features
43485 The @samp{org.gnu.gdb.s390.core} feature is required for S/390 and
43486 System z targets. It should contain the PSW and the 16 general
43487 registers. In particular, System z targets should provide the 64-bit
43488 registers @samp{pswm}, @samp{pswa}, and @samp{r0} through @samp{r15}.
43489 S/390 targets should provide the 32-bit versions of these registers.
43490 A System z target that runs in 31-bit addressing mode should provide
43491 32-bit versions of @samp{pswm} and @samp{pswa}, as well as the general
43492 register's upper halves @samp{r0h} through @samp{r15h}, and their
43493 lower halves @samp{r0l} through @samp{r15l}.
43495 The @samp{org.gnu.gdb.s390.fpr} feature is required. It should
43496 contain the 64-bit registers @samp{f0} through @samp{f15}, and
43499 The @samp{org.gnu.gdb.s390.acr} feature is required. It should
43500 contain the 32-bit registers @samp{acr0} through @samp{acr15}.
43502 The @samp{org.gnu.gdb.s390.linux} feature is optional. It should
43503 contain the register @samp{orig_r2}, which is 64-bit wide on System z
43504 targets and 32-bit otherwise. In addition, the feature may contain
43505 the @samp{last_break} register, whose width depends on the addressing
43506 mode, as well as the @samp{system_call} register, which is always
43509 The @samp{org.gnu.gdb.s390.tdb} feature is optional. It should
43510 contain the 64-bit registers @samp{tdb0}, @samp{tac}, @samp{tct},
43511 @samp{atia}, and @samp{tr0} through @samp{tr15}.
43513 The @samp{org.gnu.gdb.s390.vx} feature is optional. It should contain
43514 64-bit wide registers @samp{v0l} through @samp{v15l}, which will be
43515 combined by @value{GDBN} with the floating point registers @samp{f0}
43516 through @samp{f15} to present the 128-bit wide vector registers
43517 @samp{v0} through @samp{v15}. In addition, this feature should
43518 contain the 128-bit wide vector registers @samp{v16} through
43521 The @samp{org.gnu.gdb.s390.gs} feature is optional. It should contain
43522 the 64-bit wide guarded-storage-control registers @samp{gsd},
43523 @samp{gssm}, and @samp{gsepla}.
43525 The @samp{org.gnu.gdb.s390.gsbc} feature is optional. It should contain
43526 the 64-bit wide guarded-storage broadcast control registers
43527 @samp{bc_gsd}, @samp{bc_gssm}, and @samp{bc_gsepla}.
43529 @node Sparc Features
43530 @subsection Sparc Features
43531 @cindex target descriptions, sparc32 features
43532 @cindex target descriptions, sparc64 features
43533 The @samp{org.gnu.gdb.sparc.cpu} feature is required for sparc32/sparc64
43534 targets. It should describe the following registers:
43538 @samp{g0} through @samp{g7}
43540 @samp{o0} through @samp{o7}
43542 @samp{l0} through @samp{l7}
43544 @samp{i0} through @samp{i7}
43547 They may be 32-bit or 64-bit depending on the target.
43549 Also the @samp{org.gnu.gdb.sparc.fpu} feature is required for sparc32/sparc64
43550 targets. It should describe the following registers:
43554 @samp{f0} through @samp{f31}
43556 @samp{f32} through @samp{f62} for sparc64
43559 The @samp{org.gnu.gdb.sparc.cp0} feature is required for sparc32/sparc64
43560 targets. It should describe the following registers:
43564 @samp{y}, @samp{psr}, @samp{wim}, @samp{tbr}, @samp{pc}, @samp{npc},
43565 @samp{fsr}, and @samp{csr} for sparc32
43567 @samp{pc}, @samp{npc}, @samp{state}, @samp{fsr}, @samp{fprs}, and @samp{y}
43571 @node TIC6x Features
43572 @subsection TMS320C6x Features
43573 @cindex target descriptions, TIC6x features
43574 @cindex target descriptions, TMS320C6x features
43575 The @samp{org.gnu.gdb.tic6x.core} feature is required for TMS320C6x
43576 targets. It should contain registers @samp{A0} through @samp{A15},
43577 registers @samp{B0} through @samp{B15}, @samp{CSR} and @samp{PC}.
43579 The @samp{org.gnu.gdb.tic6x.gp} feature is optional. It should
43580 contain registers @samp{A16} through @samp{A31} and @samp{B16}
43581 through @samp{B31}.
43583 The @samp{org.gnu.gdb.tic6x.c6xp} feature is optional. It should
43584 contain registers @samp{TSR}, @samp{ILC} and @samp{RILC}.
43586 @node Operating System Information
43587 @appendix Operating System Information
43588 @cindex operating system information
43594 Users of @value{GDBN} often wish to obtain information about the state of
43595 the operating system running on the target---for example the list of
43596 processes, or the list of open files. This section describes the
43597 mechanism that makes it possible. This mechanism is similar to the
43598 target features mechanism (@pxref{Target Descriptions}), but focuses
43599 on a different aspect of target.
43601 Operating system information is retrived from the target via the
43602 remote protocol, using @samp{qXfer} requests (@pxref{qXfer osdata
43603 read}). The object name in the request should be @samp{osdata}, and
43604 the @var{annex} identifies the data to be fetched.
43607 @appendixsection Process list
43608 @cindex operating system information, process list
43610 When requesting the process list, the @var{annex} field in the
43611 @samp{qXfer} request should be @samp{processes}. The returned data is
43612 an XML document. The formal syntax of this document is defined in
43613 @file{gdb/features/osdata.dtd}.
43615 An example document is:
43618 <?xml version="1.0"?>
43619 <!DOCTYPE target SYSTEM "osdata.dtd">
43620 <osdata type="processes">
43622 <column name="pid">1</column>
43623 <column name="user">root</column>
43624 <column name="command">/sbin/init</column>
43625 <column name="cores">1,2,3</column>
43630 Each item should include a column whose name is @samp{pid}. The value
43631 of that column should identify the process on the target. The
43632 @samp{user} and @samp{command} columns are optional, and will be
43633 displayed by @value{GDBN}. The @samp{cores} column, if present,
43634 should contain a comma-separated list of cores that this process
43635 is running on. Target may provide additional columns,
43636 which @value{GDBN} currently ignores.
43638 @node Trace File Format
43639 @appendix Trace File Format
43640 @cindex trace file format
43642 The trace file comes in three parts: a header, a textual description
43643 section, and a trace frame section with binary data.
43645 The header has the form @code{\x7fTRACE0\n}. The first byte is
43646 @code{0x7f} so as to indicate that the file contains binary data,
43647 while the @code{0} is a version number that may have different values
43650 The description section consists of multiple lines of @sc{ascii} text
43651 separated by newline characters (@code{0xa}). The lines may include a
43652 variety of optional descriptive or context-setting information, such
43653 as tracepoint definitions or register set size. @value{GDBN} will
43654 ignore any line that it does not recognize. An empty line marks the end
43659 Specifies the size of a register block in bytes. This is equal to the
43660 size of a @code{g} packet payload in the remote protocol. @var{size}
43661 is an ascii decimal number. There should be only one such line in
43662 a single trace file.
43664 @item status @var{status}
43665 Trace status. @var{status} has the same format as a @code{qTStatus}
43666 remote packet reply. There should be only one such line in a single trace
43669 @item tp @var{payload}
43670 Tracepoint definition. The @var{payload} has the same format as
43671 @code{qTfP}/@code{qTsP} remote packet reply payload. A single tracepoint
43672 may take multiple lines of definition, corresponding to the multiple
43675 @item tsv @var{payload}
43676 Trace state variable definition. The @var{payload} has the same format as
43677 @code{qTfV}/@code{qTsV} remote packet reply payload. A single variable
43678 may take multiple lines of definition, corresponding to the multiple
43681 @item tdesc @var{payload}
43682 Target description in XML format. The @var{payload} is a single line of
43683 the XML file. All such lines should be concatenated together to get
43684 the original XML file. This file is in the same format as @code{qXfer}
43685 @code{features} payload, and corresponds to the main @code{target.xml}
43686 file. Includes are not allowed.
43690 The trace frame section consists of a number of consecutive frames.
43691 Each frame begins with a two-byte tracepoint number, followed by a
43692 four-byte size giving the amount of data in the frame. The data in
43693 the frame consists of a number of blocks, each introduced by a
43694 character indicating its type (at least register, memory, and trace
43695 state variable). The data in this section is raw binary, not a
43696 hexadecimal or other encoding; its endianness matches the target's
43699 @c FIXME bi-arch may require endianness/arch info in description section
43702 @item R @var{bytes}
43703 Register block. The number and ordering of bytes matches that of a
43704 @code{g} packet in the remote protocol. Note that these are the
43705 actual bytes, in target order, not a hexadecimal encoding.
43707 @item M @var{address} @var{length} @var{bytes}...
43708 Memory block. This is a contiguous block of memory, at the 8-byte
43709 address @var{address}, with a 2-byte length @var{length}, followed by
43710 @var{length} bytes.
43712 @item V @var{number} @var{value}
43713 Trace state variable block. This records the 8-byte signed value
43714 @var{value} of trace state variable numbered @var{number}.
43718 Future enhancements of the trace file format may include additional types
43721 @node Index Section Format
43722 @appendix @code{.gdb_index} section format
43723 @cindex .gdb_index section format
43724 @cindex index section format
43726 This section documents the index section that is created by @code{save
43727 gdb-index} (@pxref{Index Files}). The index section is
43728 DWARF-specific; some knowledge of DWARF is assumed in this
43731 The mapped index file format is designed to be directly
43732 @code{mmap}able on any architecture. In most cases, a datum is
43733 represented using a little-endian 32-bit integer value, called an
43734 @code{offset_type}. Big endian machines must byte-swap the values
43735 before using them. Exceptions to this rule are noted. The data is
43736 laid out such that alignment is always respected.
43738 A mapped index consists of several areas, laid out in order.
43742 The file header. This is a sequence of values, of @code{offset_type}
43743 unless otherwise noted:
43747 The version number, currently 8. Versions 1, 2 and 3 are obsolete.
43748 Version 4 uses a different hashing function from versions 5 and 6.
43749 Version 6 includes symbols for inlined functions, whereas versions 4
43750 and 5 do not. Version 7 adds attributes to the CU indices in the
43751 symbol table. Version 8 specifies that symbols from DWARF type units
43752 (@samp{DW_TAG_type_unit}) refer to the type unit's symbol table and not the
43753 compilation unit (@samp{DW_TAG_comp_unit}) using the type.
43755 @value{GDBN} will only read version 4, 5, or 6 indices
43756 by specifying @code{set use-deprecated-index-sections on}.
43757 GDB has a workaround for potentially broken version 7 indices so it is
43758 currently not flagged as deprecated.
43761 The offset, from the start of the file, of the CU list.
43764 The offset, from the start of the file, of the types CU list. Note
43765 that this area can be empty, in which case this offset will be equal
43766 to the next offset.
43769 The offset, from the start of the file, of the address area.
43772 The offset, from the start of the file, of the symbol table.
43775 The offset, from the start of the file, of the constant pool.
43779 The CU list. This is a sequence of pairs of 64-bit little-endian
43780 values, sorted by the CU offset. The first element in each pair is
43781 the offset of a CU in the @code{.debug_info} section. The second
43782 element in each pair is the length of that CU. References to a CU
43783 elsewhere in the map are done using a CU index, which is just the
43784 0-based index into this table. Note that if there are type CUs, then
43785 conceptually CUs and type CUs form a single list for the purposes of
43789 The types CU list. This is a sequence of triplets of 64-bit
43790 little-endian values. In a triplet, the first value is the CU offset,
43791 the second value is the type offset in the CU, and the third value is
43792 the type signature. The types CU list is not sorted.
43795 The address area. The address area consists of a sequence of address
43796 entries. Each address entry has three elements:
43800 The low address. This is a 64-bit little-endian value.
43803 The high address. This is a 64-bit little-endian value. Like
43804 @code{DW_AT_high_pc}, the value is one byte beyond the end.
43807 The CU index. This is an @code{offset_type} value.
43811 The symbol table. This is an open-addressed hash table. The size of
43812 the hash table is always a power of 2.
43814 Each slot in the hash table consists of a pair of @code{offset_type}
43815 values. The first value is the offset of the symbol's name in the
43816 constant pool. The second value is the offset of the CU vector in the
43819 If both values are 0, then this slot in the hash table is empty. This
43820 is ok because while 0 is a valid constant pool index, it cannot be a
43821 valid index for both a string and a CU vector.
43823 The hash value for a table entry is computed by applying an
43824 iterative hash function to the symbol's name. Starting with an
43825 initial value of @code{r = 0}, each (unsigned) character @samp{c} in
43826 the string is incorporated into the hash using the formula depending on the
43831 The formula is @code{r = r * 67 + c - 113}.
43833 @item Versions 5 to 7
43834 The formula is @code{r = r * 67 + tolower (c) - 113}.
43837 The terminating @samp{\0} is not incorporated into the hash.
43839 The step size used in the hash table is computed via
43840 @code{((hash * 17) & (size - 1)) | 1}, where @samp{hash} is the hash
43841 value, and @samp{size} is the size of the hash table. The step size
43842 is used to find the next candidate slot when handling a hash
43845 The names of C@t{++} symbols in the hash table are canonicalized. We
43846 don't currently have a simple description of the canonicalization
43847 algorithm; if you intend to create new index sections, you must read
43851 The constant pool. This is simply a bunch of bytes. It is organized
43852 so that alignment is correct: CU vectors are stored first, followed by
43855 A CU vector in the constant pool is a sequence of @code{offset_type}
43856 values. The first value is the number of CU indices in the vector.
43857 Each subsequent value is the index and symbol attributes of a CU in
43858 the CU list. This element in the hash table is used to indicate which
43859 CUs define the symbol and how the symbol is used.
43860 See below for the format of each CU index+attributes entry.
43862 A string in the constant pool is zero-terminated.
43865 Attributes were added to CU index values in @code{.gdb_index} version 7.
43866 If a symbol has multiple uses within a CU then there is one
43867 CU index+attributes value for each use.
43869 The format of each CU index+attributes entry is as follows
43875 This is the index of the CU in the CU list.
43877 These bits are reserved for future purposes and must be zero.
43879 The kind of the symbol in the CU.
43883 This value is reserved and should not be used.
43884 By reserving zero the full @code{offset_type} value is backwards compatible
43885 with previous versions of the index.
43887 The symbol is a type.
43889 The symbol is a variable or an enum value.
43891 The symbol is a function.
43893 Any other kind of symbol.
43895 These values are reserved.
43899 This bit is zero if the value is global and one if it is static.
43901 The determination of whether a symbol is global or static is complicated.
43902 The authorative reference is the file @file{dwarf2read.c} in
43903 @value{GDBN} sources.
43907 This pseudo-code describes the computation of a symbol's kind and
43908 global/static attributes in the index.
43911 is_external = get_attribute (die, DW_AT_external);
43912 language = get_attribute (cu_die, DW_AT_language);
43915 case DW_TAG_typedef:
43916 case DW_TAG_base_type:
43917 case DW_TAG_subrange_type:
43921 case DW_TAG_enumerator:
43923 is_static = language != CPLUS;
43925 case DW_TAG_subprogram:
43927 is_static = ! (is_external || language == ADA);
43929 case DW_TAG_constant:
43931 is_static = ! is_external;
43933 case DW_TAG_variable:
43935 is_static = ! is_external;
43937 case DW_TAG_namespace:
43941 case DW_TAG_class_type:
43942 case DW_TAG_interface_type:
43943 case DW_TAG_structure_type:
43944 case DW_TAG_union_type:
43945 case DW_TAG_enumeration_type:
43947 is_static = language != CPLUS;
43955 @appendix Manual pages
43959 * gdb man:: The GNU Debugger man page
43960 * gdbserver man:: Remote Server for the GNU Debugger man page
43961 * gcore man:: Generate a core file of a running program
43962 * gdbinit man:: gdbinit scripts
43963 * gdb-add-index man:: Add index files to speed up GDB
43969 @c man title gdb The GNU Debugger
43971 @c man begin SYNOPSIS gdb
43972 gdb [@option{-help}] [@option{-nh}] [@option{-nx}] [@option{-q}]
43973 [@option{-batch}] [@option{-cd=}@var{dir}] [@option{-f}]
43974 [@option{-b}@w{ }@var{bps}]
43975 [@option{-tty=}@var{dev}] [@option{-s} @var{symfile}]
43976 [@option{-e}@w{ }@var{prog}] [@option{-se}@w{ }@var{prog}]
43977 [@option{-c}@w{ }@var{core}] [@option{-p}@w{ }@var{procID}]
43978 [@option{-x}@w{ }@var{cmds}] [@option{-d}@w{ }@var{dir}]
43979 [@var{prog}|@var{prog} @var{procID}|@var{prog} @var{core}]
43982 @c man begin DESCRIPTION gdb
43983 The purpose of a debugger such as @value{GDBN} is to allow you to see what is
43984 going on ``inside'' another program while it executes -- or what another
43985 program was doing at the moment it crashed.
43987 @value{GDBN} can do four main kinds of things (plus other things in support of
43988 these) to help you catch bugs in the act:
43992 Start your program, specifying anything that might affect its behavior.
43995 Make your program stop on specified conditions.
43998 Examine what has happened, when your program has stopped.
44001 Change things in your program, so you can experiment with correcting the
44002 effects of one bug and go on to learn about another.
44005 You can use @value{GDBN} to debug programs written in C, C@t{++}, Fortran and
44008 @value{GDBN} is invoked with the shell command @code{gdb}. Once started, it reads
44009 commands from the terminal until you tell it to exit with the @value{GDBN}
44010 command @code{quit}. You can get online help from @value{GDBN} itself
44011 by using the command @code{help}.
44013 You can run @code{gdb} with no arguments or options; but the most
44014 usual way to start @value{GDBN} is with one argument or two, specifying an
44015 executable program as the argument:
44021 You can also start with both an executable program and a core file specified:
44027 You can, instead, specify a process ID as a second argument, if you want
44028 to debug a running process:
44036 would attach @value{GDBN} to process @code{1234} (unless you also have a file
44037 named @file{1234}; @value{GDBN} does check for a core file first).
44038 With option @option{-p} you can omit the @var{program} filename.
44040 Here are some of the most frequently needed @value{GDBN} commands:
44042 @c pod2man highlights the right hand side of the @item lines.
44044 @item break [@var{file}:]@var{function}
44045 Set a breakpoint at @var{function} (in @var{file}).
44047 @item run [@var{arglist}]
44048 Start your program (with @var{arglist}, if specified).
44051 Backtrace: display the program stack.
44053 @item print @var{expr}
44054 Display the value of an expression.
44057 Continue running your program (after stopping, e.g. at a breakpoint).
44060 Execute next program line (after stopping); step @emph{over} any
44061 function calls in the line.
44063 @item edit [@var{file}:]@var{function}
44064 look at the program line where it is presently stopped.
44066 @item list [@var{file}:]@var{function}
44067 type the text of the program in the vicinity of where it is presently stopped.
44070 Execute next program line (after stopping); step @emph{into} any
44071 function calls in the line.
44073 @item help [@var{name}]
44074 Show information about @value{GDBN} command @var{name}, or general information
44075 about using @value{GDBN}.
44078 Exit from @value{GDBN}.
44082 For full details on @value{GDBN},
44083 see @cite{Using GDB: A Guide to the GNU Source-Level Debugger},
44084 by Richard M. Stallman and Roland H. Pesch. The same text is available online
44085 as the @code{gdb} entry in the @code{info} program.
44089 @c man begin OPTIONS gdb
44090 Any arguments other than options specify an executable
44091 file and core file (or process ID); that is, the first argument
44092 encountered with no
44093 associated option flag is equivalent to a @option{-se} option, and the second,
44094 if any, is equivalent to a @option{-c} option if it's the name of a file.
44096 both long and short forms; both are shown here. The long forms are also
44097 recognized if you truncate them, so long as enough of the option is
44098 present to be unambiguous. (If you prefer, you can flag option
44099 arguments with @option{+} rather than @option{-}, though we illustrate the
44100 more usual convention.)
44102 All the options and command line arguments you give are processed
44103 in sequential order. The order makes a difference when the @option{-x}
44109 List all options, with brief explanations.
44111 @item -symbols=@var{file}
44112 @itemx -s @var{file}
44113 Read symbol table from file @var{file}.
44116 Enable writing into executable and core files.
44118 @item -exec=@var{file}
44119 @itemx -e @var{file}
44120 Use file @var{file} as the executable file to execute when
44121 appropriate, and for examining pure data in conjunction with a core
44124 @item -se=@var{file}
44125 Read symbol table from file @var{file} and use it as the executable
44128 @item -core=@var{file}
44129 @itemx -c @var{file}
44130 Use file @var{file} as a core dump to examine.
44132 @item -command=@var{file}
44133 @itemx -x @var{file}
44134 Execute @value{GDBN} commands from file @var{file}.
44136 @item -ex @var{command}
44137 Execute given @value{GDBN} @var{command}.
44139 @item -directory=@var{directory}
44140 @itemx -d @var{directory}
44141 Add @var{directory} to the path to search for source files.
44144 Do not execute commands from @file{~/.gdbinit}.
44148 Do not execute commands from any @file{.gdbinit} initialization files.
44152 ``Quiet''. Do not print the introductory and copyright messages. These
44153 messages are also suppressed in batch mode.
44156 Run in batch mode. Exit with status @code{0} after processing all the command
44157 files specified with @option{-x} (and @file{.gdbinit}, if not inhibited).
44158 Exit with nonzero status if an error occurs in executing the @value{GDBN}
44159 commands in the command files.
44161 Batch mode may be useful for running @value{GDBN} as a filter, for example to
44162 download and run a program on another computer; in order to make this
44163 more useful, the message
44166 Program exited normally.
44170 (which is ordinarily issued whenever a program running under @value{GDBN} control
44171 terminates) is not issued when running in batch mode.
44173 @item -cd=@var{directory}
44174 Run @value{GDBN} using @var{directory} as its working directory,
44175 instead of the current directory.
44179 Emacs sets this option when it runs @value{GDBN} as a subprocess. It tells
44180 @value{GDBN} to output the full file name and line number in a standard,
44181 recognizable fashion each time a stack frame is displayed (which
44182 includes each time the program stops). This recognizable format looks
44183 like two @samp{\032} characters, followed by the file name, line number
44184 and character position separated by colons, and a newline. The
44185 Emacs-to-@value{GDBN} interface program uses the two @samp{\032}
44186 characters as a signal to display the source code for the frame.
44189 Set the line speed (baud rate or bits per second) of any serial
44190 interface used by @value{GDBN} for remote debugging.
44192 @item -tty=@var{device}
44193 Run using @var{device} for your program's standard input and output.
44197 @c man begin SEEALSO gdb
44199 The full documentation for @value{GDBN} is maintained as a Texinfo manual.
44200 If the @code{info} and @code{gdb} programs and @value{GDBN}'s Texinfo
44201 documentation are properly installed at your site, the command
44208 should give you access to the complete manual.
44210 @cite{Using GDB: A Guide to the GNU Source-Level Debugger},
44211 Richard M. Stallman and Roland H. Pesch, July 1991.
44215 @node gdbserver man
44216 @heading gdbserver man
44218 @c man title gdbserver Remote Server for the GNU Debugger
44220 @c man begin SYNOPSIS gdbserver
44221 gdbserver @var{comm} @var{prog} [@var{args}@dots{}]
44223 gdbserver --attach @var{comm} @var{pid}
44225 gdbserver --multi @var{comm}
44229 @c man begin DESCRIPTION gdbserver
44230 @command{gdbserver} is a program that allows you to run @value{GDBN} on a different machine
44231 than the one which is running the program being debugged.
44234 @subheading Usage (server (target) side)
44237 Usage (server (target) side):
44240 First, you need to have a copy of the program you want to debug put onto
44241 the target system. The program can be stripped to save space if needed, as
44242 @command{gdbserver} doesn't care about symbols. All symbol handling is taken care of by
44243 the @value{GDBN} running on the host system.
44245 To use the server, you log on to the target system, and run the @command{gdbserver}
44246 program. You must tell it (a) how to communicate with @value{GDBN}, (b) the name of
44247 your program, and (c) its arguments. The general syntax is:
44250 target> gdbserver @var{comm} @var{program} [@var{args} ...]
44253 For example, using a serial port, you might say:
44257 @c @file would wrap it as F</dev/com1>.
44258 target> gdbserver /dev/com1 emacs foo.txt
44261 target> gdbserver @file{/dev/com1} emacs foo.txt
44265 This tells @command{gdbserver} to debug emacs with an argument of foo.txt, and
44266 to communicate with @value{GDBN} via @file{/dev/com1}. @command{gdbserver} now
44267 waits patiently for the host @value{GDBN} to communicate with it.
44269 To use a TCP connection, you could say:
44272 target> gdbserver host:2345 emacs foo.txt
44275 This says pretty much the same thing as the last example, except that we are
44276 going to communicate with the @code{host} @value{GDBN} via TCP. The @code{host:2345} argument means
44277 that we are expecting to see a TCP connection from @code{host} to local TCP port
44278 2345. (Currently, the @code{host} part is ignored.) You can choose any number you
44279 want for the port number as long as it does not conflict with any existing TCP
44280 ports on the target system. This same port number must be used in the host
44281 @value{GDBN}s @code{target remote} command, which will be described shortly. Note that if
44282 you chose a port number that conflicts with another service, @command{gdbserver} will
44283 print an error message and exit.
44285 @command{gdbserver} can also attach to running programs.
44286 This is accomplished via the @option{--attach} argument. The syntax is:
44289 target> gdbserver --attach @var{comm} @var{pid}
44292 @var{pid} is the process ID of a currently running process. It isn't
44293 necessary to point @command{gdbserver} at a binary for the running process.
44295 To start @code{gdbserver} without supplying an initial command to run
44296 or process ID to attach, use the @option{--multi} command line option.
44297 In such case you should connect using @kbd{target extended-remote} to start
44298 the program you want to debug.
44301 target> gdbserver --multi @var{comm}
44305 @subheading Usage (host side)
44311 You need an unstripped copy of the target program on your host system, since
44312 @value{GDBN} needs to examine its symbol tables and such. Start up @value{GDBN} as you normally
44313 would, with the target program as the first argument. (You may need to use the
44314 @option{--baud} option if the serial line is running at anything except 9600 baud.)
44315 That is @code{gdb TARGET-PROG}, or @code{gdb --baud BAUD TARGET-PROG}. After that, the only
44316 new command you need to know about is @code{target remote}
44317 (or @code{target extended-remote}). Its argument is either
44318 a device name (usually a serial device, like @file{/dev/ttyb}), or a @code{HOST:PORT}
44319 descriptor. For example:
44323 @c @file would wrap it as F</dev/ttyb>.
44324 (gdb) target remote /dev/ttyb
44327 (gdb) target remote @file{/dev/ttyb}
44332 communicates with the server via serial line @file{/dev/ttyb}, and:
44335 (gdb) target remote the-target:2345
44339 communicates via a TCP connection to port 2345 on host `the-target', where
44340 you previously started up @command{gdbserver} with the same port number. Note that for
44341 TCP connections, you must start up @command{gdbserver} prior to using the `target remote'
44342 command, otherwise you may get an error that looks something like
44343 `Connection refused'.
44345 @command{gdbserver} can also debug multiple inferiors at once,
44348 the @value{GDBN} manual in node @code{Inferiors and Programs}
44349 -- shell command @code{info -f gdb -n 'Inferiors and Programs'}.
44352 @ref{Inferiors and Programs}.
44354 In such case use the @code{extended-remote} @value{GDBN} command variant:
44357 (gdb) target extended-remote the-target:2345
44360 The @command{gdbserver} option @option{--multi} may or may not be used in such
44364 @c man begin OPTIONS gdbserver
44365 There are three different modes for invoking @command{gdbserver}:
44370 Debug a specific program specified by its program name:
44373 gdbserver @var{comm} @var{prog} [@var{args}@dots{}]
44376 The @var{comm} parameter specifies how should the server communicate
44377 with @value{GDBN}; it is either a device name (to use a serial line),
44378 a TCP port number (@code{:1234}), or @code{-} or @code{stdio} to use
44379 stdin/stdout of @code{gdbserver}. Specify the name of the program to
44380 debug in @var{prog}. Any remaining arguments will be passed to the
44381 program verbatim. When the program exits, @value{GDBN} will close the
44382 connection, and @code{gdbserver} will exit.
44385 Debug a specific program by specifying the process ID of a running
44389 gdbserver --attach @var{comm} @var{pid}
44392 The @var{comm} parameter is as described above. Supply the process ID
44393 of a running program in @var{pid}; @value{GDBN} will do everything
44394 else. Like with the previous mode, when the process @var{pid} exits,
44395 @value{GDBN} will close the connection, and @code{gdbserver} will exit.
44398 Multi-process mode -- debug more than one program/process:
44401 gdbserver --multi @var{comm}
44404 In this mode, @value{GDBN} can instruct @command{gdbserver} which
44405 command(s) to run. Unlike the other 2 modes, @value{GDBN} will not
44406 close the connection when a process being debugged exits, so you can
44407 debug several processes in the same session.
44410 In each of the modes you may specify these options:
44415 List all options, with brief explanations.
44418 This option causes @command{gdbserver} to print its version number and exit.
44421 @command{gdbserver} will attach to a running program. The syntax is:
44424 target> gdbserver --attach @var{comm} @var{pid}
44427 @var{pid} is the process ID of a currently running process. It isn't
44428 necessary to point @command{gdbserver} at a binary for the running process.
44431 To start @code{gdbserver} without supplying an initial command to run
44432 or process ID to attach, use this command line option.
44433 Then you can connect using @kbd{target extended-remote} and start
44434 the program you want to debug. The syntax is:
44437 target> gdbserver --multi @var{comm}
44441 Instruct @code{gdbserver} to display extra status information about the debugging
44443 This option is intended for @code{gdbserver} development and for bug reports to
44446 @item --remote-debug
44447 Instruct @code{gdbserver} to display remote protocol debug output.
44448 This option is intended for @code{gdbserver} development and for bug reports to
44451 @item --debug-format=option1@r{[},option2,...@r{]}
44452 Instruct @code{gdbserver} to include extra information in each line
44453 of debugging output.
44454 @xref{Other Command-Line Arguments for gdbserver}.
44457 Specify a wrapper to launch programs
44458 for debugging. The option should be followed by the name of the
44459 wrapper, then any command-line arguments to pass to the wrapper, then
44460 @kbd{--} indicating the end of the wrapper arguments.
44463 By default, @command{gdbserver} keeps the listening TCP port open, so that
44464 additional connections are possible. However, if you start @code{gdbserver}
44465 with the @option{--once} option, it will stop listening for any further
44466 connection attempts after connecting to the first @value{GDBN} session.
44468 @c --disable-packet is not documented for users.
44470 @c --disable-randomization and --no-disable-randomization are superseded by
44471 @c QDisableRandomization.
44476 @c man begin SEEALSO gdbserver
44478 The full documentation for @value{GDBN} is maintained as a Texinfo manual.
44479 If the @code{info} and @code{gdb} programs and @value{GDBN}'s Texinfo
44480 documentation are properly installed at your site, the command
44486 should give you access to the complete manual.
44488 @cite{Using GDB: A Guide to the GNU Source-Level Debugger},
44489 Richard M. Stallman and Roland H. Pesch, July 1991.
44496 @c man title gcore Generate a core file of a running program
44499 @c man begin SYNOPSIS gcore
44500 gcore [-a] [-o @var{prefix}] @var{pid1} [@var{pid2}...@var{pidN}]
44504 @c man begin DESCRIPTION gcore
44505 Generate core dumps of one or more running programs with process IDs
44506 @var{pid1}, @var{pid2}, etc. A core file produced by @command{gcore}
44507 is equivalent to one produced by the kernel when the process crashes
44508 (and when @kbd{ulimit -c} was used to set up an appropriate core dump
44509 limit). However, unlike after a crash, after @command{gcore} finishes
44510 its job the program remains running without any change.
44513 @c man begin OPTIONS gcore
44516 Dump all memory mappings. The actual effect of this option depends on
44517 the Operating System. On @sc{gnu}/Linux, it will disable
44518 @code{use-coredump-filter} (@pxref{set use-coredump-filter}) and
44519 enable @code{dump-excluded-mappings} (@pxref{set
44520 dump-excluded-mappings}).
44522 @item -o @var{prefix}
44523 The optional argument @var{prefix} specifies the prefix to be used
44524 when composing the file names of the core dumps. The file name is
44525 composed as @file{@var{prefix}.@var{pid}}, where @var{pid} is the
44526 process ID of the running program being analyzed by @command{gcore}.
44527 If not specified, @var{prefix} defaults to @var{gcore}.
44531 @c man begin SEEALSO gcore
44533 The full documentation for @value{GDBN} is maintained as a Texinfo manual.
44534 If the @code{info} and @code{gdb} programs and @value{GDBN}'s Texinfo
44535 documentation are properly installed at your site, the command
44542 should give you access to the complete manual.
44544 @cite{Using GDB: A Guide to the GNU Source-Level Debugger},
44545 Richard M. Stallman and Roland H. Pesch, July 1991.
44552 @c man title gdbinit GDB initialization scripts
44555 @c man begin SYNOPSIS gdbinit
44556 @ifset SYSTEM_GDBINIT
44557 @value{SYSTEM_GDBINIT}
44566 @c man begin DESCRIPTION gdbinit
44567 These files contain @value{GDBN} commands to automatically execute during
44568 @value{GDBN} startup. The lines of contents are canned sequences of commands,
44571 the @value{GDBN} manual in node @code{Sequences}
44572 -- shell command @code{info -f gdb -n Sequences}.
44578 Please read more in
44580 the @value{GDBN} manual in node @code{Startup}
44581 -- shell command @code{info -f gdb -n Startup}.
44588 @ifset SYSTEM_GDBINIT
44589 @item @value{SYSTEM_GDBINIT}
44591 @ifclear SYSTEM_GDBINIT
44592 @item (not enabled with @code{--with-system-gdbinit} during compilation)
44594 System-wide initialization file. It is executed unless user specified
44595 @value{GDBN} option @code{-nx} or @code{-n}.
44598 the @value{GDBN} manual in node @code{System-wide configuration}
44599 -- shell command @code{info -f gdb -n 'System-wide configuration'}.
44602 @ref{System-wide configuration}.
44606 User initialization file. It is executed unless user specified
44607 @value{GDBN} options @code{-nx}, @code{-n} or @code{-nh}.
44610 Initialization file for current directory. It may need to be enabled with
44611 @value{GDBN} security command @code{set auto-load local-gdbinit}.
44614 the @value{GDBN} manual in node @code{Init File in the Current Directory}
44615 -- shell command @code{info -f gdb -n 'Init File in the Current Directory'}.
44618 @ref{Init File in the Current Directory}.
44623 @c man begin SEEALSO gdbinit
44625 gdb(1), @code{info -f gdb -n Startup}
44627 The full documentation for @value{GDBN} is maintained as a Texinfo manual.
44628 If the @code{info} and @code{gdb} programs and @value{GDBN}'s Texinfo
44629 documentation are properly installed at your site, the command
44635 should give you access to the complete manual.
44637 @cite{Using GDB: A Guide to the GNU Source-Level Debugger},
44638 Richard M. Stallman and Roland H. Pesch, July 1991.
44642 @node gdb-add-index man
44643 @heading gdb-add-index
44644 @pindex gdb-add-index
44645 @anchor{gdb-add-index}
44647 @c man title gdb-add-index Add index files to speed up GDB
44649 @c man begin SYNOPSIS gdb-add-index
44650 gdb-add-index @var{filename}
44653 @c man begin DESCRIPTION gdb-add-index
44654 When @value{GDBN} finds a symbol file, it scans the symbols in the
44655 file in order to construct an internal symbol table. This lets most
44656 @value{GDBN} operations work quickly--at the cost of a delay early on.
44657 For large programs, this delay can be quite lengthy, so @value{GDBN}
44658 provides a way to build an index, which speeds up startup.
44660 To determine whether a file contains such an index, use the command
44661 @kbd{readelf -S filename}: the index is stored in a section named
44662 @code{.gdb_index}. The index file can only be produced on systems
44663 which use ELF binaries and DWARF debug information (i.e., sections
44664 named @code{.debug_*}).
44666 @command{gdb-add-index} uses @value{GDBN} and @command{objdump} found
44667 in the @env{PATH} environment variable. If you want to use different
44668 versions of these programs, you can specify them through the
44669 @env{GDB} and @env{OBJDUMP} environment variables.
44673 the @value{GDBN} manual in node @code{Index Files}
44674 -- shell command @kbd{info -f gdb -n "Index Files"}.
44681 @c man begin SEEALSO gdb-add-index
44683 The full documentation for @value{GDBN} is maintained as a Texinfo manual.
44684 If the @code{info} and @code{gdb} programs and @value{GDBN}'s Texinfo
44685 documentation are properly installed at your site, the command
44691 should give you access to the complete manual.
44693 @cite{Using GDB: A Guide to the GNU Source-Level Debugger},
44694 Richard M. Stallman and Roland H. Pesch, July 1991.
44700 @node GNU Free Documentation License
44701 @appendix GNU Free Documentation License
44704 @node Concept Index
44705 @unnumbered Concept Index
44709 @node Command and Variable Index
44710 @unnumbered Command, Variable, and Function Index
44715 % I think something like @@colophon should be in texinfo. In the
44717 \long\def\colophon{\hbox to0pt{}\vfill
44718 \centerline{The body of this manual is set in}
44719 \centerline{\fontname\tenrm,}
44720 \centerline{with headings in {\bf\fontname\tenbf}}
44721 \centerline{and examples in {\tt\fontname\tentt}.}
44722 \centerline{{\it\fontname\tenit\/},}
44723 \centerline{{\bf\fontname\tenbf}, and}
44724 \centerline{{\sl\fontname\tensl\/}}
44725 \centerline{are used for emphasis.}\vfill}
44727 % Blame: doc@@cygnus.com, 1991.