Install and generate docs for gdb-add-index
[external/binutils.git] / gdb / doc / gdb.texinfo
1 \input texinfo      @c -*-texinfo-*-
2 @c Copyright (C) 1988-2018 Free Software Foundation, Inc.
3 @c
4 @c %**start of header
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.
7 @setfilename gdb.info
8 @c
9 @c man begin INCLUDE
10 @include gdb-cfg.texi
11 @c man end
12 @c
13 @settitle Debugging with @value{GDBN}
14 @setchapternewpage odd
15 @c %**end of header
16
17 @iftex
18 @c @smallbook
19 @c @cropmarks
20 @end iftex
21
22 @finalout
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.
27 @syncodeindex ky fn
28 @syncodeindex tp fn
29
30 @c readline appendices use @vindex, @findex and @ftable,
31 @c annotate.texi and gdbmi use @findex.
32 @syncodeindex vr fn
33
34 @c !!set GDB manual's edition---not the same as GDB version!
35 @c This is updated by GNU Press.
36 @set EDITION Tenth
37
38 @c !!set GDB edit command default editor
39 @set EDITOR /bin/ex
40
41 @c THIS MANUAL REQUIRES TEXINFO 4.0 OR LATER.
42
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
46 @direntry
47 * Gdb: (gdb).                     The GNU debugger.
48 * gdbserver: (gdb) Server.        The GNU debugging server.
49 @end direntry
50
51 @copying
52 @c man begin COPYRIGHT
53 Copyright @copyright{} 1988-2018 Free Software Foundation, Inc.
54
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.
61
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.''
65 @c man end
66 @end copying
67
68 @ifnottex
69 This file documents the @sc{gnu} debugger @value{GDBN}.
70
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}
75 @end ifset
76 Version @value{GDBVN}.
77
78 @insertcopying
79 @end ifnottex
80
81 @titlepage
82 @title Debugging with @value{GDBN}
83 @subtitle The @sc{gnu} Source-Level Debugger
84 @sp 1
85 @subtitle @value{EDITION} Edition, for @value{GDBN} version @value{GDBVN}
86 @ifset VERSION_PACKAGE
87 @sp 1
88 @subtitle @value{VERSION_PACKAGE}
89 @end ifset
90 @author Richard Stallman, Roland Pesch, Stan Shebs, et al.
91 @page
92 @tex
93 {\parskip=0pt
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
97 }
98 @end tex
99
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 @*
105
106 @insertcopying
107 @end titlepage
108 @page
109
110 @ifnottex
111 @node Top, Summary, (dir), (dir)
112
113 @top Debugging with @value{GDBN}
114
115 This file describes @value{GDBN}, the @sc{gnu} symbolic debugger.
116
117 This is the @value{EDITION} Edition, for @value{GDBN}
118 @ifset VERSION_PACKAGE
119 @value{VERSION_PACKAGE}
120 @end ifset
121 Version @value{GDBVN}.
122
123 Copyright (C) 1988-2018 Free Software Foundation, Inc.
124
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.
128
129 @menu
130 * Summary::                     Summary of @value{GDBN}
131 * Sample Session::              A sample @value{GDBN} session
132
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
146
147 * Languages::                   Using @value{GDBN} with different languages
148
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
164
165 * GDB Bugs::                    Reporting bugs in @value{GDBN}
166
167 @ifset SYSTEM_READLINE
168 * Command Line Editing: (rluserman).         Command Line Editing
169 * Using History Interactively: (history).    Using History Interactively
170 @end ifset
171 @ifclear SYSTEM_READLINE
172 * Command Line Editing::        Command Line Editing
173 * Using History Interactively:: Using History Interactively
174 @end ifclear
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
182                                 @value{GDBN}
183 * Operating System Information:: Getting additional information from
184                                  the operating system
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
194 @end menu
195
196 @end ifnottex
197
198 @contents
199
200 @node Summary
201 @unnumbered Summary of @value{GDBN}
202
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.
206
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:
209
210 @itemize @bullet
211 @item
212 Start your program, specifying anything that might affect its behavior.
213
214 @item
215 Make your program stop on specified conditions.
216
217 @item
218 Examine what has happened, when your program has stopped.
219
220 @item
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.
223 @end itemize
224
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++}.
228
229 Support for D is partial.  For information on D, see
230 @ref{D,,D}.
231
232 @cindex Modula-2
233 Support for Modula-2 is partial.  For information on Modula-2, see
234 @ref{Modula-2,,Modula-2}.
235
236 Support for OpenCL C is partial.  For information on OpenCL C, see
237 @ref{OpenCL C,,OpenCL C}.
238
239 @cindex Pascal
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
243 syntax.
244
245 @cindex Fortran
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
248 underscore.
249
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.
252
253 @menu
254 * Free Software::               Freely redistributable software
255 * Free Documentation::          Free Software Needs Free Documentation
256 * Contributors::                Contributors to GDB
257 @end menu
258
259 @node Free Software
260 @unnumberedsec Free Software
261
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.
270
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
273 from anyone else.
274
275 @node Free Documentation
276 @unnumberedsec Free Software Needs Free Documentation
277
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
285 gaps today.
286
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.
292
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.
298
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.
306
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.
311
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
318 community.
319
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
328 of the manual.
329
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.
335
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.
342
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}.
352
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.
361
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}.
365
366 @node Contributors
367 @unnumberedsec Contributors to @value{GDBN}
368
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.
376
377 Changes much prior to version 2.0 are lost in the mists of time.
378
379 @quotation
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!
383 @end quotation
384
385 So that they may not regard their many labors as thankless, we
386 particularly thank those who shepherded @value{GDBN} through major
387 releases:
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).
397
398 Richard Stallman, assisted at various times by Peter TerMaat, Chris
399 Hanson, and Richard Mlynarik, handled releases through 2.8.
400
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).
406
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.
410
411 David Johnson wrote the original COFF support; Pace Willison did
412 the original support for encapsulated COFF.
413
414 Brent Benson of Harris Computer Systems contributed DWARF 2 support.
415
416 Adam de Boor and Bradley Davis contributed the ISI Optimum V support.
417 Per Bothner, Noboyuki Hikichi, and Alessandro Forin contributed MIPS
418 support.
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.
435
436 Andreas Schwab contributed M68K @sc{gnu}/Linux support.
437
438 Rich Schaefer and Peter Schauer helped with support of SunOS shared
439 libraries.
440
441 Jay Fenlason and Roland McGrath ensured that @value{GDBN} and GAS agree
442 about several machine instruction sets.
443
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.
448
449 Brian Fox is the author of the readline libraries providing
450 command-line editing and command history.
451
452 Andrew Beers of SUNY Buffalo wrote the language-switching code, the
453 Modula-2 support, and contributed the Languages chapter of this manual.
454
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
457 symbols.
458
459 Hitachi America (now Renesas America), Ltd. sponsored the support for
460 H8/300, H8/500, and Super-H processors.
461
462 NEC sponsored the support for the v850, Vr4xxx, and Vr5xxx processors.
463
464 Mitsubishi (now Renesas) sponsored the support for D10V, D30V, and M32R/D
465 processors.
466
467 Toshiba sponsored the support for the TX39 Mips processor.
468
469 Matsushita sponsored the support for the MN10200 and MN10300 processors.
470
471 Fujitsu sponsored the support for SPARClite and FR30 processors.
472
473 Kung Hsu, Jeff Law, and Rick Sladkey added support for hardware
474 watchpoints.
475
476 Michael Snyder added support for tracepoints.
477
478 Stu Grossman wrote gdbserver.
479
480 Jim Kingdon, Peter Schauer, Ian Taylor, and Stu Grossman made
481 nearly innumerable bug fixes and cleanups throughout @value{GDBN}.
482
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.
490
491 DJ Delorie ported @value{GDBN} to MS-DOS, for the DJGPP project.
492 Robert Hoehne made significant contributions to the DJGPP port.
493
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.
509
510 Andrew Cagney, Fernando Nasser, and Elena Zannoni, while working for
511 Cygnus Solutions, implemented the original @sc{gdb/mi} interface.
512
513 Jim Blandy added support for preprocessor macros, while working for Red
514 Hat.
515
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.
522
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
534 Weigand.
535
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.
540
541 Michael Eager and staff of Xilinx, Inc., contributed support for the
542 Xilinx MicroBlaze architecture.
543
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.
548
549 The original port to the OpenRISC 1000 is believed to be due to
550 Alessandro Forin and Per Bothner.  More recent ports have been the work
551 of Jeremy Bennett, Franck Jullien, Stefan Wallentowitz and
552 Stafford Horne.
553
554 @node Sample Session
555 @chapter A Sample @value{GDBN} Session
556
557 You can use this manual at your leisure to read all about @value{GDBN}.
558 However, a handful of commands are enough to get started using the
559 debugger.  This chapter illustrates those commands.
560
561 @iftex
562 In this sample session, we emphasize user input like this: @b{input},
563 to make it easier to pick out from the surrounding output.
564 @end iftex
565
566 @c FIXME: this example may not be appropriate for some configs, where
567 @c FIXME...primary interest is in remote use.
568
569 One of the preliminary versions of @sc{gnu} @code{m4} (a generic macro
570 processor) exhibits the following bug: sometimes, when we change its
571 quote strings from the default, the commands used to capture one macro
572 definition within another stop working.  In the following short @code{m4}
573 session, we define a macro @code{foo} which expands to @code{0000}; we
574 then use the @code{m4} built-in @code{defn} to define @code{bar} as the
575 same thing.  However, when we change the open quote string to
576 @code{<QUOTE>} and the close quote string to @code{<UNQUOTE>}, the same
577 procedure fails to define a new synonym @code{baz}:
578
579 @smallexample
580 $ @b{cd gnu/m4}
581 $ @b{./m4}
582 @b{define(foo,0000)}
583
584 @b{foo}
585 0000
586 @b{define(bar,defn(`foo'))}
587
588 @b{bar}
589 0000
590 @b{changequote(<QUOTE>,<UNQUOTE>)}
591
592 @b{define(baz,defn(<QUOTE>foo<UNQUOTE>))}
593 @b{baz}
594 @b{Ctrl-d}
595 m4: End of input: 0: fatal error: EOF in string
596 @end smallexample
597
598 @noindent
599 Let us use @value{GDBN} to try to see what is going on.
600
601 @smallexample
602 $ @b{@value{GDBP} m4}
603 @c FIXME: this falsifies the exact text played out, to permit smallbook
604 @c FIXME... format to come out better.
605 @value{GDBN} is free software and you are welcome to distribute copies
606  of it under certain conditions; type "show copying" to see
607  the conditions.
608 There is absolutely no warranty for @value{GDBN}; type "show warranty"
609  for details.
610
611 @value{GDBN} @value{GDBVN}, Copyright 1999 Free Software Foundation, Inc...
612 (@value{GDBP})
613 @end smallexample
614
615 @noindent
616 @value{GDBN} reads only enough symbol data to know where to find the
617 rest when needed; as a result, the first prompt comes up very quickly.
618 We now tell @value{GDBN} to use a narrower display width than usual, so
619 that examples fit in this manual.
620
621 @smallexample
622 (@value{GDBP}) @b{set width 70}
623 @end smallexample
624
625 @noindent
626 We need to see how the @code{m4} built-in @code{changequote} works.
627 Having looked at the source, we know the relevant subroutine is
628 @code{m4_changequote}, so we set a breakpoint there with the @value{GDBN}
629 @code{break} command.
630
631 @smallexample
632 (@value{GDBP}) @b{break m4_changequote}
633 Breakpoint 1 at 0x62f4: file builtin.c, line 879.
634 @end smallexample
635
636 @noindent
637 Using the @code{run} command, we start @code{m4} running under @value{GDBN}
638 control; as long as control does not reach the @code{m4_changequote}
639 subroutine, the program runs as usual:
640
641 @smallexample
642 (@value{GDBP}) @b{run}
643 Starting program: /work/Editorial/gdb/gnu/m4/m4
644 @b{define(foo,0000)}
645
646 @b{foo}
647 0000
648 @end smallexample
649
650 @noindent
651 To trigger the breakpoint, we call @code{changequote}.  @value{GDBN}
652 suspends execution of @code{m4}, displaying information about the
653 context where it stops.
654
655 @smallexample
656 @b{changequote(<QUOTE>,<UNQUOTE>)}
657
658 Breakpoint 1, m4_changequote (argc=3, argv=0x33c70)
659     at builtin.c:879
660 879         if (bad_argc(TOKEN_DATA_TEXT(argv[0]),argc,1,3))
661 @end smallexample
662
663 @noindent
664 Now we use the command @code{n} (@code{next}) to advance execution to
665 the next line of the current function.
666
667 @smallexample
668 (@value{GDBP}) @b{n}
669 882         set_quotes((argc >= 2) ? TOKEN_DATA_TEXT(argv[1])\
670  : nil,
671 @end smallexample
672
673 @noindent
674 @code{set_quotes} looks like a promising subroutine.  We can go into it
675 by using the command @code{s} (@code{step}) instead of @code{next}.
676 @code{step} goes to the next line to be executed in @emph{any}
677 subroutine, so it steps into @code{set_quotes}.
678
679 @smallexample
680 (@value{GDBP}) @b{s}
681 set_quotes (lq=0x34c78 "<QUOTE>", rq=0x34c88 "<UNQUOTE>")
682     at input.c:530
683 530         if (lquote != def_lquote)
684 @end smallexample
685
686 @noindent
687 The display that shows the subroutine where @code{m4} is now
688 suspended (and its arguments) is called a stack frame display.  It
689 shows a summary of the stack.  We can use the @code{backtrace}
690 command (which can also be spelled @code{bt}), to see where we are
691 in the stack as a whole: the @code{backtrace} command displays a
692 stack frame for each active subroutine.
693
694 @smallexample
695 (@value{GDBP}) @b{bt}
696 #0  set_quotes (lq=0x34c78 "<QUOTE>", rq=0x34c88 "<UNQUOTE>")
697     at input.c:530
698 #1  0x6344 in m4_changequote (argc=3, argv=0x33c70)
699     at builtin.c:882
700 #2  0x8174 in expand_macro (sym=0x33320) at macro.c:242
701 #3  0x7a88 in expand_token (obs=0x0, t=209696, td=0xf7fffa30)
702     at macro.c:71
703 #4  0x79dc in expand_input () at macro.c:40
704 #5  0x2930 in main (argc=0, argv=0xf7fffb20) at m4.c:195
705 @end smallexample
706
707 @noindent
708 We step through a few more lines to see what happens.  The first two
709 times, we can use @samp{s}; the next two times we use @code{n} to avoid
710 falling into the @code{xstrdup} subroutine.
711
712 @smallexample
713 (@value{GDBP}) @b{s}
714 0x3b5c  532         if (rquote != def_rquote)
715 (@value{GDBP}) @b{s}
716 0x3b80  535         lquote = (lq == nil || *lq == '\0') ?  \
717 def_lquote : xstrdup(lq);
718 (@value{GDBP}) @b{n}
719 536         rquote = (rq == nil || *rq == '\0') ? def_rquote\
720  : xstrdup(rq);
721 (@value{GDBP}) @b{n}
722 538         len_lquote = strlen(rquote);
723 @end smallexample
724
725 @noindent
726 The last line displayed looks a little odd; we can examine the variables
727 @code{lquote} and @code{rquote} to see if they are in fact the new left
728 and right quotes we specified.  We use the command @code{p}
729 (@code{print}) to see their values.
730
731 @smallexample
732 (@value{GDBP}) @b{p lquote}
733 $1 = 0x35d40 "<QUOTE>"
734 (@value{GDBP}) @b{p rquote}
735 $2 = 0x35d50 "<UNQUOTE>"
736 @end smallexample
737
738 @noindent
739 @code{lquote} and @code{rquote} are indeed the new left and right quotes.
740 To look at some context, we can display ten lines of source
741 surrounding the current line with the @code{l} (@code{list}) command.
742
743 @smallexample
744 (@value{GDBP}) @b{l}
745 533             xfree(rquote);
746 534
747 535         lquote = (lq == nil || *lq == '\0') ? def_lquote\
748  : xstrdup (lq);
749 536         rquote = (rq == nil || *rq == '\0') ? def_rquote\
750  : xstrdup (rq);
751 537
752 538         len_lquote = strlen(rquote);
753 539         len_rquote = strlen(lquote);
754 540     @}
755 541
756 542     void
757 @end smallexample
758
759 @noindent
760 Let us step past the two lines that set @code{len_lquote} and
761 @code{len_rquote}, and then examine the values of those variables.
762
763 @smallexample
764 (@value{GDBP}) @b{n}
765 539         len_rquote = strlen(lquote);
766 (@value{GDBP}) @b{n}
767 540     @}
768 (@value{GDBP}) @b{p len_lquote}
769 $3 = 9
770 (@value{GDBP}) @b{p len_rquote}
771 $4 = 7
772 @end smallexample
773
774 @noindent
775 That certainly looks wrong, assuming @code{len_lquote} and
776 @code{len_rquote} are meant to be the lengths of @code{lquote} and
777 @code{rquote} respectively.  We can set them to better values using
778 the @code{p} command, since it can print the value of
779 any expression---and that expression can include subroutine calls and
780 assignments.
781
782 @smallexample
783 (@value{GDBP}) @b{p len_lquote=strlen(lquote)}
784 $5 = 7
785 (@value{GDBP}) @b{p len_rquote=strlen(rquote)}
786 $6 = 9
787 @end smallexample
788
789 @noindent
790 Is that enough to fix the problem of using the new quotes with the
791 @code{m4} built-in @code{defn}?  We can allow @code{m4} to continue
792 executing with the @code{c} (@code{continue}) command, and then try the
793 example that caused trouble initially:
794
795 @smallexample
796 (@value{GDBP}) @b{c}
797 Continuing.
798
799 @b{define(baz,defn(<QUOTE>foo<UNQUOTE>))}
800
801 baz
802 0000
803 @end smallexample
804
805 @noindent
806 Success!  The new quotes now work just as well as the default ones.  The
807 problem seems to have been just the two typos defining the wrong
808 lengths.  We allow @code{m4} exit by giving it an EOF as input:
809
810 @smallexample
811 @b{Ctrl-d}
812 Program exited normally.
813 @end smallexample
814
815 @noindent
816 The message @samp{Program exited normally.} is from @value{GDBN}; it
817 indicates @code{m4} has finished executing.  We can end our @value{GDBN}
818 session with the @value{GDBN} @code{quit} command.
819
820 @smallexample
821 (@value{GDBP}) @b{quit}
822 @end smallexample
823
824 @node Invocation
825 @chapter Getting In and Out of @value{GDBN}
826
827 This chapter discusses how to start @value{GDBN}, and how to get out of it.
828 The essentials are:
829 @itemize @bullet
830 @item
831 type @samp{@value{GDBP}} to start @value{GDBN}.
832 @item
833 type @kbd{quit} or @kbd{Ctrl-d} to exit.
834 @end itemize
835
836 @menu
837 * Invoking GDB::                How to start @value{GDBN}
838 * Quitting GDB::                How to quit @value{GDBN}
839 * Shell Commands::              How to use shell commands inside @value{GDBN}
840 * Logging Output::              How to log @value{GDBN}'s output to a file
841 @end menu
842
843 @node Invoking GDB
844 @section Invoking @value{GDBN}
845
846 Invoke @value{GDBN} by running the program @code{@value{GDBP}}.  Once started,
847 @value{GDBN} reads commands from the terminal until you tell it to exit.
848
849 You can also run @code{@value{GDBP}} with a variety of arguments and options,
850 to specify more of your debugging environment at the outset.
851
852 The command-line options described here are designed
853 to cover a variety of situations; in some environments, some of these
854 options may effectively be unavailable.
855
856 The most usual way to start @value{GDBN} is with one argument,
857 specifying an executable program:
858
859 @smallexample
860 @value{GDBP} @var{program}
861 @end smallexample
862
863 @noindent
864 You can also start with both an executable program and a core file
865 specified:
866
867 @smallexample
868 @value{GDBP} @var{program} @var{core}
869 @end smallexample
870
871 You can, instead, specify a process ID as a second argument, if you want
872 to debug a running process:
873
874 @smallexample
875 @value{GDBP} @var{program} 1234
876 @end smallexample
877
878 @noindent
879 would attach @value{GDBN} to process @code{1234} (unless you also have a file
880 named @file{1234}; @value{GDBN} does check for a core file first).
881
882 Taking advantage of the second command-line argument requires a fairly
883 complete operating system; when you use @value{GDBN} as a remote
884 debugger attached to a bare board, there may not be any notion of
885 ``process'', and there is often no way to get a core dump.  @value{GDBN}
886 will warn you if it is unable to attach or to read core dumps.
887
888 You can optionally have @code{@value{GDBP}} pass any arguments after the
889 executable file to the inferior using @code{--args}.  This option stops
890 option processing.
891 @smallexample
892 @value{GDBP} --args gcc -O2 -c foo.c
893 @end smallexample
894 This will cause @code{@value{GDBP}} to debug @code{gcc}, and to set
895 @code{gcc}'s command-line arguments (@pxref{Arguments}) to @samp{-O2 -c foo.c}.
896
897 You can run @code{@value{GDBP}} without printing the front material, which describes
898 @value{GDBN}'s non-warranty, by specifying @code{--silent}
899 (or @code{-q}/@code{--quiet}):
900
901 @smallexample
902 @value{GDBP} --silent
903 @end smallexample
904
905 @noindent
906 You can further control how @value{GDBN} starts up by using command-line
907 options.  @value{GDBN} itself can remind you of the options available.
908
909 @noindent
910 Type
911
912 @smallexample
913 @value{GDBP} -help
914 @end smallexample
915
916 @noindent
917 to display all available options and briefly describe their use
918 (@samp{@value{GDBP} -h} is a shorter equivalent).
919
920 All options and command line arguments you give are processed
921 in sequential order.  The order makes a difference when the
922 @samp{-x} option is used.
923
924
925 @menu
926 * File Options::                Choosing files
927 * Mode Options::                Choosing modes
928 * Startup::                     What @value{GDBN} does during startup
929 @end menu
930
931 @node File Options
932 @subsection Choosing Files
933
934 When @value{GDBN} starts, it reads any arguments other than options as
935 specifying an executable file and core file (or process ID).  This is
936 the same as if the arguments were specified by the @samp{-se} and
937 @samp{-c} (or @samp{-p}) options respectively.  (@value{GDBN} reads the
938 first argument that does not have an associated option flag as
939 equivalent to the @samp{-se} option followed by that argument; and the
940 second argument that does not have an associated option flag, if any, as
941 equivalent to the @samp{-c}/@samp{-p} option followed by that argument.)
942 If the second argument begins with a decimal digit, @value{GDBN} will
943 first attempt to attach to it as a process, and if that fails, attempt
944 to open it as a corefile.  If you have a corefile whose name begins with
945 a digit, you can prevent @value{GDBN} from treating it as a pid by
946 prefixing it with @file{./}, e.g.@: @file{./12345}.
947
948 If @value{GDBN} has not been configured to included core file support,
949 such as for most embedded targets, then it will complain about a second
950 argument and ignore it.
951
952 Many options have both long and short forms; both are shown in the
953 following list.  @value{GDBN} also recognizes the long forms if you truncate
954 them, so long as enough of the option is present to be unambiguous.
955 (If you prefer, you can flag option arguments with @samp{--} rather
956 than @samp{-}, though we illustrate the more usual convention.)
957
958 @c NOTE: the @cindex entries here use double dashes ON PURPOSE.  This
959 @c way, both those who look for -foo and --foo in the index, will find
960 @c it.
961
962 @table @code
963 @item -symbols @var{file}
964 @itemx -s @var{file}
965 @cindex @code{--symbols}
966 @cindex @code{-s}
967 Read symbol table from file @var{file}.
968
969 @item -exec @var{file}
970 @itemx -e @var{file}
971 @cindex @code{--exec}
972 @cindex @code{-e}
973 Use file @var{file} as the executable file to execute when appropriate,
974 and for examining pure data in conjunction with a core dump.
975
976 @item -se @var{file}
977 @cindex @code{--se}
978 Read symbol table from file @var{file} and use it as the executable
979 file.
980
981 @item -core @var{file}
982 @itemx -c @var{file}
983 @cindex @code{--core}
984 @cindex @code{-c}
985 Use file @var{file} as a core dump to examine.
986
987 @item -pid @var{number}
988 @itemx -p @var{number}
989 @cindex @code{--pid}
990 @cindex @code{-p}
991 Connect to process ID @var{number}, as with the @code{attach} command.
992
993 @item -command @var{file}
994 @itemx -x @var{file}
995 @cindex @code{--command}
996 @cindex @code{-x}
997 Execute commands from file @var{file}.  The contents of this file is
998 evaluated exactly as the @code{source} command would.
999 @xref{Command Files,, Command files}.
1000
1001 @item -eval-command @var{command}
1002 @itemx -ex @var{command}
1003 @cindex @code{--eval-command}
1004 @cindex @code{-ex}
1005 Execute a single @value{GDBN} command.
1006
1007 This option may be used multiple times to call multiple commands.  It may
1008 also be interleaved with @samp{-command} as required.
1009
1010 @smallexample
1011 @value{GDBP} -ex 'target sim' -ex 'load' \
1012    -x setbreakpoints -ex 'run' a.out
1013 @end smallexample
1014
1015 @item -init-command @var{file}
1016 @itemx -ix @var{file}
1017 @cindex @code{--init-command}
1018 @cindex @code{-ix}
1019 Execute commands from file @var{file} before loading the inferior (but
1020 after loading gdbinit files).
1021 @xref{Startup}.
1022
1023 @item -init-eval-command @var{command}
1024 @itemx -iex @var{command}
1025 @cindex @code{--init-eval-command}
1026 @cindex @code{-iex}
1027 Execute a single @value{GDBN} command before loading the inferior (but
1028 after loading gdbinit files).
1029 @xref{Startup}.
1030
1031 @item -directory @var{directory}
1032 @itemx -d @var{directory}
1033 @cindex @code{--directory}
1034 @cindex @code{-d}
1035 Add @var{directory} to the path to search for source and script files.
1036
1037 @item -r
1038 @itemx -readnow
1039 @cindex @code{--readnow}
1040 @cindex @code{-r}
1041 Read each symbol file's entire symbol table immediately, rather than
1042 the default, which is to read it incrementally as it is needed.
1043 This makes startup slower, but makes future operations faster.
1044
1045 @item --readnever
1046 @anchor{--readnever}
1047 @cindex @code{--readnever}, command-line option
1048 Do not read each symbol file's symbolic debug information.  This makes
1049 startup faster but at the expense of not being able to perform
1050 symbolic debugging.  DWARF unwind information is also not read,
1051 meaning backtraces may become incomplete or inaccurate.  One use of
1052 this is when a user simply wants to do the following sequence: attach,
1053 dump core, detach.  Loading the debugging information in this case is
1054 an unnecessary cause of delay.
1055 @end table
1056
1057 @node Mode Options
1058 @subsection Choosing Modes
1059
1060 You can run @value{GDBN} in various alternative modes---for example, in
1061 batch mode or quiet mode.
1062
1063 @table @code
1064 @anchor{-nx}
1065 @item -nx
1066 @itemx -n
1067 @cindex @code{--nx}
1068 @cindex @code{-n}
1069 Do not execute commands found in any initialization file.
1070 There are three init files, loaded in the following order:
1071
1072 @table @code
1073 @item @file{system.gdbinit}
1074 This is the system-wide init file.
1075 Its location is specified with the @code{--with-system-gdbinit}
1076 configure option (@pxref{System-wide configuration}).
1077 It is loaded first when @value{GDBN} starts, before command line options
1078 have been processed.
1079 @item @file{~/.gdbinit}
1080 This is the init file in your home directory.
1081 It is loaded next, after @file{system.gdbinit}, and before
1082 command options have been processed.
1083 @item @file{./.gdbinit}
1084 This is the init file in the current directory.
1085 It is loaded last, after command line options other than @code{-x} and
1086 @code{-ex} have been processed.  Command line options @code{-x} and
1087 @code{-ex} are processed last, after @file{./.gdbinit} has been loaded.
1088 @end table
1089
1090 For further documentation on startup processing, @xref{Startup}.
1091 For documentation on how to write command files,
1092 @xref{Command Files,,Command Files}.
1093
1094 @anchor{-nh}
1095 @item -nh
1096 @cindex @code{--nh}
1097 Do not execute commands found in @file{~/.gdbinit}, the init file
1098 in your home directory.
1099 @xref{Startup}.
1100
1101 @item -quiet
1102 @itemx -silent
1103 @itemx -q
1104 @cindex @code{--quiet}
1105 @cindex @code{--silent}
1106 @cindex @code{-q}
1107 ``Quiet''.  Do not print the introductory and copyright messages.  These
1108 messages are also suppressed in batch mode.
1109
1110 @item -batch
1111 @cindex @code{--batch}
1112 Run in batch mode.  Exit with status @code{0} after processing all the
1113 command files specified with @samp{-x} (and all commands from
1114 initialization files, if not inhibited with @samp{-n}).  Exit with
1115 nonzero status if an error occurs in executing the @value{GDBN} commands
1116 in the command files.  Batch mode also disables pagination, sets unlimited
1117 terminal width and height @pxref{Screen Size}, and acts as if @kbd{set confirm
1118 off} were in effect (@pxref{Messages/Warnings}).
1119
1120 Batch mode may be useful for running @value{GDBN} as a filter, for
1121 example to download and run a program on another computer; in order to
1122 make this more useful, the message
1123
1124 @smallexample
1125 Program exited normally.
1126 @end smallexample
1127
1128 @noindent
1129 (which is ordinarily issued whenever a program running under
1130 @value{GDBN} control terminates) is not issued when running in batch
1131 mode.
1132
1133 @item -batch-silent
1134 @cindex @code{--batch-silent}
1135 Run in batch mode exactly like @samp{-batch}, but totally silently.  All
1136 @value{GDBN} output to @code{stdout} is prevented (@code{stderr} is
1137 unaffected).  This is much quieter than @samp{-silent} and would be useless
1138 for an interactive session.
1139
1140 This is particularly useful when using targets that give @samp{Loading section}
1141 messages, for example.
1142
1143 Note that targets that give their output via @value{GDBN}, as opposed to
1144 writing directly to @code{stdout}, will also be made silent.
1145
1146 @item -return-child-result
1147 @cindex @code{--return-child-result}
1148 The return code from @value{GDBN} will be the return code from the child
1149 process (the process being debugged), with the following exceptions:
1150
1151 @itemize @bullet
1152 @item
1153 @value{GDBN} exits abnormally.  E.g., due to an incorrect argument or an
1154 internal error.  In this case the exit code is the same as it would have been
1155 without @samp{-return-child-result}.
1156 @item
1157 The user quits with an explicit value.  E.g., @samp{quit 1}.
1158 @item
1159 The child process never runs, or is not allowed to terminate, in which case
1160 the exit code will be -1.
1161 @end itemize
1162
1163 This option is useful in conjunction with @samp{-batch} or @samp{-batch-silent},
1164 when @value{GDBN} is being used as a remote program loader or simulator
1165 interface.
1166
1167 @item -nowindows
1168 @itemx -nw
1169 @cindex @code{--nowindows}
1170 @cindex @code{-nw}
1171 ``No windows''.  If @value{GDBN} comes with a graphical user interface
1172 (GUI) built in, then this option tells @value{GDBN} to only use the command-line
1173 interface.  If no GUI is available, this option has no effect.
1174
1175 @item -windows
1176 @itemx -w
1177 @cindex @code{--windows}
1178 @cindex @code{-w}
1179 If @value{GDBN} includes a GUI, then this option requires it to be
1180 used if possible.
1181
1182 @item -cd @var{directory}
1183 @cindex @code{--cd}
1184 Run @value{GDBN} using @var{directory} as its working directory,
1185 instead of the current directory.
1186
1187 @item -data-directory @var{directory}
1188 @itemx -D @var{directory}
1189 @cindex @code{--data-directory}
1190 @cindex @code{-D}
1191 Run @value{GDBN} using @var{directory} as its data directory.
1192 The data directory is where @value{GDBN} searches for its
1193 auxiliary files.  @xref{Data Files}.
1194
1195 @item -fullname
1196 @itemx -f
1197 @cindex @code{--fullname}
1198 @cindex @code{-f}
1199 @sc{gnu} Emacs sets this option when it runs @value{GDBN} as a
1200 subprocess.  It tells @value{GDBN} to output the full file name and line
1201 number in a standard, recognizable fashion each time a stack frame is
1202 displayed (which includes each time your program stops).  This
1203 recognizable format looks like two @samp{\032} characters, followed by
1204 the file name, line number and character position separated by colons,
1205 and a newline.  The Emacs-to-@value{GDBN} interface program uses the two
1206 @samp{\032} characters as a signal to display the source code for the
1207 frame.
1208
1209 @item -annotate @var{level}
1210 @cindex @code{--annotate}
1211 This option sets the @dfn{annotation level} inside @value{GDBN}.  Its
1212 effect is identical to using @samp{set annotate @var{level}}
1213 (@pxref{Annotations}).  The annotation @var{level} controls how much
1214 information @value{GDBN} prints together with its prompt, values of
1215 expressions, source lines, and other types of output.  Level 0 is the
1216 normal, level 1 is for use when @value{GDBN} is run as a subprocess of
1217 @sc{gnu} Emacs, level 3 is the maximum annotation suitable for programs
1218 that control @value{GDBN}, and level 2 has been deprecated.
1219
1220 The annotation mechanism has largely been superseded by @sc{gdb/mi}
1221 (@pxref{GDB/MI}).
1222
1223 @item --args
1224 @cindex @code{--args}
1225 Change interpretation of command line so that arguments following the
1226 executable file are passed as command line arguments to the inferior.
1227 This option stops option processing.
1228
1229 @item -baud @var{bps}
1230 @itemx -b @var{bps}
1231 @cindex @code{--baud}
1232 @cindex @code{-b}
1233 Set the line speed (baud rate or bits per second) of any serial
1234 interface used by @value{GDBN} for remote debugging.
1235
1236 @item -l @var{timeout}
1237 @cindex @code{-l}
1238 Set the timeout (in seconds) of any communication used by @value{GDBN}
1239 for remote debugging.
1240
1241 @item -tty @var{device}
1242 @itemx -t @var{device}
1243 @cindex @code{--tty}
1244 @cindex @code{-t}
1245 Run using @var{device} for your program's standard input and output.
1246 @c FIXME: kingdon thinks there is more to -tty.  Investigate.
1247
1248 @c resolve the situation of these eventually
1249 @item -tui
1250 @cindex @code{--tui}
1251 Activate the @dfn{Text User Interface} when starting.  The Text User
1252 Interface manages several text windows on the terminal, showing
1253 source, assembly, registers and @value{GDBN} command outputs
1254 (@pxref{TUI, ,@value{GDBN} Text User Interface}).  Do not use this
1255 option if you run @value{GDBN} from Emacs (@pxref{Emacs, ,
1256 Using @value{GDBN} under @sc{gnu} Emacs}).
1257
1258 @item -interpreter @var{interp}
1259 @cindex @code{--interpreter}
1260 Use the interpreter @var{interp} for interface with the controlling
1261 program or device.  This option is meant to be set by programs which
1262 communicate with @value{GDBN} using it as a back end.
1263 @xref{Interpreters, , Command Interpreters}.
1264
1265 @samp{--interpreter=mi} (or @samp{--interpreter=mi2}) causes
1266 @value{GDBN} to use the @dfn{@sc{gdb/mi} interface} (@pxref{GDB/MI, ,
1267 The @sc{gdb/mi} Interface}) included since @value{GDBN} version 6.0.  The
1268 previous @sc{gdb/mi} interface, included in @value{GDBN} version 5.3 and
1269 selected with @samp{--interpreter=mi1}, is deprecated.  Earlier
1270 @sc{gdb/mi} interfaces are no longer supported.
1271
1272 @item -write
1273 @cindex @code{--write}
1274 Open the executable and core files for both reading and writing.  This
1275 is equivalent to the @samp{set write on} command inside @value{GDBN}
1276 (@pxref{Patching}).
1277
1278 @item -statistics
1279 @cindex @code{--statistics}
1280 This option causes @value{GDBN} to print statistics about time and
1281 memory usage after it completes each command and returns to the prompt.
1282
1283 @item -version
1284 @cindex @code{--version}
1285 This option causes @value{GDBN} to print its version number and
1286 no-warranty blurb, and exit.
1287
1288 @item -configuration
1289 @cindex @code{--configuration}
1290 This option causes @value{GDBN} to print details about its build-time
1291 configuration parameters, and then exit.  These details can be
1292 important when reporting @value{GDBN} bugs (@pxref{GDB Bugs}).
1293
1294 @end table
1295
1296 @node Startup
1297 @subsection What @value{GDBN} Does During Startup
1298 @cindex @value{GDBN} startup
1299
1300 Here's the description of what @value{GDBN} does during session startup:
1301
1302 @enumerate
1303 @item
1304 Sets up the command interpreter as specified by the command line
1305 (@pxref{Mode Options, interpreter}).
1306
1307 @item
1308 @cindex init file
1309 Reads the system-wide @dfn{init file} (if @option{--with-system-gdbinit} was
1310 used when building @value{GDBN}; @pxref{System-wide configuration,
1311  ,System-wide configuration and settings}) and executes all the commands in
1312 that file.
1313
1314 @anchor{Home Directory Init File}
1315 @item
1316 Reads the init file (if any) in your home directory@footnote{On
1317 DOS/Windows systems, the home directory is the one pointed to by the
1318 @code{HOME} environment variable.} and executes all the commands in
1319 that file.
1320
1321 @anchor{Option -init-eval-command}
1322 @item
1323 Executes commands and command files specified by the @samp{-iex} and
1324 @samp{-ix} options in their specified order.  Usually you should use the
1325 @samp{-ex} and @samp{-x} options instead, but this way you can apply
1326 settings before @value{GDBN} init files get executed and before inferior
1327 gets loaded.
1328
1329 @item
1330 Processes command line options and operands.
1331
1332 @anchor{Init File in the Current Directory during Startup}
1333 @item
1334 Reads and executes the commands from init file (if any) in the current
1335 working directory as long as @samp{set auto-load local-gdbinit} is set to
1336 @samp{on} (@pxref{Init File in the Current Directory}).
1337 This is only done if the current directory is
1338 different from your home directory.  Thus, you can have more than one
1339 init file, one generic in your home directory, and another, specific
1340 to the program you are debugging, in the directory where you invoke
1341 @value{GDBN}.
1342
1343 @item
1344 If the command line specified a program to debug, or a process to
1345 attach to, or a core file, @value{GDBN} loads any auto-loaded
1346 scripts provided for the program or for its loaded shared libraries.
1347 @xref{Auto-loading}.
1348
1349 If you wish to disable the auto-loading during startup,
1350 you must do something like the following:
1351
1352 @smallexample
1353 $ gdb -iex "set auto-load python-scripts off" myprogram
1354 @end smallexample
1355
1356 Option @samp{-ex} does not work because the auto-loading is then turned
1357 off too late.
1358
1359 @item
1360 Executes commands and command files specified by the @samp{-ex} and
1361 @samp{-x} options in their specified order.  @xref{Command Files}, for
1362 more details about @value{GDBN} command files.
1363
1364 @item
1365 Reads the command history recorded in the @dfn{history file}.
1366 @xref{Command History}, for more details about the command history and the
1367 files where @value{GDBN} records it.
1368 @end enumerate
1369
1370 Init files use the same syntax as @dfn{command files} (@pxref{Command
1371 Files}) and are processed by @value{GDBN} in the same way.  The init
1372 file in your home directory can set options (such as @samp{set
1373 complaints}) that affect subsequent processing of command line options
1374 and operands.  Init files are not executed if you use the @samp{-nx}
1375 option (@pxref{Mode Options, ,Choosing Modes}).
1376
1377 To display the list of init files loaded by gdb at startup, you
1378 can use @kbd{gdb --help}.
1379
1380 @cindex init file name
1381 @cindex @file{.gdbinit}
1382 @cindex @file{gdb.ini}
1383 The @value{GDBN} init files are normally called @file{.gdbinit}.
1384 The DJGPP port of @value{GDBN} uses the name @file{gdb.ini}, due to
1385 the limitations of file names imposed by DOS filesystems.  The Windows
1386 port of @value{GDBN} uses the standard name, but if it finds a
1387 @file{gdb.ini} file in your home directory, it warns you about that
1388 and suggests to rename the file to the standard name.
1389
1390
1391 @node Quitting GDB
1392 @section Quitting @value{GDBN}
1393 @cindex exiting @value{GDBN}
1394 @cindex leaving @value{GDBN}
1395
1396 @table @code
1397 @kindex quit @r{[}@var{expression}@r{]}
1398 @kindex q @r{(@code{quit})}
1399 @item quit @r{[}@var{expression}@r{]}
1400 @itemx q
1401 To exit @value{GDBN}, use the @code{quit} command (abbreviated
1402 @code{q}), or type an end-of-file character (usually @kbd{Ctrl-d}).  If you
1403 do not supply @var{expression}, @value{GDBN} will terminate normally;
1404 otherwise it will terminate using the result of @var{expression} as the
1405 error code.
1406 @end table
1407
1408 @cindex interrupt
1409 An interrupt (often @kbd{Ctrl-c}) does not exit from @value{GDBN}, but rather
1410 terminates the action of any @value{GDBN} command that is in progress and
1411 returns to @value{GDBN} command level.  It is safe to type the interrupt
1412 character at any time because @value{GDBN} does not allow it to take effect
1413 until a time when it is safe.
1414
1415 If you have been using @value{GDBN} to control an attached process or
1416 device, you can release it with the @code{detach} command
1417 (@pxref{Attach, ,Debugging an Already-running Process}).
1418
1419 @node Shell Commands
1420 @section Shell Commands
1421
1422 If you need to execute occasional shell commands during your
1423 debugging session, there is no need to leave or suspend @value{GDBN}; you can
1424 just use the @code{shell} command.
1425
1426 @table @code
1427 @kindex shell
1428 @kindex !
1429 @cindex shell escape
1430 @item shell @var{command-string}
1431 @itemx !@var{command-string}
1432 Invoke a standard shell to execute @var{command-string}.
1433 Note that no space is needed between @code{!} and @var{command-string}.
1434 If it exists, the environment variable @code{SHELL} determines which
1435 shell to run.  Otherwise @value{GDBN} uses the default shell
1436 (@file{/bin/sh} on Unix systems, @file{COMMAND.COM} on MS-DOS, etc.).
1437 @end table
1438
1439 The utility @code{make} is often needed in development environments.
1440 You do not have to use the @code{shell} command for this purpose in
1441 @value{GDBN}:
1442
1443 @table @code
1444 @kindex make
1445 @cindex calling make
1446 @item make @var{make-args}
1447 Execute the @code{make} program with the specified
1448 arguments.  This is equivalent to @samp{shell make @var{make-args}}.
1449 @end table
1450
1451 @node Logging Output
1452 @section Logging Output
1453 @cindex logging @value{GDBN} output
1454 @cindex save @value{GDBN} output to a file
1455
1456 You may want to save the output of @value{GDBN} commands to a file.
1457 There are several commands to control @value{GDBN}'s logging.
1458
1459 @table @code
1460 @kindex set logging
1461 @item set logging on
1462 Enable logging.
1463 @item set logging off
1464 Disable logging.
1465 @cindex logging file name
1466 @item set logging file @var{file}
1467 Change the name of the current logfile.  The default logfile is @file{gdb.txt}.
1468 @item set logging overwrite [on|off]
1469 By default, @value{GDBN} will append to the logfile.  Set @code{overwrite} if
1470 you want @code{set logging on} to overwrite the logfile instead.
1471 @item set logging redirect [on|off]
1472 By default, @value{GDBN} output will go to both the terminal and the logfile.
1473 Set @code{redirect} if you want output to go only to the log file.
1474 @kindex show logging
1475 @item show logging
1476 Show the current values of the logging settings.
1477 @end table
1478
1479 @node Commands
1480 @chapter @value{GDBN} Commands
1481
1482 You can abbreviate a @value{GDBN} command to the first few letters of the command
1483 name, if that abbreviation is unambiguous; and you can repeat certain
1484 @value{GDBN} commands by typing just @key{RET}.  You can also use the @key{TAB}
1485 key to get @value{GDBN} to fill out the rest of a word in a command (or to
1486 show you the alternatives available, if there is more than one possibility).
1487
1488 @menu
1489 * Command Syntax::              How to give commands to @value{GDBN}
1490 * Completion::                  Command completion
1491 * Help::                        How to ask @value{GDBN} for help
1492 @end menu
1493
1494 @node Command Syntax
1495 @section Command Syntax
1496
1497 A @value{GDBN} command is a single line of input.  There is no limit on
1498 how long it can be.  It starts with a command name, which is followed by
1499 arguments whose meaning depends on the command name.  For example, the
1500 command @code{step} accepts an argument which is the number of times to
1501 step, as in @samp{step 5}.  You can also use the @code{step} command
1502 with no arguments.  Some commands do not allow any arguments.
1503
1504 @cindex abbreviation
1505 @value{GDBN} command names may always be truncated if that abbreviation is
1506 unambiguous.  Other possible command abbreviations are listed in the
1507 documentation for individual commands.  In some cases, even ambiguous
1508 abbreviations are allowed; for example, @code{s} is specially defined as
1509 equivalent to @code{step} even though there are other commands whose
1510 names start with @code{s}.  You can test abbreviations by using them as
1511 arguments to the @code{help} command.
1512
1513 @cindex repeating commands
1514 @kindex RET @r{(repeat last command)}
1515 A blank line as input to @value{GDBN} (typing just @key{RET}) means to
1516 repeat the previous command.  Certain commands (for example, @code{run})
1517 will not repeat this way; these are commands whose unintentional
1518 repetition might cause trouble and which you are unlikely to want to
1519 repeat.  User-defined commands can disable this feature; see
1520 @ref{Define, dont-repeat}.
1521
1522 The @code{list} and @code{x} commands, when you repeat them with
1523 @key{RET}, construct new arguments rather than repeating
1524 exactly as typed.  This permits easy scanning of source or memory.
1525
1526 @value{GDBN} can also use @key{RET} in another way: to partition lengthy
1527 output, in a way similar to the common utility @code{more}
1528 (@pxref{Screen Size,,Screen Size}).  Since it is easy to press one
1529 @key{RET} too many in this situation, @value{GDBN} disables command
1530 repetition after any command that generates this sort of display.
1531
1532 @kindex # @r{(a comment)}
1533 @cindex comment
1534 Any text from a @kbd{#} to the end of the line is a comment; it does
1535 nothing.  This is useful mainly in command files (@pxref{Command
1536 Files,,Command Files}).
1537
1538 @cindex repeating command sequences
1539 @kindex Ctrl-o @r{(operate-and-get-next)}
1540 The @kbd{Ctrl-o} binding is useful for repeating a complex sequence of
1541 commands.  This command accepts the current line, like @key{RET}, and
1542 then fetches the next line relative to the current line from the history
1543 for editing.
1544
1545 @node Completion
1546 @section Command Completion
1547
1548 @cindex completion
1549 @cindex word completion
1550 @value{GDBN} can fill in the rest of a word in a command for you, if there is
1551 only one possibility; it can also show you what the valid possibilities
1552 are for the next word in a command, at any time.  This works for @value{GDBN}
1553 commands, @value{GDBN} subcommands, and the names of symbols in your program.
1554
1555 Press the @key{TAB} key whenever you want @value{GDBN} to fill out the rest
1556 of a word.  If there is only one possibility, @value{GDBN} fills in the
1557 word, and waits for you to finish the command (or press @key{RET} to
1558 enter it).  For example, if you type
1559
1560 @c FIXME "@key" does not distinguish its argument sufficiently to permit
1561 @c complete accuracy in these examples; space introduced for clarity.
1562 @c If texinfo enhancements make it unnecessary, it would be nice to
1563 @c replace " @key" by "@key" in the following...
1564 @smallexample
1565 (@value{GDBP}) info bre @key{TAB}
1566 @end smallexample
1567
1568 @noindent
1569 @value{GDBN} fills in the rest of the word @samp{breakpoints}, since that is
1570 the only @code{info} subcommand beginning with @samp{bre}:
1571
1572 @smallexample
1573 (@value{GDBP}) info breakpoints
1574 @end smallexample
1575
1576 @noindent
1577 You can either press @key{RET} at this point, to run the @code{info
1578 breakpoints} command, or backspace and enter something else, if
1579 @samp{breakpoints} does not look like the command you expected.  (If you
1580 were sure you wanted @code{info breakpoints} in the first place, you
1581 might as well just type @key{RET} immediately after @samp{info bre},
1582 to exploit command abbreviations rather than command completion).
1583
1584 If there is more than one possibility for the next word when you press
1585 @key{TAB}, @value{GDBN} sounds a bell.  You can either supply more
1586 characters and try again, or just press @key{TAB} a second time;
1587 @value{GDBN} displays all the possible completions for that word.  For
1588 example, you might want to set a breakpoint on a subroutine whose name
1589 begins with @samp{make_}, but when you type @kbd{b make_@key{TAB}} @value{GDBN}
1590 just sounds the bell.  Typing @key{TAB} again displays all the
1591 function names in your program that begin with those characters, for
1592 example:
1593
1594 @smallexample
1595 (@value{GDBP}) b make_ @key{TAB}
1596 @exdent @value{GDBN} sounds bell; press @key{TAB} again, to see:
1597 make_a_section_from_file     make_environ
1598 make_abs_section             make_function_type
1599 make_blockvector             make_pointer_type
1600 make_cleanup                 make_reference_type
1601 make_command                 make_symbol_completion_list
1602 (@value{GDBP}) b make_
1603 @end smallexample
1604
1605 @noindent
1606 After displaying the available possibilities, @value{GDBN} copies your
1607 partial input (@samp{b make_} in the example) so you can finish the
1608 command.
1609
1610 If you just want to see the list of alternatives in the first place, you
1611 can press @kbd{M-?} rather than pressing @key{TAB} twice.  @kbd{M-?}
1612 means @kbd{@key{META} ?}.  You can type this either by holding down a
1613 key designated as the @key{META} shift on your keyboard (if there is
1614 one) while typing @kbd{?}, or as @key{ESC} followed by @kbd{?}.
1615
1616 If the number of possible completions is large, @value{GDBN} will
1617 print as much of the list as it has collected, as well as a message
1618 indicating that the list may be truncated.
1619
1620 @smallexample
1621 (@value{GDBP}) b m@key{TAB}@key{TAB}
1622 main
1623 <... the rest of the possible completions ...>
1624 *** List may be truncated, max-completions reached. ***
1625 (@value{GDBP}) b m
1626 @end smallexample
1627
1628 @noindent
1629 This behavior can be controlled with the following commands:
1630
1631 @table @code
1632 @kindex set max-completions
1633 @item set max-completions @var{limit}
1634 @itemx set max-completions unlimited
1635 Set the maximum number of completion candidates.  @value{GDBN} will
1636 stop looking for more completions once it collects this many candidates.
1637 This is useful when completing on things like function names as collecting
1638 all the possible candidates can be time consuming.
1639 The default value is 200.  A value of zero disables tab-completion.
1640 Note that setting either no limit or a very large limit can make
1641 completion slow.
1642 @kindex show max-completions
1643 @item show max-completions
1644 Show the maximum number of candidates that @value{GDBN} will collect and show
1645 during completion.
1646 @end table
1647
1648 @cindex quotes in commands
1649 @cindex completion of quoted strings
1650 Sometimes the string you need, while logically a ``word'', may contain
1651 parentheses or other characters that @value{GDBN} normally excludes from
1652 its notion of a word.  To permit word completion to work in this
1653 situation, you may enclose words in @code{'} (single quote marks) in
1654 @value{GDBN} commands.
1655
1656 A likely situation where you might need this is in typing an
1657 expression that involves a C@t{++} symbol name with template
1658 parameters.  This is because when completing expressions, GDB treats
1659 the @samp{<} character as word delimiter, assuming that it's the
1660 less-than comparison operator (@pxref{C Operators, , C and C@t{++}
1661 Operators}).
1662
1663 For example, when you want to call a C@t{++} template function
1664 interactively using the @code{print} or @code{call} commands, you may
1665 need to distinguish whether you mean the version of @code{name} that
1666 was specialized for @code{int}, @code{name<int>()}, or the version
1667 that was specialized for @code{float}, @code{name<float>()}.  To use
1668 the word-completion facilities in this situation, type a single quote
1669 @code{'} at the beginning of the function name.  This alerts
1670 @value{GDBN} that it may need to consider more information than usual
1671 when you press @key{TAB} or @kbd{M-?} to request word completion:
1672
1673 @smallexample
1674 (@value{GDBP}) p 'func< @kbd{M-?}
1675 func<int>()    func<float>()
1676 (@value{GDBP}) p 'func<
1677 @end smallexample
1678
1679 When setting breakpoints however (@pxref{Specify Location}), you don't
1680 usually need to type a quote before the function name, because
1681 @value{GDBN} understands that you want to set a breakpoint on a
1682 function:
1683
1684 @smallexample
1685 (@value{GDBP}) b func< @kbd{M-?}
1686 func<int>()    func<float>()
1687 (@value{GDBP}) b func<
1688 @end smallexample
1689
1690 This is true even in the case of typing the name of C@t{++} overloaded
1691 functions (multiple definitions of the same function, distinguished by
1692 argument type).  For example, when you want to set a breakpoint you
1693 don't need to distinguish whether you mean the version of @code{name}
1694 that takes an @code{int} parameter, @code{name(int)}, or the version
1695 that takes a @code{float} parameter, @code{name(float)}.
1696
1697 @smallexample
1698 (@value{GDBP}) b bubble( @kbd{M-?}
1699 bubble(int)    bubble(double)
1700 (@value{GDBP}) b bubble(dou @kbd{M-?}
1701 bubble(double)
1702 @end smallexample
1703
1704 See @ref{quoting names} for a description of other scenarios that
1705 require quoting.
1706
1707 For more information about overloaded functions, see @ref{C Plus Plus
1708 Expressions, ,C@t{++} Expressions}.  You can use the command @code{set
1709 overload-resolution off} to disable overload resolution;
1710 see @ref{Debugging C Plus Plus, ,@value{GDBN} Features for C@t{++}}.
1711
1712 @cindex completion of structure field names
1713 @cindex structure field name completion
1714 @cindex completion of union field names
1715 @cindex union field name completion
1716 When completing in an expression which looks up a field in a
1717 structure, @value{GDBN} also tries@footnote{The completer can be
1718 confused by certain kinds of invalid expressions.  Also, it only
1719 examines the static type of the expression, not the dynamic type.} to
1720 limit completions to the field names available in the type of the
1721 left-hand-side:
1722
1723 @smallexample
1724 (@value{GDBP}) p gdb_stdout.@kbd{M-?}
1725 magic                to_fputs             to_rewind
1726 to_data              to_isatty            to_write
1727 to_delete            to_put               to_write_async_safe
1728 to_flush             to_read
1729 @end smallexample
1730
1731 @noindent
1732 This is because the @code{gdb_stdout} is a variable of the type
1733 @code{struct ui_file} that is defined in @value{GDBN} sources as
1734 follows:
1735
1736 @smallexample
1737 struct ui_file
1738 @{
1739    int *magic;
1740    ui_file_flush_ftype *to_flush;
1741    ui_file_write_ftype *to_write;
1742    ui_file_write_async_safe_ftype *to_write_async_safe;
1743    ui_file_fputs_ftype *to_fputs;
1744    ui_file_read_ftype *to_read;
1745    ui_file_delete_ftype *to_delete;
1746    ui_file_isatty_ftype *to_isatty;
1747    ui_file_rewind_ftype *to_rewind;
1748    ui_file_put_ftype *to_put;
1749    void *to_data;
1750 @}
1751 @end smallexample
1752
1753
1754 @node Help
1755 @section Getting Help
1756 @cindex online documentation
1757 @kindex help
1758
1759 You can always ask @value{GDBN} itself for information on its commands,
1760 using the command @code{help}.
1761
1762 @table @code
1763 @kindex h @r{(@code{help})}
1764 @item help
1765 @itemx h
1766 You can use @code{help} (abbreviated @code{h}) with no arguments to
1767 display a short list of named classes of commands:
1768
1769 @smallexample
1770 (@value{GDBP}) help
1771 List of classes of commands:
1772
1773 aliases -- Aliases of other commands
1774 breakpoints -- Making program stop at certain points
1775 data -- Examining data
1776 files -- Specifying and examining files
1777 internals -- Maintenance commands
1778 obscure -- Obscure features
1779 running -- Running the program
1780 stack -- Examining the stack
1781 status -- Status inquiries
1782 support -- Support facilities
1783 tracepoints -- Tracing of program execution without
1784                stopping the program
1785 user-defined -- User-defined commands
1786
1787 Type "help" followed by a class name for a list of
1788 commands in that class.
1789 Type "help" followed by command name for full
1790 documentation.
1791 Command name abbreviations are allowed if unambiguous.
1792 (@value{GDBP})
1793 @end smallexample
1794 @c the above line break eliminates huge line overfull...
1795
1796 @item help @var{class}
1797 Using one of the general help classes as an argument, you can get a
1798 list of the individual commands in that class.  For example, here is the
1799 help display for the class @code{status}:
1800
1801 @smallexample
1802 (@value{GDBP}) help status
1803 Status inquiries.
1804
1805 List of commands:
1806
1807 @c Line break in "show" line falsifies real output, but needed
1808 @c to fit in smallbook page size.
1809 info -- Generic command for showing things
1810         about the program being debugged
1811 show -- Generic command for showing things
1812         about the debugger
1813
1814 Type "help" followed by command name for full
1815 documentation.
1816 Command name abbreviations are allowed if unambiguous.
1817 (@value{GDBP})
1818 @end smallexample
1819
1820 @item help @var{command}
1821 With a command name as @code{help} argument, @value{GDBN} displays a
1822 short paragraph on how to use that command.
1823
1824 @kindex apropos
1825 @item apropos @var{args}
1826 The @code{apropos} command searches through all of the @value{GDBN}
1827 commands, and their documentation, for the regular expression specified in
1828 @var{args}.  It prints out all matches found.  For example:
1829
1830 @smallexample
1831 apropos alias
1832 @end smallexample
1833
1834 @noindent
1835 results in:
1836
1837 @smallexample
1838 @c @group
1839 alias -- Define a new command that is an alias of an existing command
1840 aliases -- Aliases of other commands
1841 d -- Delete some breakpoints or auto-display expressions
1842 del -- Delete some breakpoints or auto-display expressions
1843 delete -- Delete some breakpoints or auto-display expressions
1844 @c @end group
1845 @end smallexample
1846
1847 @kindex complete
1848 @item complete @var{args}
1849 The @code{complete @var{args}} command lists all the possible completions
1850 for the beginning of a command.  Use @var{args} to specify the beginning of the
1851 command you want completed.  For example:
1852
1853 @smallexample
1854 complete i
1855 @end smallexample
1856
1857 @noindent results in:
1858
1859 @smallexample
1860 @group
1861 if
1862 ignore
1863 info
1864 inspect
1865 @end group
1866 @end smallexample
1867
1868 @noindent This is intended for use by @sc{gnu} Emacs.
1869 @end table
1870
1871 In addition to @code{help}, you can use the @value{GDBN} commands @code{info}
1872 and @code{show} to inquire about the state of your program, or the state
1873 of @value{GDBN} itself.  Each command supports many topics of inquiry; this
1874 manual introduces each of them in the appropriate context.  The listings
1875 under @code{info} and under @code{show} in the Command, Variable, and
1876 Function Index point to all the sub-commands.  @xref{Command and Variable
1877 Index}.
1878
1879 @c @group
1880 @table @code
1881 @kindex info
1882 @kindex i @r{(@code{info})}
1883 @item info
1884 This command (abbreviated @code{i}) is for describing the state of your
1885 program.  For example, you can show the arguments passed to a function
1886 with @code{info args}, list the registers currently in use with @code{info
1887 registers}, or list the breakpoints you have set with @code{info breakpoints}.
1888 You can get a complete list of the @code{info} sub-commands with
1889 @w{@code{help info}}.
1890
1891 @kindex set
1892 @item set
1893 You can assign the result of an expression to an environment variable with
1894 @code{set}.  For example, you can set the @value{GDBN} prompt to a $-sign with
1895 @code{set prompt $}.
1896
1897 @kindex show
1898 @item show
1899 In contrast to @code{info}, @code{show} is for describing the state of
1900 @value{GDBN} itself.
1901 You can change most of the things you can @code{show}, by using the
1902 related command @code{set}; for example, you can control what number
1903 system is used for displays with @code{set radix}, or simply inquire
1904 which is currently in use with @code{show radix}.
1905
1906 @kindex info set
1907 To display all the settable parameters and their current
1908 values, you can use @code{show} with no arguments; you may also use
1909 @code{info set}.  Both commands produce the same display.
1910 @c FIXME: "info set" violates the rule that "info" is for state of
1911 @c FIXME...program.  Ck w/ GNU: "info set" to be called something else,
1912 @c FIXME...or change desc of rule---eg "state of prog and debugging session"?
1913 @end table
1914 @c @end group
1915
1916 Here are several miscellaneous @code{show} subcommands, all of which are
1917 exceptional in lacking corresponding @code{set} commands:
1918
1919 @table @code
1920 @kindex show version
1921 @cindex @value{GDBN} version number
1922 @item show version
1923 Show what version of @value{GDBN} is running.  You should include this
1924 information in @value{GDBN} bug-reports.  If multiple versions of
1925 @value{GDBN} are in use at your site, you may need to determine which
1926 version of @value{GDBN} you are running; as @value{GDBN} evolves, new
1927 commands are introduced, and old ones may wither away.  Also, many
1928 system vendors ship variant versions of @value{GDBN}, and there are
1929 variant versions of @value{GDBN} in @sc{gnu}/Linux distributions as well.
1930 The version number is the same as the one announced when you start
1931 @value{GDBN}.
1932
1933 @kindex show copying
1934 @kindex info copying
1935 @cindex display @value{GDBN} copyright
1936 @item show copying
1937 @itemx info copying
1938 Display information about permission for copying @value{GDBN}.
1939
1940 @kindex show warranty
1941 @kindex info warranty
1942 @item show warranty
1943 @itemx info warranty
1944 Display the @sc{gnu} ``NO WARRANTY'' statement, or a warranty,
1945 if your version of @value{GDBN} comes with one.
1946
1947 @kindex show configuration
1948 @item show configuration
1949 Display detailed information about the way @value{GDBN} was configured
1950 when it was built.  This displays the optional arguments passed to the
1951 @file{configure} script and also configuration parameters detected
1952 automatically by @command{configure}.  When reporting a @value{GDBN}
1953 bug (@pxref{GDB Bugs}), it is important to include this information in
1954 your report.
1955
1956 @end table
1957
1958 @node Running
1959 @chapter Running Programs Under @value{GDBN}
1960
1961 When you run a program under @value{GDBN}, you must first generate
1962 debugging information when you compile it.
1963
1964 You may start @value{GDBN} with its arguments, if any, in an environment
1965 of your choice.  If you are doing native debugging, you may redirect
1966 your program's input and output, debug an already running process, or
1967 kill a child process.
1968
1969 @menu
1970 * Compilation::                 Compiling for debugging
1971 * Starting::                    Starting your program
1972 * Arguments::                   Your program's arguments
1973 * Environment::                 Your program's environment
1974
1975 * Working Directory::           Your program's working directory
1976 * Input/Output::                Your program's input and output
1977 * Attach::                      Debugging an already-running process
1978 * Kill Process::                Killing the child process
1979
1980 * Inferiors and Programs::      Debugging multiple inferiors and programs
1981 * Threads::                     Debugging programs with multiple threads
1982 * Forks::                       Debugging forks
1983 * Checkpoint/Restart::          Setting a @emph{bookmark} to return to later
1984 @end menu
1985
1986 @node Compilation
1987 @section Compiling for Debugging
1988
1989 In order to debug a program effectively, you need to generate
1990 debugging information when you compile it.  This debugging information
1991 is stored in the object file; it describes the data type of each
1992 variable or function and the correspondence between source line numbers
1993 and addresses in the executable code.
1994
1995 To request debugging information, specify the @samp{-g} option when you run
1996 the compiler.
1997
1998 Programs that are to be shipped to your customers are compiled with
1999 optimizations, using the @samp{-O} compiler option.  However, some
2000 compilers are unable to handle the @samp{-g} and @samp{-O} options
2001 together.  Using those compilers, you cannot generate optimized
2002 executables containing debugging information.
2003
2004 @value{NGCC}, the @sc{gnu} C/C@t{++} compiler, supports @samp{-g} with or
2005 without @samp{-O}, making it possible to debug optimized code.  We
2006 recommend that you @emph{always} use @samp{-g} whenever you compile a
2007 program.  You may think your program is correct, but there is no sense
2008 in pushing your luck.  For more information, see @ref{Optimized Code}.
2009
2010 Older versions of the @sc{gnu} C compiler permitted a variant option
2011 @w{@samp{-gg}} for debugging information.  @value{GDBN} no longer supports this
2012 format; if your @sc{gnu} C compiler has this option, do not use it.
2013
2014 @value{GDBN} knows about preprocessor macros and can show you their
2015 expansion (@pxref{Macros}).  Most compilers do not include information
2016 about preprocessor macros in the debugging information if you specify
2017 the @option{-g} flag alone.  Version 3.1 and later of @value{NGCC},
2018 the @sc{gnu} C compiler, provides macro information if you are using
2019 the DWARF debugging format, and specify the option @option{-g3}.
2020
2021 @xref{Debugging Options,,Options for Debugging Your Program or GCC,
2022 gcc.info, Using the @sc{gnu} Compiler Collection (GCC)}, for more
2023 information on @value{NGCC} options affecting debug information.
2024
2025 You will have the best debugging experience if you use the latest
2026 version of the DWARF debugging format that your compiler supports.
2027 DWARF is currently the most expressive and best supported debugging
2028 format in @value{GDBN}.
2029
2030 @need 2000
2031 @node Starting
2032 @section Starting your Program
2033 @cindex starting
2034 @cindex running
2035
2036 @table @code
2037 @kindex run
2038 @kindex r @r{(@code{run})}
2039 @item run
2040 @itemx r
2041 Use the @code{run} command to start your program under @value{GDBN}.
2042 You must first specify the program name with an argument to
2043 @value{GDBN} (@pxref{Invocation, ,Getting In and Out of
2044 @value{GDBN}}), or by using the @code{file} or @code{exec-file}
2045 command (@pxref{Files, ,Commands to Specify Files}).
2046
2047 @end table
2048
2049 If you are running your program in an execution environment that
2050 supports processes, @code{run} creates an inferior process and makes
2051 that process run your program.  In some environments without processes,
2052 @code{run} jumps to the start of your program.  Other targets,
2053 like @samp{remote}, are always running.  If you get an error
2054 message like this one:
2055
2056 @smallexample
2057 The "remote" target does not support "run".
2058 Try "help target" or "continue".
2059 @end smallexample
2060
2061 @noindent
2062 then use @code{continue} to run your program.  You may need @code{load}
2063 first (@pxref{load}).
2064
2065 The execution of a program is affected by certain information it
2066 receives from its superior.  @value{GDBN} provides ways to specify this
2067 information, which you must do @emph{before} starting your program.  (You
2068 can change it after starting your program, but such changes only affect
2069 your program the next time you start it.)  This information may be
2070 divided into four categories:
2071
2072 @table @asis
2073 @item The @emph{arguments.}
2074 Specify the arguments to give your program as the arguments of the
2075 @code{run} command.  If a shell is available on your target, the shell
2076 is used to pass the arguments, so that you may use normal conventions
2077 (such as wildcard expansion or variable substitution) in describing
2078 the arguments.
2079 In Unix systems, you can control which shell is used with the
2080 @code{SHELL} environment variable.  If you do not define @code{SHELL},
2081 @value{GDBN} uses the default shell (@file{/bin/sh}).  You can disable
2082 use of any shell with the @code{set startup-with-shell} command (see
2083 below for details).
2084
2085 @item The @emph{environment.}
2086 Your program normally inherits its environment from @value{GDBN}, but you can
2087 use the @value{GDBN} commands @code{set environment} and @code{unset
2088 environment} to change parts of the environment that affect
2089 your program.  @xref{Environment, ,Your Program's Environment}.
2090
2091 @item The @emph{working directory.}
2092 You can set your program's working directory with the command
2093 @kbd{set cwd}.  If you do not set any working directory with this
2094 command, your program will inherit @value{GDBN}'s working directory if
2095 native debugging, or the remote server's working directory if remote
2096 debugging.  @xref{Working Directory, ,Your Program's Working
2097 Directory}.
2098
2099 @item The @emph{standard input and output.}
2100 Your program normally uses the same device for standard input and
2101 standard output as @value{GDBN} is using.  You can redirect input and output
2102 in the @code{run} command line, or you can use the @code{tty} command to
2103 set a different device for your program.
2104 @xref{Input/Output, ,Your Program's Input and Output}.
2105
2106 @cindex pipes
2107 @emph{Warning:} While input and output redirection work, you cannot use
2108 pipes to pass the output of the program you are debugging to another
2109 program; if you attempt this, @value{GDBN} is likely to wind up debugging the
2110 wrong program.
2111 @end table
2112
2113 When you issue the @code{run} command, your program begins to execute
2114 immediately.  @xref{Stopping, ,Stopping and Continuing}, for discussion
2115 of how to arrange for your program to stop.  Once your program has
2116 stopped, you may call functions in your program, using the @code{print}
2117 or @code{call} commands.  @xref{Data, ,Examining Data}.
2118
2119 If the modification time of your symbol file has changed since the last
2120 time @value{GDBN} read its symbols, @value{GDBN} discards its symbol
2121 table, and reads it again.  When it does this, @value{GDBN} tries to retain
2122 your current breakpoints.
2123
2124 @table @code
2125 @kindex start
2126 @item start
2127 @cindex run to main procedure
2128 The name of the main procedure can vary from language to language.
2129 With C or C@t{++}, the main procedure name is always @code{main}, but
2130 other languages such as Ada do not require a specific name for their
2131 main procedure.  The debugger provides a convenient way to start the
2132 execution of the program and to stop at the beginning of the main
2133 procedure, depending on the language used.
2134
2135 The @samp{start} command does the equivalent of setting a temporary
2136 breakpoint at the beginning of the main procedure and then invoking
2137 the @samp{run} command.
2138
2139 @cindex elaboration phase
2140 Some programs contain an @dfn{elaboration} phase where some startup code is
2141 executed before the main procedure is called.  This depends on the
2142 languages used to write your program.  In C@t{++}, for instance,
2143 constructors for static and global objects are executed before
2144 @code{main} is called.  It is therefore possible that the debugger stops
2145 before reaching the main procedure.  However, the temporary breakpoint
2146 will remain to halt execution.
2147
2148 Specify the arguments to give to your program as arguments to the
2149 @samp{start} command.  These arguments will be given verbatim to the
2150 underlying @samp{run} command.  Note that the same arguments will be
2151 reused if no argument is provided during subsequent calls to
2152 @samp{start} or @samp{run}.
2153
2154 It is sometimes necessary to debug the program during elaboration.  In
2155 these cases, using the @code{start} command would stop the execution
2156 of your program too late, as the program would have already completed
2157 the elaboration phase.  Under these circumstances, either insert
2158 breakpoints in your elaboration code before running your program or
2159 use the @code{starti} command.
2160
2161 @kindex starti
2162 @item starti
2163 @cindex run to first instruction
2164 The @samp{starti} command does the equivalent of setting a temporary
2165 breakpoint at the first instruction of a program's execution and then
2166 invoking the @samp{run} command.  For programs containing an
2167 elaboration phase, the @code{starti} command will stop execution at
2168 the start of the elaboration phase.
2169
2170 @anchor{set exec-wrapper}
2171 @kindex set exec-wrapper
2172 @item set exec-wrapper @var{wrapper}
2173 @itemx show exec-wrapper
2174 @itemx unset exec-wrapper
2175 When @samp{exec-wrapper} is set, the specified wrapper is used to
2176 launch programs for debugging.  @value{GDBN} starts your program
2177 with a shell command of the form @kbd{exec @var{wrapper}
2178 @var{program}}.  Quoting is added to @var{program} and its
2179 arguments, but not to @var{wrapper}, so you should add quotes if
2180 appropriate for your shell.  The wrapper runs until it executes
2181 your program, and then @value{GDBN} takes control.
2182
2183 You can use any program that eventually calls @code{execve} with
2184 its arguments as a wrapper.  Several standard Unix utilities do
2185 this, e.g.@: @code{env} and @code{nohup}.  Any Unix shell script ending
2186 with @code{exec "$@@"} will also work.
2187
2188 For example, you can use @code{env} to pass an environment variable to
2189 the debugged program, without setting the variable in your shell's
2190 environment:
2191
2192 @smallexample
2193 (@value{GDBP}) set exec-wrapper env 'LD_PRELOAD=libtest.so'
2194 (@value{GDBP}) run
2195 @end smallexample
2196
2197 This command is available when debugging locally on most targets, excluding
2198 @sc{djgpp}, Cygwin, MS Windows, and QNX Neutrino.
2199
2200 @kindex set startup-with-shell
2201 @anchor{set startup-with-shell}
2202 @item set startup-with-shell
2203 @itemx set startup-with-shell on
2204 @itemx set startup-with-shell off
2205 @itemx show startup-with-shell
2206 On Unix systems, by default, if a shell is available on your target,
2207 @value{GDBN}) uses it to start your program.  Arguments of the
2208 @code{run} command are passed to the shell, which does variable
2209 substitution, expands wildcard characters and performs redirection of
2210 I/O.  In some circumstances, it may be useful to disable such use of a
2211 shell, for example, when debugging the shell itself or diagnosing
2212 startup failures such as:
2213
2214 @smallexample
2215 (@value{GDBP}) run
2216 Starting program: ./a.out
2217 During startup program terminated with signal SIGSEGV, Segmentation fault.
2218 @end smallexample
2219
2220 @noindent
2221 which indicates the shell or the wrapper specified with
2222 @samp{exec-wrapper} crashed, not your program.  Most often, this is
2223 caused by something odd in your shell's non-interactive mode
2224 initialization file---such as @file{.cshrc} for C-shell,
2225 $@file{.zshenv} for the Z shell, or the file specified in the
2226 @samp{BASH_ENV} environment variable for BASH.
2227
2228 @anchor{set auto-connect-native-target}
2229 @kindex set auto-connect-native-target
2230 @item set auto-connect-native-target
2231 @itemx set auto-connect-native-target on
2232 @itemx set auto-connect-native-target off
2233 @itemx show auto-connect-native-target
2234
2235 By default, if not connected to any target yet (e.g., with
2236 @code{target remote}), the @code{run} command starts your program as a
2237 native process under @value{GDBN}, on your local machine.  If you're
2238 sure you don't want to debug programs on your local machine, you can
2239 tell @value{GDBN} to not connect to the native target automatically
2240 with the @code{set auto-connect-native-target off} command.
2241
2242 If @code{on}, which is the default, and if @value{GDBN} is not
2243 connected to a target already, the @code{run} command automaticaly
2244 connects to the native target, if one is available.
2245
2246 If @code{off}, and if @value{GDBN} is not connected to a target
2247 already, the @code{run} command fails with an error:
2248
2249 @smallexample
2250 (@value{GDBP}) run
2251 Don't know how to run.  Try "help target".
2252 @end smallexample
2253
2254 If @value{GDBN} is already connected to a target, @value{GDBN} always
2255 uses it with the @code{run} command.
2256
2257 In any case, you can explicitly connect to the native target with the
2258 @code{target native} command.  For example,
2259
2260 @smallexample
2261 (@value{GDBP}) set auto-connect-native-target off
2262 (@value{GDBP}) run
2263 Don't know how to run.  Try "help target".
2264 (@value{GDBP}) target native
2265 (@value{GDBP}) run
2266 Starting program: ./a.out
2267 [Inferior 1 (process 10421) exited normally]
2268 @end smallexample
2269
2270 In case you connected explicitly to the @code{native} target,
2271 @value{GDBN} remains connected even if all inferiors exit, ready for
2272 the next @code{run} command.  Use the @code{disconnect} command to
2273 disconnect.
2274
2275 Examples of other commands that likewise respect the
2276 @code{auto-connect-native-target} setting: @code{attach}, @code{info
2277 proc}, @code{info os}.
2278
2279 @kindex set disable-randomization
2280 @item set disable-randomization
2281 @itemx set disable-randomization on
2282 This option (enabled by default in @value{GDBN}) will turn off the native
2283 randomization of the virtual address space of the started program.  This option
2284 is useful for multiple debugging sessions to make the execution better
2285 reproducible and memory addresses reusable across debugging sessions.
2286
2287 This feature is implemented only on certain targets, including @sc{gnu}/Linux.
2288 On @sc{gnu}/Linux you can get the same behavior using
2289
2290 @smallexample
2291 (@value{GDBP}) set exec-wrapper setarch `uname -m` -R
2292 @end smallexample
2293
2294 @item set disable-randomization off
2295 Leave the behavior of the started executable unchanged.  Some bugs rear their
2296 ugly heads only when the program is loaded at certain addresses.  If your bug
2297 disappears when you run the program under @value{GDBN}, that might be because
2298 @value{GDBN} by default disables the address randomization on platforms, such
2299 as @sc{gnu}/Linux, which do that for stand-alone programs.  Use @kbd{set
2300 disable-randomization off} to try to reproduce such elusive bugs.
2301
2302 On targets where it is available, virtual address space randomization
2303 protects the programs against certain kinds of security attacks.  In these
2304 cases the attacker needs to know the exact location of a concrete executable
2305 code.  Randomizing its location makes it impossible to inject jumps misusing
2306 a code at its expected addresses.
2307
2308 Prelinking shared libraries provides a startup performance advantage but it
2309 makes addresses in these libraries predictable for privileged processes by
2310 having just unprivileged access at the target system.  Reading the shared
2311 library binary gives enough information for assembling the malicious code
2312 misusing it.  Still even a prelinked shared library can get loaded at a new
2313 random address just requiring the regular relocation process during the
2314 startup.  Shared libraries not already prelinked are always loaded at
2315 a randomly chosen address.
2316
2317 Position independent executables (PIE) contain position independent code
2318 similar to the shared libraries and therefore such executables get loaded at
2319 a randomly chosen address upon startup.  PIE executables always load even
2320 already prelinked shared libraries at a random address.  You can build such
2321 executable using @command{gcc -fPIE -pie}.
2322
2323 Heap (malloc storage), stack and custom mmap areas are always placed randomly
2324 (as long as the randomization is enabled).
2325
2326 @item show disable-randomization
2327 Show the current setting of the explicit disable of the native randomization of
2328 the virtual address space of the started program.
2329
2330 @end table
2331
2332 @node Arguments
2333 @section Your Program's Arguments
2334
2335 @cindex arguments (to your program)
2336 The arguments to your program can be specified by the arguments of the
2337 @code{run} command.
2338 They are passed to a shell, which expands wildcard characters and
2339 performs redirection of I/O, and thence to your program.  Your
2340 @code{SHELL} environment variable (if it exists) specifies what shell
2341 @value{GDBN} uses.  If you do not define @code{SHELL}, @value{GDBN} uses
2342 the default shell (@file{/bin/sh} on Unix).
2343
2344 On non-Unix systems, the program is usually invoked directly by
2345 @value{GDBN}, which emulates I/O redirection via the appropriate system
2346 calls, and the wildcard characters are expanded by the startup code of
2347 the program, not by the shell.
2348
2349 @code{run} with no arguments uses the same arguments used by the previous
2350 @code{run}, or those set by the @code{set args} command.
2351
2352 @table @code
2353 @kindex set args
2354 @item set args
2355 Specify the arguments to be used the next time your program is run.  If
2356 @code{set args} has no arguments, @code{run} executes your program
2357 with no arguments.  Once you have run your program with arguments,
2358 using @code{set args} before the next @code{run} is the only way to run
2359 it again without arguments.
2360
2361 @kindex show args
2362 @item show args
2363 Show the arguments to give your program when it is started.
2364 @end table
2365
2366 @node Environment
2367 @section Your Program's Environment
2368
2369 @cindex environment (of your program)
2370 The @dfn{environment} consists of a set of environment variables and
2371 their values.  Environment variables conventionally record such things as
2372 your user name, your home directory, your terminal type, and your search
2373 path for programs to run.  Usually you set up environment variables with
2374 the shell and they are inherited by all the other programs you run.  When
2375 debugging, it can be useful to try running your program with a modified
2376 environment without having to start @value{GDBN} over again.
2377
2378 @table @code
2379 @kindex path
2380 @item path @var{directory}
2381 Add @var{directory} to the front of the @code{PATH} environment variable
2382 (the search path for executables) that will be passed to your program.
2383 The value of @code{PATH} used by @value{GDBN} does not change.
2384 You may specify several directory names, separated by whitespace or by a
2385 system-dependent separator character (@samp{:} on Unix, @samp{;} on
2386 MS-DOS and MS-Windows).  If @var{directory} is already in the path, it
2387 is moved to the front, so it is searched sooner.
2388
2389 You can use the string @samp{$cwd} to refer to whatever is the current
2390 working directory at the time @value{GDBN} searches the path.  If you
2391 use @samp{.} instead, it refers to the directory where you executed the
2392 @code{path} command.  @value{GDBN} replaces @samp{.} in the
2393 @var{directory} argument (with the current path) before adding
2394 @var{directory} to the search path.
2395 @c 'path' is explicitly nonrepeatable, but RMS points out it is silly to
2396 @c document that, since repeating it would be a no-op.
2397
2398 @kindex show paths
2399 @item show paths
2400 Display the list of search paths for executables (the @code{PATH}
2401 environment variable).
2402
2403 @kindex show environment
2404 @item show environment @r{[}@var{varname}@r{]}
2405 Print the value of environment variable @var{varname} to be given to
2406 your program when it starts.  If you do not supply @var{varname},
2407 print the names and values of all environment variables to be given to
2408 your program.  You can abbreviate @code{environment} as @code{env}.
2409
2410 @kindex set environment
2411 @anchor{set environment}
2412 @item set environment @var{varname} @r{[}=@var{value}@r{]}
2413 Set environment variable @var{varname} to @var{value}.  The value
2414 changes for your program (and the shell @value{GDBN} uses to launch
2415 it), not for @value{GDBN} itself.  The @var{value} may be any string; the
2416 values of environment variables are just strings, and any
2417 interpretation is supplied by your program itself.  The @var{value}
2418 parameter is optional; if it is eliminated, the variable is set to a
2419 null value.
2420 @c "any string" here does not include leading, trailing
2421 @c blanks. Gnu asks: does anyone care?
2422
2423 For example, this command:
2424
2425 @smallexample
2426 set env USER = foo
2427 @end smallexample
2428
2429 @noindent
2430 tells the debugged program, when subsequently run, that its user is named
2431 @samp{foo}.  (The spaces around @samp{=} are used for clarity here; they
2432 are not actually required.)
2433
2434 Note that on Unix systems, @value{GDBN} runs your program via a shell,
2435 which also inherits the environment set with @code{set environment}.
2436 If necessary, you can avoid that by using the @samp{env} program as a
2437 wrapper instead of using @code{set environment}.  @xref{set
2438 exec-wrapper}, for an example doing just that.
2439
2440 Environment variables that are set by the user are also transmitted to
2441 @command{gdbserver} to be used when starting the remote inferior.
2442 @pxref{QEnvironmentHexEncoded}.
2443
2444 @kindex unset environment
2445 @anchor{unset environment}
2446 @item unset environment @var{varname}
2447 Remove variable @var{varname} from the environment to be passed to your
2448 program.  This is different from @samp{set env @var{varname} =};
2449 @code{unset environment} removes the variable from the environment,
2450 rather than assigning it an empty value.
2451
2452 Environment variables that are unset by the user are also unset on
2453 @command{gdbserver} when starting the remote inferior.
2454 @pxref{QEnvironmentUnset}.
2455 @end table
2456
2457 @emph{Warning:} On Unix systems, @value{GDBN} runs your program using
2458 the shell indicated by your @code{SHELL} environment variable if it
2459 exists (or @code{/bin/sh} if not).  If your @code{SHELL} variable
2460 names a shell that runs an initialization file when started
2461 non-interactively---such as @file{.cshrc} for C-shell, $@file{.zshenv}
2462 for the Z shell, or the file specified in the @samp{BASH_ENV}
2463 environment variable for BASH---any variables you set in that file
2464 affect your program.  You may wish to move setting of environment
2465 variables to files that are only run when you sign on, such as
2466 @file{.login} or @file{.profile}.
2467
2468 @node Working Directory
2469 @section Your Program's Working Directory
2470
2471 @cindex working directory (of your program)
2472 Each time you start your program with @code{run}, the inferior will be
2473 initialized with the current working directory specified by the
2474 @kbd{set cwd} command.  If no directory has been specified by this
2475 command, then the inferior will inherit @value{GDBN}'s current working
2476 directory as its working directory if native debugging, or it will
2477 inherit the remote server's current working directory if remote
2478 debugging.
2479
2480 @table @code
2481 @kindex set cwd
2482 @cindex change inferior's working directory
2483 @anchor{set cwd command}
2484 @item set cwd @r{[}@var{directory}@r{]}
2485 Set the inferior's working directory to @var{directory}, which will be
2486 @code{glob}-expanded in order to resolve tildes (@file{~}).  If no
2487 argument has been specified, the command clears the setting and resets
2488 it to an empty state.  This setting has no effect on @value{GDBN}'s
2489 working directory, and it only takes effect the next time you start
2490 the inferior.  The @file{~} in @var{directory} is a short for the
2491 @dfn{home directory}, usually pointed to by the @env{HOME} environment
2492 variable.  On MS-Windows, if @env{HOME} is not defined, @value{GDBN}
2493 uses the concatenation of @env{HOMEDRIVE} and @env{HOMEPATH} as
2494 fallback.
2495
2496 You can also change @value{GDBN}'s current working directory by using
2497 the @code{cd} command.
2498 @xref{cd command}
2499
2500 @kindex show cwd
2501 @cindex show inferior's working directory
2502 @item show cwd
2503 Show the inferior's working directory.  If no directory has been
2504 specified by @kbd{set cwd}, then the default inferior's working
2505 directory is the same as @value{GDBN}'s working directory.
2506
2507 @kindex cd
2508 @cindex change @value{GDBN}'s working directory
2509 @anchor{cd command}
2510 @item cd @r{[}@var{directory}@r{]}
2511 Set the @value{GDBN} working directory to @var{directory}.  If not
2512 given, @var{directory} uses @file{'~'}.
2513
2514 The @value{GDBN} working directory serves as a default for the
2515 commands that specify files for @value{GDBN} to operate on.
2516 @xref{Files, ,Commands to Specify Files}.
2517 @xref{set cwd command}
2518
2519 @kindex pwd
2520 @item pwd
2521 Print the @value{GDBN} working directory.
2522 @end table
2523
2524 It is generally impossible to find the current working directory of
2525 the process being debugged (since a program can change its directory
2526 during its run).  If you work on a system where @value{GDBN} supports
2527 the @code{info proc} command (@pxref{Process Information}), you can
2528 use the @code{info proc} command to find out the
2529 current working directory of the debuggee.
2530
2531 @node Input/Output
2532 @section Your Program's Input and Output
2533
2534 @cindex redirection
2535 @cindex i/o
2536 @cindex terminal
2537 By default, the program you run under @value{GDBN} does input and output to
2538 the same terminal that @value{GDBN} uses.  @value{GDBN} switches the terminal
2539 to its own terminal modes to interact with you, but it records the terminal
2540 modes your program was using and switches back to them when you continue
2541 running your program.
2542
2543 @table @code
2544 @kindex info terminal
2545 @item info terminal
2546 Displays information recorded by @value{GDBN} about the terminal modes your
2547 program is using.
2548 @end table
2549
2550 You can redirect your program's input and/or output using shell
2551 redirection with the @code{run} command.  For example,
2552
2553 @smallexample
2554 run > outfile
2555 @end smallexample
2556
2557 @noindent
2558 starts your program, diverting its output to the file @file{outfile}.
2559
2560 @kindex tty
2561 @cindex controlling terminal
2562 Another way to specify where your program should do input and output is
2563 with the @code{tty} command.  This command accepts a file name as
2564 argument, and causes this file to be the default for future @code{run}
2565 commands.  It also resets the controlling terminal for the child
2566 process, for future @code{run} commands.  For example,
2567
2568 @smallexample
2569 tty /dev/ttyb
2570 @end smallexample
2571
2572 @noindent
2573 directs that processes started with subsequent @code{run} commands
2574 default to do input and output on the terminal @file{/dev/ttyb} and have
2575 that as their controlling terminal.
2576
2577 An explicit redirection in @code{run} overrides the @code{tty} command's
2578 effect on the input/output device, but not its effect on the controlling
2579 terminal.
2580
2581 When you use the @code{tty} command or redirect input in the @code{run}
2582 command, only the input @emph{for your program} is affected.  The input
2583 for @value{GDBN} still comes from your terminal.  @code{tty} is an alias
2584 for @code{set inferior-tty}.
2585
2586 @cindex inferior tty
2587 @cindex set inferior controlling terminal
2588 You can use the @code{show inferior-tty} command to tell @value{GDBN} to
2589 display the name of the terminal that will be used for future runs of your
2590 program.
2591
2592 @table @code
2593 @item set inferior-tty [ @var{tty} ]
2594 @kindex set inferior-tty
2595 Set the tty for the program being debugged to @var{tty}.  Omitting @var{tty}
2596 restores the default behavior, which is to use the same terminal as
2597 @value{GDBN}.
2598
2599 @item show inferior-tty
2600 @kindex show inferior-tty
2601 Show the current tty for the program being debugged.
2602 @end table
2603
2604 @node Attach
2605 @section Debugging an Already-running Process
2606 @kindex attach
2607 @cindex attach
2608
2609 @table @code
2610 @item attach @var{process-id}
2611 This command attaches to a running process---one that was started
2612 outside @value{GDBN}.  (@code{info files} shows your active
2613 targets.)  The command takes as argument a process ID.  The usual way to
2614 find out the @var{process-id} of a Unix process is with the @code{ps} utility,
2615 or with the @samp{jobs -l} shell command.
2616
2617 @code{attach} does not repeat if you press @key{RET} a second time after
2618 executing the command.
2619 @end table
2620
2621 To use @code{attach}, your program must be running in an environment
2622 which supports processes; for example, @code{attach} does not work for
2623 programs on bare-board targets that lack an operating system.  You must
2624 also have permission to send the process a signal.
2625
2626 When you use @code{attach}, the debugger finds the program running in
2627 the process first by looking in the current working directory, then (if
2628 the program is not found) by using the source file search path
2629 (@pxref{Source Path, ,Specifying Source Directories}).  You can also use
2630 the @code{file} command to load the program.  @xref{Files, ,Commands to
2631 Specify Files}.
2632
2633 The first thing @value{GDBN} does after arranging to debug the specified
2634 process is to stop it.  You can examine and modify an attached process
2635 with all the @value{GDBN} commands that are ordinarily available when
2636 you start processes with @code{run}.  You can insert breakpoints; you
2637 can step and continue; you can modify storage.  If you would rather the
2638 process continue running, you may use the @code{continue} command after
2639 attaching @value{GDBN} to the process.
2640
2641 @table @code
2642 @kindex detach
2643 @item detach
2644 When you have finished debugging the attached process, you can use the
2645 @code{detach} command to release it from @value{GDBN} control.  Detaching
2646 the process continues its execution.  After the @code{detach} command,
2647 that process and @value{GDBN} become completely independent once more, and you
2648 are ready to @code{attach} another process or start one with @code{run}.
2649 @code{detach} does not repeat if you press @key{RET} again after
2650 executing the command.
2651 @end table
2652
2653 If you exit @value{GDBN} while you have an attached process, you detach
2654 that process.  If you use the @code{run} command, you kill that process.
2655 By default, @value{GDBN} asks for confirmation if you try to do either of these
2656 things; you can control whether or not you need to confirm by using the
2657 @code{set confirm} command (@pxref{Messages/Warnings, ,Optional Warnings and
2658 Messages}).
2659
2660 @node Kill Process
2661 @section Killing the Child Process
2662
2663 @table @code
2664 @kindex kill
2665 @item kill
2666 Kill the child process in which your program is running under @value{GDBN}.
2667 @end table
2668
2669 This command is useful if you wish to debug a core dump instead of a
2670 running process.  @value{GDBN} ignores any core dump file while your program
2671 is running.
2672
2673 On some operating systems, a program cannot be executed outside @value{GDBN}
2674 while you have breakpoints set on it inside @value{GDBN}.  You can use the
2675 @code{kill} command in this situation to permit running your program
2676 outside the debugger.
2677
2678 The @code{kill} command is also useful if you wish to recompile and
2679 relink your program, since on many systems it is impossible to modify an
2680 executable file while it is running in a process.  In this case, when you
2681 next type @code{run}, @value{GDBN} notices that the file has changed, and
2682 reads the symbol table again (while trying to preserve your current
2683 breakpoint settings).
2684
2685 @node Inferiors and Programs
2686 @section Debugging Multiple Inferiors and Programs
2687
2688 @value{GDBN} lets you run and debug multiple programs in a single
2689 session.  In addition, @value{GDBN} on some systems may let you run
2690 several programs simultaneously (otherwise you have to exit from one
2691 before starting another).  In the most general case, you can have
2692 multiple threads of execution in each of multiple processes, launched
2693 from multiple executables.
2694
2695 @cindex inferior
2696 @value{GDBN} represents the state of each program execution with an
2697 object called an @dfn{inferior}.  An inferior typically corresponds to
2698 a process, but is more general and applies also to targets that do not
2699 have processes.  Inferiors may be created before a process runs, and
2700 may be retained after a process exits.  Inferiors have unique
2701 identifiers that are different from process ids.  Usually each
2702 inferior will also have its own distinct address space, although some
2703 embedded targets may have several inferiors running in different parts
2704 of a single address space.  Each inferior may in turn have multiple
2705 threads running in it.
2706
2707 To find out what inferiors exist at any moment, use @w{@code{info
2708 inferiors}}:
2709
2710 @table @code
2711 @kindex info inferiors
2712 @item info inferiors
2713 Print a list of all inferiors currently being managed by @value{GDBN}.
2714
2715 @value{GDBN} displays for each inferior (in this order):
2716
2717 @enumerate
2718 @item
2719 the inferior number assigned by @value{GDBN}
2720
2721 @item
2722 the target system's inferior identifier
2723
2724 @item
2725 the name of the executable the inferior is running.
2726
2727 @end enumerate
2728
2729 @noindent
2730 An asterisk @samp{*} preceding the @value{GDBN} inferior number
2731 indicates the current inferior.
2732
2733 For example,
2734 @end table
2735 @c end table here to get a little more width for example
2736
2737 @smallexample
2738 (@value{GDBP}) info inferiors
2739   Num  Description       Executable
2740   2    process 2307      hello
2741 * 1    process 3401      goodbye
2742 @end smallexample
2743
2744 To switch focus between inferiors, use the @code{inferior} command:
2745
2746 @table @code
2747 @kindex inferior @var{infno}
2748 @item inferior @var{infno}
2749 Make inferior number @var{infno} the current inferior.  The argument
2750 @var{infno} is the inferior number assigned by @value{GDBN}, as shown
2751 in the first field of the @samp{info inferiors} display.
2752 @end table
2753
2754 @vindex $_inferior@r{, convenience variable}
2755 The debugger convenience variable @samp{$_inferior} contains the
2756 number of the current inferior.  You may find this useful in writing
2757 breakpoint conditional expressions, command scripts, and so forth.
2758 @xref{Convenience Vars,, Convenience Variables}, for general
2759 information on convenience variables.
2760
2761 You can get multiple executables into a debugging session via the
2762 @code{add-inferior} and @w{@code{clone-inferior}} commands.  On some
2763 systems @value{GDBN} can add inferiors to the debug session
2764 automatically by following calls to @code{fork} and @code{exec}.  To
2765 remove inferiors from the debugging session use the
2766 @w{@code{remove-inferiors}} command.
2767
2768 @table @code
2769 @kindex add-inferior
2770 @item add-inferior [ -copies @var{n} ] [ -exec @var{executable} ]
2771 Adds @var{n} inferiors to be run using @var{executable} as the
2772 executable; @var{n} defaults to 1.  If no executable is specified,
2773 the inferiors begins empty, with no program.  You can still assign or
2774 change the program assigned to the inferior at any time by using the
2775 @code{file} command with the executable name as its argument.
2776
2777 @kindex clone-inferior
2778 @item clone-inferior [ -copies @var{n} ] [ @var{infno} ]
2779 Adds @var{n} inferiors ready to execute the same program as inferior
2780 @var{infno}; @var{n} defaults to 1, and @var{infno} defaults to the
2781 number of the current inferior.  This is a convenient command when you
2782 want to run another instance of the inferior you are debugging.
2783
2784 @smallexample
2785 (@value{GDBP}) info inferiors
2786   Num  Description       Executable
2787 * 1    process 29964     helloworld
2788 (@value{GDBP}) clone-inferior
2789 Added inferior 2.
2790 1 inferiors added.
2791 (@value{GDBP}) info inferiors
2792   Num  Description       Executable
2793   2    <null>            helloworld
2794 * 1    process 29964     helloworld
2795 @end smallexample
2796
2797 You can now simply switch focus to inferior 2 and run it.
2798
2799 @kindex remove-inferiors
2800 @item remove-inferiors @var{infno}@dots{}
2801 Removes the inferior or inferiors @var{infno}@dots{}.  It is not
2802 possible to remove an inferior that is running with this command.  For
2803 those, use the @code{kill} or @code{detach} command first.
2804
2805 @end table
2806
2807 To quit debugging one of the running inferiors that is not the current
2808 inferior, you can either detach from it by using the @w{@code{detach
2809 inferior}} command (allowing it to run independently), or kill it
2810 using the @w{@code{kill inferiors}} command:
2811
2812 @table @code
2813 @kindex detach inferiors @var{infno}@dots{}
2814 @item detach inferior @var{infno}@dots{}
2815 Detach from the inferior or inferiors identified by @value{GDBN}
2816 inferior number(s) @var{infno}@dots{}.  Note that the inferior's entry
2817 still stays on the list of inferiors shown by @code{info inferiors},
2818 but its Description will show @samp{<null>}.
2819
2820 @kindex kill inferiors @var{infno}@dots{}
2821 @item kill inferiors @var{infno}@dots{}
2822 Kill the inferior or inferiors identified by @value{GDBN} inferior
2823 number(s) @var{infno}@dots{}.  Note that the inferior's entry still
2824 stays on the list of inferiors shown by @code{info inferiors}, but its
2825 Description will show @samp{<null>}.
2826 @end table
2827
2828 After the successful completion of a command such as @code{detach},
2829 @code{detach inferiors}, @code{kill} or @code{kill inferiors}, or after
2830 a normal process exit, the inferior is still valid and listed with
2831 @code{info inferiors}, ready to be restarted.
2832
2833
2834 To be notified when inferiors are started or exit under @value{GDBN}'s
2835 control use @w{@code{set print inferior-events}}:
2836
2837 @table @code
2838 @kindex set print inferior-events
2839 @cindex print messages on inferior start and exit
2840 @item set print inferior-events
2841 @itemx set print inferior-events on
2842 @itemx set print inferior-events off
2843 The @code{set print inferior-events} command allows you to enable or
2844 disable printing of messages when @value{GDBN} notices that new
2845 inferiors have started or that inferiors have exited or have been
2846 detached.  By default, these messages will not be printed.
2847
2848 @kindex show print inferior-events
2849 @item show print inferior-events
2850 Show whether messages will be printed when @value{GDBN} detects that
2851 inferiors have started, exited or have been detached.
2852 @end table
2853
2854 Many commands will work the same with multiple programs as with a
2855 single program: e.g., @code{print myglobal} will simply display the
2856 value of @code{myglobal} in the current inferior.
2857
2858
2859 Occasionaly, when debugging @value{GDBN} itself, it may be useful to
2860 get more info about the relationship of inferiors, programs, address
2861 spaces in a debug session.  You can do that with the @w{@code{maint
2862 info program-spaces}} command.
2863
2864 @table @code
2865 @kindex maint info program-spaces
2866 @item maint info program-spaces
2867 Print a list of all program spaces currently being managed by
2868 @value{GDBN}.
2869
2870 @value{GDBN} displays for each program space (in this order):
2871
2872 @enumerate
2873 @item
2874 the program space number assigned by @value{GDBN}
2875
2876 @item
2877 the name of the executable loaded into the program space, with e.g.,
2878 the @code{file} command.
2879
2880 @end enumerate
2881
2882 @noindent
2883 An asterisk @samp{*} preceding the @value{GDBN} program space number
2884 indicates the current program space.
2885
2886 In addition, below each program space line, @value{GDBN} prints extra
2887 information that isn't suitable to display in tabular form.  For
2888 example, the list of inferiors bound to the program space.
2889
2890 @smallexample
2891 (@value{GDBP}) maint info program-spaces
2892   Id   Executable
2893 * 1    hello
2894   2    goodbye
2895         Bound inferiors: ID 1 (process 21561)
2896 @end smallexample
2897
2898 Here we can see that no inferior is running the program @code{hello},
2899 while @code{process 21561} is running the program @code{goodbye}.  On
2900 some targets, it is possible that multiple inferiors are bound to the
2901 same program space.  The most common example is that of debugging both
2902 the parent and child processes of a @code{vfork} call.  For example,
2903
2904 @smallexample
2905 (@value{GDBP}) maint info program-spaces
2906   Id   Executable
2907 * 1    vfork-test
2908         Bound inferiors: ID 2 (process 18050), ID 1 (process 18045)
2909 @end smallexample
2910
2911 Here, both inferior 2 and inferior 1 are running in the same program
2912 space as a result of inferior 1 having executed a @code{vfork} call.
2913 @end table
2914
2915 @node Threads
2916 @section Debugging Programs with Multiple Threads
2917
2918 @cindex threads of execution
2919 @cindex multiple threads
2920 @cindex switching threads
2921 In some operating systems, such as GNU/Linux and Solaris, a single program
2922 may have more than one @dfn{thread} of execution.  The precise semantics
2923 of threads differ from one operating system to another, but in general
2924 the threads of a single program are akin to multiple processes---except
2925 that they share one address space (that is, they can all examine and
2926 modify the same variables).  On the other hand, each thread has its own
2927 registers and execution stack, and perhaps private memory.
2928
2929 @value{GDBN} provides these facilities for debugging multi-thread
2930 programs:
2931
2932 @itemize @bullet
2933 @item automatic notification of new threads
2934 @item @samp{thread @var{thread-id}}, a command to switch among threads
2935 @item @samp{info threads}, a command to inquire about existing threads
2936 @item @samp{thread apply [@var{thread-id-list}] [@var{all}] @var{args}},
2937 a command to apply a command to a list of threads
2938 @item thread-specific breakpoints
2939 @item @samp{set print thread-events}, which controls printing of 
2940 messages on thread start and exit.
2941 @item @samp{set libthread-db-search-path @var{path}}, which lets
2942 the user specify which @code{libthread_db} to use if the default choice
2943 isn't compatible with the program.
2944 @end itemize
2945
2946 @cindex focus of debugging
2947 @cindex current thread
2948 The @value{GDBN} thread debugging facility allows you to observe all
2949 threads while your program runs---but whenever @value{GDBN} takes
2950 control, one thread in particular is always the focus of debugging.
2951 This thread is called the @dfn{current thread}.  Debugging commands show
2952 program information from the perspective of the current thread.
2953
2954 @cindex @code{New} @var{systag} message
2955 @cindex thread identifier (system)
2956 @c FIXME-implementors!! It would be more helpful if the [New...] message
2957 @c included GDB's numeric thread handle, so you could just go to that
2958 @c thread without first checking `info threads'.
2959 Whenever @value{GDBN} detects a new thread in your program, it displays
2960 the target system's identification for the thread with a message in the
2961 form @samp{[New @var{systag}]}, where @var{systag} is a thread identifier
2962 whose form varies depending on the particular system.  For example, on
2963 @sc{gnu}/Linux, you might see
2964
2965 @smallexample
2966 [New Thread 0x41e02940 (LWP 25582)]
2967 @end smallexample
2968
2969 @noindent
2970 when @value{GDBN} notices a new thread.  In contrast, on other systems,
2971 the @var{systag} is simply something like @samp{process 368}, with no
2972 further qualifier.
2973
2974 @c FIXME!! (1) Does the [New...] message appear even for the very first
2975 @c         thread of a program, or does it only appear for the
2976 @c         second---i.e.@: when it becomes obvious we have a multithread
2977 @c         program?
2978 @c         (2) *Is* there necessarily a first thread always?  Or do some
2979 @c         multithread systems permit starting a program with multiple
2980 @c         threads ab initio?
2981
2982 @anchor{thread numbers}
2983 @cindex thread number, per inferior
2984 @cindex thread identifier (GDB)
2985 For debugging purposes, @value{GDBN} associates its own thread number
2986 ---always a single integer---with each thread of an inferior.  This
2987 number is unique between all threads of an inferior, but not unique
2988 between threads of different inferiors.
2989
2990 @cindex qualified thread ID
2991 You can refer to a given thread in an inferior using the qualified
2992 @var{inferior-num}.@var{thread-num} syntax, also known as
2993 @dfn{qualified thread ID}, with @var{inferior-num} being the inferior
2994 number and @var{thread-num} being the thread number of the given
2995 inferior.  For example, thread @code{2.3} refers to thread number 3 of
2996 inferior 2.  If you omit @var{inferior-num} (e.g., @code{thread 3}),
2997 then @value{GDBN} infers you're referring to a thread of the current
2998 inferior.
2999
3000 Until you create a second inferior, @value{GDBN} does not show the
3001 @var{inferior-num} part of thread IDs, even though you can always use
3002 the full @var{inferior-num}.@var{thread-num} form to refer to threads
3003 of inferior 1, the initial inferior.
3004
3005 @anchor{thread ID lists}
3006 @cindex thread ID lists
3007 Some commands accept a space-separated @dfn{thread ID list} as
3008 argument.  A list element can be:
3009
3010 @enumerate
3011 @item
3012 A thread ID as shown in the first field of the @samp{info threads}
3013 display, with or without an inferior qualifier.  E.g., @samp{2.1} or
3014 @samp{1}.
3015
3016 @item
3017 A range of thread numbers, again with or without an inferior
3018 qualifier, as in @var{inf}.@var{thr1}-@var{thr2} or
3019 @var{thr1}-@var{thr2}.  E.g., @samp{1.2-4} or @samp{2-4}.
3020
3021 @item
3022 All threads of an inferior, specified with a star wildcard, with or
3023 without an inferior qualifier, as in @var{inf}.@code{*} (e.g.,
3024 @samp{1.*}) or @code{*}.  The former refers to all threads of the
3025 given inferior, and the latter form without an inferior qualifier
3026 refers to all threads of the current inferior.
3027
3028 @end enumerate
3029
3030 For example, if the current inferior is 1, and inferior 7 has one
3031 thread with ID 7.1, the thread list @samp{1 2-3 4.5 6.7-9 7.*}
3032 includes threads 1 to 3 of inferior 1, thread 5 of inferior 4, threads
3033 7 to 9 of inferior 6 and all threads of inferior 7.  That is, in
3034 expanded qualified form, the same as @samp{1.1 1.2 1.3 4.5 6.7 6.8 6.9
3035 7.1}.
3036
3037
3038 @anchor{global thread numbers}
3039 @cindex global thread number
3040 @cindex global thread identifier (GDB)
3041 In addition to a @emph{per-inferior} number, each thread is also
3042 assigned a unique @emph{global} number, also known as @dfn{global
3043 thread ID}, a single integer.  Unlike the thread number component of
3044 the thread ID, no two threads have the same global ID, even when
3045 you're debugging multiple inferiors.
3046
3047 From @value{GDBN}'s perspective, a process always has at least one
3048 thread.  In other words, @value{GDBN} assigns a thread number to the
3049 program's ``main thread'' even if the program is not multi-threaded.
3050
3051 @vindex $_thread@r{, convenience variable}
3052 @vindex $_gthread@r{, convenience variable}
3053 The debugger convenience variables @samp{$_thread} and
3054 @samp{$_gthread} contain, respectively, the per-inferior thread number
3055 and the global thread number of the current thread.  You may find this
3056 useful in writing breakpoint conditional expressions, command scripts,
3057 and so forth.  @xref{Convenience Vars,, Convenience Variables}, for
3058 general information on convenience variables.
3059
3060 If @value{GDBN} detects the program is multi-threaded, it augments the
3061 usual message about stopping at a breakpoint with the ID and name of
3062 the thread that hit the breakpoint.
3063
3064 @smallexample
3065 Thread 2 "client" hit Breakpoint 1, send_message () at client.c:68
3066 @end smallexample
3067
3068 Likewise when the program receives a signal:
3069
3070 @smallexample
3071 Thread 1 "main" received signal SIGINT, Interrupt.
3072 @end smallexample
3073
3074 @table @code
3075 @kindex info threads
3076 @item info threads @r{[}@var{thread-id-list}@r{]}
3077
3078 Display information about one or more threads.  With no arguments
3079 displays information about all threads.  You can specify the list of
3080 threads that you want to display using the thread ID list syntax
3081 (@pxref{thread ID lists}).
3082
3083 @value{GDBN} displays for each thread (in this order):
3084
3085 @enumerate
3086 @item
3087 the per-inferior thread number assigned by @value{GDBN}
3088
3089 @item
3090 the global thread number assigned by @value{GDBN}, if the @samp{-gid}
3091 option was specified
3092
3093 @item
3094 the target system's thread identifier (@var{systag})
3095
3096 @item
3097 the thread's name, if one is known.  A thread can either be named by
3098 the user (see @code{thread name}, below), or, in some cases, by the
3099 program itself.
3100
3101 @item
3102 the current stack frame summary for that thread
3103 @end enumerate
3104
3105 @noindent
3106 An asterisk @samp{*} to the left of the @value{GDBN} thread number
3107 indicates the current thread.
3108
3109 For example,
3110 @end table
3111 @c end table here to get a little more width for example
3112
3113 @smallexample
3114 (@value{GDBP}) info threads
3115   Id   Target Id         Frame
3116 * 1    process 35 thread 13  main (argc=1, argv=0x7ffffff8)
3117   2    process 35 thread 23  0x34e5 in sigpause ()
3118   3    process 35 thread 27  0x34e5 in sigpause ()
3119     at threadtest.c:68
3120 @end smallexample
3121
3122 If you're debugging multiple inferiors, @value{GDBN} displays thread
3123 IDs using the qualified @var{inferior-num}.@var{thread-num} format.
3124 Otherwise, only @var{thread-num} is shown.
3125
3126 If you specify the @samp{-gid} option, @value{GDBN} displays a column
3127 indicating each thread's global thread ID:
3128
3129 @smallexample
3130 (@value{GDBP}) info threads
3131   Id   GId  Target Id             Frame
3132   1.1  1    process 35 thread 13  main (argc=1, argv=0x7ffffff8)
3133   1.2  3    process 35 thread 23  0x34e5 in sigpause ()
3134   1.3  4    process 35 thread 27  0x34e5 in sigpause ()
3135 * 2.1  2    process 65 thread 1   main (argc=1, argv=0x7ffffff8)
3136 @end smallexample
3137
3138 On Solaris, you can display more information about user threads with a
3139 Solaris-specific command:
3140
3141 @table @code
3142 @item maint info sol-threads
3143 @kindex maint info sol-threads
3144 @cindex thread info (Solaris)
3145 Display info on Solaris user threads.
3146 @end table
3147
3148 @table @code
3149 @kindex thread @var{thread-id}
3150 @item thread @var{thread-id}
3151 Make thread ID @var{thread-id} the current thread.  The command
3152 argument @var{thread-id} is the @value{GDBN} thread ID, as shown in
3153 the first field of the @samp{info threads} display, with or without an
3154 inferior qualifier (e.g., @samp{2.1} or @samp{1}).
3155
3156 @value{GDBN} responds by displaying the system identifier of the
3157 thread you selected, and its current stack frame summary:
3158
3159 @smallexample
3160 (@value{GDBP}) thread 2
3161 [Switching to thread 2 (Thread 0xb7fdab70 (LWP 12747))]
3162 #0  some_function (ignore=0x0) at example.c:8
3163 8           printf ("hello\n");
3164 @end smallexample
3165
3166 @noindent
3167 As with the @samp{[New @dots{}]} message, the form of the text after
3168 @samp{Switching to} depends on your system's conventions for identifying
3169 threads.
3170
3171 @kindex thread apply
3172 @cindex apply command to several threads
3173 @item thread apply [@var{thread-id-list} | all [-ascending]] @var{command}
3174 The @code{thread apply} command allows you to apply the named
3175 @var{command} to one or more threads.  Specify the threads that you
3176 want affected using the thread ID list syntax (@pxref{thread ID
3177 lists}), or specify @code{all} to apply to all threads.  To apply a
3178 command to all threads in descending order, type @kbd{thread apply all
3179 @var{command}}.  To apply a command to all threads in ascending order,
3180 type @kbd{thread apply all -ascending @var{command}}.
3181
3182
3183 @kindex thread name
3184 @cindex name a thread
3185 @item thread name [@var{name}]
3186 This command assigns a name to the current thread.  If no argument is
3187 given, any existing user-specified name is removed.  The thread name
3188 appears in the @samp{info threads} display.
3189
3190 On some systems, such as @sc{gnu}/Linux, @value{GDBN} is able to
3191 determine the name of the thread as given by the OS.  On these
3192 systems, a name specified with @samp{thread name} will override the
3193 system-give name, and removing the user-specified name will cause
3194 @value{GDBN} to once again display the system-specified name.
3195
3196 @kindex thread find
3197 @cindex search for a thread
3198 @item thread find [@var{regexp}]
3199 Search for and display thread ids whose name or @var{systag}
3200 matches the supplied regular expression.
3201
3202 As well as being the complement to the @samp{thread name} command, 
3203 this command also allows you to identify a thread by its target 
3204 @var{systag}.  For instance, on @sc{gnu}/Linux, the target @var{systag}
3205 is the LWP id.
3206
3207 @smallexample
3208 (@value{GDBN}) thread find 26688
3209 Thread 4 has target id 'Thread 0x41e02940 (LWP 26688)'
3210 (@value{GDBN}) info thread 4
3211   Id   Target Id         Frame 
3212   4    Thread 0x41e02940 (LWP 26688) 0x00000031ca6cd372 in select ()
3213 @end smallexample
3214
3215 @kindex set print thread-events
3216 @cindex print messages on thread start and exit
3217 @item set print thread-events
3218 @itemx set print thread-events on
3219 @itemx set print thread-events off
3220 The @code{set print thread-events} command allows you to enable or
3221 disable printing of messages when @value{GDBN} notices that new threads have
3222 started or that threads have exited.  By default, these messages will
3223 be printed if detection of these events is supported by the target.
3224 Note that these messages cannot be disabled on all targets.
3225
3226 @kindex show print thread-events
3227 @item show print thread-events
3228 Show whether messages will be printed when @value{GDBN} detects that threads
3229 have started and exited.
3230 @end table
3231
3232 @xref{Thread Stops,,Stopping and Starting Multi-thread Programs}, for
3233 more information about how @value{GDBN} behaves when you stop and start
3234 programs with multiple threads.
3235
3236 @xref{Set Watchpoints,,Setting Watchpoints}, for information about
3237 watchpoints in programs with multiple threads.
3238
3239 @anchor{set libthread-db-search-path}
3240 @table @code
3241 @kindex set libthread-db-search-path
3242 @cindex search path for @code{libthread_db}
3243 @item set libthread-db-search-path @r{[}@var{path}@r{]}
3244 If this variable is set, @var{path} is a colon-separated list of
3245 directories @value{GDBN} will use to search for @code{libthread_db}.
3246 If you omit @var{path}, @samp{libthread-db-search-path} will be reset to
3247 its default value (@code{$sdir:$pdir} on @sc{gnu}/Linux and Solaris systems).
3248 Internally, the default value comes from the @code{LIBTHREAD_DB_SEARCH_PATH}
3249 macro.
3250
3251 On @sc{gnu}/Linux and Solaris systems, @value{GDBN} uses a ``helper''
3252 @code{libthread_db} library to obtain information about threads in the
3253 inferior process.  @value{GDBN} will use @samp{libthread-db-search-path}
3254 to find @code{libthread_db}.  @value{GDBN} also consults first if inferior
3255 specific thread debugging library loading is enabled
3256 by @samp{set auto-load libthread-db} (@pxref{libthread_db.so.1 file}).
3257
3258 A special entry @samp{$sdir} for @samp{libthread-db-search-path}
3259 refers to the default system directories that are
3260 normally searched for loading shared libraries.  The @samp{$sdir} entry
3261 is the only kind not needing to be enabled by @samp{set auto-load libthread-db}
3262 (@pxref{libthread_db.so.1 file}).
3263
3264 A special entry @samp{$pdir} for @samp{libthread-db-search-path}
3265 refers to the directory from which @code{libpthread}
3266 was loaded in the inferior process.
3267
3268 For any @code{libthread_db} library @value{GDBN} finds in above directories,
3269 @value{GDBN} attempts to initialize it with the current inferior process.
3270 If this initialization fails (which could happen because of a version
3271 mismatch between @code{libthread_db} and @code{libpthread}), @value{GDBN}
3272 will unload @code{libthread_db}, and continue with the next directory.
3273 If none of @code{libthread_db} libraries initialize successfully,
3274 @value{GDBN} will issue a warning and thread debugging will be disabled.
3275
3276 Setting @code{libthread-db-search-path} is currently implemented
3277 only on some platforms.
3278
3279 @kindex show libthread-db-search-path 
3280 @item show libthread-db-search-path 
3281 Display current libthread_db search path.
3282
3283 @kindex set debug libthread-db
3284 @kindex show debug libthread-db
3285 @cindex debugging @code{libthread_db}
3286 @item set debug libthread-db
3287 @itemx show debug libthread-db
3288 Turns on or off display of @code{libthread_db}-related events.
3289 Use @code{1} to enable, @code{0} to disable.
3290 @end table
3291
3292 @node Forks
3293 @section Debugging Forks
3294
3295 @cindex fork, debugging programs which call
3296 @cindex multiple processes
3297 @cindex processes, multiple
3298 On most systems, @value{GDBN} has no special support for debugging
3299 programs which create additional processes using the @code{fork}
3300 function.  When a program forks, @value{GDBN} will continue to debug the
3301 parent process and the child process will run unimpeded.  If you have
3302 set a breakpoint in any code which the child then executes, the child
3303 will get a @code{SIGTRAP} signal which (unless it catches the signal)
3304 will cause it to terminate.
3305
3306 However, if you want to debug the child process there is a workaround
3307 which isn't too painful.  Put a call to @code{sleep} in the code which
3308 the child process executes after the fork.  It may be useful to sleep
3309 only if a certain environment variable is set, or a certain file exists,
3310 so that the delay need not occur when you don't want to run @value{GDBN}
3311 on the child.  While the child is sleeping, use the @code{ps} program to
3312 get its process ID.  Then tell @value{GDBN} (a new invocation of
3313 @value{GDBN} if you are also debugging the parent process) to attach to
3314 the child process (@pxref{Attach}).  From that point on you can debug
3315 the child process just like any other process which you attached to.
3316
3317 On some systems, @value{GDBN} provides support for debugging programs
3318 that create additional processes using the @code{fork} or @code{vfork}
3319 functions.  On @sc{gnu}/Linux platforms, this feature is supported
3320 with kernel version 2.5.46 and later.
3321
3322 The fork debugging commands are supported in native mode and when
3323 connected to @code{gdbserver} in either @code{target remote} mode or
3324 @code{target extended-remote} mode.
3325
3326 By default, when a program forks, @value{GDBN} will continue to debug
3327 the parent process and the child process will run unimpeded.
3328
3329 If you want to follow the child process instead of the parent process,
3330 use the command @w{@code{set follow-fork-mode}}.
3331
3332 @table @code
3333 @kindex set follow-fork-mode
3334 @item set follow-fork-mode @var{mode}
3335 Set the debugger response to a program call of @code{fork} or
3336 @code{vfork}.  A call to @code{fork} or @code{vfork} creates a new
3337 process.  The @var{mode} argument can be:
3338
3339 @table @code
3340 @item parent
3341 The original process is debugged after a fork.  The child process runs
3342 unimpeded.  This is the default.
3343
3344 @item child
3345 The new process is debugged after a fork.  The parent process runs
3346 unimpeded.
3347
3348 @end table
3349
3350 @kindex show follow-fork-mode
3351 @item show follow-fork-mode
3352 Display the current debugger response to a @code{fork} or @code{vfork} call.
3353 @end table
3354
3355 @cindex debugging multiple processes
3356 On Linux, if you want to debug both the parent and child processes, use the
3357 command @w{@code{set detach-on-fork}}.
3358
3359 @table @code
3360 @kindex set detach-on-fork
3361 @item set detach-on-fork @var{mode}
3362 Tells gdb whether to detach one of the processes after a fork, or
3363 retain debugger control over them both.
3364
3365 @table @code
3366 @item on
3367 The child process (or parent process, depending on the value of
3368 @code{follow-fork-mode}) will be detached and allowed to run 
3369 independently.  This is the default.
3370
3371 @item off
3372 Both processes will be held under the control of @value{GDBN}.
3373 One process (child or parent, depending on the value of 
3374 @code{follow-fork-mode}) is debugged as usual, while the other
3375 is held suspended.  
3376
3377 @end table
3378
3379 @kindex show detach-on-fork
3380 @item show detach-on-fork
3381 Show whether detach-on-fork mode is on/off.
3382 @end table
3383
3384 If you choose to set @samp{detach-on-fork} mode off, then @value{GDBN}
3385 will retain control of all forked processes (including nested forks).
3386 You can list the forked processes under the control of @value{GDBN} by
3387 using the @w{@code{info inferiors}} command, and switch from one fork
3388 to another by using the @code{inferior} command (@pxref{Inferiors and
3389 Programs, ,Debugging Multiple Inferiors and Programs}).
3390
3391 To quit debugging one of the forked processes, you can either detach
3392 from it by using the @w{@code{detach inferiors}} command (allowing it
3393 to run independently), or kill it using the @w{@code{kill inferiors}}
3394 command.  @xref{Inferiors and Programs, ,Debugging Multiple Inferiors
3395 and Programs}.
3396
3397 If you ask to debug a child process and a @code{vfork} is followed by an
3398 @code{exec}, @value{GDBN} executes the new target up to the first
3399 breakpoint in the new target.  If you have a breakpoint set on
3400 @code{main} in your original program, the breakpoint will also be set on
3401 the child process's @code{main}.
3402
3403 On some systems, when a child process is spawned by @code{vfork}, you
3404 cannot debug the child or parent until an @code{exec} call completes.
3405
3406 If you issue a @code{run} command to @value{GDBN} after an @code{exec}
3407 call executes, the new target restarts.  To restart the parent
3408 process, use the @code{file} command with the parent executable name
3409 as its argument.  By default, after an @code{exec} call executes,
3410 @value{GDBN} discards the symbols of the previous executable image.
3411 You can change this behaviour with the @w{@code{set follow-exec-mode}}
3412 command.
3413
3414 @table @code
3415 @kindex set follow-exec-mode
3416 @item set follow-exec-mode @var{mode}
3417
3418 Set debugger response to a program call of @code{exec}.  An
3419 @code{exec} call replaces the program image of a process.
3420
3421 @code{follow-exec-mode} can be:
3422
3423 @table @code
3424 @item new
3425 @value{GDBN} creates a new inferior and rebinds the process to this
3426 new inferior.  The program the process was running before the
3427 @code{exec} call can be restarted afterwards by restarting the
3428 original inferior.
3429
3430 For example:
3431
3432 @smallexample
3433 (@value{GDBP}) info inferiors
3434 (gdb) info inferior
3435   Id   Description   Executable
3436 * 1    <null>        prog1
3437 (@value{GDBP}) run
3438 process 12020 is executing new program: prog2
3439 Program exited normally.
3440 (@value{GDBP}) info inferiors
3441   Id   Description   Executable
3442   1    <null>        prog1
3443 * 2    <null>        prog2
3444 @end smallexample
3445
3446 @item same
3447 @value{GDBN} keeps the process bound to the same inferior.  The new
3448 executable image replaces the previous executable loaded in the
3449 inferior.  Restarting the inferior after the @code{exec} call, with
3450 e.g., the @code{run} command, restarts the executable the process was
3451 running after the @code{exec} call.  This is the default mode.
3452
3453 For example:
3454
3455 @smallexample
3456 (@value{GDBP}) info inferiors
3457   Id   Description   Executable
3458 * 1    <null>        prog1
3459 (@value{GDBP}) run
3460 process 12020 is executing new program: prog2
3461 Program exited normally.
3462 (@value{GDBP}) info inferiors
3463   Id   Description   Executable
3464 * 1    <null>        prog2
3465 @end smallexample
3466
3467 @end table
3468 @end table
3469
3470 @code{follow-exec-mode} is supported in native mode and
3471 @code{target extended-remote} mode.
3472
3473 You can use the @code{catch} command to make @value{GDBN} stop whenever
3474 a @code{fork}, @code{vfork}, or @code{exec} call is made.  @xref{Set
3475 Catchpoints, ,Setting Catchpoints}.
3476
3477 @node Checkpoint/Restart
3478 @section Setting a @emph{Bookmark} to Return to Later
3479
3480 @cindex checkpoint
3481 @cindex restart
3482 @cindex bookmark
3483 @cindex snapshot of a process
3484 @cindex rewind program state
3485
3486 On certain operating systems@footnote{Currently, only
3487 @sc{gnu}/Linux.}, @value{GDBN} is able to save a @dfn{snapshot} of a
3488 program's state, called a @dfn{checkpoint}, and come back to it
3489 later.
3490
3491 Returning to a checkpoint effectively undoes everything that has
3492 happened in the program since the @code{checkpoint} was saved.  This
3493 includes changes in memory, registers, and even (within some limits)
3494 system state.  Effectively, it is like going back in time to the
3495 moment when the checkpoint was saved.
3496
3497 Thus, if you're stepping thru a program and you think you're 
3498 getting close to the point where things go wrong, you can save
3499 a checkpoint.  Then, if you accidentally go too far and miss
3500 the critical statement, instead of having to restart your program
3501 from the beginning, you can just go back to the checkpoint and
3502 start again from there.
3503
3504 This can be especially useful if it takes a lot of time or 
3505 steps to reach the point where you think the bug occurs.  
3506
3507 To use the @code{checkpoint}/@code{restart} method of debugging:
3508
3509 @table @code
3510 @kindex checkpoint
3511 @item checkpoint
3512 Save a snapshot of the debugged program's current execution state.
3513 The @code{checkpoint} command takes no arguments, but each checkpoint
3514 is assigned a small integer id, similar to a breakpoint id.
3515
3516 @kindex info checkpoints
3517 @item info checkpoints
3518 List the checkpoints that have been saved in the current debugging
3519 session.  For each checkpoint, the following information will be
3520 listed:
3521
3522 @table @code
3523 @item Checkpoint ID
3524 @item Process ID
3525 @item Code Address
3526 @item Source line, or label
3527 @end table
3528
3529 @kindex restart @var{checkpoint-id}
3530 @item restart @var{checkpoint-id}
3531 Restore the program state that was saved as checkpoint number
3532 @var{checkpoint-id}.  All program variables, registers, stack frames
3533 etc.@:  will be returned to the values that they had when the checkpoint
3534 was saved.  In essence, gdb will ``wind back the clock'' to the point
3535 in time when the checkpoint was saved.
3536
3537 Note that breakpoints, @value{GDBN} variables, command history etc.
3538 are not affected by restoring a checkpoint.  In general, a checkpoint
3539 only restores things that reside in the program being debugged, not in
3540 the debugger.
3541
3542 @kindex delete checkpoint @var{checkpoint-id}
3543 @item delete checkpoint @var{checkpoint-id}
3544 Delete the previously-saved checkpoint identified by @var{checkpoint-id}.
3545
3546 @end table
3547
3548 Returning to a previously saved checkpoint will restore the user state
3549 of the program being debugged, plus a significant subset of the system
3550 (OS) state, including file pointers.  It won't ``un-write'' data from
3551 a file, but it will rewind the file pointer to the previous location,
3552 so that the previously written data can be overwritten.  For files
3553 opened in read mode, the pointer will also be restored so that the
3554 previously read data can be read again.
3555
3556 Of course, characters that have been sent to a printer (or other
3557 external device) cannot be ``snatched back'', and characters received
3558 from eg.@: a serial device can be removed from internal program buffers,
3559 but they cannot be ``pushed back'' into the serial pipeline, ready to
3560 be received again.  Similarly, the actual contents of files that have
3561 been changed cannot be restored (at this time).
3562
3563 However, within those constraints, you actually can ``rewind'' your
3564 program to a previously saved point in time, and begin debugging it
3565 again --- and you can change the course of events so as to debug a
3566 different execution path this time.
3567
3568 @cindex checkpoints and process id
3569 Finally, there is one bit of internal program state that will be
3570 different when you return to a checkpoint --- the program's process
3571 id.  Each checkpoint will have a unique process id (or @var{pid}), 
3572 and each will be different from the program's original @var{pid}.
3573 If your program has saved a local copy of its process id, this could
3574 potentially pose a problem.
3575
3576 @subsection A Non-obvious Benefit of Using Checkpoints
3577
3578 On some systems such as @sc{gnu}/Linux, address space randomization
3579 is performed on new processes for security reasons.  This makes it 
3580 difficult or impossible to set a breakpoint, or watchpoint, on an
3581 absolute address if you have to restart the program, since the 
3582 absolute location of a symbol will change from one execution to the
3583 next.
3584
3585 A checkpoint, however, is an @emph{identical} copy of a process. 
3586 Therefore if you create a checkpoint at (eg.@:) the start of main, 
3587 and simply return to that checkpoint instead of restarting the 
3588 process, you can avoid the effects of address randomization and
3589 your symbols will all stay in the same place.
3590
3591 @node Stopping
3592 @chapter Stopping and Continuing
3593
3594 The principal purposes of using a debugger are so that you can stop your
3595 program before it terminates; or so that, if your program runs into
3596 trouble, you can investigate and find out why.
3597
3598 Inside @value{GDBN}, your program may stop for any of several reasons,
3599 such as a signal, a breakpoint, or reaching a new line after a
3600 @value{GDBN} command such as @code{step}.  You may then examine and
3601 change variables, set new breakpoints or remove old ones, and then
3602 continue execution.  Usually, the messages shown by @value{GDBN} provide
3603 ample explanation of the status of your program---but you can also
3604 explicitly request this information at any time.
3605
3606 @table @code
3607 @kindex info program
3608 @item info program
3609 Display information about the status of your program: whether it is
3610 running or not, what process it is, and why it stopped.
3611 @end table
3612
3613 @menu
3614 * Breakpoints::                 Breakpoints, watchpoints, and catchpoints
3615 * Continuing and Stepping::     Resuming execution
3616 * Skipping Over Functions and Files::
3617                                 Skipping over functions and files
3618 * Signals::                     Signals
3619 * Thread Stops::                Stopping and starting multi-thread programs
3620 @end menu
3621
3622 @node Breakpoints
3623 @section Breakpoints, Watchpoints, and Catchpoints
3624
3625 @cindex breakpoints
3626 A @dfn{breakpoint} makes your program stop whenever a certain point in
3627 the program is reached.  For each breakpoint, you can add conditions to
3628 control in finer detail whether your program stops.  You can set
3629 breakpoints with the @code{break} command and its variants (@pxref{Set
3630 Breaks, ,Setting Breakpoints}), to specify the place where your program
3631 should stop by line number, function name or exact address in the
3632 program.
3633
3634 On some systems, you can set breakpoints in shared libraries before
3635 the executable is run.
3636
3637 @cindex watchpoints
3638 @cindex data breakpoints
3639 @cindex memory tracing
3640 @cindex breakpoint on memory address
3641 @cindex breakpoint on variable modification
3642 A @dfn{watchpoint} is a special breakpoint that stops your program
3643 when the value of an expression changes.  The expression may be a value
3644 of a variable, or it could involve values of one or more variables
3645 combined by operators, such as @samp{a + b}.  This is sometimes called
3646 @dfn{data breakpoints}.  You must use a different command to set
3647 watchpoints (@pxref{Set Watchpoints, ,Setting Watchpoints}), but aside
3648 from that, you can manage a watchpoint like any other breakpoint: you
3649 enable, disable, and delete both breakpoints and watchpoints using the
3650 same commands.
3651
3652 You can arrange to have values from your program displayed automatically
3653 whenever @value{GDBN} stops at a breakpoint.  @xref{Auto Display,,
3654 Automatic Display}.
3655
3656 @cindex catchpoints
3657 @cindex breakpoint on events
3658 A @dfn{catchpoint} is another special breakpoint that stops your program
3659 when a certain kind of event occurs, such as the throwing of a C@t{++}
3660 exception or the loading of a library.  As with watchpoints, you use a
3661 different command to set a catchpoint (@pxref{Set Catchpoints, ,Setting
3662 Catchpoints}), but aside from that, you can manage a catchpoint like any
3663 other breakpoint.  (To stop when your program receives a signal, use the
3664 @code{handle} command; see @ref{Signals, ,Signals}.)
3665
3666 @cindex breakpoint numbers
3667 @cindex numbers for breakpoints
3668 @value{GDBN} assigns a number to each breakpoint, watchpoint, or
3669 catchpoint when you create it; these numbers are successive integers
3670 starting with one.  In many of the commands for controlling various
3671 features of breakpoints you use the breakpoint number to say which
3672 breakpoint you want to change.  Each breakpoint may be @dfn{enabled} or
3673 @dfn{disabled}; if disabled, it has no effect on your program until you
3674 enable it again.
3675
3676 @cindex breakpoint ranges
3677 @cindex breakpoint lists
3678 @cindex ranges of breakpoints
3679 @cindex lists of breakpoints
3680 Some @value{GDBN} commands accept a space-separated list of breakpoints
3681 on which to operate.  A list element can be either a single breakpoint number,
3682 like @samp{5}, or a range of such numbers, like @samp{5-7}.
3683 When a breakpoint list is given to a command, all breakpoints in that list
3684 are operated on.
3685
3686 @menu
3687 * Set Breaks::                  Setting breakpoints
3688 * Set Watchpoints::             Setting watchpoints
3689 * Set Catchpoints::             Setting catchpoints
3690 * Delete Breaks::               Deleting breakpoints
3691 * Disabling::                   Disabling breakpoints
3692 * Conditions::                  Break conditions
3693 * Break Commands::              Breakpoint command lists
3694 * Dynamic Printf::              Dynamic printf
3695 * Save Breakpoints::            How to save breakpoints in a file
3696 * Static Probe Points::         Listing static probe points
3697 * Error in Breakpoints::        ``Cannot insert breakpoints''
3698 * Breakpoint-related Warnings:: ``Breakpoint address adjusted...''
3699 @end menu
3700
3701 @node Set Breaks
3702 @subsection Setting Breakpoints
3703
3704 @c FIXME LMB what does GDB do if no code on line of breakpt?
3705 @c       consider in particular declaration with/without initialization.
3706 @c
3707 @c FIXME 2 is there stuff on this already? break at fun start, already init?
3708
3709 @kindex break
3710 @kindex b @r{(@code{break})}
3711 @vindex $bpnum@r{, convenience variable}
3712 @cindex latest breakpoint
3713 Breakpoints are set with the @code{break} command (abbreviated
3714 @code{b}).  The debugger convenience variable @samp{$bpnum} records the
3715 number of the breakpoint you've set most recently; see @ref{Convenience
3716 Vars,, Convenience Variables}, for a discussion of what you can do with
3717 convenience variables.
3718
3719 @table @code
3720 @item break @var{location}
3721 Set a breakpoint at the given @var{location}, which can specify a
3722 function name, a line number, or an address of an instruction.
3723 (@xref{Specify Location}, for a list of all the possible ways to
3724 specify a @var{location}.)  The breakpoint will stop your program just
3725 before it executes any of the code in the specified @var{location}.
3726
3727 When using source languages that permit overloading of symbols, such as
3728 C@t{++}, a function name may refer to more than one possible place to break.
3729 @xref{Ambiguous Expressions,,Ambiguous Expressions}, for a discussion of
3730 that situation.
3731
3732 It is also possible to insert a breakpoint that will stop the program
3733 only if a specific thread (@pxref{Thread-Specific Breakpoints})
3734 or a specific task (@pxref{Ada Tasks}) hits that breakpoint.
3735
3736 @item break
3737 When called without any arguments, @code{break} sets a breakpoint at
3738 the next instruction to be executed in the selected stack frame
3739 (@pxref{Stack, ,Examining the Stack}).  In any selected frame but the
3740 innermost, this makes your program stop as soon as control
3741 returns to that frame.  This is similar to the effect of a
3742 @code{finish} command in the frame inside the selected frame---except
3743 that @code{finish} does not leave an active breakpoint.  If you use
3744 @code{break} without an argument in the innermost frame, @value{GDBN} stops
3745 the next time it reaches the current location; this may be useful
3746 inside loops.
3747
3748 @value{GDBN} normally ignores breakpoints when it resumes execution, until at
3749 least one instruction has been executed.  If it did not do this, you
3750 would be unable to proceed past a breakpoint without first disabling the
3751 breakpoint.  This rule applies whether or not the breakpoint already
3752 existed when your program stopped.
3753
3754 @item break @dots{} if @var{cond}
3755 Set a breakpoint with condition @var{cond}; evaluate the expression
3756 @var{cond} each time the breakpoint is reached, and stop only if the
3757 value is nonzero---that is, if @var{cond} evaluates as true.
3758 @samp{@dots{}} stands for one of the possible arguments described
3759 above (or no argument) specifying where to break.  @xref{Conditions,
3760 ,Break Conditions}, for more information on breakpoint conditions.
3761
3762 @kindex tbreak
3763 @item tbreak @var{args}
3764 Set a breakpoint enabled only for one stop.  The @var{args} are the
3765 same as for the @code{break} command, and the breakpoint is set in the same
3766 way, but the breakpoint is automatically deleted after the first time your
3767 program stops there.  @xref{Disabling, ,Disabling Breakpoints}.
3768
3769 @kindex hbreak
3770 @cindex hardware breakpoints
3771 @item hbreak @var{args}
3772 Set a hardware-assisted breakpoint.  The @var{args} are the same as for the
3773 @code{break} command and the breakpoint is set in the same way, but the
3774 breakpoint requires hardware support and some target hardware may not
3775 have this support.  The main purpose of this is EPROM/ROM code
3776 debugging, so you can set a breakpoint at an instruction without
3777 changing the instruction.  This can be used with the new trap-generation
3778 provided by SPARClite DSU and most x86-based targets.  These targets
3779 will generate traps when a program accesses some data or instruction
3780 address that is assigned to the debug registers.  However the hardware
3781 breakpoint registers can take a limited number of breakpoints.  For
3782 example, on the DSU, only two data breakpoints can be set at a time, and
3783 @value{GDBN} will reject this command if more than two are used.  Delete
3784 or disable unused hardware breakpoints before setting new ones
3785 (@pxref{Disabling, ,Disabling Breakpoints}).
3786 @xref{Conditions, ,Break Conditions}.
3787 For remote targets, you can restrict the number of hardware
3788 breakpoints @value{GDBN} will use, see @ref{set remote
3789 hardware-breakpoint-limit}.
3790
3791 @kindex thbreak
3792 @item thbreak @var{args}
3793 Set a hardware-assisted breakpoint enabled only for one stop.  The @var{args}
3794 are the same as for the @code{hbreak} command and the breakpoint is set in
3795 the same way.  However, like the @code{tbreak} command,
3796 the breakpoint is automatically deleted after the
3797 first time your program stops there.  Also, like the @code{hbreak}
3798 command, the breakpoint requires hardware support and some target hardware
3799 may not have this support.  @xref{Disabling, ,Disabling Breakpoints}.
3800 See also @ref{Conditions, ,Break Conditions}.
3801
3802 @kindex rbreak
3803 @cindex regular expression
3804 @cindex breakpoints at functions matching a regexp
3805 @cindex set breakpoints in many functions
3806 @item rbreak @var{regex}
3807 Set breakpoints on all functions matching the regular expression
3808 @var{regex}.  This command sets an unconditional breakpoint on all
3809 matches, printing a list of all breakpoints it set.  Once these
3810 breakpoints are set, they are treated just like the breakpoints set with
3811 the @code{break} command.  You can delete them, disable them, or make
3812 them conditional the same way as any other breakpoint.
3813
3814 The syntax of the regular expression is the standard one used with tools
3815 like @file{grep}.  Note that this is different from the syntax used by
3816 shells, so for instance @code{foo*} matches all functions that include
3817 an @code{fo} followed by zero or more @code{o}s.  There is an implicit
3818 @code{.*} leading and trailing the regular expression you supply, so to
3819 match only functions that begin with @code{foo}, use @code{^foo}.
3820
3821 @cindex non-member C@t{++} functions, set breakpoint in
3822 When debugging C@t{++} programs, @code{rbreak} is useful for setting
3823 breakpoints on overloaded functions that are not members of any special
3824 classes.
3825
3826 @cindex set breakpoints on all functions
3827 The @code{rbreak} command can be used to set breakpoints in
3828 @strong{all} the functions in a program, like this:
3829
3830 @smallexample
3831 (@value{GDBP}) rbreak .
3832 @end smallexample
3833
3834 @item rbreak @var{file}:@var{regex}
3835 If @code{rbreak} is called with a filename qualification, it limits
3836 the search for functions matching the given regular expression to the
3837 specified @var{file}.  This can be used, for example, to set breakpoints on
3838 every function in a given file:
3839
3840 @smallexample
3841 (@value{GDBP}) rbreak file.c:.
3842 @end smallexample
3843
3844 The colon separating the filename qualifier from the regex may
3845 optionally be surrounded by spaces.
3846
3847 @kindex info breakpoints
3848 @cindex @code{$_} and @code{info breakpoints}
3849 @item info breakpoints @r{[}@var{list}@dots{}@r{]}
3850 @itemx info break @r{[}@var{list}@dots{}@r{]}
3851 Print a table of all breakpoints, watchpoints, and catchpoints set and
3852 not deleted.  Optional argument @var{n} means print information only
3853 about the specified breakpoint(s) (or watchpoint(s) or catchpoint(s)).
3854 For each breakpoint, following columns are printed:
3855
3856 @table @emph
3857 @item Breakpoint Numbers
3858 @item Type
3859 Breakpoint, watchpoint, or catchpoint.
3860 @item Disposition
3861 Whether the breakpoint is marked to be disabled or deleted when hit.
3862 @item Enabled or Disabled
3863 Enabled breakpoints are marked with @samp{y}.  @samp{n} marks breakpoints
3864 that are not enabled.
3865 @item Address
3866 Where the breakpoint is in your program, as a memory address.  For a
3867 pending breakpoint whose address is not yet known, this field will
3868 contain @samp{<PENDING>}.  Such breakpoint won't fire until a shared
3869 library that has the symbol or line referred by breakpoint is loaded.
3870 See below for details.  A breakpoint with several locations will
3871 have @samp{<MULTIPLE>} in this field---see below for details.
3872 @item What
3873 Where the breakpoint is in the source for your program, as a file and
3874 line number.  For a pending breakpoint, the original string passed to
3875 the breakpoint command will be listed as it cannot be resolved until
3876 the appropriate shared library is loaded in the future.
3877 @end table
3878
3879 @noindent
3880 If a breakpoint is conditional, there are two evaluation modes: ``host'' and
3881 ``target''.  If mode is ``host'', breakpoint condition evaluation is done by
3882 @value{GDBN} on the host's side.  If it is ``target'', then the condition
3883 is evaluated by the target.  The @code{info break} command shows
3884 the condition on the line following the affected breakpoint, together with
3885 its condition evaluation mode in between parentheses.
3886
3887 Breakpoint commands, if any, are listed after that.  A pending breakpoint is
3888 allowed to have a condition specified for it.  The condition is not parsed for
3889 validity until a shared library is loaded that allows the pending
3890 breakpoint to resolve to a valid location.
3891
3892 @noindent
3893 @code{info break} with a breakpoint
3894 number @var{n} as argument lists only that breakpoint.  The
3895 convenience variable @code{$_} and the default examining-address for
3896 the @code{x} command are set to the address of the last breakpoint
3897 listed (@pxref{Memory, ,Examining Memory}).
3898
3899 @noindent
3900 @code{info break} displays a count of the number of times the breakpoint
3901 has been hit.  This is especially useful in conjunction with the
3902 @code{ignore} command.  You can ignore a large number of breakpoint
3903 hits, look at the breakpoint info to see how many times the breakpoint
3904 was hit, and then run again, ignoring one less than that number.  This
3905 will get you quickly to the last hit of that breakpoint.
3906
3907 @noindent
3908 For a breakpoints with an enable count (xref) greater than 1,
3909 @code{info break} also displays that count.
3910
3911 @end table
3912
3913 @value{GDBN} allows you to set any number of breakpoints at the same place in
3914 your program.  There is nothing silly or meaningless about this.  When
3915 the breakpoints are conditional, this is even useful
3916 (@pxref{Conditions, ,Break Conditions}).
3917
3918 @cindex multiple locations, breakpoints
3919 @cindex breakpoints, multiple locations
3920 It is possible that a breakpoint corresponds to several locations
3921 in your program.  Examples of this situation are:
3922
3923 @itemize @bullet
3924 @item
3925 Multiple functions in the program may have the same name.
3926
3927 @item
3928 For a C@t{++} constructor, the @value{NGCC} compiler generates several
3929 instances of the function body, used in different cases.
3930
3931 @item
3932 For a C@t{++} template function, a given line in the function can
3933 correspond to any number of instantiations.
3934
3935 @item
3936 For an inlined function, a given source line can correspond to
3937 several places where that function is inlined.
3938 @end itemize
3939
3940 In all those cases, @value{GDBN} will insert a breakpoint at all
3941 the relevant locations.
3942
3943 A breakpoint with multiple locations is displayed in the breakpoint
3944 table using several rows---one header row, followed by one row for
3945 each breakpoint location.  The header row has @samp{<MULTIPLE>} in the
3946 address column.  The rows for individual locations contain the actual
3947 addresses for locations, and show the functions to which those
3948 locations belong.  The number column for a location is of the form
3949 @var{breakpoint-number}.@var{location-number}.
3950
3951 For example:
3952
3953 @smallexample
3954 Num     Type           Disp Enb  Address    What
3955 1       breakpoint     keep y    <MULTIPLE>
3956         stop only if i==1
3957         breakpoint already hit 1 time
3958 1.1                         y    0x080486a2 in void foo<int>() at t.cc:8
3959 1.2                         y    0x080486ca in void foo<double>() at t.cc:8
3960 @end smallexample
3961
3962 You cannot delete the individual locations from a breakpoint.  However,
3963 each location can be individually enabled or disabled by passing
3964 @var{breakpoint-number}.@var{location-number} as argument to the
3965 @code{enable} and @code{disable} commands.  It's also possible to
3966 @code{enable} and @code{disable} a range of @var{location-number}
3967 locations using a @var{breakpoint-number} and two @var{location-number}s,
3968 in increasing order, separated by a hyphen, like
3969 @kbd{@var{breakpoint-number}.@var{location-number1}-@var{location-number2}},
3970 in which case @value{GDBN} acts on all the locations in the range (inclusive).
3971 Disabling or enabling the parent breakpoint (@pxref{Disabling}) affects
3972 all of the locations that belong to that breakpoint.
3973
3974 @cindex pending breakpoints
3975 It's quite common to have a breakpoint inside a shared library.
3976 Shared libraries can be loaded and unloaded explicitly,
3977 and possibly repeatedly, as the program is executed.  To support
3978 this use case, @value{GDBN} updates breakpoint locations whenever
3979 any shared library is loaded or unloaded.  Typically, you would
3980 set a breakpoint in a shared library at the beginning of your
3981 debugging session, when the library is not loaded, and when the
3982 symbols from the library are not available.  When you try to set
3983 breakpoint, @value{GDBN} will ask you if you want to set
3984 a so called @dfn{pending breakpoint}---breakpoint whose address
3985 is not yet resolved.
3986
3987 After the program is run, whenever a new shared library is loaded,
3988 @value{GDBN} reevaluates all the breakpoints.  When a newly loaded
3989 shared library contains the symbol or line referred to by some
3990 pending breakpoint, that breakpoint is resolved and becomes an
3991 ordinary breakpoint.  When a library is unloaded, all breakpoints
3992 that refer to its symbols or source lines become pending again.
3993
3994 This logic works for breakpoints with multiple locations, too.  For
3995 example, if you have a breakpoint in a C@t{++} template function, and
3996 a newly loaded shared library has an instantiation of that template,
3997 a new location is added to the list of locations for the breakpoint.
3998
3999 Except for having unresolved address, pending breakpoints do not
4000 differ from regular breakpoints.  You can set conditions or commands,
4001 enable and disable them and perform other breakpoint operations.
4002
4003 @value{GDBN} provides some additional commands for controlling what
4004 happens when the @samp{break} command cannot resolve breakpoint
4005 address specification to an address:
4006
4007 @kindex set breakpoint pending
4008 @kindex show breakpoint pending
4009 @table @code
4010 @item set breakpoint pending auto
4011 This is the default behavior.  When @value{GDBN} cannot find the breakpoint
4012 location, it queries you whether a pending breakpoint should be created.
4013
4014 @item set breakpoint pending on
4015 This indicates that an unrecognized breakpoint location should automatically
4016 result in a pending breakpoint being created.
4017
4018 @item set breakpoint pending off
4019 This indicates that pending breakpoints are not to be created.  Any
4020 unrecognized breakpoint location results in an error.  This setting does
4021 not affect any pending breakpoints previously created.
4022
4023 @item show breakpoint pending
4024 Show the current behavior setting for creating pending breakpoints.
4025 @end table
4026
4027 The settings above only affect the @code{break} command and its
4028 variants.  Once breakpoint is set, it will be automatically updated
4029 as shared libraries are loaded and unloaded.
4030
4031 @cindex automatic hardware breakpoints
4032 For some targets, @value{GDBN} can automatically decide if hardware or
4033 software breakpoints should be used, depending on whether the
4034 breakpoint address is read-only or read-write.  This applies to
4035 breakpoints set with the @code{break} command as well as to internal
4036 breakpoints set by commands like @code{next} and @code{finish}.  For
4037 breakpoints set with @code{hbreak}, @value{GDBN} will always use hardware
4038 breakpoints.
4039
4040 You can control this automatic behaviour with the following commands:
4041
4042 @kindex set breakpoint auto-hw
4043 @kindex show breakpoint auto-hw
4044 @table @code
4045 @item set breakpoint auto-hw on
4046 This is the default behavior.  When @value{GDBN} sets a breakpoint, it
4047 will try to use the target memory map to decide if software or hardware
4048 breakpoint must be used.
4049
4050 @item set breakpoint auto-hw off
4051 This indicates @value{GDBN} should not automatically select breakpoint
4052 type.  If the target provides a memory map, @value{GDBN} will warn when
4053 trying to set software breakpoint at a read-only address.
4054 @end table
4055
4056 @value{GDBN} normally implements breakpoints by replacing the program code
4057 at the breakpoint address with a special instruction, which, when
4058 executed, given control to the debugger.  By default, the program
4059 code is so modified only when the program is resumed.  As soon as
4060 the program stops, @value{GDBN} restores the original instructions.  This
4061 behaviour guards against leaving breakpoints inserted in the
4062 target should gdb abrubptly disconnect.  However, with slow remote
4063 targets, inserting and removing breakpoint can reduce the performance.
4064 This behavior can be controlled with the following commands::
4065
4066 @kindex set breakpoint always-inserted
4067 @kindex show breakpoint always-inserted
4068 @table @code
4069 @item set breakpoint always-inserted off
4070 All breakpoints, including newly added by the user, are inserted in
4071 the target only when the target is resumed.  All breakpoints are
4072 removed from the target when it stops.  This is the default mode.
4073
4074 @item set breakpoint always-inserted on
4075 Causes all breakpoints to be inserted in the target at all times.  If
4076 the user adds a new breakpoint, or changes an existing breakpoint, the
4077 breakpoints in the target are updated immediately.  A breakpoint is
4078 removed from the target only when breakpoint itself is deleted.
4079 @end table
4080
4081 @value{GDBN} handles conditional breakpoints by evaluating these conditions
4082 when a breakpoint breaks.  If the condition is true, then the process being
4083 debugged stops, otherwise the process is resumed.
4084
4085 If the target supports evaluating conditions on its end, @value{GDBN} may
4086 download the breakpoint, together with its conditions, to it.
4087
4088 This feature can be controlled via the following commands:
4089
4090 @kindex set breakpoint condition-evaluation
4091 @kindex show breakpoint condition-evaluation
4092 @table @code
4093 @item set breakpoint condition-evaluation host
4094 This option commands @value{GDBN} to evaluate the breakpoint
4095 conditions on the host's side.  Unconditional breakpoints are sent to
4096 the target which in turn receives the triggers and reports them back to GDB
4097 for condition evaluation.  This is the standard evaluation mode.
4098
4099 @item set breakpoint condition-evaluation target
4100 This option commands @value{GDBN} to download breakpoint conditions
4101 to the target at the moment of their insertion.  The target
4102 is responsible for evaluating the conditional expression and reporting
4103 breakpoint stop events back to @value{GDBN} whenever the condition
4104 is true.  Due to limitations of target-side evaluation, some conditions
4105 cannot be evaluated there, e.g., conditions that depend on local data
4106 that is only known to the host.  Examples include
4107 conditional expressions involving convenience variables, complex types
4108 that cannot be handled by the agent expression parser and expressions
4109 that are too long to be sent over to the target, specially when the
4110 target is a remote system.  In these cases, the conditions will be
4111 evaluated by @value{GDBN}.
4112
4113 @item set breakpoint condition-evaluation auto
4114 This is the default mode.  If the target supports evaluating breakpoint
4115 conditions on its end, @value{GDBN} will download breakpoint conditions to
4116 the target (limitations mentioned previously apply).  If the target does
4117 not support breakpoint condition evaluation, then @value{GDBN} will fallback
4118 to evaluating all these conditions on the host's side.
4119 @end table
4120
4121
4122 @cindex negative breakpoint numbers
4123 @cindex internal @value{GDBN} breakpoints
4124 @value{GDBN} itself sometimes sets breakpoints in your program for
4125 special purposes, such as proper handling of @code{longjmp} (in C
4126 programs).  These internal breakpoints are assigned negative numbers,
4127 starting with @code{-1}; @samp{info breakpoints} does not display them.
4128 You can see these breakpoints with the @value{GDBN} maintenance command
4129 @samp{maint info breakpoints} (@pxref{maint info breakpoints}).
4130
4131
4132 @node Set Watchpoints
4133 @subsection Setting Watchpoints
4134
4135 @cindex setting watchpoints
4136 You can use a watchpoint to stop execution whenever the value of an
4137 expression changes, without having to predict a particular place where
4138 this may happen.  (This is sometimes called a @dfn{data breakpoint}.)
4139 The expression may be as simple as the value of a single variable, or
4140 as complex as many variables combined by operators.  Examples include:
4141
4142 @itemize @bullet
4143 @item
4144 A reference to the value of a single variable.
4145
4146 @item
4147 An address cast to an appropriate data type.  For example,
4148 @samp{*(int *)0x12345678} will watch a 4-byte region at the specified
4149 address (assuming an @code{int} occupies 4 bytes).
4150
4151 @item
4152 An arbitrarily complex expression, such as @samp{a*b + c/d}.  The
4153 expression can use any operators valid in the program's native
4154 language (@pxref{Languages}).
4155 @end itemize
4156
4157 You can set a watchpoint on an expression even if the expression can
4158 not be evaluated yet.  For instance, you can set a watchpoint on
4159 @samp{*global_ptr} before @samp{global_ptr} is initialized.
4160 @value{GDBN} will stop when your program sets @samp{global_ptr} and
4161 the expression produces a valid value.  If the expression becomes
4162 valid in some other way than changing a variable (e.g.@: if the memory
4163 pointed to by @samp{*global_ptr} becomes readable as the result of a
4164 @code{malloc} call), @value{GDBN} may not stop until the next time
4165 the expression changes.
4166
4167 @cindex software watchpoints
4168 @cindex hardware watchpoints
4169 Depending on your system, watchpoints may be implemented in software or
4170 hardware.  @value{GDBN} does software watchpointing by single-stepping your
4171 program and testing the variable's value each time, which is hundreds of
4172 times slower than normal execution.  (But this may still be worth it, to
4173 catch errors where you have no clue what part of your program is the
4174 culprit.)
4175
4176 On some systems, such as most PowerPC or x86-based targets,
4177 @value{GDBN} includes support for hardware watchpoints, which do not
4178 slow down the running of your program.
4179
4180 @table @code
4181 @kindex watch
4182 @item watch @r{[}-l@r{|}-location@r{]} @var{expr} @r{[}thread @var{thread-id}@r{]} @r{[}mask @var{maskvalue}@r{]}
4183 Set a watchpoint for an expression.  @value{GDBN} will break when the
4184 expression @var{expr} is written into by the program and its value
4185 changes.  The simplest (and the most popular) use of this command is
4186 to watch the value of a single variable:
4187
4188 @smallexample
4189 (@value{GDBP}) watch foo
4190 @end smallexample
4191
4192 If the command includes a @code{@r{[}thread @var{thread-id}@r{]}}
4193 argument, @value{GDBN} breaks only when the thread identified by
4194 @var{thread-id} changes the value of @var{expr}.  If any other threads
4195 change the value of @var{expr}, @value{GDBN} will not break.  Note
4196 that watchpoints restricted to a single thread in this way only work
4197 with Hardware Watchpoints.
4198
4199 Ordinarily a watchpoint respects the scope of variables in @var{expr}
4200 (see below).  The @code{-location} argument tells @value{GDBN} to
4201 instead watch the memory referred to by @var{expr}.  In this case,
4202 @value{GDBN} will evaluate @var{expr}, take the address of the result,
4203 and watch the memory at that address.  The type of the result is used
4204 to determine the size of the watched memory.  If the expression's
4205 result does not have an address, then @value{GDBN} will print an
4206 error.
4207
4208 The @code{@r{[}mask @var{maskvalue}@r{]}} argument allows creation
4209 of masked watchpoints, if the current architecture supports this
4210 feature (e.g., PowerPC Embedded architecture, see @ref{PowerPC
4211 Embedded}.)  A @dfn{masked watchpoint} specifies a mask in addition
4212 to an address to watch.  The mask specifies that some bits of an address
4213 (the bits which are reset in the mask) should be ignored when matching
4214 the address accessed by the inferior against the watchpoint address.
4215 Thus, a masked watchpoint watches many addresses simultaneously---those
4216 addresses whose unmasked bits are identical to the unmasked bits in the
4217 watchpoint address.  The @code{mask} argument implies @code{-location}.
4218 Examples:
4219
4220 @smallexample
4221 (@value{GDBP}) watch foo mask 0xffff00ff
4222 (@value{GDBP}) watch *0xdeadbeef mask 0xffffff00
4223 @end smallexample
4224
4225 @kindex rwatch
4226 @item rwatch @r{[}-l@r{|}-location@r{]} @var{expr} @r{[}thread @var{thread-id}@r{]} @r{[}mask @var{maskvalue}@r{]}
4227 Set a watchpoint that will break when the value of @var{expr} is read
4228 by the program.
4229
4230 @kindex awatch
4231 @item awatch @r{[}-l@r{|}-location@r{]} @var{expr} @r{[}thread @var{thread-id}@r{]} @r{[}mask @var{maskvalue}@r{]}
4232 Set a watchpoint that will break when @var{expr} is either read from
4233 or written into by the program.
4234
4235 @kindex info watchpoints @r{[}@var{list}@dots{}@r{]}
4236 @item info watchpoints @r{[}@var{list}@dots{}@r{]}
4237 This command prints a list of watchpoints, using the same format as
4238 @code{info break} (@pxref{Set Breaks}).
4239 @end table
4240
4241 If you watch for a change in a numerically entered address you need to
4242 dereference it, as the address itself is just a constant number which will
4243 never change.  @value{GDBN} refuses to create a watchpoint that watches
4244 a never-changing value:
4245
4246 @smallexample
4247 (@value{GDBP}) watch 0x600850
4248 Cannot watch constant value 0x600850.
4249 (@value{GDBP}) watch *(int *) 0x600850
4250 Watchpoint 1: *(int *) 6293584
4251 @end smallexample
4252
4253 @value{GDBN} sets a @dfn{hardware watchpoint} if possible.  Hardware
4254 watchpoints execute very quickly, and the debugger reports a change in
4255 value at the exact instruction where the change occurs.  If @value{GDBN}
4256 cannot set a hardware watchpoint, it sets a software watchpoint, which
4257 executes more slowly and reports the change in value at the next
4258 @emph{statement}, not the instruction, after the change occurs.
4259
4260 @cindex use only software watchpoints
4261 You can force @value{GDBN} to use only software watchpoints with the
4262 @kbd{set can-use-hw-watchpoints 0} command.  With this variable set to
4263 zero, @value{GDBN} will never try to use hardware watchpoints, even if
4264 the underlying system supports them.  (Note that hardware-assisted
4265 watchpoints that were set @emph{before} setting
4266 @code{can-use-hw-watchpoints} to zero will still use the hardware
4267 mechanism of watching expression values.)
4268
4269 @table @code
4270 @item set can-use-hw-watchpoints
4271 @kindex set can-use-hw-watchpoints
4272 Set whether or not to use hardware watchpoints.
4273
4274 @item show can-use-hw-watchpoints
4275 @kindex show can-use-hw-watchpoints
4276 Show the current mode of using hardware watchpoints.
4277 @end table
4278
4279 For remote targets, you can restrict the number of hardware
4280 watchpoints @value{GDBN} will use, see @ref{set remote
4281 hardware-breakpoint-limit}.
4282
4283 When you issue the @code{watch} command, @value{GDBN} reports
4284
4285 @smallexample
4286 Hardware watchpoint @var{num}: @var{expr}
4287 @end smallexample
4288
4289 @noindent
4290 if it was able to set a hardware watchpoint.
4291
4292 Currently, the @code{awatch} and @code{rwatch} commands can only set
4293 hardware watchpoints, because accesses to data that don't change the
4294 value of the watched expression cannot be detected without examining
4295 every instruction as it is being executed, and @value{GDBN} does not do
4296 that currently.  If @value{GDBN} finds that it is unable to set a
4297 hardware breakpoint with the @code{awatch} or @code{rwatch} command, it
4298 will print a message like this:
4299
4300 @smallexample
4301 Expression cannot be implemented with read/access watchpoint.
4302 @end smallexample
4303
4304 Sometimes, @value{GDBN} cannot set a hardware watchpoint because the
4305 data type of the watched expression is wider than what a hardware
4306 watchpoint on the target machine can handle.  For example, some systems
4307 can only watch regions that are up to 4 bytes wide; on such systems you
4308 cannot set hardware watchpoints for an expression that yields a
4309 double-precision floating-point number (which is typically 8 bytes
4310 wide).  As a work-around, it might be possible to break the large region
4311 into a series of smaller ones and watch them with separate watchpoints.
4312
4313 If you set too many hardware watchpoints, @value{GDBN} might be unable
4314 to insert all of them when you resume the execution of your program.
4315 Since the precise number of active watchpoints is unknown until such
4316 time as the program is about to be resumed, @value{GDBN} might not be
4317 able to warn you about this when you set the watchpoints, and the
4318 warning will be printed only when the program is resumed:
4319
4320 @smallexample
4321 Hardware watchpoint @var{num}: Could not insert watchpoint
4322 @end smallexample
4323
4324 @noindent
4325 If this happens, delete or disable some of the watchpoints.
4326
4327 Watching complex expressions that reference many variables can also
4328 exhaust the resources available for hardware-assisted watchpoints.
4329 That's because @value{GDBN} needs to watch every variable in the
4330 expression with separately allocated resources.
4331
4332 If you call a function interactively using @code{print} or @code{call},
4333 any watchpoints you have set will be inactive until @value{GDBN} reaches another
4334 kind of breakpoint or the call completes.
4335
4336 @value{GDBN} automatically deletes watchpoints that watch local
4337 (automatic) variables, or expressions that involve such variables, when
4338 they go out of scope, that is, when the execution leaves the block in
4339 which these variables were defined.  In particular, when the program
4340 being debugged terminates, @emph{all} local variables go out of scope,
4341 and so only watchpoints that watch global variables remain set.  If you
4342 rerun the program, you will need to set all such watchpoints again.  One
4343 way of doing that would be to set a code breakpoint at the entry to the
4344 @code{main} function and when it breaks, set all the watchpoints.
4345
4346 @cindex watchpoints and threads
4347 @cindex threads and watchpoints
4348 In multi-threaded programs, watchpoints will detect changes to the
4349 watched expression from every thread.
4350
4351 @quotation
4352 @emph{Warning:} In multi-threaded programs, software watchpoints
4353 have only limited usefulness.  If @value{GDBN} creates a software
4354 watchpoint, it can only watch the value of an expression @emph{in a
4355 single thread}.  If you are confident that the expression can only
4356 change due to the current thread's activity (and if you are also
4357 confident that no other thread can become current), then you can use
4358 software watchpoints as usual.  However, @value{GDBN} may not notice
4359 when a non-current thread's activity changes the expression.  (Hardware
4360 watchpoints, in contrast, watch an expression in all threads.)
4361 @end quotation
4362
4363 @xref{set remote hardware-watchpoint-limit}.
4364
4365 @node Set Catchpoints
4366 @subsection Setting Catchpoints
4367 @cindex catchpoints, setting
4368 @cindex exception handlers
4369 @cindex event handling
4370
4371 You can use @dfn{catchpoints} to cause the debugger to stop for certain
4372 kinds of program events, such as C@t{++} exceptions or the loading of a
4373 shared library.  Use the @code{catch} command to set a catchpoint.
4374
4375 @table @code
4376 @kindex catch
4377 @item catch @var{event}
4378 Stop when @var{event} occurs.  The @var{event} can be any of the following:
4379
4380 @table @code
4381 @item throw @r{[}@var{regexp}@r{]}
4382 @itemx rethrow @r{[}@var{regexp}@r{]}
4383 @itemx catch @r{[}@var{regexp}@r{]}
4384 @kindex catch throw
4385 @kindex catch rethrow
4386 @kindex catch catch
4387 @cindex stop on C@t{++} exceptions
4388 The throwing, re-throwing, or catching of a C@t{++} exception.
4389
4390 If @var{regexp} is given, then only exceptions whose type matches the
4391 regular expression will be caught.
4392
4393 @vindex $_exception@r{, convenience variable}
4394 The convenience variable @code{$_exception} is available at an
4395 exception-related catchpoint, on some systems.  This holds the
4396 exception being thrown.
4397
4398 There are currently some limitations to C@t{++} exception handling in
4399 @value{GDBN}:
4400
4401 @itemize @bullet
4402 @item
4403 The support for these commands is system-dependent.  Currently, only
4404 systems using the @samp{gnu-v3} C@t{++} ABI (@pxref{ABI}) are
4405 supported.
4406
4407 @item
4408 The regular expression feature and the @code{$_exception} convenience
4409 variable rely on the presence of some SDT probes in @code{libstdc++}.
4410 If these probes are not present, then these features cannot be used.
4411 These probes were first available in the GCC 4.8 release, but whether
4412 or not they are available in your GCC also depends on how it was
4413 built.
4414
4415 @item
4416 The @code{$_exception} convenience variable is only valid at the
4417 instruction at which an exception-related catchpoint is set.
4418
4419 @item
4420 When an exception-related catchpoint is hit, @value{GDBN} stops at a
4421 location in the system library which implements runtime exception
4422 support for C@t{++}, usually @code{libstdc++}.  You can use @code{up}
4423 (@pxref{Selection}) to get to your code.
4424
4425 @item
4426 If you call a function interactively, @value{GDBN} normally returns
4427 control to you when the function has finished executing.  If the call
4428 raises an exception, however, the call may bypass the mechanism that
4429 returns control to you and cause your program either to abort or to
4430 simply continue running until it hits a breakpoint, catches a signal
4431 that @value{GDBN} is listening for, or exits.  This is the case even if
4432 you set a catchpoint for the exception; catchpoints on exceptions are
4433 disabled within interactive calls.  @xref{Calling}, for information on
4434 controlling this with @code{set unwind-on-terminating-exception}.
4435
4436 @item
4437 You cannot raise an exception interactively.
4438
4439 @item
4440 You cannot install an exception handler interactively.
4441 @end itemize
4442
4443 @item exception
4444 @kindex catch exception
4445 @cindex Ada exception catching
4446 @cindex catch Ada exceptions
4447 An Ada exception being raised.  If an exception name is specified
4448 at the end of the command (eg @code{catch exception Program_Error}),
4449 the debugger will stop only when this specific exception is raised.
4450 Otherwise, the debugger stops execution when any Ada exception is raised.
4451
4452 When inserting an exception catchpoint on a user-defined exception whose
4453 name is identical to one of the exceptions defined by the language, the
4454 fully qualified name must be used as the exception name.  Otherwise,
4455 @value{GDBN} will assume that it should stop on the pre-defined exception
4456 rather than the user-defined one.  For instance, assuming an exception
4457 called @code{Constraint_Error} is defined in package @code{Pck}, then
4458 the command to use to catch such exceptions is @kbd{catch exception
4459 Pck.Constraint_Error}.
4460
4461 @item handlers
4462 @kindex catch handlers
4463 @cindex Ada exception handlers catching
4464 @cindex catch Ada exceptions when handled
4465 An Ada exception being handled.  If an exception name is
4466 specified at the end of the command
4467  (eg @kbd{catch handlers Program_Error}), the debugger will stop
4468 only when this specific exception is handled.
4469 Otherwise, the debugger stops execution when any Ada exception is handled.
4470
4471 When inserting a handlers catchpoint on a user-defined
4472 exception whose name is identical to one of the exceptions
4473 defined by the language, the fully qualified name must be used
4474 as the exception name.  Otherwise, @value{GDBN} will assume that it
4475 should stop on the pre-defined exception rather than the
4476 user-defined one.  For instance, assuming an exception called
4477  @code{Constraint_Error} is defined in package @code{Pck}, then the
4478 command to use to catch such exceptions handling is
4479 @kbd{catch handlers Pck.Constraint_Error}.
4480
4481 @item exception unhandled
4482 @kindex catch exception unhandled
4483 An exception that was raised but is not handled by the program.
4484
4485 @item assert
4486 @kindex catch assert
4487 A failed Ada assertion.
4488
4489 @item exec
4490 @kindex catch exec
4491 @cindex break on fork/exec
4492 A call to @code{exec}.
4493
4494 @item syscall
4495 @itemx syscall @r{[}@var{name} @r{|} @var{number} @r{|} @r{group:}@var{groupname} @r{|} @r{g:}@var{groupname}@r{]} @dots{}
4496 @kindex catch syscall
4497 @cindex break on a system call.
4498 A call to or return from a system call, a.k.a.@: @dfn{syscall}.  A
4499 syscall is a mechanism for application programs to request a service
4500 from the operating system (OS) or one of the OS system services.
4501 @value{GDBN} can catch some or all of the syscalls issued by the
4502 debuggee, and show the related information for each syscall.  If no
4503 argument is specified, calls to and returns from all system calls
4504 will be caught.
4505
4506 @var{name} can be any system call name that is valid for the
4507 underlying OS.  Just what syscalls are valid depends on the OS.  On
4508 GNU and Unix systems, you can find the full list of valid syscall
4509 names on @file{/usr/include/asm/unistd.h}.
4510
4511 @c For MS-Windows, the syscall names and the corresponding numbers
4512 @c can be found, e.g., on this URL:
4513 @c http://www.metasploit.com/users/opcode/syscalls.html
4514 @c but we don't support Windows syscalls yet.
4515
4516 Normally, @value{GDBN} knows in advance which syscalls are valid for
4517 each OS, so you can use the @value{GDBN} command-line completion
4518 facilities (@pxref{Completion,, command completion}) to list the
4519 available choices.
4520
4521 You may also specify the system call numerically.  A syscall's
4522 number is the value passed to the OS's syscall dispatcher to
4523 identify the requested service.  When you specify the syscall by its
4524 name, @value{GDBN} uses its database of syscalls to convert the name
4525 into the corresponding numeric code, but using the number directly
4526 may be useful if @value{GDBN}'s database does not have the complete
4527 list of syscalls on your system (e.g., because @value{GDBN} lags
4528 behind the OS upgrades).
4529
4530 You may specify a group of related syscalls to be caught at once using
4531 the @code{group:} syntax (@code{g:} is a shorter equivalent).  For
4532 instance, on some platforms @value{GDBN} allows you to catch all
4533 network related syscalls, by passing the argument @code{group:network}
4534 to @code{catch syscall}.  Note that not all syscall groups are
4535 available in every system.  You can use the command completion
4536 facilities (@pxref{Completion,, command completion}) to list the
4537 syscall groups available on your environment.
4538
4539 The example below illustrates how this command works if you don't provide
4540 arguments to it:
4541
4542 @smallexample
4543 (@value{GDBP}) catch syscall
4544 Catchpoint 1 (syscall)
4545 (@value{GDBP}) r
4546 Starting program: /tmp/catch-syscall
4547
4548 Catchpoint 1 (call to syscall 'close'), \
4549            0xffffe424 in __kernel_vsyscall ()
4550 (@value{GDBP}) c
4551 Continuing.
4552
4553 Catchpoint 1 (returned from syscall 'close'), \
4554         0xffffe424 in __kernel_vsyscall ()
4555 (@value{GDBP})
4556 @end smallexample
4557
4558 Here is an example of catching a system call by name:
4559
4560 @smallexample
4561 (@value{GDBP}) catch syscall chroot
4562 Catchpoint 1 (syscall 'chroot' [61])
4563 (@value{GDBP}) r
4564 Starting program: /tmp/catch-syscall
4565
4566 Catchpoint 1 (call to syscall 'chroot'), \
4567                    0xffffe424 in __kernel_vsyscall ()
4568 (@value{GDBP}) c
4569 Continuing.
4570
4571 Catchpoint 1 (returned from syscall 'chroot'), \
4572         0xffffe424 in __kernel_vsyscall ()
4573 (@value{GDBP})
4574 @end smallexample
4575
4576 An example of specifying a system call numerically.  In the case
4577 below, the syscall number has a corresponding entry in the XML
4578 file, so @value{GDBN} finds its name and prints it:
4579
4580 @smallexample
4581 (@value{GDBP}) catch syscall 252
4582 Catchpoint 1 (syscall(s) 'exit_group')
4583 (@value{GDBP}) r
4584 Starting program: /tmp/catch-syscall
4585
4586 Catchpoint 1 (call to syscall 'exit_group'), \
4587                    0xffffe424 in __kernel_vsyscall ()
4588 (@value{GDBP}) c
4589 Continuing.
4590
4591 Program exited normally.
4592 (@value{GDBP})
4593 @end smallexample
4594
4595 Here is an example of catching a syscall group:
4596
4597 @smallexample
4598 (@value{GDBP}) catch syscall group:process
4599 Catchpoint 1 (syscalls 'exit' [1] 'fork' [2] 'waitpid' [7]
4600 'execve' [11] 'wait4' [114] 'clone' [120] 'vfork' [190]
4601 'exit_group' [252] 'waitid' [284] 'unshare' [310])
4602 (@value{GDBP}) r
4603 Starting program: /tmp/catch-syscall
4604
4605 Catchpoint 1 (call to syscall fork), 0x00007ffff7df4e27 in open64 ()
4606    from /lib64/ld-linux-x86-64.so.2
4607
4608 (@value{GDBP}) c
4609 Continuing.
4610 @end smallexample
4611
4612 However, there can be situations when there is no corresponding name
4613 in XML file for that syscall number.  In this case, @value{GDBN} prints
4614 a warning message saying that it was not able to find the syscall name,
4615 but the catchpoint will be set anyway.  See the example below:
4616
4617 @smallexample
4618 (@value{GDBP}) catch syscall 764
4619 warning: The number '764' does not represent a known syscall.
4620 Catchpoint 2 (syscall 764)
4621 (@value{GDBP})
4622 @end smallexample
4623
4624 If you configure @value{GDBN} using the @samp{--without-expat} option,
4625 it will not be able to display syscall names.  Also, if your
4626 architecture does not have an XML file describing its system calls,
4627 you will not be able to see the syscall names.  It is important to
4628 notice that these two features are used for accessing the syscall
4629 name database.  In either case, you will see a warning like this:
4630
4631 @smallexample
4632 (@value{GDBP}) catch syscall
4633 warning: Could not open "syscalls/i386-linux.xml"
4634 warning: Could not load the syscall XML file 'syscalls/i386-linux.xml'.
4635 GDB will not be able to display syscall names.
4636 Catchpoint 1 (syscall)
4637 (@value{GDBP})
4638 @end smallexample
4639
4640 Of course, the file name will change depending on your architecture and system.
4641
4642 Still using the example above, you can also try to catch a syscall by its
4643 number.  In this case, you would see something like:
4644
4645 @smallexample
4646 (@value{GDBP}) catch syscall 252
4647 Catchpoint 1 (syscall(s) 252)
4648 @end smallexample
4649
4650 Again, in this case @value{GDBN} would not be able to display syscall's names.
4651
4652 @item fork
4653 @kindex catch fork
4654 A call to @code{fork}.
4655
4656 @item vfork
4657 @kindex catch vfork
4658 A call to @code{vfork}.
4659
4660 @item load @r{[}regexp@r{]}
4661 @itemx unload @r{[}regexp@r{]}
4662 @kindex catch load
4663 @kindex catch unload
4664 The loading or unloading of a shared library.  If @var{regexp} is
4665 given, then the catchpoint will stop only if the regular expression
4666 matches one of the affected libraries.
4667
4668 @item signal @r{[}@var{signal}@dots{} @r{|} @samp{all}@r{]}
4669 @kindex catch signal
4670 The delivery of a signal.
4671
4672 With no arguments, this catchpoint will catch any signal that is not
4673 used internally by @value{GDBN}, specifically, all signals except
4674 @samp{SIGTRAP} and @samp{SIGINT}.
4675
4676 With the argument @samp{all}, all signals, including those used by
4677 @value{GDBN}, will be caught.  This argument cannot be used with other
4678 signal names.
4679
4680 Otherwise, the arguments are a list of signal names as given to
4681 @code{handle} (@pxref{Signals}).  Only signals specified in this list
4682 will be caught.
4683
4684 One reason that @code{catch signal} can be more useful than
4685 @code{handle} is that you can attach commands and conditions to the
4686 catchpoint.
4687
4688 When a signal is caught by a catchpoint, the signal's @code{stop} and
4689 @code{print} settings, as specified by @code{handle}, are ignored.
4690 However, whether the signal is still delivered to the inferior depends
4691 on the @code{pass} setting; this can be changed in the catchpoint's
4692 commands.
4693
4694 @end table
4695
4696 @item tcatch @var{event}
4697 @kindex tcatch
4698 Set a catchpoint that is enabled only for one stop.  The catchpoint is
4699 automatically deleted after the first time the event is caught.
4700
4701 @end table
4702
4703 Use the @code{info break} command to list the current catchpoints.
4704
4705
4706 @node Delete Breaks
4707 @subsection Deleting Breakpoints
4708
4709 @cindex clearing breakpoints, watchpoints, catchpoints
4710 @cindex deleting breakpoints, watchpoints, catchpoints
4711 It is often necessary to eliminate a breakpoint, watchpoint, or
4712 catchpoint once it has done its job and you no longer want your program
4713 to stop there.  This is called @dfn{deleting} the breakpoint.  A
4714 breakpoint that has been deleted no longer exists; it is forgotten.
4715
4716 With the @code{clear} command you can delete breakpoints according to
4717 where they are in your program.  With the @code{delete} command you can
4718 delete individual breakpoints, watchpoints, or catchpoints by specifying
4719 their breakpoint numbers.
4720
4721 It is not necessary to delete a breakpoint to proceed past it.  @value{GDBN}
4722 automatically ignores breakpoints on the first instruction to be executed
4723 when you continue execution without changing the execution address.
4724
4725 @table @code
4726 @kindex clear
4727 @item clear
4728 Delete any breakpoints at the next instruction to be executed in the
4729 selected stack frame (@pxref{Selection, ,Selecting a Frame}).  When
4730 the innermost frame is selected, this is a good way to delete a
4731 breakpoint where your program just stopped.
4732
4733 @item clear @var{location}
4734 Delete any breakpoints set at the specified @var{location}.
4735 @xref{Specify Location}, for the various forms of @var{location}; the
4736 most useful ones are listed below:
4737
4738 @table @code
4739 @item clear @var{function}
4740 @itemx clear @var{filename}:@var{function}
4741 Delete any breakpoints set at entry to the named @var{function}.
4742
4743 @item clear @var{linenum}
4744 @itemx clear @var{filename}:@var{linenum}
4745 Delete any breakpoints set at or within the code of the specified
4746 @var{linenum} of the specified @var{filename}.
4747 @end table
4748
4749 @cindex delete breakpoints
4750 @kindex delete
4751 @kindex d @r{(@code{delete})}
4752 @item delete @r{[}breakpoints@r{]} @r{[}@var{list}@dots{}@r{]}
4753 Delete the breakpoints, watchpoints, or catchpoints of the breakpoint
4754 list specified as argument.  If no argument is specified, delete all
4755 breakpoints (@value{GDBN} asks confirmation, unless you have @code{set
4756 confirm off}).  You can abbreviate this command as @code{d}.
4757 @end table
4758
4759 @node Disabling
4760 @subsection Disabling Breakpoints
4761
4762 @cindex enable/disable a breakpoint
4763 Rather than deleting a breakpoint, watchpoint, or catchpoint, you might
4764 prefer to @dfn{disable} it.  This makes the breakpoint inoperative as if
4765 it had been deleted, but remembers the information on the breakpoint so
4766 that you can @dfn{enable} it again later.
4767
4768 You disable and enable breakpoints, watchpoints, and catchpoints with
4769 the @code{enable} and @code{disable} commands, optionally specifying
4770 one or more breakpoint numbers as arguments.  Use @code{info break} to
4771 print a list of all breakpoints, watchpoints, and catchpoints if you
4772 do not know which numbers to use.
4773
4774 Disabling and enabling a breakpoint that has multiple locations
4775 affects all of its locations.
4776
4777 A breakpoint, watchpoint, or catchpoint can have any of several
4778 different states of enablement:
4779
4780 @itemize @bullet
4781 @item
4782 Enabled.  The breakpoint stops your program.  A breakpoint set
4783 with the @code{break} command starts out in this state.
4784 @item
4785 Disabled.  The breakpoint has no effect on your program.
4786 @item
4787 Enabled once.  The breakpoint stops your program, but then becomes
4788 disabled.
4789 @item
4790 Enabled for a count.  The breakpoint stops your program for the next
4791 N times, then becomes disabled.
4792 @item
4793 Enabled for deletion.  The breakpoint stops your program, but
4794 immediately after it does so it is deleted permanently.  A breakpoint
4795 set with the @code{tbreak} command starts out in this state.
4796 @end itemize
4797
4798 You can use the following commands to enable or disable breakpoints,
4799 watchpoints, and catchpoints:
4800
4801 @table @code
4802 @kindex disable
4803 @kindex dis @r{(@code{disable})}
4804 @item disable @r{[}breakpoints@r{]} @r{[}@var{list}@dots{}@r{]}
4805 Disable the specified breakpoints---or all breakpoints, if none are
4806 listed.  A disabled breakpoint has no effect but is not forgotten.  All
4807 options such as ignore-counts, conditions and commands are remembered in
4808 case the breakpoint is enabled again later.  You may abbreviate
4809 @code{disable} as @code{dis}.
4810
4811 @kindex enable
4812 @item enable @r{[}breakpoints@r{]} @r{[}@var{list}@dots{}@r{]}
4813 Enable the specified breakpoints (or all defined breakpoints).  They
4814 become effective once again in stopping your program.
4815
4816 @item enable @r{[}breakpoints@r{]} once @var{list}@dots{}
4817 Enable the specified breakpoints temporarily.  @value{GDBN} disables any
4818 of these breakpoints immediately after stopping your program.
4819
4820 @item enable @r{[}breakpoints@r{]} count @var{count} @var{list}@dots{}
4821 Enable the specified breakpoints temporarily.  @value{GDBN} records
4822 @var{count} with each of the specified breakpoints, and decrements a
4823 breakpoint's count when it is hit.  When any count reaches 0,
4824 @value{GDBN} disables that breakpoint.  If a breakpoint has an ignore
4825 count (@pxref{Conditions, ,Break Conditions}), that will be
4826 decremented to 0 before @var{count} is affected.
4827
4828 @item enable @r{[}breakpoints@r{]} delete @var{list}@dots{}
4829 Enable the specified breakpoints to work once, then die.  @value{GDBN}
4830 deletes any of these breakpoints as soon as your program stops there.
4831 Breakpoints set by the @code{tbreak} command start out in this state.
4832 @end table
4833
4834 @c FIXME: I think the following ``Except for [...] @code{tbreak}'' is
4835 @c confusing: tbreak is also initially enabled.
4836 Except for a breakpoint set with @code{tbreak} (@pxref{Set Breaks,
4837 ,Setting Breakpoints}), breakpoints that you set are initially enabled;
4838 subsequently, they become disabled or enabled only when you use one of
4839 the commands above.  (The command @code{until} can set and delete a
4840 breakpoint of its own, but it does not change the state of your other
4841 breakpoints; see @ref{Continuing and Stepping, ,Continuing and
4842 Stepping}.)
4843
4844 @node Conditions
4845 @subsection Break Conditions
4846 @cindex conditional breakpoints
4847 @cindex breakpoint conditions
4848
4849 @c FIXME what is scope of break condition expr?  Context where wanted?
4850 @c      in particular for a watchpoint?
4851 The simplest sort of breakpoint breaks every time your program reaches a
4852 specified place.  You can also specify a @dfn{condition} for a
4853 breakpoint.  A condition is just a Boolean expression in your
4854 programming language (@pxref{Expressions, ,Expressions}).  A breakpoint with
4855 a condition evaluates the expression each time your program reaches it,
4856 and your program stops only if the condition is @emph{true}.
4857
4858 This is the converse of using assertions for program validation; in that
4859 situation, you want to stop when the assertion is violated---that is,
4860 when the condition is false.  In C, if you want to test an assertion expressed
4861 by the condition @var{assert}, you should set the condition
4862 @samp{! @var{assert}} on the appropriate breakpoint.
4863
4864 Conditions are also accepted for watchpoints; you may not need them,
4865 since a watchpoint is inspecting the value of an expression anyhow---but
4866 it might be simpler, say, to just set a watchpoint on a variable name,
4867 and specify a condition that tests whether the new value is an interesting
4868 one.
4869
4870 Break conditions can have side effects, and may even call functions in
4871 your program.  This can be useful, for example, to activate functions
4872 that log program progress, or to use your own print functions to
4873 format special data structures.  The effects are completely predictable
4874 unless there is another enabled breakpoint at the same address.  (In
4875 that case, @value{GDBN} might see the other breakpoint first and stop your
4876 program without checking the condition of this one.)  Note that
4877 breakpoint commands are usually more convenient and flexible than break
4878 conditions for the
4879 purpose of performing side effects when a breakpoint is reached
4880 (@pxref{Break Commands, ,Breakpoint Command Lists}).
4881
4882 Breakpoint conditions can also be evaluated on the target's side if
4883 the target supports it.  Instead of evaluating the conditions locally,
4884 @value{GDBN} encodes the expression into an agent expression
4885 (@pxref{Agent Expressions}) suitable for execution on the target,
4886 independently of @value{GDBN}.  Global variables become raw memory
4887 locations, locals become stack accesses, and so forth.
4888
4889 In this case, @value{GDBN} will only be notified of a breakpoint trigger
4890 when its condition evaluates to true.  This mechanism may provide faster
4891 response times depending on the performance characteristics of the target
4892 since it does not need to keep @value{GDBN} informed about
4893 every breakpoint trigger, even those with false conditions.
4894
4895 Break conditions can be specified when a breakpoint is set, by using
4896 @samp{if} in the arguments to the @code{break} command.  @xref{Set
4897 Breaks, ,Setting Breakpoints}.  They can also be changed at any time
4898 with the @code{condition} command.
4899
4900 You can also use the @code{if} keyword with the @code{watch} command.
4901 The @code{catch} command does not recognize the @code{if} keyword;
4902 @code{condition} is the only way to impose a further condition on a
4903 catchpoint.
4904
4905 @table @code
4906 @kindex condition
4907 @item condition @var{bnum} @var{expression}
4908 Specify @var{expression} as the break condition for breakpoint,
4909 watchpoint, or catchpoint number @var{bnum}.  After you set a condition,
4910 breakpoint @var{bnum} stops your program only if the value of
4911 @var{expression} is true (nonzero, in C).  When you use
4912 @code{condition}, @value{GDBN} checks @var{expression} immediately for
4913 syntactic correctness, and to determine whether symbols in it have
4914 referents in the context of your breakpoint.  If @var{expression} uses
4915 symbols not referenced in the context of the breakpoint, @value{GDBN}
4916 prints an error message:
4917
4918 @smallexample
4919 No symbol "foo" in current context.
4920 @end smallexample
4921
4922 @noindent
4923 @value{GDBN} does
4924 not actually evaluate @var{expression} at the time the @code{condition}
4925 command (or a command that sets a breakpoint with a condition, like
4926 @code{break if @dots{}}) is given, however.  @xref{Expressions, ,Expressions}.
4927
4928 @item condition @var{bnum}
4929 Remove the condition from breakpoint number @var{bnum}.  It becomes
4930 an ordinary unconditional breakpoint.
4931 @end table
4932
4933 @cindex ignore count (of breakpoint)
4934 A special case of a breakpoint condition is to stop only when the
4935 breakpoint has been reached a certain number of times.  This is so
4936 useful that there is a special way to do it, using the @dfn{ignore
4937 count} of the breakpoint.  Every breakpoint has an ignore count, which
4938 is an integer.  Most of the time, the ignore count is zero, and
4939 therefore has no effect.  But if your program reaches a breakpoint whose
4940 ignore count is positive, then instead of stopping, it just decrements
4941 the ignore count by one and continues.  As a result, if the ignore count
4942 value is @var{n}, the breakpoint does not stop the next @var{n} times
4943 your program reaches it.
4944
4945 @table @code
4946 @kindex ignore
4947 @item ignore @var{bnum} @var{count}
4948 Set the ignore count of breakpoint number @var{bnum} to @var{count}.
4949 The next @var{count} times the breakpoint is reached, your program's
4950 execution does not stop; other than to decrement the ignore count, @value{GDBN}
4951 takes no action.
4952
4953 To make the breakpoint stop the next time it is reached, specify
4954 a count of zero.
4955
4956 When you use @code{continue} to resume execution of your program from a
4957 breakpoint, you can specify an ignore count directly as an argument to
4958 @code{continue}, rather than using @code{ignore}.  @xref{Continuing and
4959 Stepping,,Continuing and Stepping}.
4960
4961 If a breakpoint has a positive ignore count and a condition, the
4962 condition is not checked.  Once the ignore count reaches zero,
4963 @value{GDBN} resumes checking the condition.
4964
4965 You could achieve the effect of the ignore count with a condition such
4966 as @w{@samp{$foo-- <= 0}} using a debugger convenience variable that
4967 is decremented each time.  @xref{Convenience Vars, ,Convenience
4968 Variables}.
4969 @end table
4970
4971 Ignore counts apply to breakpoints, watchpoints, and catchpoints.
4972
4973
4974 @node Break Commands
4975 @subsection Breakpoint Command Lists
4976
4977 @cindex breakpoint commands
4978 You can give any breakpoint (or watchpoint or catchpoint) a series of
4979 commands to execute when your program stops due to that breakpoint.  For
4980 example, you might want to print the values of certain expressions, or
4981 enable other breakpoints.
4982
4983 @table @code
4984 @kindex commands
4985 @kindex end@r{ (breakpoint commands)}
4986 @item commands @r{[}@var{list}@dots{}@r{]}
4987 @itemx @dots{} @var{command-list} @dots{}
4988 @itemx end
4989 Specify a list of commands for the given breakpoints.  The commands
4990 themselves appear on the following lines.  Type a line containing just
4991 @code{end} to terminate the commands.
4992
4993 To remove all commands from a breakpoint, type @code{commands} and
4994 follow it immediately with @code{end}; that is, give no commands.
4995
4996 With no argument, @code{commands} refers to the last breakpoint,
4997 watchpoint, or catchpoint set (not to the breakpoint most recently
4998 encountered).  If the most recent breakpoints were set with a single
4999 command, then the @code{commands} will apply to all the breakpoints
5000 set by that command.  This applies to breakpoints set by
5001 @code{rbreak}, and also applies when a single @code{break} command
5002 creates multiple breakpoints (@pxref{Ambiguous Expressions,,Ambiguous
5003 Expressions}).
5004 @end table
5005
5006 Pressing @key{RET} as a means of repeating the last @value{GDBN} command is
5007 disabled within a @var{command-list}.
5008
5009 You can use breakpoint commands to start your program up again.  Simply
5010 use the @code{continue} command, or @code{step}, or any other command
5011 that resumes execution.
5012
5013 Any other commands in the command list, after a command that resumes
5014 execution, are ignored.  This is because any time you resume execution
5015 (even with a simple @code{next} or @code{step}), you may encounter
5016 another breakpoint---which could have its own command list, leading to
5017 ambiguities about which list to execute.
5018
5019 @kindex silent
5020 If the first command you specify in a command list is @code{silent}, the
5021 usual message about stopping at a breakpoint is not printed.  This may
5022 be desirable for breakpoints that are to print a specific message and
5023 then continue.  If none of the remaining commands print anything, you
5024 see no sign that the breakpoint was reached.  @code{silent} is
5025 meaningful only at the beginning of a breakpoint command list.
5026
5027 The commands @code{echo}, @code{output}, and @code{printf} allow you to
5028 print precisely controlled output, and are often useful in silent
5029 breakpoints.  @xref{Output, ,Commands for Controlled Output}.
5030
5031 For example, here is how you could use breakpoint commands to print the
5032 value of @code{x} at entry to @code{foo} whenever @code{x} is positive.
5033
5034 @smallexample
5035 break foo if x>0
5036 commands
5037 silent
5038 printf "x is %d\n",x
5039 cont
5040 end
5041 @end smallexample
5042
5043 One application for breakpoint commands is to compensate for one bug so
5044 you can test for another.  Put a breakpoint just after the erroneous line
5045 of code, give it a condition to detect the case in which something
5046 erroneous has been done, and give it commands to assign correct values
5047 to any variables that need them.  End with the @code{continue} command
5048 so that your program does not stop, and start with the @code{silent}
5049 command so that no output is produced.  Here is an example:
5050
5051 @smallexample
5052 break 403
5053 commands
5054 silent
5055 set x = y + 4
5056 cont
5057 end
5058 @end smallexample
5059
5060 @node Dynamic Printf
5061 @subsection Dynamic Printf
5062
5063 @cindex dynamic printf
5064 @cindex dprintf
5065 The dynamic printf command @code{dprintf} combines a breakpoint with
5066 formatted printing of your program's data to give you the effect of
5067 inserting @code{printf} calls into your program on-the-fly, without
5068 having to recompile it.
5069
5070 In its most basic form, the output goes to the GDB console.  However,
5071 you can set the variable @code{dprintf-style} for alternate handling.
5072 For instance, you can ask to format the output by calling your
5073 program's @code{printf} function.  This has the advantage that the
5074 characters go to the program's output device, so they can recorded in
5075 redirects to files and so forth.
5076
5077 If you are doing remote debugging with a stub or agent, you can also
5078 ask to have the printf handled by the remote agent.  In addition to
5079 ensuring that the output goes to the remote program's device along
5080 with any other output the program might produce, you can also ask that
5081 the dprintf remain active even after disconnecting from the remote
5082 target.  Using the stub/agent is also more efficient, as it can do
5083 everything without needing to communicate with @value{GDBN}.
5084
5085 @table @code
5086 @kindex dprintf
5087 @item dprintf @var{location},@var{template},@var{expression}[,@var{expression}@dots{}]
5088 Whenever execution reaches @var{location}, print the values of one or
5089 more @var{expressions} under the control of the string @var{template}.
5090 To print several values, separate them with commas.
5091
5092 @item set dprintf-style @var{style}
5093 Set the dprintf output to be handled in one of several different
5094 styles enumerated below.  A change of style affects all existing
5095 dynamic printfs immediately.  (If you need individual control over the
5096 print commands, simply define normal breakpoints with
5097 explicitly-supplied command lists.)
5098
5099 @table @code
5100 @item gdb
5101 @kindex dprintf-style gdb
5102 Handle the output using the @value{GDBN} @code{printf} command.
5103
5104 @item call
5105 @kindex dprintf-style call
5106 Handle the output by calling a function in your program (normally
5107 @code{printf}).
5108
5109 @item agent
5110 @kindex dprintf-style agent
5111 Have the remote debugging agent (such as @code{gdbserver}) handle
5112 the output itself.  This style is only available for agents that
5113 support running commands on the target.
5114 @end table
5115
5116 @item set dprintf-function @var{function}
5117 Set the function to call if the dprintf style is @code{call}.  By
5118 default its value is @code{printf}.  You may set it to any expression.
5119 that @value{GDBN} can evaluate to a function, as per the @code{call}
5120 command.
5121
5122 @item set dprintf-channel @var{channel}
5123 Set a ``channel'' for dprintf.  If set to a non-empty value,
5124 @value{GDBN} will evaluate it as an expression and pass the result as
5125 a first argument to the @code{dprintf-function}, in the manner of
5126 @code{fprintf} and similar functions.  Otherwise, the dprintf format
5127 string will be the first argument, in the manner of @code{printf}.
5128
5129 As an example, if you wanted @code{dprintf} output to go to a logfile
5130 that is a standard I/O stream assigned to the variable @code{mylog},
5131 you could do the following:
5132
5133 @example
5134 (gdb) set dprintf-style call
5135 (gdb) set dprintf-function fprintf
5136 (gdb) set dprintf-channel mylog
5137 (gdb) dprintf 25,"at line 25, glob=%d\n",glob
5138 Dprintf 1 at 0x123456: file main.c, line 25.
5139 (gdb) info break
5140 1       dprintf        keep y   0x00123456 in main at main.c:25
5141         call (void) fprintf (mylog,"at line 25, glob=%d\n",glob)
5142         continue
5143 (gdb)
5144 @end example
5145
5146 Note that the @code{info break} displays the dynamic printf commands
5147 as normal breakpoint commands; you can thus easily see the effect of
5148 the variable settings.
5149
5150 @item set disconnected-dprintf on
5151 @itemx set disconnected-dprintf off
5152 @kindex set disconnected-dprintf
5153 Choose whether @code{dprintf} commands should continue to run if
5154 @value{GDBN} has disconnected from the target.  This only applies
5155 if the @code{dprintf-style} is @code{agent}.
5156
5157 @item show disconnected-dprintf off
5158 @kindex show disconnected-dprintf
5159 Show the current choice for disconnected @code{dprintf}.
5160
5161 @end table
5162
5163 @value{GDBN} does not check the validity of function and channel,
5164 relying on you to supply values that are meaningful for the contexts
5165 in which they are being used.  For instance, the function and channel
5166 may be the values of local variables, but if that is the case, then
5167 all enabled dynamic prints must be at locations within the scope of
5168 those locals.  If evaluation fails, @value{GDBN} will report an error.
5169
5170 @node Save Breakpoints
5171 @subsection How to save breakpoints to a file
5172
5173 To save breakpoint definitions to a file use the @w{@code{save
5174 breakpoints}} command.
5175
5176 @table @code
5177 @kindex save breakpoints
5178 @cindex save breakpoints to a file for future sessions
5179 @item save breakpoints [@var{filename}]
5180 This command saves all current breakpoint definitions together with
5181 their commands and ignore counts, into a file @file{@var{filename}}
5182 suitable for use in a later debugging session.  This includes all
5183 types of breakpoints (breakpoints, watchpoints, catchpoints,
5184 tracepoints).  To read the saved breakpoint definitions, use the
5185 @code{source} command (@pxref{Command Files}).  Note that watchpoints
5186 with expressions involving local variables may fail to be recreated
5187 because it may not be possible to access the context where the
5188 watchpoint is valid anymore.  Because the saved breakpoint definitions
5189 are simply a sequence of @value{GDBN} commands that recreate the
5190 breakpoints, you can edit the file in your favorite editing program,
5191 and remove the breakpoint definitions you're not interested in, or
5192 that can no longer be recreated.
5193 @end table
5194
5195 @node Static Probe Points
5196 @subsection Static Probe Points
5197
5198 @cindex static probe point, SystemTap
5199 @cindex static probe point, DTrace
5200 @value{GDBN} supports @dfn{SDT} probes in the code.  @acronym{SDT} stands
5201 for Statically Defined Tracing, and the probes are designed to have a tiny
5202 runtime code and data footprint, and no dynamic relocations.
5203
5204 Currently, the following types of probes are supported on
5205 ELF-compatible systems:
5206
5207 @itemize @bullet
5208
5209 @item @code{SystemTap} (@uref{http://sourceware.org/systemtap/})
5210 @acronym{SDT} probes@footnote{See
5211 @uref{http://sourceware.org/systemtap/wiki/AddingUserSpaceProbingToApps}
5212 for more information on how to add @code{SystemTap} @acronym{SDT}
5213 probes in your applications.}.  @code{SystemTap} probes are usable
5214 from assembly, C and C@t{++} languages@footnote{See
5215 @uref{http://sourceware.org/systemtap/wiki/UserSpaceProbeImplementation}
5216 for a good reference on how the @acronym{SDT} probes are implemented.}.  
5217
5218 @item @code{DTrace} (@uref{http://oss.oracle.com/projects/DTrace})
5219 @acronym{USDT} probes.  @code{DTrace} probes are usable from C and
5220 C@t{++} languages.
5221 @end itemize
5222
5223 @cindex semaphores on static probe points
5224 Some @code{SystemTap} probes have an associated semaphore variable;
5225 for instance, this happens automatically if you defined your probe
5226 using a DTrace-style @file{.d} file.  If your probe has a semaphore,
5227 @value{GDBN} will automatically enable it when you specify a
5228 breakpoint using the @samp{-probe-stap} notation.  But, if you put a
5229 breakpoint at a probe's location by some other method (e.g.,
5230 @code{break file:line}), then @value{GDBN} will not automatically set
5231 the semaphore.  @code{DTrace} probes do not support semaphores.
5232
5233 You can examine the available static static probes using @code{info
5234 probes}, with optional arguments:
5235
5236 @table @code
5237 @kindex info probes
5238 @item info probes @r{[}@var{type}@r{]} @r{[}@var{provider} @r{[}@var{name} @r{[}@var{objfile}@r{]}@r{]}@r{]}
5239 If given, @var{type} is either @code{stap} for listing
5240 @code{SystemTap} probes or @code{dtrace} for listing @code{DTrace}
5241 probes.  If omitted all probes are listed regardless of their types.
5242
5243 If given, @var{provider} is a regular expression used to match against provider
5244 names when selecting which probes to list.  If omitted, probes by all
5245 probes from all providers are listed.
5246
5247 If given, @var{name} is a regular expression to match against probe names
5248 when selecting which probes to list.  If omitted, probe names are not
5249 considered when deciding whether to display them.
5250
5251 If given, @var{objfile} is a regular expression used to select which
5252 object files (executable or shared libraries) to examine.  If not
5253 given, all object files are considered.
5254
5255 @item info probes all
5256 List the available static probes, from all types.
5257 @end table
5258
5259 @cindex enabling and disabling probes
5260 Some probe points can be enabled and/or disabled.  The effect of
5261 enabling or disabling a probe depends on the type of probe being
5262 handled.  Some @code{DTrace} probes can be enabled or
5263 disabled, but @code{SystemTap} probes cannot be disabled.
5264
5265 You can enable (or disable) one or more probes using the following
5266 commands, with optional arguments:
5267
5268 @table @code
5269 @kindex enable probes
5270 @item enable probes @r{[}@var{provider} @r{[}@var{name} @r{[}@var{objfile}@r{]}@r{]}@r{]}
5271 If given, @var{provider} is a regular expression used to match against
5272 provider names when selecting which probes to enable.  If omitted,
5273 all probes from all providers are enabled.
5274
5275 If given, @var{name} is a regular expression to match against probe
5276 names when selecting which probes to enable.  If omitted, probe names
5277 are not considered when deciding whether to enable them.
5278
5279 If given, @var{objfile} is a regular expression used to select which
5280 object files (executable or shared libraries) to examine.  If not
5281 given, all object files are considered.
5282
5283 @kindex disable probes
5284 @item disable probes @r{[}@var{provider} @r{[}@var{name} @r{[}@var{objfile}@r{]}@r{]}@r{]}
5285 See the @code{enable probes} command above for a description of the
5286 optional arguments accepted by this command.
5287 @end table
5288
5289 @vindex $_probe_arg@r{, convenience variable}
5290 A probe may specify up to twelve arguments.  These are available at the
5291 point at which the probe is defined---that is, when the current PC is
5292 at the probe's location.  The arguments are available using the
5293 convenience variables (@pxref{Convenience Vars})
5294 @code{$_probe_arg0}@dots{}@code{$_probe_arg11}.  In @code{SystemTap}
5295 probes each probe argument is an integer of the appropriate size;
5296 types are not preserved.  In @code{DTrace} probes types are preserved
5297 provided that they are recognized as such by @value{GDBN}; otherwise
5298 the value of the probe argument will be a long integer.  The
5299 convenience variable @code{$_probe_argc} holds the number of arguments
5300 at the current probe point.
5301
5302 These variables are always available, but attempts to access them at
5303 any location other than a probe point will cause @value{GDBN} to give
5304 an error message.
5305
5306
5307 @c  @ifclear BARETARGET
5308 @node Error in Breakpoints
5309 @subsection ``Cannot insert breakpoints''
5310
5311 If you request too many active hardware-assisted breakpoints and
5312 watchpoints, you will see this error message:
5313
5314 @c FIXME: the precise wording of this message may change; the relevant
5315 @c source change is not committed yet (Sep 3, 1999).
5316 @smallexample
5317 Stopped; cannot insert breakpoints.
5318 You may have requested too many hardware breakpoints and watchpoints.
5319 @end smallexample
5320
5321 @noindent
5322 This message is printed when you attempt to resume the program, since
5323 only then @value{GDBN} knows exactly how many hardware breakpoints and
5324 watchpoints it needs to insert.
5325
5326 When this message is printed, you need to disable or remove some of the
5327 hardware-assisted breakpoints and watchpoints, and then continue.
5328
5329 @node Breakpoint-related Warnings
5330 @subsection ``Breakpoint address adjusted...''
5331 @cindex breakpoint address adjusted
5332
5333 Some processor architectures place constraints on the addresses at
5334 which breakpoints may be placed.  For architectures thus constrained,
5335 @value{GDBN} will attempt to adjust the breakpoint's address to comply
5336 with the constraints dictated by the architecture.
5337
5338 One example of such an architecture is the Fujitsu FR-V.  The FR-V is
5339 a VLIW architecture in which a number of RISC-like instructions may be
5340 bundled together for parallel execution.  The FR-V architecture
5341 constrains the location of a breakpoint instruction within such a
5342 bundle to the instruction with the lowest address.  @value{GDBN}
5343 honors this constraint by adjusting a breakpoint's address to the
5344 first in the bundle.
5345
5346 It is not uncommon for optimized code to have bundles which contain
5347 instructions from different source statements, thus it may happen that
5348 a breakpoint's address will be adjusted from one source statement to
5349 another.  Since this adjustment may significantly alter @value{GDBN}'s
5350 breakpoint related behavior from what the user expects, a warning is
5351 printed when the breakpoint is first set and also when the breakpoint
5352 is hit.
5353
5354 A warning like the one below is printed when setting a breakpoint
5355 that's been subject to address adjustment:
5356
5357 @smallexample
5358 warning: Breakpoint address adjusted from 0x00010414 to 0x00010410.
5359 @end smallexample
5360
5361 Such warnings are printed both for user settable and @value{GDBN}'s
5362 internal breakpoints.  If you see one of these warnings, you should
5363 verify that a breakpoint set at the adjusted address will have the
5364 desired affect.  If not, the breakpoint in question may be removed and
5365 other breakpoints may be set which will have the desired behavior.
5366 E.g., it may be sufficient to place the breakpoint at a later
5367 instruction.  A conditional breakpoint may also be useful in some
5368 cases to prevent the breakpoint from triggering too often.
5369
5370 @value{GDBN} will also issue a warning when stopping at one of these
5371 adjusted breakpoints:
5372
5373 @smallexample
5374 warning: Breakpoint 1 address previously adjusted from 0x00010414
5375 to 0x00010410.
5376 @end smallexample
5377
5378 When this warning is encountered, it may be too late to take remedial
5379 action except in cases where the breakpoint is hit earlier or more
5380 frequently than expected.
5381
5382 @node Continuing and Stepping
5383 @section Continuing and Stepping
5384
5385 @cindex stepping
5386 @cindex continuing
5387 @cindex resuming execution
5388 @dfn{Continuing} means resuming program execution until your program
5389 completes normally.  In contrast, @dfn{stepping} means executing just
5390 one more ``step'' of your program, where ``step'' may mean either one
5391 line of source code, or one machine instruction (depending on what
5392 particular command you use).  Either when continuing or when stepping,
5393 your program may stop even sooner, due to a breakpoint or a signal.  (If
5394 it stops due to a signal, you may want to use @code{handle}, or use
5395 @samp{signal 0} to resume execution (@pxref{Signals, ,Signals}),
5396 or you may step into the signal's handler (@pxref{stepping and signal
5397 handlers}).)
5398
5399 @table @code
5400 @kindex continue
5401 @kindex c @r{(@code{continue})}
5402 @kindex fg @r{(resume foreground execution)}
5403 @item continue @r{[}@var{ignore-count}@r{]}
5404 @itemx c @r{[}@var{ignore-count}@r{]}
5405 @itemx fg @r{[}@var{ignore-count}@r{]}
5406 Resume program execution, at the address where your program last stopped;
5407 any breakpoints set at that address are bypassed.  The optional argument
5408 @var{ignore-count} allows you to specify a further number of times to
5409 ignore a breakpoint at this location; its effect is like that of
5410 @code{ignore} (@pxref{Conditions, ,Break Conditions}).
5411
5412 The argument @var{ignore-count} is meaningful only when your program
5413 stopped due to a breakpoint.  At other times, the argument to
5414 @code{continue} is ignored.
5415
5416 The synonyms @code{c} and @code{fg} (for @dfn{foreground}, as the
5417 debugged program is deemed to be the foreground program) are provided
5418 purely for convenience, and have exactly the same behavior as
5419 @code{continue}.
5420 @end table
5421
5422 To resume execution at a different place, you can use @code{return}
5423 (@pxref{Returning, ,Returning from a Function}) to go back to the
5424 calling function; or @code{jump} (@pxref{Jumping, ,Continuing at a
5425 Different Address}) to go to an arbitrary location in your program.
5426
5427 A typical technique for using stepping is to set a breakpoint
5428 (@pxref{Breakpoints, ,Breakpoints; Watchpoints; and Catchpoints}) at the
5429 beginning of the function or the section of your program where a problem
5430 is believed to lie, run your program until it stops at that breakpoint,
5431 and then step through the suspect area, examining the variables that are
5432 interesting, until you see the problem happen.
5433
5434 @table @code
5435 @kindex step
5436 @kindex s @r{(@code{step})}
5437 @item step
5438 Continue running your program until control reaches a different source
5439 line, then stop it and return control to @value{GDBN}.  This command is
5440 abbreviated @code{s}.
5441
5442 @quotation
5443 @c "without debugging information" is imprecise; actually "without line
5444 @c numbers in the debugging information".  (gcc -g1 has debugging info but
5445 @c not line numbers).  But it seems complex to try to make that
5446 @c distinction here.
5447 @emph{Warning:} If you use the @code{step} command while control is
5448 within a function that was compiled without debugging information,
5449 execution proceeds until control reaches a function that does have
5450 debugging information.  Likewise, it will not step into a function which
5451 is compiled without debugging information.  To step through functions
5452 without debugging information, use the @code{stepi} command, described
5453 below.
5454 @end quotation
5455
5456 The @code{step} command only stops at the first instruction of a source
5457 line.  This prevents the multiple stops that could otherwise occur in
5458 @code{switch} statements, @code{for} loops, etc.  @code{step} continues
5459 to stop if a function that has debugging information is called within
5460 the line.  In other words, @code{step} @emph{steps inside} any functions
5461 called within the line.
5462
5463 Also, the @code{step} command only enters a function if there is line
5464 number information for the function.  Otherwise it acts like the
5465 @code{next} command.  This avoids problems when using @code{cc -gl}
5466 on @acronym{MIPS} machines.  Previously, @code{step} entered subroutines if there
5467 was any debugging information about the routine.
5468
5469 @item step @var{count}
5470 Continue running as in @code{step}, but do so @var{count} times.  If a
5471 breakpoint is reached, or a signal not related to stepping occurs before
5472 @var{count} steps, stepping stops right away.
5473
5474 @kindex next
5475 @kindex n @r{(@code{next})}
5476 @item next @r{[}@var{count}@r{]}
5477 Continue to the next source line in the current (innermost) stack frame.
5478 This is similar to @code{step}, but function calls that appear within
5479 the line of code are executed without stopping.  Execution stops when
5480 control reaches a different line of code at the original stack level
5481 that was executing when you gave the @code{next} command.  This command
5482 is abbreviated @code{n}.
5483
5484 An argument @var{count} is a repeat count, as for @code{step}.
5485
5486
5487 @c  FIX ME!!  Do we delete this, or is there a way it fits in with
5488 @c  the following paragraph?   ---  Vctoria
5489 @c
5490 @c  @code{next} within a function that lacks debugging information acts like
5491 @c  @code{step}, but any function calls appearing within the code of the
5492 @c  function are executed without stopping.
5493
5494 The @code{next} command only stops at the first instruction of a
5495 source line.  This prevents multiple stops that could otherwise occur in
5496 @code{switch} statements, @code{for} loops, etc.
5497
5498 @kindex set step-mode
5499 @item set step-mode
5500 @cindex functions without line info, and stepping
5501 @cindex stepping into functions with no line info
5502 @itemx set step-mode on
5503 The @code{set step-mode on} command causes the @code{step} command to
5504 stop at the first instruction of a function which contains no debug line
5505 information rather than stepping over it.
5506
5507 This is useful in cases where you may be interested in inspecting the
5508 machine instructions of a function which has no symbolic info and do not
5509 want @value{GDBN} to automatically skip over this function.
5510
5511 @item set step-mode off
5512 Causes the @code{step} command to step over any functions which contains no
5513 debug information.  This is the default.
5514
5515 @item show step-mode
5516 Show whether @value{GDBN} will stop in or step over functions without
5517 source line debug information.
5518
5519 @kindex finish
5520 @kindex fin @r{(@code{finish})}
5521 @item finish
5522 Continue running until just after function in the selected stack frame
5523 returns.  Print the returned value (if any).  This command can be
5524 abbreviated as @code{fin}.
5525
5526 Contrast this with the @code{return} command (@pxref{Returning,
5527 ,Returning from a Function}).
5528
5529 @kindex until
5530 @kindex u @r{(@code{until})}
5531 @cindex run until specified location
5532 @item until
5533 @itemx u
5534 Continue running until a source line past the current line, in the
5535 current stack frame, is reached.  This command is used to avoid single
5536 stepping through a loop more than once.  It is like the @code{next}
5537 command, except that when @code{until} encounters a jump, it
5538 automatically continues execution until the program counter is greater
5539 than the address of the jump.
5540
5541 This means that when you reach the end of a loop after single stepping
5542 though it, @code{until} makes your program continue execution until it
5543 exits the loop.  In contrast, a @code{next} command at the end of a loop
5544 simply steps back to the beginning of the loop, which forces you to step
5545 through the next iteration.
5546
5547 @code{until} always stops your program if it attempts to exit the current
5548 stack frame.
5549
5550 @code{until} may produce somewhat counterintuitive results if the order
5551 of machine code does not match the order of the source lines.  For
5552 example, in the following excerpt from a debugging session, the @code{f}
5553 (@code{frame}) command shows that execution is stopped at line
5554 @code{206}; yet when we use @code{until}, we get to line @code{195}:
5555
5556 @smallexample
5557 (@value{GDBP}) f
5558 #0  main (argc=4, argv=0xf7fffae8) at m4.c:206
5559 206                 expand_input();
5560 (@value{GDBP}) until
5561 195             for ( ; argc > 0; NEXTARG) @{
5562 @end smallexample
5563
5564 This happened because, for execution efficiency, the compiler had
5565 generated code for the loop closure test at the end, rather than the
5566 start, of the loop---even though the test in a C @code{for}-loop is
5567 written before the body of the loop.  The @code{until} command appeared
5568 to step back to the beginning of the loop when it advanced to this
5569 expression; however, it has not really gone to an earlier
5570 statement---not in terms of the actual machine code.
5571
5572 @code{until} with no argument works by means of single
5573 instruction stepping, and hence is slower than @code{until} with an
5574 argument.
5575
5576 @item until @var{location}
5577 @itemx u @var{location}
5578 Continue running your program until either the specified @var{location} is
5579 reached, or the current stack frame returns.  The location is any of
5580 the forms described in @ref{Specify Location}.
5581 This form of the command uses temporary breakpoints, and
5582 hence is quicker than @code{until} without an argument.  The specified
5583 location is actually reached only if it is in the current frame.  This
5584 implies that @code{until} can be used to skip over recursive function
5585 invocations.  For instance in the code below, if the current location is
5586 line @code{96}, issuing @code{until 99} will execute the program up to
5587 line @code{99} in the same invocation of factorial, i.e., after the inner
5588 invocations have returned.
5589
5590 @smallexample
5591 94      int factorial (int value)
5592 95      @{
5593 96          if (value > 1) @{
5594 97            value *= factorial (value - 1);
5595 98          @}
5596 99          return (value);
5597 100     @}
5598 @end smallexample
5599
5600
5601 @kindex advance @var{location}
5602 @item advance @var{location}
5603 Continue running the program up to the given @var{location}.  An argument is
5604 required, which should be of one of the forms described in
5605 @ref{Specify Location}.
5606 Execution will also stop upon exit from the current stack
5607 frame.  This command is similar to @code{until}, but @code{advance} will
5608 not skip over recursive function calls, and the target location doesn't
5609 have to be in the same frame as the current one.
5610
5611
5612 @kindex stepi
5613 @kindex si @r{(@code{stepi})}
5614 @item stepi
5615 @itemx stepi @var{arg}
5616 @itemx si
5617 Execute one machine instruction, then stop and return to the debugger.
5618
5619 It is often useful to do @samp{display/i $pc} when stepping by machine
5620 instructions.  This makes @value{GDBN} automatically display the next
5621 instruction to be executed, each time your program stops.  @xref{Auto
5622 Display,, Automatic Display}.
5623
5624 An argument is a repeat count, as in @code{step}.
5625
5626 @need 750
5627 @kindex nexti
5628 @kindex ni @r{(@code{nexti})}
5629 @item nexti
5630 @itemx nexti @var{arg}
5631 @itemx ni
5632 Execute one machine instruction, but if it is a function call,
5633 proceed until the function returns.
5634
5635 An argument is a repeat count, as in @code{next}.
5636
5637 @end table
5638
5639 @anchor{range stepping}
5640 @cindex range stepping
5641 @cindex target-assisted range stepping
5642 By default, and if available, @value{GDBN} makes use of
5643 target-assisted @dfn{range stepping}.  In other words, whenever you
5644 use a stepping command (e.g., @code{step}, @code{next}), @value{GDBN}
5645 tells the target to step the corresponding range of instruction
5646 addresses instead of issuing multiple single-steps.  This speeds up
5647 line stepping, particularly for remote targets.  Ideally, there should
5648 be no reason you would want to turn range stepping off.  However, it's
5649 possible that a bug in the debug info, a bug in the remote stub (for
5650 remote targets), or even a bug in @value{GDBN} could make line
5651 stepping behave incorrectly when target-assisted range stepping is
5652 enabled.  You can use the following command to turn off range stepping
5653 if necessary:
5654
5655 @table @code
5656 @kindex set range-stepping
5657 @kindex show range-stepping
5658 @item set range-stepping
5659 @itemx show range-stepping
5660 Control whether range stepping is enabled.
5661
5662 If @code{on}, and the target supports it, @value{GDBN} tells the
5663 target to step a range of addresses itself, instead of issuing
5664 multiple single-steps.  If @code{off}, @value{GDBN} always issues
5665 single-steps, even if range stepping is supported by the target.  The
5666 default is @code{on}.
5667
5668 @end table
5669
5670 @node Skipping Over Functions and Files
5671 @section Skipping Over Functions and Files
5672 @cindex skipping over functions and files
5673
5674 The program you are debugging may contain some functions which are
5675 uninteresting to debug.  The @code{skip} command lets you tell @value{GDBN} to
5676 skip a function, all functions in a file or a particular function in
5677 a particular file when stepping.
5678
5679 For example, consider the following C function:
5680
5681 @smallexample
5682 101     int func()
5683 102     @{
5684 103         foo(boring());
5685 104         bar(boring());
5686 105     @}
5687 @end smallexample
5688
5689 @noindent
5690 Suppose you wish to step into the functions @code{foo} and @code{bar}, but you
5691 are not interested in stepping through @code{boring}.  If you run @code{step}
5692 at line 103, you'll enter @code{boring()}, but if you run @code{next}, you'll
5693 step over both @code{foo} and @code{boring}!
5694
5695 One solution is to @code{step} into @code{boring} and use the @code{finish}
5696 command to immediately exit it.  But this can become tedious if @code{boring}
5697 is called from many places.
5698
5699 A more flexible solution is to execute @kbd{skip boring}.  This instructs
5700 @value{GDBN} never to step into @code{boring}.  Now when you execute
5701 @code{step} at line 103, you'll step over @code{boring} and directly into
5702 @code{foo}.
5703
5704 Functions may be skipped by providing either a function name, linespec
5705 (@pxref{Specify Location}), regular expression that matches the function's
5706 name, file name or a @code{glob}-style pattern that matches the file name.
5707
5708 On Posix systems the form of the regular expression is
5709 ``Extended Regular Expressions''.  See for example @samp{man 7 regex}
5710 on @sc{gnu}/Linux systems.  On non-Posix systems the form of the regular
5711 expression is whatever is provided by the @code{regcomp} function of
5712 the underlying system.
5713 See for example @samp{man 7 glob} on @sc{gnu}/Linux systems for a
5714 description of @code{glob}-style patterns.
5715
5716 @table @code
5717 @kindex skip
5718 @item skip @r{[}@var{options}@r{]}
5719 The basic form of the @code{skip} command takes zero or more options
5720 that specify what to skip.
5721 The @var{options} argument is any useful combination of the following:
5722
5723 @table @code
5724 @item -file @var{file}
5725 @itemx -fi @var{file}
5726 Functions in @var{file} will be skipped over when stepping.
5727
5728 @item -gfile @var{file-glob-pattern}
5729 @itemx -gfi @var{file-glob-pattern}
5730 @cindex skipping over files via glob-style patterns
5731 Functions in files matching @var{file-glob-pattern} will be skipped
5732 over when stepping.
5733
5734 @smallexample
5735 (gdb) skip -gfi utils/*.c
5736 @end smallexample
5737
5738 @item -function @var{linespec}
5739 @itemx -fu @var{linespec}
5740 Functions named by @var{linespec} or the function containing the line
5741 named by @var{linespec} will be skipped over when stepping.
5742 @xref{Specify Location}.
5743
5744 @item -rfunction @var{regexp}
5745 @itemx -rfu @var{regexp}
5746 @cindex skipping over functions via regular expressions
5747 Functions whose name matches @var{regexp} will be skipped over when stepping.
5748
5749 This form is useful for complex function names.
5750 For example, there is generally no need to step into C@t{++} @code{std::string}
5751 constructors or destructors.  Plus with C@t{++} templates it can be hard to
5752 write out the full name of the function, and often it doesn't matter what
5753 the template arguments are.  Specifying the function to be skipped as a
5754 regular expression makes this easier.
5755
5756 @smallexample
5757 (gdb) skip -rfu ^std::(allocator|basic_string)<.*>::~?\1 *\(
5758 @end smallexample
5759
5760 If you want to skip every templated C@t{++} constructor and destructor
5761 in the @code{std} namespace you can do:
5762
5763 @smallexample
5764 (gdb) skip -rfu ^std::([a-zA-z0-9_]+)<.*>::~?\1 *\(
5765 @end smallexample
5766 @end table
5767
5768 If no options are specified, the function you're currently debugging
5769 will be skipped.
5770
5771 @kindex skip function
5772 @item skip function @r{[}@var{linespec}@r{]}
5773 After running this command, the function named by @var{linespec} or the
5774 function containing the line named by @var{linespec} will be skipped over when
5775 stepping.  @xref{Specify Location}.
5776
5777 If you do not specify @var{linespec}, the function you're currently debugging
5778 will be skipped.
5779
5780 (If you have a function called @code{file} that you want to skip, use
5781 @kbd{skip function file}.)
5782
5783 @kindex skip file
5784 @item skip file @r{[}@var{filename}@r{]}
5785 After running this command, any function whose source lives in @var{filename}
5786 will be skipped over when stepping.
5787
5788 @smallexample
5789 (gdb) skip file boring.c
5790 File boring.c will be skipped when stepping.
5791 @end smallexample
5792
5793 If you do not specify @var{filename}, functions whose source lives in the file
5794 you're currently debugging will be skipped.
5795 @end table
5796
5797 Skips can be listed, deleted, disabled, and enabled, much like breakpoints.
5798 These are the commands for managing your list of skips:
5799
5800 @table @code
5801 @kindex info skip
5802 @item info skip @r{[}@var{range}@r{]}
5803 Print details about the specified skip(s).  If @var{range} is not specified,
5804 print a table with details about all functions and files marked for skipping.
5805 @code{info skip} prints the following information about each skip:
5806
5807 @table @emph
5808 @item Identifier
5809 A number identifying this skip.
5810 @item Enabled or Disabled
5811 Enabled skips are marked with @samp{y}.
5812 Disabled skips are marked with @samp{n}.
5813 @item Glob
5814 If the file name is a @samp{glob} pattern this is @samp{y}.
5815 Otherwise it is @samp{n}.
5816 @item File
5817 The name or @samp{glob} pattern of the file to be skipped.
5818 If no file is specified this is @samp{<none>}.
5819 @item RE
5820 If the function name is a @samp{regular expression} this is @samp{y}.
5821 Otherwise it is @samp{n}.
5822 @item Function
5823 The name or regular expression of the function to skip.
5824 If no function is specified this is @samp{<none>}.
5825 @end table
5826
5827 @kindex skip delete
5828 @item skip delete @r{[}@var{range}@r{]}
5829 Delete the specified skip(s).  If @var{range} is not specified, delete all
5830 skips.
5831
5832 @kindex skip enable
5833 @item skip enable @r{[}@var{range}@r{]}
5834 Enable the specified skip(s).  If @var{range} is not specified, enable all
5835 skips.
5836
5837 @kindex skip disable
5838 @item skip disable @r{[}@var{range}@r{]}
5839 Disable the specified skip(s).  If @var{range} is not specified, disable all
5840 skips.
5841
5842 @end table
5843
5844 @node Signals
5845 @section Signals
5846 @cindex signals
5847
5848 A signal is an asynchronous event that can happen in a program.  The
5849 operating system defines the possible kinds of signals, and gives each
5850 kind a name and a number.  For example, in Unix @code{SIGINT} is the
5851 signal a program gets when you type an interrupt character (often @kbd{Ctrl-c});
5852 @code{SIGSEGV} is the signal a program gets from referencing a place in
5853 memory far away from all the areas in use; @code{SIGALRM} occurs when
5854 the alarm clock timer goes off (which happens only if your program has
5855 requested an alarm).
5856
5857 @cindex fatal signals
5858 Some signals, including @code{SIGALRM}, are a normal part of the
5859 functioning of your program.  Others, such as @code{SIGSEGV}, indicate
5860 errors; these signals are @dfn{fatal} (they kill your program immediately) if the
5861 program has not specified in advance some other way to handle the signal.
5862 @code{SIGINT} does not indicate an error in your program, but it is normally
5863 fatal so it can carry out the purpose of the interrupt: to kill the program.
5864
5865 @value{GDBN} has the ability to detect any occurrence of a signal in your
5866 program.  You can tell @value{GDBN} in advance what to do for each kind of
5867 signal.
5868
5869 @cindex handling signals
5870 Normally, @value{GDBN} is set up to let the non-erroneous signals like
5871 @code{SIGALRM} be silently passed to your program
5872 (so as not to interfere with their role in the program's functioning)
5873 but to stop your program immediately whenever an error signal happens.
5874 You can change these settings with the @code{handle} command.
5875
5876 @table @code
5877 @kindex info signals
5878 @kindex info handle
5879 @item info signals
5880 @itemx info handle
5881 Print a table of all the kinds of signals and how @value{GDBN} has been told to
5882 handle each one.  You can use this to see the signal numbers of all
5883 the defined types of signals.
5884
5885 @item info signals @var{sig}
5886 Similar, but print information only about the specified signal number.
5887
5888 @code{info handle} is an alias for @code{info signals}.
5889
5890 @item catch signal @r{[}@var{signal}@dots{} @r{|} @samp{all}@r{]}
5891 Set a catchpoint for the indicated signals.  @xref{Set Catchpoints},
5892 for details about this command.
5893
5894 @kindex handle
5895 @item handle @var{signal} @r{[}@var{keywords}@dots{}@r{]}
5896 Change the way @value{GDBN} handles signal @var{signal}.  The @var{signal}
5897 can be the number of a signal or its name (with or without the
5898 @samp{SIG} at the beginning); a list of signal numbers of the form
5899 @samp{@var{low}-@var{high}}; or the word @samp{all}, meaning all the
5900 known signals.  Optional arguments @var{keywords}, described below,
5901 say what change to make.
5902 @end table
5903
5904 @c @group
5905 The keywords allowed by the @code{handle} command can be abbreviated.
5906 Their full names are:
5907
5908 @table @code
5909 @item nostop
5910 @value{GDBN} should not stop your program when this signal happens.  It may
5911 still print a message telling you that the signal has come in.
5912
5913 @item stop
5914 @value{GDBN} should stop your program when this signal happens.  This implies
5915 the @code{print} keyword as well.
5916
5917 @item print
5918 @value{GDBN} should print a message when this signal happens.
5919
5920 @item noprint
5921 @value{GDBN} should not mention the occurrence of the signal at all.  This
5922 implies the @code{nostop} keyword as well.
5923
5924 @item pass
5925 @itemx noignore
5926 @value{GDBN} should allow your program to see this signal; your program
5927 can handle the signal, or else it may terminate if the signal is fatal
5928 and not handled.  @code{pass} and @code{noignore} are synonyms.
5929
5930 @item nopass
5931 @itemx ignore
5932 @value{GDBN} should not allow your program to see this signal.
5933 @code{nopass} and @code{ignore} are synonyms.
5934 @end table
5935 @c @end group
5936
5937 When a signal stops your program, the signal is not visible to the
5938 program until you
5939 continue.  Your program sees the signal then, if @code{pass} is in
5940 effect for the signal in question @emph{at that time}.  In other words,
5941 after @value{GDBN} reports a signal, you can use the @code{handle}
5942 command with @code{pass} or @code{nopass} to control whether your
5943 program sees that signal when you continue.
5944
5945 The default is set to @code{nostop}, @code{noprint}, @code{pass} for
5946 non-erroneous signals such as @code{SIGALRM}, @code{SIGWINCH} and
5947 @code{SIGCHLD}, and to @code{stop}, @code{print}, @code{pass} for the
5948 erroneous signals.
5949
5950 You can also use the @code{signal} command to prevent your program from
5951 seeing a signal, or cause it to see a signal it normally would not see,
5952 or to give it any signal at any time.  For example, if your program stopped
5953 due to some sort of memory reference error, you might store correct
5954 values into the erroneous variables and continue, hoping to see more
5955 execution; but your program would probably terminate immediately as
5956 a result of the fatal signal once it saw the signal.  To prevent this,
5957 you can continue with @samp{signal 0}.  @xref{Signaling, ,Giving your
5958 Program a Signal}.
5959
5960 @cindex stepping and signal handlers
5961 @anchor{stepping and signal handlers}
5962
5963 @value{GDBN} optimizes for stepping the mainline code.  If a signal
5964 that has @code{handle nostop} and @code{handle pass} set arrives while
5965 a stepping command (e.g., @code{stepi}, @code{step}, @code{next}) is
5966 in progress, @value{GDBN} lets the signal handler run and then resumes
5967 stepping the mainline code once the signal handler returns.  In other
5968 words, @value{GDBN} steps over the signal handler.  This prevents
5969 signals that you've specified as not interesting (with @code{handle
5970 nostop}) from changing the focus of debugging unexpectedly.  Note that
5971 the signal handler itself may still hit a breakpoint, stop for another
5972 signal that has @code{handle stop} in effect, or for any other event
5973 that normally results in stopping the stepping command sooner.  Also
5974 note that @value{GDBN} still informs you that the program received a
5975 signal if @code{handle print} is set.
5976
5977 @anchor{stepping into signal handlers}
5978
5979 If you set @code{handle pass} for a signal, and your program sets up a
5980 handler for it, then issuing a stepping command, such as @code{step}
5981 or @code{stepi}, when your program is stopped due to the signal will
5982 step @emph{into} the signal handler (if the target supports that).
5983
5984 Likewise, if you use the @code{queue-signal} command to queue a signal
5985 to be delivered to the current thread when execution of the thread
5986 resumes (@pxref{Signaling, ,Giving your Program a Signal}), then a
5987 stepping command will step into the signal handler.
5988
5989 Here's an example, using @code{stepi} to step to the first instruction
5990 of @code{SIGUSR1}'s handler:
5991
5992 @smallexample
5993 (@value{GDBP}) handle SIGUSR1
5994 Signal        Stop      Print   Pass to program Description
5995 SIGUSR1       Yes       Yes     Yes             User defined signal 1
5996 (@value{GDBP}) c
5997 Continuing.
5998
5999 Program received signal SIGUSR1, User defined signal 1.
6000 main () sigusr1.c:28
6001 28        p = 0;
6002 (@value{GDBP}) si
6003 sigusr1_handler () at sigusr1.c:9
6004 9       @{
6005 @end smallexample
6006
6007 The same, but using @code{queue-signal} instead of waiting for the
6008 program to receive the signal first:
6009
6010 @smallexample
6011 (@value{GDBP}) n
6012 28        p = 0;
6013 (@value{GDBP}) queue-signal SIGUSR1
6014 (@value{GDBP}) si
6015 sigusr1_handler () at sigusr1.c:9
6016 9       @{
6017 (@value{GDBP})
6018 @end smallexample
6019
6020 @cindex extra signal information
6021 @anchor{extra signal information}
6022
6023 On some targets, @value{GDBN} can inspect extra signal information
6024 associated with the intercepted signal, before it is actually
6025 delivered to the program being debugged.  This information is exported
6026 by the convenience variable @code{$_siginfo}, and consists of data
6027 that is passed by the kernel to the signal handler at the time of the
6028 receipt of a signal.  The data type of the information itself is
6029 target dependent.  You can see the data type using the @code{ptype
6030 $_siginfo} command.  On Unix systems, it typically corresponds to the
6031 standard @code{siginfo_t} type, as defined in the @file{signal.h}
6032 system header.
6033
6034 Here's an example, on a @sc{gnu}/Linux system, printing the stray
6035 referenced address that raised a segmentation fault.
6036
6037 @smallexample
6038 @group
6039 (@value{GDBP}) continue
6040 Program received signal SIGSEGV, Segmentation fault.
6041 0x0000000000400766 in main ()
6042 69        *(int *)p = 0;
6043 (@value{GDBP}) ptype $_siginfo
6044 type = struct @{
6045     int si_signo;
6046     int si_errno;
6047     int si_code;
6048     union @{
6049         int _pad[28];
6050         struct @{...@} _kill;
6051         struct @{...@} _timer;
6052         struct @{...@} _rt;
6053         struct @{...@} _sigchld;
6054         struct @{...@} _sigfault;
6055         struct @{...@} _sigpoll;
6056     @} _sifields;
6057 @}
6058 (@value{GDBP}) ptype $_siginfo._sifields._sigfault
6059 type = struct @{
6060     void *si_addr;
6061 @}
6062 (@value{GDBP}) p $_siginfo._sifields._sigfault.si_addr
6063 $1 = (void *) 0x7ffff7ff7000
6064 @end group
6065 @end smallexample
6066
6067 Depending on target support, @code{$_siginfo} may also be writable.
6068
6069 @cindex Intel MPX boundary violations
6070 @cindex boundary violations, Intel MPX
6071 On some targets, a @code{SIGSEGV} can be caused by a boundary
6072 violation, i.e., accessing an address outside of the allowed range.
6073 In those cases @value{GDBN} may displays additional information,
6074 depending on how @value{GDBN} has been told to handle the signal.
6075 With @code{handle stop SIGSEGV}, @value{GDBN} displays the violation
6076 kind: "Upper" or "Lower", the memory address accessed and the
6077 bounds, while with @code{handle nostop SIGSEGV} no additional
6078 information is displayed.
6079
6080 The usual output of a segfault is:
6081 @smallexample
6082 Program received signal SIGSEGV, Segmentation fault
6083 0x0000000000400d7c in upper () at i386-mpx-sigsegv.c:68
6084 68        value = *(p + len);
6085 @end smallexample
6086
6087 While a bound violation is presented as:
6088 @smallexample
6089 Program received signal SIGSEGV, Segmentation fault
6090 Upper bound violation while accessing address 0x7fffffffc3b3
6091 Bounds: [lower = 0x7fffffffc390, upper = 0x7fffffffc3a3]
6092 0x0000000000400d7c in upper () at i386-mpx-sigsegv.c:68
6093 68        value = *(p + len);
6094 @end smallexample
6095
6096 @node Thread Stops
6097 @section Stopping and Starting Multi-thread Programs
6098
6099 @cindex stopped threads
6100 @cindex threads, stopped
6101
6102 @cindex continuing threads
6103 @cindex threads, continuing
6104
6105 @value{GDBN} supports debugging programs with multiple threads
6106 (@pxref{Threads,, Debugging Programs with Multiple Threads}).  There
6107 are two modes of controlling execution of your program within the
6108 debugger.  In the default mode, referred to as @dfn{all-stop mode},
6109 when any thread in your program stops (for example, at a breakpoint 
6110 or while being stepped), all other threads in the program are also stopped by 
6111 @value{GDBN}.  On some targets, @value{GDBN} also supports 
6112 @dfn{non-stop mode}, in which other threads can continue to run freely while
6113 you examine the stopped thread in the debugger.
6114
6115 @menu
6116 * All-Stop Mode::               All threads stop when GDB takes control
6117 * Non-Stop Mode::               Other threads continue to execute
6118 * Background Execution::        Running your program asynchronously
6119 * Thread-Specific Breakpoints:: Controlling breakpoints
6120 * Interrupted System Calls::    GDB may interfere with system calls
6121 * Observer Mode::               GDB does not alter program behavior
6122 @end menu
6123
6124 @node All-Stop Mode
6125 @subsection All-Stop Mode
6126
6127 @cindex all-stop mode
6128
6129 In all-stop mode, whenever your program stops under @value{GDBN} for any reason,
6130 @emph{all} threads of execution stop, not just the current thread.  This
6131 allows you to examine the overall state of the program, including
6132 switching between threads, without worrying that things may change
6133 underfoot.
6134
6135 Conversely, whenever you restart the program, @emph{all} threads start
6136 executing.  @emph{This is true even when single-stepping} with commands
6137 like @code{step} or @code{next}.
6138
6139 In particular, @value{GDBN} cannot single-step all threads in lockstep.
6140 Since thread scheduling is up to your debugging target's operating
6141 system (not controlled by @value{GDBN}), other threads may
6142 execute more than one statement while the current thread completes a
6143 single step.  Moreover, in general other threads stop in the middle of a
6144 statement, rather than at a clean statement boundary, when the program
6145 stops.
6146
6147 You might even find your program stopped in another thread after
6148 continuing or even single-stepping.  This happens whenever some other
6149 thread runs into a breakpoint, a signal, or an exception before the
6150 first thread completes whatever you requested.
6151
6152 @cindex automatic thread selection
6153 @cindex switching threads automatically
6154 @cindex threads, automatic switching
6155 Whenever @value{GDBN} stops your program, due to a breakpoint or a
6156 signal, it automatically selects the thread where that breakpoint or
6157 signal happened.  @value{GDBN} alerts you to the context switch with a
6158 message such as @samp{[Switching to Thread @var{n}]} to identify the
6159 thread.  
6160
6161 On some OSes, you can modify @value{GDBN}'s default behavior by
6162 locking the OS scheduler to allow only a single thread to run.
6163
6164 @table @code
6165 @item set scheduler-locking @var{mode}
6166 @cindex scheduler locking mode
6167 @cindex lock scheduler
6168 Set the scheduler locking mode.  It applies to normal execution,
6169 record mode, and replay mode.  If it is @code{off}, then there is no
6170 locking and any thread may run at any time.  If @code{on}, then only
6171 the current thread may run when the inferior is resumed.  The
6172 @code{step} mode optimizes for single-stepping; it prevents other
6173 threads from preempting the current thread while you are stepping, so
6174 that the focus of debugging does not change unexpectedly.  Other
6175 threads never get a chance to run when you step, and they are
6176 completely free to run when you use commands like @samp{continue},
6177 @samp{until}, or @samp{finish}.  However, unless another thread hits a
6178 breakpoint during its timeslice, @value{GDBN} does not change the
6179 current thread away from the thread that you are debugging.  The
6180 @code{replay} mode behaves like @code{off} in record mode and like
6181 @code{on} in replay mode.
6182
6183 @item show scheduler-locking
6184 Display the current scheduler locking mode.
6185 @end table
6186
6187 @cindex resume threads of multiple processes simultaneously
6188 By default, when you issue one of the execution commands such as
6189 @code{continue}, @code{next} or @code{step}, @value{GDBN} allows only
6190 threads of the current inferior to run.  For example, if @value{GDBN}
6191 is attached to two inferiors, each with two threads, the
6192 @code{continue} command resumes only the two threads of the current
6193 inferior.  This is useful, for example, when you debug a program that
6194 forks and you want to hold the parent stopped (so that, for instance,
6195 it doesn't run to exit), while you debug the child.  In other
6196 situations, you may not be interested in inspecting the current state
6197 of any of the processes @value{GDBN} is attached to, and you may want
6198 to resume them all until some breakpoint is hit.  In the latter case,
6199 you can instruct @value{GDBN} to allow all threads of all the
6200 inferiors to run with the @w{@code{set schedule-multiple}} command.
6201
6202 @table @code
6203 @kindex set schedule-multiple
6204 @item set schedule-multiple
6205 Set the mode for allowing threads of multiple processes to be resumed
6206 when an execution command is issued.  When @code{on}, all threads of
6207 all processes are allowed to run.  When @code{off}, only the threads
6208 of the current process are resumed.  The default is @code{off}.  The
6209 @code{scheduler-locking} mode takes precedence when set to @code{on},
6210 or while you are stepping and set to @code{step}.
6211
6212 @item show schedule-multiple
6213 Display the current mode for resuming the execution of threads of
6214 multiple processes.
6215 @end table
6216
6217 @node Non-Stop Mode
6218 @subsection Non-Stop Mode
6219
6220 @cindex non-stop mode
6221
6222 @c This section is really only a place-holder, and needs to be expanded
6223 @c with more details.
6224
6225 For some multi-threaded targets, @value{GDBN} supports an optional
6226 mode of operation in which you can examine stopped program threads in
6227 the debugger while other threads continue to execute freely.  This
6228 minimizes intrusion when debugging live systems, such as programs
6229 where some threads have real-time constraints or must continue to
6230 respond to external events.  This is referred to as @dfn{non-stop} mode.
6231
6232 In non-stop mode, when a thread stops to report a debugging event,
6233 @emph{only} that thread is stopped; @value{GDBN} does not stop other
6234 threads as well, in contrast to the all-stop mode behavior.  Additionally,
6235 execution commands such as @code{continue} and @code{step} apply by default
6236 only to the current thread in non-stop mode, rather than all threads as
6237 in all-stop mode.  This allows you to control threads explicitly in
6238 ways that are not possible in all-stop mode --- for example, stepping
6239 one thread while allowing others to run freely, stepping
6240 one thread while holding all others stopped, or stepping several threads
6241 independently and simultaneously.
6242
6243 To enter non-stop mode, use this sequence of commands before you run
6244 or attach to your program:
6245
6246 @smallexample
6247 # If using the CLI, pagination breaks non-stop.
6248 set pagination off
6249
6250 # Finally, turn it on!
6251 set non-stop on
6252 @end smallexample
6253
6254 You can use these commands to manipulate the non-stop mode setting:
6255
6256 @table @code
6257 @kindex set non-stop
6258 @item set non-stop on
6259 Enable selection of non-stop mode.
6260 @item set non-stop off
6261 Disable selection of non-stop mode.
6262 @kindex show non-stop
6263 @item show non-stop
6264 Show the current non-stop enablement setting.
6265 @end table
6266
6267 Note these commands only reflect whether non-stop mode is enabled,
6268 not whether the currently-executing program is being run in non-stop mode.
6269 In particular, the @code{set non-stop} preference is only consulted when
6270 @value{GDBN} starts or connects to the target program, and it is generally
6271 not possible to switch modes once debugging has started.  Furthermore,
6272 since not all targets support non-stop mode, even when you have enabled
6273 non-stop mode, @value{GDBN} may still fall back to all-stop operation by
6274 default.
6275
6276 In non-stop mode, all execution commands apply only to the current thread
6277 by default.  That is, @code{continue} only continues one thread.
6278 To continue all threads, issue @code{continue -a} or @code{c -a}.
6279
6280 You can use @value{GDBN}'s background execution commands
6281 (@pxref{Background Execution}) to run some threads in the background
6282 while you continue to examine or step others from @value{GDBN}.
6283 The MI execution commands (@pxref{GDB/MI Program Execution}) are
6284 always executed asynchronously in non-stop mode.
6285
6286 Suspending execution is done with the @code{interrupt} command when
6287 running in the background, or @kbd{Ctrl-c} during foreground execution.
6288 In all-stop mode, this stops the whole process;
6289 but in non-stop mode the interrupt applies only to the current thread.
6290 To stop the whole program, use @code{interrupt -a}.
6291
6292 Other execution commands do not currently support the @code{-a} option.
6293
6294 In non-stop mode, when a thread stops, @value{GDBN} doesn't automatically make
6295 that thread current, as it does in all-stop mode.  This is because the
6296 thread stop notifications are asynchronous with respect to @value{GDBN}'s
6297 command interpreter, and it would be confusing if @value{GDBN} unexpectedly
6298 changed to a different thread just as you entered a command to operate on the
6299 previously current thread.
6300
6301 @node Background Execution
6302 @subsection Background Execution
6303
6304 @cindex foreground execution
6305 @cindex background execution
6306 @cindex asynchronous execution
6307 @cindex execution, foreground, background and asynchronous
6308
6309 @value{GDBN}'s execution commands have two variants:  the normal
6310 foreground (synchronous) behavior, and a background
6311 (asynchronous) behavior.  In foreground execution, @value{GDBN} waits for
6312 the program to report that some thread has stopped before prompting for
6313 another command.  In background execution, @value{GDBN} immediately gives
6314 a command prompt so that you can issue other commands while your program runs.
6315
6316 If the target doesn't support async mode, @value{GDBN} issues an error
6317 message if you attempt to use the background execution commands.
6318
6319 To specify background execution, add a @code{&} to the command.  For example,
6320 the background form of the @code{continue} command is @code{continue&}, or
6321 just @code{c&}.  The execution commands that accept background execution
6322 are:
6323
6324 @table @code
6325 @kindex run&
6326 @item run
6327 @xref{Starting, , Starting your Program}.
6328
6329 @item attach
6330 @kindex attach&
6331 @xref{Attach, , Debugging an Already-running Process}.
6332
6333 @item step
6334 @kindex step&
6335 @xref{Continuing and Stepping, step}.
6336
6337 @item stepi
6338 @kindex stepi&
6339 @xref{Continuing and Stepping, stepi}.
6340
6341 @item next
6342 @kindex next&
6343 @xref{Continuing and Stepping, next}.
6344
6345 @item nexti
6346 @kindex nexti&
6347 @xref{Continuing and Stepping, nexti}.
6348
6349 @item continue
6350 @kindex continue&
6351 @xref{Continuing and Stepping, continue}.
6352
6353 @item finish
6354 @kindex finish&
6355 @xref{Continuing and Stepping, finish}.
6356
6357 @item until
6358 @kindex until&
6359 @xref{Continuing and Stepping, until}.
6360
6361 @end table
6362
6363 Background execution is especially useful in conjunction with non-stop
6364 mode for debugging programs with multiple threads; see @ref{Non-Stop Mode}.
6365 However, you can also use these commands in the normal all-stop mode with
6366 the restriction that you cannot issue another execution command until the
6367 previous one finishes.  Examples of commands that are valid in all-stop
6368 mode while the program is running include @code{help} and @code{info break}.
6369
6370 You can interrupt your program while it is running in the background by
6371 using the @code{interrupt} command.
6372
6373 @table @code
6374 @kindex interrupt
6375 @item interrupt
6376 @itemx interrupt -a
6377
6378 Suspend execution of the running program.  In all-stop mode,
6379 @code{interrupt} stops the whole process, but in non-stop mode, it stops
6380 only the current thread.  To stop the whole program in non-stop mode,
6381 use @code{interrupt -a}.
6382 @end table
6383
6384 @node Thread-Specific Breakpoints
6385 @subsection Thread-Specific Breakpoints
6386
6387 When your program has multiple threads (@pxref{Threads,, Debugging
6388 Programs with Multiple Threads}), you can choose whether to set
6389 breakpoints on all threads, or on a particular thread.
6390
6391 @table @code
6392 @cindex breakpoints and threads
6393 @cindex thread breakpoints
6394 @kindex break @dots{} thread @var{thread-id}
6395 @item break @var{location} thread @var{thread-id}
6396 @itemx break @var{location} thread @var{thread-id} if @dots{}
6397 @var{location} specifies source lines; there are several ways of
6398 writing them (@pxref{Specify Location}), but the effect is always to
6399 specify some source line.
6400
6401 Use the qualifier @samp{thread @var{thread-id}} with a breakpoint command
6402 to specify that you only want @value{GDBN} to stop the program when a
6403 particular thread reaches this breakpoint.  The @var{thread-id} specifier
6404 is one of the thread identifiers assigned by @value{GDBN}, shown
6405 in the first column of the @samp{info threads} display.
6406
6407 If you do not specify @samp{thread @var{thread-id}} when you set a
6408 breakpoint, the breakpoint applies to @emph{all} threads of your
6409 program.
6410
6411 You can use the @code{thread} qualifier on conditional breakpoints as
6412 well; in this case, place @samp{thread @var{thread-id}} before or
6413 after the breakpoint condition, like this:
6414
6415 @smallexample
6416 (@value{GDBP}) break frik.c:13 thread 28 if bartab > lim
6417 @end smallexample
6418
6419 @end table
6420
6421 Thread-specific breakpoints are automatically deleted when
6422 @value{GDBN} detects the corresponding thread is no longer in the
6423 thread list.  For example:
6424
6425 @smallexample
6426 (@value{GDBP}) c
6427 Thread-specific breakpoint 3 deleted - thread 28 no longer in the thread list.
6428 @end smallexample
6429
6430 There are several ways for a thread to disappear, such as a regular
6431 thread exit, but also when you detach from the process with the
6432 @code{detach} command (@pxref{Attach, ,Debugging an Already-running
6433 Process}), or if @value{GDBN} loses the remote connection
6434 (@pxref{Remote Debugging}), etc.  Note that with some targets,
6435 @value{GDBN} is only able to detect a thread has exited when the user
6436 explictly asks for the thread list with the @code{info threads}
6437 command.
6438
6439 @node Interrupted System Calls
6440 @subsection Interrupted System Calls 
6441
6442 @cindex thread breakpoints and system calls
6443 @cindex system calls and thread breakpoints
6444 @cindex premature return from system calls
6445 There is an unfortunate side effect when using @value{GDBN} to debug
6446 multi-threaded programs.  If one thread stops for a
6447 breakpoint, or for some other reason, and another thread is blocked in a
6448 system call, then the system call may return prematurely.  This is a
6449 consequence of the interaction between multiple threads and the signals
6450 that @value{GDBN} uses to implement breakpoints and other events that
6451 stop execution.
6452
6453 To handle this problem, your program should check the return value of
6454 each system call and react appropriately.  This is good programming
6455 style anyways.
6456
6457 For example, do not write code like this:
6458
6459 @smallexample
6460   sleep (10);
6461 @end smallexample
6462
6463 The call to @code{sleep} will return early if a different thread stops
6464 at a breakpoint or for some other reason.
6465
6466 Instead, write this:
6467
6468 @smallexample
6469   int unslept = 10;
6470   while (unslept > 0)
6471     unslept = sleep (unslept);
6472 @end smallexample
6473
6474 A system call is allowed to return early, so the system is still
6475 conforming to its specification.  But @value{GDBN} does cause your
6476 multi-threaded program to behave differently than it would without
6477 @value{GDBN}.
6478
6479 Also, @value{GDBN} uses internal breakpoints in the thread library to
6480 monitor certain events such as thread creation and thread destruction.
6481 When such an event happens, a system call in another thread may return
6482 prematurely, even though your program does not appear to stop.
6483
6484 @node Observer Mode
6485 @subsection Observer Mode
6486
6487 If you want to build on non-stop mode and observe program behavior
6488 without any chance of disruption by @value{GDBN}, you can set
6489 variables to disable all of the debugger's attempts to modify state,
6490 whether by writing memory, inserting breakpoints, etc.  These operate
6491 at a low level, intercepting operations from all commands.
6492
6493 When all of these are set to @code{off}, then @value{GDBN} is said to
6494 be @dfn{observer mode}.  As a convenience, the variable
6495 @code{observer} can be set to disable these, plus enable non-stop
6496 mode.
6497
6498 Note that @value{GDBN} will not prevent you from making nonsensical
6499 combinations of these settings. For instance, if you have enabled
6500 @code{may-insert-breakpoints} but disabled @code{may-write-memory},
6501 then breakpoints that work by writing trap instructions into the code
6502 stream will still not be able to be placed.
6503
6504 @table @code
6505
6506 @kindex observer
6507 @item set observer on
6508 @itemx set observer off
6509 When set to @code{on}, this disables all the permission variables
6510 below (except for @code{insert-fast-tracepoints}), plus enables
6511 non-stop debugging.  Setting this to @code{off} switches back to
6512 normal debugging, though remaining in non-stop mode.
6513
6514 @item show observer
6515 Show whether observer mode is on or off.
6516
6517 @kindex may-write-registers
6518 @item set may-write-registers on
6519 @itemx set may-write-registers off
6520 This controls whether @value{GDBN} will attempt to alter the values of
6521 registers, such as with assignment expressions in @code{print}, or the
6522 @code{jump} command.  It defaults to @code{on}.
6523
6524 @item show may-write-registers
6525 Show the current permission to write registers.
6526
6527 @kindex may-write-memory
6528 @item set may-write-memory on
6529 @itemx set may-write-memory off
6530 This controls whether @value{GDBN} will attempt to alter the contents
6531 of memory, such as with assignment expressions in @code{print}.  It
6532 defaults to @code{on}.
6533
6534 @item show may-write-memory
6535 Show the current permission to write memory.
6536
6537 @kindex may-insert-breakpoints
6538 @item set may-insert-breakpoints on
6539 @itemx set may-insert-breakpoints off
6540 This controls whether @value{GDBN} will attempt to insert breakpoints.
6541 This affects all breakpoints, including internal breakpoints defined
6542 by @value{GDBN}.  It defaults to @code{on}.
6543
6544 @item show may-insert-breakpoints
6545 Show the current permission to insert breakpoints.
6546
6547 @kindex may-insert-tracepoints
6548 @item set may-insert-tracepoints on
6549 @itemx set may-insert-tracepoints off
6550 This controls whether @value{GDBN} will attempt to insert (regular)
6551 tracepoints at the beginning of a tracing experiment.  It affects only
6552 non-fast tracepoints, fast tracepoints being under the control of
6553 @code{may-insert-fast-tracepoints}.  It defaults to @code{on}.
6554
6555 @item show may-insert-tracepoints
6556 Show the current permission to insert tracepoints.
6557
6558 @kindex may-insert-fast-tracepoints
6559 @item set may-insert-fast-tracepoints on
6560 @itemx set may-insert-fast-tracepoints off
6561 This controls whether @value{GDBN} will attempt to insert fast
6562 tracepoints at the beginning of a tracing experiment.  It affects only
6563 fast tracepoints, regular (non-fast) tracepoints being under the
6564 control of @code{may-insert-tracepoints}.  It defaults to @code{on}.
6565
6566 @item show may-insert-fast-tracepoints
6567 Show the current permission to insert fast tracepoints.
6568
6569 @kindex may-interrupt
6570 @item set may-interrupt on
6571 @itemx set may-interrupt off
6572 This controls whether @value{GDBN} will attempt to interrupt or stop
6573 program execution.  When this variable is @code{off}, the
6574 @code{interrupt} command will have no effect, nor will
6575 @kbd{Ctrl-c}. It defaults to @code{on}.
6576
6577 @item show may-interrupt
6578 Show the current permission to interrupt or stop the program.
6579
6580 @end table
6581
6582 @node Reverse Execution
6583 @chapter Running programs backward
6584 @cindex reverse execution
6585 @cindex running programs backward
6586
6587 When you are debugging a program, it is not unusual to realize that
6588 you have gone too far, and some event of interest has already happened.
6589 If the target environment supports it, @value{GDBN} can allow you to
6590 ``rewind'' the program by running it backward.
6591
6592 A target environment that supports reverse execution should be able
6593 to ``undo'' the changes in machine state that have taken place as the
6594 program was executing normally.  Variables, registers etc.@: should
6595 revert to their previous values.  Obviously this requires a great
6596 deal of sophistication on the part of the target environment; not
6597 all target environments can support reverse execution.
6598
6599 When a program is executed in reverse, the instructions that
6600 have most recently been executed are ``un-executed'', in reverse
6601 order.  The program counter runs backward, following the previous
6602 thread of execution in reverse.  As each instruction is ``un-executed'',
6603 the values of memory and/or registers that were changed by that
6604 instruction are reverted to their previous states.  After executing
6605 a piece of source code in reverse, all side effects of that code
6606 should be ``undone'', and all variables should be returned to their
6607 prior values@footnote{
6608 Note that some side effects are easier to undo than others.  For instance,
6609 memory and registers are relatively easy, but device I/O is hard.  Some
6610 targets may be able undo things like device I/O, and some may not.
6611
6612 The contract between @value{GDBN} and the reverse executing target
6613 requires only that the target do something reasonable when
6614 @value{GDBN} tells it to execute backwards, and then report the 
6615 results back to @value{GDBN}.  Whatever the target reports back to
6616 @value{GDBN}, @value{GDBN} will report back to the user.  @value{GDBN}
6617 assumes that the memory and registers that the target reports are in a
6618 consistant state, but @value{GDBN} accepts whatever it is given.
6619 }.
6620
6621 If you are debugging in a target environment that supports
6622 reverse execution, @value{GDBN} provides the following commands.
6623
6624 @table @code
6625 @kindex reverse-continue
6626 @kindex rc @r{(@code{reverse-continue})}
6627 @item reverse-continue @r{[}@var{ignore-count}@r{]}
6628 @itemx rc @r{[}@var{ignore-count}@r{]}
6629 Beginning at the point where your program last stopped, start executing
6630 in reverse.  Reverse execution will stop for breakpoints and synchronous
6631 exceptions (signals), just like normal execution.  Behavior of
6632 asynchronous signals depends on the target environment.
6633
6634 @kindex reverse-step
6635 @kindex rs @r{(@code{step})}
6636 @item reverse-step @r{[}@var{count}@r{]}
6637 Run the program backward until control reaches the start of a
6638 different source line; then stop it, and return control to @value{GDBN}.
6639
6640 Like the @code{step} command, @code{reverse-step} will only stop
6641 at the beginning of a source line.  It ``un-executes'' the previously
6642 executed source line.  If the previous source line included calls to
6643 debuggable functions, @code{reverse-step} will step (backward) into
6644 the called function, stopping at the beginning of the @emph{last}
6645 statement in the called function (typically a return statement).
6646
6647 Also, as with the @code{step} command, if non-debuggable functions are
6648 called, @code{reverse-step} will run thru them backward without stopping.
6649
6650 @kindex reverse-stepi
6651 @kindex rsi @r{(@code{reverse-stepi})}
6652 @item reverse-stepi @r{[}@var{count}@r{]}
6653 Reverse-execute one machine instruction.  Note that the instruction
6654 to be reverse-executed is @emph{not} the one pointed to by the program
6655 counter, but the instruction executed prior to that one.  For instance,
6656 if the last instruction was a jump, @code{reverse-stepi} will take you
6657 back from the destination of the jump to the jump instruction itself.
6658
6659 @kindex reverse-next
6660 @kindex rn @r{(@code{reverse-next})}
6661 @item reverse-next @r{[}@var{count}@r{]}
6662 Run backward to the beginning of the previous line executed in
6663 the current (innermost) stack frame.  If the line contains function
6664 calls, they will be ``un-executed'' without stopping.  Starting from
6665 the first line of a function, @code{reverse-next} will take you back
6666 to the caller of that function, @emph{before} the function was called,
6667 just as the normal @code{next} command would take you from the last 
6668 line of a function back to its return to its caller
6669 @footnote{Unless the code is too heavily optimized.}.
6670
6671 @kindex reverse-nexti
6672 @kindex rni @r{(@code{reverse-nexti})}
6673 @item reverse-nexti @r{[}@var{count}@r{]}
6674 Like @code{nexti}, @code{reverse-nexti} executes a single instruction
6675 in reverse, except that called functions are ``un-executed'' atomically.
6676 That is, if the previously executed instruction was a return from
6677 another function, @code{reverse-nexti} will continue to execute
6678 in reverse until the call to that function (from the current stack
6679 frame) is reached.
6680
6681 @kindex reverse-finish
6682 @item reverse-finish
6683 Just as the @code{finish} command takes you to the point where the
6684 current function returns, @code{reverse-finish} takes you to the point
6685 where it was called.  Instead of ending up at the end of the current
6686 function invocation, you end up at the beginning.
6687
6688 @kindex set exec-direction
6689 @item set exec-direction
6690 Set the direction of target execution.
6691 @item set exec-direction reverse
6692 @cindex execute forward or backward in time
6693 @value{GDBN} will perform all execution commands in reverse, until the
6694 exec-direction mode is changed to ``forward''.  Affected commands include
6695 @code{step, stepi, next, nexti, continue, and finish}.  The @code{return}
6696 command cannot be used in reverse mode.
6697 @item set exec-direction forward
6698 @value{GDBN} will perform all execution commands in the normal fashion.
6699 This is the default.
6700 @end table
6701
6702
6703 @node Process Record and Replay
6704 @chapter Recording Inferior's Execution and Replaying It
6705 @cindex process record and replay
6706 @cindex recording inferior's execution and replaying it
6707
6708 On some platforms, @value{GDBN} provides a special @dfn{process record
6709 and replay} target that can record a log of the process execution, and
6710 replay it later with both forward and reverse execution commands.
6711
6712 @cindex replay mode
6713 When this target is in use, if the execution log includes the record
6714 for the next instruction, @value{GDBN} will debug in @dfn{replay
6715 mode}.  In the replay mode, the inferior does not really execute code
6716 instructions.  Instead, all the events that normally happen during
6717 code execution are taken from the execution log.  While code is not
6718 really executed in replay mode, the values of registers (including the
6719 program counter register) and the memory of the inferior are still
6720 changed as they normally would.  Their contents are taken from the
6721 execution log.
6722
6723 @cindex record mode
6724 If the record for the next instruction is not in the execution log,
6725 @value{GDBN} will debug in @dfn{record mode}.  In this mode, the
6726 inferior executes normally, and @value{GDBN} records the execution log
6727 for future replay.
6728
6729 The process record and replay target supports reverse execution
6730 (@pxref{Reverse Execution}), even if the platform on which the
6731 inferior runs does not.  However, the reverse execution is limited in
6732 this case by the range of the instructions recorded in the execution
6733 log.  In other words, reverse execution on platforms that don't
6734 support it directly can only be done in the replay mode.
6735
6736 When debugging in the reverse direction, @value{GDBN} will work in
6737 replay mode as long as the execution log includes the record for the
6738 previous instruction; otherwise, it will work in record mode, if the
6739 platform supports reverse execution, or stop if not.
6740
6741 For architecture environments that support process record and replay,
6742 @value{GDBN} provides the following commands:
6743
6744 @table @code
6745 @kindex target record
6746 @kindex target record-full
6747 @kindex target record-btrace
6748 @kindex record
6749 @kindex record full
6750 @kindex record btrace
6751 @kindex record btrace bts
6752 @kindex record btrace pt
6753 @kindex record bts
6754 @kindex record pt
6755 @kindex rec
6756 @kindex rec full
6757 @kindex rec btrace
6758 @kindex rec btrace bts
6759 @kindex rec btrace pt
6760 @kindex rec bts
6761 @kindex rec pt
6762 @item record @var{method}
6763 This command starts the process record and replay target.  The
6764 recording method can be specified as parameter.  Without a parameter
6765 the command uses the @code{full} recording method.  The following
6766 recording methods are available:
6767
6768 @table @code
6769 @item full
6770 Full record/replay recording using @value{GDBN}'s software record and
6771 replay implementation.  This method allows replaying and reverse
6772 execution.
6773
6774 @item btrace @var{format}
6775 Hardware-supported instruction recording.  This method does not record
6776 data.  Further, the data is collected in a ring buffer so old data will
6777 be overwritten when the buffer is full.  It allows limited reverse
6778 execution.  Variables and registers are not available during reverse
6779 execution.  In remote debugging, recording continues on disconnect.
6780 Recorded data can be inspected after reconnecting.  The recording may
6781 be stopped using @code{record stop}.
6782
6783 The recording format can be specified as parameter.  Without a parameter
6784 the command chooses the recording format.  The following recording
6785 formats are available:
6786
6787 @table @code
6788 @item bts
6789 @cindex branch trace store
6790 Use the @dfn{Branch Trace Store} (@acronym{BTS}) recording format.  In
6791 this format, the processor stores a from/to record for each executed
6792 branch in the btrace ring buffer.
6793
6794 @item pt
6795 @cindex Intel Processor Trace
6796 Use the @dfn{Intel Processor Trace} recording format.  In this
6797 format, the processor stores the execution trace in a compressed form
6798 that is afterwards decoded by @value{GDBN}.
6799
6800 The trace can be recorded with very low overhead.  The compressed
6801 trace format also allows small trace buffers to already contain a big
6802 number of instructions compared to @acronym{BTS}.
6803
6804 Decoding the recorded execution trace, on the other hand, is more
6805 expensive than decoding @acronym{BTS} trace.  This is mostly due to the
6806 increased number of instructions to process.  You should increase the
6807 buffer-size with care.
6808 @end table
6809
6810 Not all recording formats may be available on all processors.
6811 @end table
6812
6813 The process record and replay target can only debug a process that is
6814 already running.  Therefore, you need first to start the process with
6815 the @kbd{run} or @kbd{start} commands, and then start the recording
6816 with the @kbd{record @var{method}} command.
6817
6818 @cindex displaced stepping, and process record and replay
6819 Displaced stepping (@pxref{Maintenance Commands,, displaced stepping})
6820 will be automatically disabled when process record and replay target
6821 is started.  That's because the process record and replay target
6822 doesn't support displaced stepping.
6823
6824 @cindex non-stop mode, and process record and replay
6825 @cindex asynchronous execution, and process record and replay
6826 If the inferior is in the non-stop mode (@pxref{Non-Stop Mode}) or in
6827 the asynchronous execution mode (@pxref{Background Execution}), not
6828 all recording methods are available.  The @code{full} recording method
6829 does not support these two modes.
6830
6831 @kindex record stop
6832 @kindex rec s
6833 @item record stop
6834 Stop the process record and replay target.  When process record and
6835 replay target stops, the entire execution log will be deleted and the
6836 inferior will either be terminated, or will remain in its final state.
6837
6838 When you stop the process record and replay target in record mode (at
6839 the end of the execution log), the inferior will be stopped at the
6840 next instruction that would have been recorded.  In other words, if
6841 you record for a while and then stop recording, the inferior process
6842 will be left in the same state as if the recording never happened.
6843
6844 On the other hand, if the process record and replay target is stopped
6845 while in replay mode (that is, not at the end of the execution log,
6846 but at some earlier point), the inferior process will become ``live''
6847 at that earlier state, and it will then be possible to continue the
6848 usual ``live'' debugging of the process from that state.
6849
6850 When the inferior process exits, or @value{GDBN} detaches from it,
6851 process record and replay target will automatically stop itself.
6852
6853 @kindex record goto
6854 @item record goto
6855 Go to a specific location in the execution log.  There are several
6856 ways to specify the location to go to:
6857
6858 @table @code
6859 @item record goto begin
6860 @itemx record goto start
6861 Go to the beginning of the execution log.
6862
6863 @item record goto end
6864 Go to the end of the execution log.
6865
6866 @item record goto @var{n}
6867 Go to instruction number @var{n} in the execution log.
6868 @end table
6869
6870 @kindex record save
6871 @item record save @var{filename}
6872 Save the execution log to a file @file{@var{filename}}.
6873 Default filename is @file{gdb_record.@var{process_id}}, where
6874 @var{process_id} is the process ID of the inferior.
6875
6876 This command may not be available for all recording methods.
6877
6878 @kindex record restore
6879 @item record restore @var{filename}
6880 Restore the execution log from a file @file{@var{filename}}.
6881 File must have been created with @code{record save}.
6882
6883 @kindex set record full
6884 @item set record full insn-number-max @var{limit}
6885 @itemx set record full insn-number-max unlimited
6886 Set the limit of instructions to be recorded for the @code{full}
6887 recording method.  Default value is 200000.
6888
6889 If @var{limit} is a positive number, then @value{GDBN} will start
6890 deleting instructions from the log once the number of the record
6891 instructions becomes greater than @var{limit}.  For every new recorded
6892 instruction, @value{GDBN} will delete the earliest recorded
6893 instruction to keep the number of recorded instructions at the limit.
6894 (Since deleting recorded instructions loses information, @value{GDBN}
6895 lets you control what happens when the limit is reached, by means of
6896 the @code{stop-at-limit} option, described below.)
6897
6898 If @var{limit} is @code{unlimited} or zero, @value{GDBN} will never
6899 delete recorded instructions from the execution log.  The number of
6900 recorded instructions is limited only by the available memory.
6901
6902 @kindex show record full
6903 @item show record full insn-number-max
6904 Show the limit of instructions to be recorded with the @code{full}
6905 recording method.
6906
6907 @item set record full stop-at-limit
6908 Control the behavior of the  @code{full} recording method when the
6909 number of recorded instructions reaches the limit.  If ON (the
6910 default), @value{GDBN} will stop when the limit is reached for the
6911 first time and ask you whether you want to stop the inferior or
6912 continue running it and recording the execution log.  If you decide
6913 to continue recording, each new recorded instruction will cause the
6914 oldest one to be deleted.
6915
6916 If this option is OFF, @value{GDBN} will automatically delete the
6917 oldest record to make room for each new one, without asking.
6918
6919 @item show record full stop-at-limit
6920 Show the current setting of @code{stop-at-limit}.
6921
6922 @item set record full memory-query
6923 Control the behavior when @value{GDBN} is unable to record memory
6924 changes caused by an instruction for the @code{full} recording method.
6925 If ON, @value{GDBN} will query whether to stop the inferior in that
6926 case.
6927
6928 If this option is OFF (the default), @value{GDBN} will automatically
6929 ignore the effect of such instructions on memory.  Later, when
6930 @value{GDBN} replays this execution log, it will mark the log of this
6931 instruction as not accessible, and it will not affect the replay
6932 results.
6933
6934 @item show record full memory-query
6935 Show the current setting of @code{memory-query}.
6936
6937 @kindex set record btrace
6938 The @code{btrace} record target does not trace data.  As a
6939 convenience, when replaying, @value{GDBN} reads read-only memory off
6940 the live program directly, assuming that the addresses of the
6941 read-only areas don't change.  This for example makes it possible to
6942 disassemble code while replaying, but not to print variables.
6943 In some cases, being able to inspect variables might be useful.
6944 You can use the following command for that:
6945
6946 @item set record btrace replay-memory-access
6947 Control the behavior of the @code{btrace} recording method when
6948 accessing memory during replay.  If @code{read-only} (the default),
6949 @value{GDBN} will only allow accesses to read-only memory.
6950 If @code{read-write}, @value{GDBN} will allow accesses to read-only
6951 and to read-write memory.  Beware that the accessed memory corresponds
6952 to the live target and not necessarily to the current replay
6953 position.
6954
6955 @kindex show record btrace
6956 @item show record btrace replay-memory-access
6957 Show the current setting of @code{replay-memory-access}.
6958
6959 @kindex set record btrace bts
6960 @item set record btrace bts buffer-size @var{size}
6961 @itemx set record btrace bts buffer-size unlimited
6962 Set the requested ring buffer size for branch tracing in @acronym{BTS}
6963 format.  Default is 64KB.
6964
6965 If @var{size} is a positive number, then @value{GDBN} will try to
6966 allocate a buffer of at least @var{size} bytes for each new thread
6967 that uses the btrace recording method and the @acronym{BTS} format.
6968 The actually obtained buffer size may differ from the requested
6969 @var{size}.  Use the @code{info record} command to see the actual
6970 buffer size for each thread that uses the btrace recording method and
6971 the @acronym{BTS} format.
6972
6973 If @var{limit} is @code{unlimited} or zero, @value{GDBN} will try to
6974 allocate a buffer of 4MB.
6975
6976 Bigger buffers mean longer traces.  On the other hand, @value{GDBN} will
6977 also need longer to process the branch trace data before it can be used.
6978
6979 @item show record btrace bts buffer-size @var{size}
6980 Show the current setting of the requested ring buffer size for branch
6981 tracing in @acronym{BTS} format.
6982
6983 @kindex set record btrace pt
6984 @item set record btrace pt buffer-size @var{size}
6985 @itemx set record btrace pt buffer-size unlimited
6986 Set the requested ring buffer size for branch tracing in Intel
6987 Processor Trace format.  Default is 16KB.
6988
6989 If @var{size} is a positive number, then @value{GDBN} will try to
6990 allocate a buffer of at least @var{size} bytes for each new thread
6991 that uses the btrace recording method and the Intel Processor Trace
6992 format.  The actually obtained buffer size may differ from the
6993 requested @var{size}.  Use the @code{info record} command to see the
6994 actual buffer size for each thread.
6995
6996 If @var{limit} is @code{unlimited} or zero, @value{GDBN} will try to
6997 allocate a buffer of 4MB.
6998
6999 Bigger buffers mean longer traces.  On the other hand, @value{GDBN} will
7000 also need longer to process the branch trace data before it can be used.
7001
7002 @item show record btrace pt buffer-size @var{size}
7003 Show the current setting of the requested ring buffer size for branch
7004 tracing in Intel Processor Trace format.
7005
7006 @kindex info record
7007 @item info record
7008 Show various statistics about the recording depending on the recording
7009 method:
7010
7011 @table @code
7012 @item full
7013 For the @code{full} recording method, it shows the state of process
7014 record and its in-memory execution log buffer, including:
7015
7016 @itemize @bullet
7017 @item
7018 Whether in record mode or replay mode.
7019 @item
7020 Lowest recorded instruction number (counting from when the current execution log started recording instructions).
7021 @item
7022 Highest recorded instruction number.
7023 @item
7024 Current instruction about to be replayed (if in replay mode).
7025 @item
7026 Number of instructions contained in the execution log.
7027 @item
7028 Maximum number of instructions that may be contained in the execution log.
7029 @end itemize
7030
7031 @item btrace
7032 For the @code{btrace} recording method, it shows:
7033
7034 @itemize @bullet
7035 @item
7036 Recording format.
7037 @item
7038 Number of instructions that have been recorded.
7039 @item
7040 Number of blocks of sequential control-flow formed by the recorded
7041 instructions.
7042 @item
7043 Whether in record mode or replay mode.
7044 @end itemize
7045
7046 For the @code{bts} recording format, it also shows:
7047 @itemize @bullet
7048 @item
7049 Size of the perf ring buffer.
7050 @end itemize
7051
7052 For the @code{pt} recording format, it also shows:
7053 @itemize @bullet
7054 @item
7055 Size of the perf ring buffer.
7056 @end itemize
7057 @end table
7058
7059 @kindex record delete
7060 @kindex rec del
7061 @item record delete
7062 When record target runs in replay mode (``in the past''), delete the
7063 subsequent execution log and begin to record a new execution log starting
7064 from the current address.  This means you will abandon the previously
7065 recorded ``future'' and begin recording a new ``future''.
7066
7067 @kindex record instruction-history
7068 @kindex rec instruction-history
7069 @item record instruction-history
7070 Disassembles instructions from the recorded execution log.  By
7071 default, ten instructions are disassembled.  This can be changed using
7072 the @code{set record instruction-history-size} command.  Instructions
7073 are printed in execution order.
7074
7075 It can also print mixed source+disassembly if you specify the the
7076 @code{/m} or @code{/s} modifier, and print the raw instructions in hex
7077 as well as in symbolic form by specifying the @code{/r} modifier.
7078
7079 The current position marker is printed for the instruction at the
7080 current program counter value.  This instruction can appear multiple
7081 times in the trace and the current position marker will be printed
7082 every time.  To omit the current position marker, specify the
7083 @code{/p} modifier.
7084
7085 To better align the printed instructions when the trace contains
7086 instructions from more than one function, the function name may be
7087 omitted by specifying the @code{/f} modifier.
7088
7089 Speculatively executed instructions are prefixed with @samp{?}.  This
7090 feature is not available for all recording formats.
7091
7092 There are several ways to specify what part of the execution log to
7093 disassemble:
7094
7095 @table @code
7096 @item record instruction-history @var{insn}
7097 Disassembles ten instructions starting from instruction number
7098 @var{insn}.
7099
7100 @item record instruction-history @var{insn}, +/-@var{n}
7101 Disassembles @var{n} instructions around instruction number
7102 @var{insn}.  If @var{n} is preceded with @code{+}, disassembles
7103 @var{n} instructions after instruction number @var{insn}.  If
7104 @var{n} is preceded with @code{-}, disassembles @var{n}
7105 instructions before instruction number @var{insn}.
7106
7107 @item record instruction-history
7108 Disassembles ten more instructions after the last disassembly.
7109
7110 @item record instruction-history -
7111 Disassembles ten more instructions before the last disassembly.
7112
7113 @item record instruction-history @var{begin}, @var{end}
7114 Disassembles instructions beginning with instruction number
7115 @var{begin} until instruction number @var{end}.  The instruction
7116 number @var{end} is included.
7117 @end table
7118
7119 This command may not be available for all recording methods.
7120
7121 @kindex set record
7122 @item set record instruction-history-size @var{size}
7123 @itemx set record instruction-history-size unlimited
7124 Define how many instructions to disassemble in the @code{record
7125 instruction-history} command.  The default value is 10.
7126 A @var{size} of @code{unlimited} means unlimited instructions.
7127
7128 @kindex show record
7129 @item show record instruction-history-size
7130 Show how many instructions to disassemble in the @code{record
7131 instruction-history} command.
7132
7133 @kindex record function-call-history
7134 @kindex rec function-call-history
7135 @item record function-call-history
7136 Prints the execution history at function granularity. It prints one
7137 line for each sequence of instructions that belong to the same
7138 function giving the name of that function, the source lines
7139 for this instruction sequence (if the @code{/l} modifier is
7140 specified), and the instructions numbers that form the sequence (if
7141 the @code{/i} modifier is specified).  The function names are indented
7142 to reflect the call stack depth if the @code{/c} modifier is
7143 specified.  The @code{/l}, @code{/i}, and @code{/c} modifiers can be
7144 given together.
7145
7146 @smallexample
7147 (@value{GDBP}) @b{list 1, 10}
7148 1   void foo (void)
7149 2   @{
7150 3   @}
7151 4
7152 5   void bar (void)
7153 6   @{
7154 7     ...
7155 8     foo ();
7156 9     ...
7157 10  @}
7158 (@value{GDBP}) @b{record function-call-history /ilc}
7159 1  bar     inst 1,4     at foo.c:6,8
7160 2    foo   inst 5,10    at foo.c:2,3
7161 3  bar     inst 11,13   at foo.c:9,10
7162 @end smallexample
7163
7164 By default, ten lines are printed.  This can be changed using the
7165 @code{set record function-call-history-size} command.  Functions are
7166 printed in execution order.  There are several ways to specify what
7167 to print:
7168
7169 @table @code
7170 @item record function-call-history @var{func}
7171 Prints ten functions starting from function number @var{func}.
7172
7173 @item record function-call-history @var{func}, +/-@var{n}
7174 Prints @var{n} functions around function number @var{func}.  If
7175 @var{n} is preceded with @code{+}, prints @var{n} functions after
7176 function number @var{func}.  If @var{n} is preceded with @code{-},
7177 prints @var{n} functions before function number @var{func}.
7178
7179 @item record function-call-history
7180 Prints ten more functions after the last ten-line print.
7181
7182 @item record function-call-history -
7183 Prints ten more functions before the last ten-line print.
7184
7185 @item record function-call-history @var{begin}, @var{end}
7186 Prints functions beginning with function number @var{begin} until
7187 function number @var{end}.  The function number @var{end} is included.
7188 @end table
7189
7190 This command may not be available for all recording methods.
7191
7192 @item set record function-call-history-size @var{size}
7193 @itemx set record function-call-history-size unlimited
7194 Define how many lines to print in the
7195 @code{record function-call-history} command.  The default value is 10.
7196 A size of @code{unlimited} means unlimited lines.
7197
7198 @item show record function-call-history-size
7199 Show how many lines to print in the
7200 @code{record function-call-history} command.
7201 @end table
7202
7203
7204 @node Stack
7205 @chapter Examining the Stack
7206
7207 When your program has stopped, the first thing you need to know is where it
7208 stopped and how it got there.
7209
7210 @cindex call stack
7211 Each time your program performs a function call, information about the call
7212 is generated.
7213 That information includes the location of the call in your program,
7214 the arguments of the call,
7215 and the local variables of the function being called.
7216 The information is saved in a block of data called a @dfn{stack frame}.
7217 The stack frames are allocated in a region of memory called the @dfn{call
7218 stack}.
7219
7220 When your program stops, the @value{GDBN} commands for examining the
7221 stack allow you to see all of this information.
7222
7223 @cindex selected frame
7224 One of the stack frames is @dfn{selected} by @value{GDBN} and many
7225 @value{GDBN} commands refer implicitly to the selected frame.  In
7226 particular, whenever you ask @value{GDBN} for the value of a variable in
7227 your program, the value is found in the selected frame.  There are
7228 special @value{GDBN} commands to select whichever frame you are
7229 interested in.  @xref{Selection, ,Selecting a Frame}.
7230
7231 When your program stops, @value{GDBN} automatically selects the
7232 currently executing frame and describes it briefly, similar to the
7233 @code{frame} command (@pxref{Frame Info, ,Information about a Frame}).
7234
7235 @menu
7236 * Frames::                      Stack frames
7237 * Backtrace::                   Backtraces
7238 * Selection::                   Selecting a frame
7239 * Frame Info::                  Information on a frame
7240 * Frame Filter Management::     Managing frame filters
7241
7242 @end menu
7243
7244 @node Frames
7245 @section Stack Frames
7246
7247 @cindex frame, definition
7248 @cindex stack frame
7249 The call stack is divided up into contiguous pieces called @dfn{stack
7250 frames}, or @dfn{frames} for short; each frame is the data associated
7251 with one call to one function.  The frame contains the arguments given
7252 to the function, the function's local variables, and the address at
7253 which the function is executing.
7254
7255 @cindex initial frame
7256 @cindex outermost frame
7257 @cindex innermost frame
7258 When your program is started, the stack has only one frame, that of the
7259 function @code{main}.  This is called the @dfn{initial} frame or the
7260 @dfn{outermost} frame.  Each time a function is called, a new frame is
7261 made.  Each time a function returns, the frame for that function invocation
7262 is eliminated.  If a function is recursive, there can be many frames for
7263 the same function.  The frame for the function in which execution is
7264 actually occurring is called the @dfn{innermost} frame.  This is the most
7265 recently created of all the stack frames that still exist.
7266
7267 @cindex frame pointer
7268 Inside your program, stack frames are identified by their addresses.  A
7269 stack frame consists of many bytes, each of which has its own address; each
7270 kind of computer has a convention for choosing one byte whose
7271 address serves as the address of the frame.  Usually this address is kept
7272 in a register called the @dfn{frame pointer register}
7273 (@pxref{Registers, $fp}) while execution is going on in that frame.
7274
7275 @cindex frame number
7276 @value{GDBN} assigns numbers to all existing stack frames, starting with
7277 zero for the innermost frame, one for the frame that called it,
7278 and so on upward.  These numbers do not really exist in your program;
7279 they are assigned by @value{GDBN} to give you a way of designating stack
7280 frames in @value{GDBN} commands.
7281
7282 @c The -fomit-frame-pointer below perennially causes hbox overflow
7283 @c underflow problems.
7284 @cindex frameless execution
7285 Some compilers provide a way to compile functions so that they operate
7286 without stack frames.  (For example, the @value{NGCC} option
7287 @smallexample
7288 @samp{-fomit-frame-pointer}
7289 @end smallexample
7290 generates functions without a frame.)
7291 This is occasionally done with heavily used library functions to save
7292 the frame setup time.  @value{GDBN} has limited facilities for dealing
7293 with these function invocations.  If the innermost function invocation
7294 has no stack frame, @value{GDBN} nevertheless regards it as though
7295 it had a separate frame, which is numbered zero as usual, allowing
7296 correct tracing of the function call chain.  However, @value{GDBN} has
7297 no provision for frameless functions elsewhere in the stack.
7298
7299 @node Backtrace
7300 @section Backtraces
7301
7302 @cindex traceback
7303 @cindex call stack traces
7304 A backtrace is a summary of how your program got where it is.  It shows one
7305 line per frame, for many frames, starting with the currently executing
7306 frame (frame zero), followed by its caller (frame one), and on up the
7307 stack.
7308
7309 @anchor{backtrace-command}
7310 @table @code
7311 @kindex backtrace
7312 @kindex bt @r{(@code{backtrace})}
7313 @item backtrace
7314 @itemx bt
7315 Print a backtrace of the entire stack: one line per frame for all
7316 frames in the stack.
7317
7318 You can stop the backtrace at any time by typing the system interrupt
7319 character, normally @kbd{Ctrl-c}.
7320
7321 @item backtrace @var{n}
7322 @itemx bt @var{n}
7323 Similar, but print only the innermost @var{n} frames.
7324
7325 @item backtrace -@var{n}
7326 @itemx bt -@var{n}
7327 Similar, but print only the outermost @var{n} frames.
7328
7329 @item backtrace full
7330 @itemx bt full
7331 @itemx bt full @var{n}
7332 @itemx bt full -@var{n}
7333 Print the values of the local variables also.  As described above,
7334 @var{n} specifies the number of frames to print.
7335
7336 @item backtrace no-filters
7337 @itemx bt no-filters
7338 @itemx bt no-filters @var{n}
7339 @itemx bt no-filters -@var{n}
7340 @itemx bt no-filters full
7341 @itemx bt no-filters full @var{n}
7342 @itemx bt no-filters full -@var{n}
7343 Do not run Python frame filters on this backtrace.  @xref{Frame
7344 Filter API}, for more information.  Additionally use @ref{disable
7345 frame-filter all} to turn off all frame filters.  This is only
7346 relevant when @value{GDBN} has been configured with @code{Python}
7347 support.
7348 @end table
7349
7350 @kindex where
7351 @kindex info stack
7352 The names @code{where} and @code{info stack} (abbreviated @code{info s})
7353 are additional aliases for @code{backtrace}.
7354
7355 @cindex multiple threads, backtrace
7356 In a multi-threaded program, @value{GDBN} by default shows the
7357 backtrace only for the current thread.  To display the backtrace for
7358 several or all of the threads, use the command @code{thread apply}
7359 (@pxref{Threads, thread apply}).  For example, if you type @kbd{thread
7360 apply all backtrace}, @value{GDBN} will display the backtrace for all
7361 the threads; this is handy when you debug a core dump of a
7362 multi-threaded program.
7363
7364 Each line in the backtrace shows the frame number and the function name.
7365 The program counter value is also shown---unless you use @code{set
7366 print address off}.  The backtrace also shows the source file name and
7367 line number, as well as the arguments to the function.  The program
7368 counter value is omitted if it is at the beginning of the code for that
7369 line number.
7370
7371 Here is an example of a backtrace.  It was made with the command
7372 @samp{bt 3}, so it shows the innermost three frames.
7373
7374 @smallexample
7375 @group
7376 #0  m4_traceon (obs=0x24eb0, argc=1, argv=0x2b8c8)
7377     at builtin.c:993
7378 #1  0x6e38 in expand_macro (sym=0x2b600, data=...) at macro.c:242
7379 #2  0x6840 in expand_token (obs=0x0, t=177664, td=0xf7fffb08)
7380     at macro.c:71
7381 (More stack frames follow...)
7382 @end group
7383 @end smallexample
7384
7385 @noindent
7386 The display for frame zero does not begin with a program counter
7387 value, indicating that your program has stopped at the beginning of the
7388 code for line @code{993} of @code{builtin.c}.
7389
7390 @noindent
7391 The value of parameter @code{data} in frame 1 has been replaced by
7392 @code{@dots{}}.  By default, @value{GDBN} prints the value of a parameter
7393 only if it is a scalar (integer, pointer, enumeration, etc).  See command
7394 @kbd{set print frame-arguments} in @ref{Print Settings} for more details
7395 on how to configure the way function parameter values are printed.
7396
7397 @cindex optimized out, in backtrace
7398 @cindex function call arguments, optimized out
7399 If your program was compiled with optimizations, some compilers will
7400 optimize away arguments passed to functions if those arguments are
7401 never used after the call.  Such optimizations generate code that
7402 passes arguments through registers, but doesn't store those arguments
7403 in the stack frame.  @value{GDBN} has no way of displaying such
7404 arguments in stack frames other than the innermost one.  Here's what
7405 such a backtrace might look like:
7406
7407 @smallexample
7408 @group
7409 #0  m4_traceon (obs=0x24eb0, argc=1, argv=0x2b8c8)
7410     at builtin.c:993
7411 #1  0x6e38 in expand_macro (sym=<optimized out>) at macro.c:242
7412 #2  0x6840 in expand_token (obs=0x0, t=<optimized out>, td=0xf7fffb08)
7413     at macro.c:71
7414 (More stack frames follow...)
7415 @end group
7416 @end smallexample
7417
7418 @noindent
7419 The values of arguments that were not saved in their stack frames are
7420 shown as @samp{<optimized out>}.
7421
7422 If you need to display the values of such optimized-out arguments,
7423 either deduce that from other variables whose values depend on the one
7424 you are interested in, or recompile without optimizations.
7425
7426 @cindex backtrace beyond @code{main} function
7427 @cindex program entry point
7428 @cindex startup code, and backtrace
7429 Most programs have a standard user entry point---a place where system
7430 libraries and startup code transition into user code.  For C this is
7431 @code{main}@footnote{
7432 Note that embedded programs (the so-called ``free-standing''
7433 environment) are not required to have a @code{main} function as the
7434 entry point.  They could even have multiple entry points.}.
7435 When @value{GDBN} finds the entry function in a backtrace
7436 it will terminate the backtrace, to avoid tracing into highly
7437 system-specific (and generally uninteresting) code.
7438
7439 If you need to examine the startup code, or limit the number of levels
7440 in a backtrace, you can change this behavior:
7441
7442 @table @code
7443 @item set backtrace past-main
7444 @itemx set backtrace past-main on
7445 @kindex set backtrace
7446 Backtraces will continue past the user entry point.
7447
7448 @item set backtrace past-main off
7449 Backtraces will stop when they encounter the user entry point.  This is the
7450 default.
7451
7452 @item show backtrace past-main
7453 @kindex show backtrace
7454 Display the current user entry point backtrace policy.
7455
7456 @item set backtrace past-entry
7457 @itemx set backtrace past-entry on
7458 Backtraces will continue past the internal entry point of an application.
7459 This entry point is encoded by the linker when the application is built,
7460 and is likely before the user entry point @code{main} (or equivalent) is called.
7461
7462 @item set backtrace past-entry off
7463 Backtraces will stop when they encounter the internal entry point of an
7464 application.  This is the default.
7465
7466 @item show backtrace past-entry
7467 Display the current internal entry point backtrace policy.
7468
7469 @item set backtrace limit @var{n}
7470 @itemx set backtrace limit 0
7471 @itemx set backtrace limit unlimited
7472 @cindex backtrace limit
7473 Limit the backtrace to @var{n} levels.  A value of @code{unlimited}
7474 or zero means unlimited levels.
7475
7476 @item show backtrace limit
7477 Display the current limit on backtrace levels.
7478 @end table
7479
7480 You can control how file names are displayed.
7481
7482 @table @code
7483 @item set filename-display
7484 @itemx set filename-display relative
7485 @cindex filename-display
7486 Display file names relative to the compilation directory.  This is the default.
7487
7488 @item set filename-display basename
7489 Display only basename of a filename.
7490
7491 @item set filename-display absolute
7492 Display an absolute filename.
7493
7494 @item show filename-display
7495 Show the current way to display filenames.
7496 @end table
7497
7498 @node Selection
7499 @section Selecting a Frame
7500
7501 Most commands for examining the stack and other data in your program work on
7502 whichever stack frame is selected at the moment.  Here are the commands for
7503 selecting a stack frame; all of them finish by printing a brief description
7504 of the stack frame just selected.
7505
7506 @table @code
7507 @kindex frame@r{, selecting}
7508 @kindex f @r{(@code{frame})}
7509 @item frame @var{n}
7510 @itemx f @var{n}
7511 Select frame number @var{n}.  Recall that frame zero is the innermost
7512 (currently executing) frame, frame one is the frame that called the
7513 innermost one, and so on.  The highest-numbered frame is the one for
7514 @code{main}.
7515
7516 @item frame @var{stack-addr} [ @var{pc-addr} ]
7517 @itemx f @var{stack-addr} [ @var{pc-addr} ]
7518 Select the frame at address @var{stack-addr}.  This is useful mainly if the
7519 chaining of stack frames has been damaged by a bug, making it
7520 impossible for @value{GDBN} to assign numbers properly to all frames.  In
7521 addition, this can be useful when your program has multiple stacks and
7522 switches between them.  The optional @var{pc-addr} can also be given to
7523 specify the value of PC for the stack frame.
7524
7525 @kindex up
7526 @item up @var{n}
7527 Move @var{n} frames up the stack; @var{n} defaults to 1.  For positive
7528 numbers @var{n}, this advances toward the outermost frame, to higher
7529 frame numbers, to frames that have existed longer.
7530
7531 @kindex down
7532 @kindex do @r{(@code{down})}
7533 @item down @var{n}
7534 Move @var{n} frames down the stack; @var{n} defaults to 1.  For
7535 positive numbers @var{n}, this advances toward the innermost frame, to
7536 lower frame numbers, to frames that were created more recently.
7537 You may abbreviate @code{down} as @code{do}.
7538 @end table
7539
7540 All of these commands end by printing two lines of output describing the
7541 frame.  The first line shows the frame number, the function name, the
7542 arguments, and the source file and line number of execution in that
7543 frame.  The second line shows the text of that source line.
7544
7545 @need 1000
7546 For example:
7547
7548 @smallexample
7549 @group
7550 (@value{GDBP}) up
7551 #1  0x22f0 in main (argc=1, argv=0xf7fffbf4, env=0xf7fffbfc)
7552     at env.c:10
7553 10              read_input_file (argv[i]);
7554 @end group
7555 @end smallexample
7556
7557 After such a printout, the @code{list} command with no arguments
7558 prints ten lines centered on the point of execution in the frame.
7559 You can also edit the program at the point of execution with your favorite
7560 editing program by typing @code{edit}.
7561 @xref{List, ,Printing Source Lines},
7562 for details.
7563
7564 @table @code
7565 @kindex select-frame
7566 @item select-frame
7567 The @code{select-frame} command is a variant of @code{frame} that does
7568 not display the new frame after selecting it.  This command is
7569 intended primarily for use in @value{GDBN} command scripts, where the
7570 output might be unnecessary and distracting.
7571
7572 @kindex down-silently
7573 @kindex up-silently
7574 @item up-silently @var{n}
7575 @itemx down-silently @var{n}
7576 These two commands are variants of @code{up} and @code{down},
7577 respectively; they differ in that they do their work silently, without
7578 causing display of the new frame.  They are intended primarily for use
7579 in @value{GDBN} command scripts, where the output might be unnecessary and
7580 distracting.
7581 @end table
7582
7583 @node Frame Info
7584 @section Information About a Frame
7585
7586 There are several other commands to print information about the selected
7587 stack frame.
7588
7589 @table @code
7590 @item frame
7591 @itemx f
7592 When used without any argument, this command does not change which
7593 frame is selected, but prints a brief description of the currently
7594 selected stack frame.  It can be abbreviated @code{f}.  With an
7595 argument, this command is used to select a stack frame.
7596 @xref{Selection, ,Selecting a Frame}.
7597
7598 @kindex info frame
7599 @kindex info f @r{(@code{info frame})}
7600 @item info frame
7601 @itemx info f
7602 This command prints a verbose description of the selected stack frame,
7603 including:
7604
7605 @itemize @bullet
7606 @item
7607 the address of the frame
7608 @item
7609 the address of the next frame down (called by this frame)
7610 @item
7611 the address of the next frame up (caller of this frame)
7612 @item
7613 the language in which the source code corresponding to this frame is written
7614 @item
7615 the address of the frame's arguments
7616 @item
7617 the address of the frame's local variables
7618 @item
7619 the program counter saved in it (the address of execution in the caller frame)
7620 @item
7621 which registers were saved in the frame
7622 @end itemize
7623
7624 @noindent The verbose description is useful when
7625 something has gone wrong that has made the stack format fail to fit
7626 the usual conventions.
7627
7628 @item info frame @var{addr}
7629 @itemx info f @var{addr}
7630 Print a verbose description of the frame at address @var{addr}, without
7631 selecting that frame.  The selected frame remains unchanged by this
7632 command.  This requires the same kind of address (more than one for some
7633 architectures) that you specify in the @code{frame} command.
7634 @xref{Selection, ,Selecting a Frame}.
7635
7636 @kindex info args
7637 @item info args
7638 Print the arguments of the selected frame, each on a separate line.
7639
7640 @item info locals
7641 @kindex info locals
7642 Print the local variables of the selected frame, each on a separate
7643 line.  These are all variables (declared either static or automatic)
7644 accessible at the point of execution of the selected frame.
7645
7646 @end table
7647
7648 @node Frame Filter Management
7649 @section Management of Frame Filters.
7650 @cindex managing frame filters
7651
7652 Frame filters are Python based utilities to manage and decorate the
7653 output of frames.  @xref{Frame Filter API}, for further information.
7654
7655 Managing frame filters is performed by several commands available
7656 within @value{GDBN}, detailed here.
7657
7658 @table @code
7659 @kindex info frame-filter
7660 @item info frame-filter
7661 Print a list of installed frame filters from all dictionaries, showing
7662 their name, priority and enabled status.
7663
7664 @kindex disable frame-filter
7665 @anchor{disable frame-filter all}
7666 @item disable frame-filter @var{filter-dictionary} @var{filter-name}
7667 Disable a frame filter in the dictionary matching
7668 @var{filter-dictionary} and @var{filter-name}.  The
7669 @var{filter-dictionary} may be @code{all}, @code{global},
7670 @code{progspace}, or the name of the object file where the frame filter
7671 dictionary resides.  When @code{all} is specified, all frame filters
7672 across all dictionaries are disabled.  The @var{filter-name} is the name
7673 of the frame filter and is used when @code{all} is not the option for
7674 @var{filter-dictionary}.  A disabled frame-filter is not deleted, it
7675 may be enabled again later.
7676
7677 @kindex enable frame-filter
7678 @item enable frame-filter @var{filter-dictionary} @var{filter-name}
7679 Enable a frame filter in the dictionary matching
7680 @var{filter-dictionary} and @var{filter-name}.  The
7681 @var{filter-dictionary} may be @code{all}, @code{global},
7682 @code{progspace} or the name of the object file where the frame filter
7683 dictionary resides.  When @code{all} is specified, all frame filters across
7684 all dictionaries are enabled.  The @var{filter-name} is the name of the frame
7685 filter and is used when @code{all} is not the option for
7686 @var{filter-dictionary}.
7687
7688 Example:
7689
7690 @smallexample
7691 (gdb) info frame-filter
7692
7693 global frame-filters:
7694   Priority  Enabled  Name
7695   1000      No       PrimaryFunctionFilter
7696   100       Yes      Reverse
7697
7698 progspace /build/test frame-filters:
7699   Priority  Enabled  Name
7700   100       Yes      ProgspaceFilter
7701
7702 objfile /build/test frame-filters:
7703   Priority  Enabled  Name
7704   999       Yes      BuildProgra Filter
7705
7706 (gdb) disable frame-filter /build/test BuildProgramFilter
7707 (gdb) info frame-filter
7708
7709 global frame-filters:
7710   Priority  Enabled  Name
7711   1000      No       PrimaryFunctionFilter
7712   100       Yes      Reverse
7713
7714 progspace /build/test frame-filters:
7715   Priority  Enabled  Name
7716   100       Yes      ProgspaceFilter
7717
7718 objfile /build/test frame-filters:
7719   Priority  Enabled  Name
7720   999       No       BuildProgramFilter
7721
7722 (gdb) enable frame-filter global PrimaryFunctionFilter
7723 (gdb) info frame-filter
7724
7725 global frame-filters:
7726   Priority  Enabled  Name
7727   1000      Yes      PrimaryFunctionFilter
7728   100       Yes      Reverse
7729
7730 progspace /build/test frame-filters:
7731   Priority  Enabled  Name
7732   100       Yes      ProgspaceFilter
7733
7734 objfile /build/test frame-filters:
7735   Priority  Enabled  Name
7736   999       No       BuildProgramFilter
7737 @end smallexample
7738
7739 @kindex set frame-filter priority
7740 @item set frame-filter priority @var{filter-dictionary} @var{filter-name} @var{priority}
7741 Set the @var{priority} of a frame filter in the dictionary matching
7742 @var{filter-dictionary}, and the frame filter name matching
7743 @var{filter-name}.  The @var{filter-dictionary} may be @code{global},
7744 @code{progspace} or the name of the object file where the frame filter
7745 dictionary resides.  The @var{priority} is an integer.
7746
7747 @kindex show frame-filter priority
7748 @item show frame-filter priority @var{filter-dictionary} @var{filter-name}
7749 Show the @var{priority} of a frame filter in the dictionary matching
7750 @var{filter-dictionary}, and the frame filter name matching
7751 @var{filter-name}.  The @var{filter-dictionary} may be @code{global},
7752 @code{progspace} or the name of the object file where the frame filter
7753 dictionary resides.
7754
7755 Example:
7756
7757 @smallexample
7758 (gdb) info frame-filter
7759
7760 global frame-filters:
7761   Priority  Enabled  Name
7762   1000      Yes      PrimaryFunctionFilter
7763   100       Yes      Reverse
7764
7765 progspace /build/test frame-filters:
7766   Priority  Enabled  Name
7767   100       Yes      ProgspaceFilter
7768
7769 objfile /build/test frame-filters:
7770   Priority  Enabled  Name
7771   999       No       BuildProgramFilter
7772
7773 (gdb) set frame-filter priority global Reverse 50
7774 (gdb) info frame-filter
7775
7776 global frame-filters:
7777   Priority  Enabled  Name
7778   1000      Yes      PrimaryFunctionFilter
7779   50        Yes      Reverse
7780
7781 progspace /build/test frame-filters:
7782   Priority  Enabled  Name
7783   100       Yes      ProgspaceFilter
7784
7785 objfile /build/test frame-filters:
7786   Priority  Enabled  Name
7787   999       No       BuildProgramFilter
7788 @end smallexample
7789 @end table
7790
7791 @node Source
7792 @chapter Examining Source Files
7793
7794 @value{GDBN} can print parts of your program's source, since the debugging
7795 information recorded in the program tells @value{GDBN} what source files were
7796 used to build it.  When your program stops, @value{GDBN} spontaneously prints
7797 the line where it stopped.  Likewise, when you select a stack frame
7798 (@pxref{Selection, ,Selecting a Frame}), @value{GDBN} prints the line where
7799 execution in that frame has stopped.  You can print other portions of
7800 source files by explicit command.
7801
7802 If you use @value{GDBN} through its @sc{gnu} Emacs interface, you may
7803 prefer to use Emacs facilities to view source; see @ref{Emacs, ,Using
7804 @value{GDBN} under @sc{gnu} Emacs}.
7805
7806 @menu
7807 * List::                        Printing source lines
7808 * Specify Location::            How to specify code locations
7809 * Edit::                        Editing source files
7810 * Search::                      Searching source files
7811 * Source Path::                 Specifying source directories
7812 * Machine Code::                Source and machine code
7813 @end menu
7814
7815 @node List
7816 @section Printing Source Lines
7817
7818 @kindex list
7819 @kindex l @r{(@code{list})}
7820 To print lines from a source file, use the @code{list} command
7821 (abbreviated @code{l}).  By default, ten lines are printed.
7822 There are several ways to specify what part of the file you want to
7823 print; see @ref{Specify Location}, for the full list.
7824
7825 Here are the forms of the @code{list} command most commonly used:
7826
7827 @table @code
7828 @item list @var{linenum}
7829 Print lines centered around line number @var{linenum} in the
7830 current source file.
7831
7832 @item list @var{function}
7833 Print lines centered around the beginning of function
7834 @var{function}.
7835
7836 @item list
7837 Print more lines.  If the last lines printed were printed with a
7838 @code{list} command, this prints lines following the last lines
7839 printed; however, if the last line printed was a solitary line printed
7840 as part of displaying a stack frame (@pxref{Stack, ,Examining the
7841 Stack}), this prints lines centered around that line.
7842
7843 @item list -
7844 Print lines just before the lines last printed.
7845 @end table
7846
7847 @cindex @code{list}, how many lines to display
7848 By default, @value{GDBN} prints ten source lines with any of these forms of
7849 the @code{list} command.  You can change this using @code{set listsize}:
7850
7851 @table @code
7852 @kindex set listsize
7853 @item set listsize @var{count}
7854 @itemx set listsize unlimited
7855 Make the @code{list} command display @var{count} source lines (unless
7856 the @code{list} argument explicitly specifies some other number).
7857 Setting @var{count} to @code{unlimited} or 0 means there's no limit.
7858
7859 @kindex show listsize
7860 @item show listsize
7861 Display the number of lines that @code{list} prints.
7862 @end table
7863
7864 Repeating a @code{list} command with @key{RET} discards the argument,
7865 so it is equivalent to typing just @code{list}.  This is more useful
7866 than listing the same lines again.  An exception is made for an
7867 argument of @samp{-}; that argument is preserved in repetition so that
7868 each repetition moves up in the source file.
7869
7870 In general, the @code{list} command expects you to supply zero, one or two
7871 @dfn{locations}.  Locations specify source lines; there are several ways
7872 of writing them (@pxref{Specify Location}), but the effect is always
7873 to specify some source line.
7874
7875 Here is a complete description of the possible arguments for @code{list}:
7876
7877 @table @code
7878 @item list @var{location}
7879 Print lines centered around the line specified by @var{location}.
7880
7881 @item list @var{first},@var{last}
7882 Print lines from @var{first} to @var{last}.  Both arguments are
7883 locations.  When a @code{list} command has two locations, and the
7884 source file of the second location is omitted, this refers to
7885 the same source file as the first location.
7886
7887 @item list ,@var{last}
7888 Print lines ending with @var{last}.
7889
7890 @item list @var{first},
7891 Print lines starting with @var{first}.
7892
7893 @item list +
7894 Print lines just after the lines last printed.
7895
7896 @item list -
7897 Print lines just before the lines last printed.
7898
7899 @item list
7900 As described in the preceding table.
7901 @end table
7902
7903 @node Specify Location
7904 @section Specifying a Location
7905 @cindex specifying location
7906 @cindex location
7907 @cindex source location
7908
7909 @menu
7910 * Linespec Locations::                Linespec locations
7911 * Explicit Locations::                Explicit locations
7912 * Address Locations::                 Address locations
7913 @end menu
7914
7915 Several @value{GDBN} commands accept arguments that specify a location
7916 of your program's code.  Since @value{GDBN} is a source-level
7917 debugger, a location usually specifies some line in the source code.
7918 Locations may be specified using three different formats:
7919 linespec locations, explicit locations, or address locations.
7920
7921 @node Linespec Locations
7922 @subsection Linespec Locations
7923 @cindex linespec locations
7924
7925 A @dfn{linespec} is a colon-separated list of source location parameters such
7926 as file name, function name, etc.  Here are all the different ways of
7927 specifying a linespec:
7928
7929 @table @code
7930 @item @var{linenum}
7931 Specifies the line number @var{linenum} of the current source file.
7932
7933 @item -@var{offset}
7934 @itemx +@var{offset}
7935 Specifies the line @var{offset} lines before or after the @dfn{current
7936 line}.  For the @code{list} command, the current line is the last one
7937 printed; for the breakpoint commands, this is the line at which
7938 execution stopped in the currently selected @dfn{stack frame}
7939 (@pxref{Frames, ,Frames}, for a description of stack frames.)  When
7940 used as the second of the two linespecs in a @code{list} command,
7941 this specifies the line @var{offset} lines up or down from the first
7942 linespec.
7943
7944 @item @var{filename}:@var{linenum}
7945 Specifies the line @var{linenum} in the source file @var{filename}.
7946 If @var{filename} is a relative file name, then it will match any
7947 source file name with the same trailing components.  For example, if
7948 @var{filename} is @samp{gcc/expr.c}, then it will match source file
7949 name of @file{/build/trunk/gcc/expr.c}, but not
7950 @file{/build/trunk/libcpp/expr.c} or @file{/build/trunk/gcc/x-expr.c}.
7951
7952 @item @var{function}
7953 Specifies the line that begins the body of the function @var{function}.
7954 For example, in C, this is the line with the open brace.
7955
7956 By default, in C@t{++} and Ada, @var{function} is interpreted as
7957 specifying all functions named @var{function} in all scopes.  For
7958 C@t{++}, this means in all namespaces and classes.  For Ada, this
7959 means in all packages.
7960
7961 For example, assuming a program with C@t{++} symbols named
7962 @code{A::B::func} and @code{B::func}, both commands @w{@kbd{break
7963 func}} and @w{@kbd{break B::func}} set a breakpoint on both symbols.
7964
7965 Commands that accept a linespec let you override this with the
7966 @code{-qualified} option.  For example, @w{@kbd{break -qualified
7967 func}} sets a breakpoint on a free-function named @code{func} ignoring
7968 any C@t{++} class methods and namespace functions called @code{func}.
7969
7970 @xref{Explicit Locations}.
7971
7972 @item @var{function}:@var{label}
7973 Specifies the line where @var{label} appears in @var{function}.
7974
7975 @item @var{filename}:@var{function}
7976 Specifies the line that begins the body of the function @var{function}
7977 in the file @var{filename}.  You only need the file name with a
7978 function name to avoid ambiguity when there are identically named
7979 functions in different source files.
7980
7981 @item @var{label}
7982 Specifies the line at which the label named @var{label} appears
7983 in the function corresponding to the currently selected stack frame.
7984 If there is no current selected stack frame (for instance, if the inferior
7985 is not running), then @value{GDBN} will not search for a label.
7986
7987 @cindex breakpoint at static probe point
7988 @item -pstap|-probe-stap @r{[}@var{objfile}:@r{[}@var{provider}:@r{]}@r{]}@var{name}
7989 The @sc{gnu}/Linux tool @code{SystemTap} provides a way for
7990 applications to embed static probes.  @xref{Static Probe Points}, for more
7991 information on finding and using static probes.  This form of linespec
7992 specifies the location of such a static probe.
7993
7994 If @var{objfile} is given, only probes coming from that shared library
7995 or executable matching @var{objfile} as a regular expression are considered.
7996 If @var{provider} is given, then only probes from that provider are considered.
7997 If several probes match the spec, @value{GDBN} will insert a breakpoint at
7998 each one of those probes.
7999 @end table
8000
8001 @node Explicit Locations
8002 @subsection Explicit Locations
8003 @cindex explicit locations
8004
8005 @dfn{Explicit locations} allow the user to directly specify the source
8006 location's parameters using option-value pairs.
8007
8008 Explicit locations are useful when several functions, labels, or
8009 file names have the same name (base name for files) in the program's
8010 sources.  In these cases, explicit locations point to the source
8011 line you meant more accurately and unambiguously.  Also, using
8012 explicit locations might be faster in large programs.
8013
8014 For example, the linespec @samp{foo:bar} may refer to a function @code{bar}
8015 defined in the file named @file{foo} or the label @code{bar} in a function
8016 named @code{foo}.  @value{GDBN} must search either the file system or
8017 the symbol table to know.
8018
8019 The list of valid explicit location options is summarized in the
8020 following table:
8021
8022 @table @code
8023 @item -source @var{filename}
8024 The value specifies the source file name.  To differentiate between
8025 files with the same base name, prepend as many directories as is necessary
8026 to uniquely identify the desired file, e.g., @file{foo/bar/baz.c}.  Otherwise
8027 @value{GDBN} will use the first file it finds with the given base
8028 name.   This option requires the use of either @code{-function} or @code{-line}.
8029
8030 @item -function @var{function}
8031 The value specifies the name of a function.  Operations
8032 on function locations unmodified by other options (such as @code{-label}
8033 or @code{-line}) refer to the line that begins the body of the function.
8034 In C, for example, this is the line with the open brace.
8035
8036 By default, in C@t{++} and Ada, @var{function} is interpreted as
8037 specifying all functions named @var{function} in all scopes.  For
8038 C@t{++}, this means in all namespaces and classes.  For Ada, this
8039 means in all packages.
8040
8041 For example, assuming a program with C@t{++} symbols named
8042 @code{A::B::func} and @code{B::func}, both commands @w{@kbd{break
8043 -function func}} and @w{@kbd{break -function B::func}} set a
8044 breakpoint on both symbols.
8045
8046 You can use the @kbd{-qualified} flag to override this (see below).
8047
8048 @item -qualified
8049
8050 This flag makes @value{GDBN} interpret a function name specified with
8051 @kbd{-function} as a complete fully-qualified name.
8052
8053 For example, assuming a C@t{++} program with symbols named
8054 @code{A::B::func} and @code{B::func}, the @w{@kbd{break -qualified
8055 -function B::func}} command sets a breakpoint on @code{B::func}, only.
8056
8057 (Note: the @kbd{-qualified} option can precede a linespec as well
8058 (@pxref{Linespec Locations}), so the particular example above could be
8059 simplified as @w{@kbd{break -qualified B::func}}.)
8060
8061 @item -label @var{label}
8062 The value specifies the name of a label.  When the function
8063 name is not specified, the label is searched in the function of the currently
8064 selected stack frame.
8065
8066 @item -line @var{number}
8067 The value specifies a line offset for the location.  The offset may either
8068 be absolute (@code{-line 3}) or relative (@code{-line +3}), depending on
8069 the command.  When specified without any other options, the line offset is
8070 relative to the current line.
8071 @end table
8072
8073 Explicit location options may be abbreviated by omitting any non-unique
8074 trailing characters from the option name, e.g., @w{@kbd{break -s main.c -li 3}}.
8075
8076 @node Address Locations
8077 @subsection Address Locations
8078 @cindex address locations
8079
8080 @dfn{Address locations} indicate a specific program address.  They have
8081 the generalized form *@var{address}.
8082
8083 For line-oriented commands, such as @code{list} and @code{edit}, this
8084 specifies a source line that contains @var{address}.  For @code{break} and
8085 other breakpoint-oriented commands, this can be used to set breakpoints in
8086 parts of your program which do not have debugging information or
8087 source files.
8088
8089 Here @var{address} may be any expression valid in the current working
8090 language (@pxref{Languages, working language}) that specifies a code
8091 address.  In addition, as a convenience, @value{GDBN} extends the
8092 semantics of expressions used in locations to cover several situations
8093 that frequently occur during debugging.  Here are the various forms
8094 of @var{address}:
8095
8096 @table @code
8097 @item @var{expression}
8098 Any expression valid in the current working language.
8099
8100 @item @var{funcaddr}
8101 An address of a function or procedure derived from its name.  In C,
8102 C@t{++}, Objective-C, Fortran, minimal, and assembly, this is
8103 simply the function's name @var{function} (and actually a special case
8104 of a valid expression).  In Pascal and Modula-2, this is
8105 @code{&@var{function}}.  In Ada, this is @code{@var{function}'Address}
8106 (although the Pascal form also works).
8107
8108 This form specifies the address of the function's first instruction,
8109 before the stack frame and arguments have been set up.
8110
8111 @item '@var{filename}':@var{funcaddr}
8112 Like @var{funcaddr} above, but also specifies the name of the source
8113 file explicitly.  This is useful if the name of the function does not
8114 specify the function unambiguously, e.g., if there are several
8115 functions with identical names in different source files.
8116 @end table
8117
8118 @node Edit
8119 @section Editing Source Files
8120 @cindex editing source files
8121
8122 @kindex edit
8123 @kindex e @r{(@code{edit})}
8124 To edit the lines in a source file, use the @code{edit} command.
8125 The editing program of your choice
8126 is invoked with the current line set to
8127 the active line in the program.
8128 Alternatively, there are several ways to specify what part of the file you
8129 want to print if you want to see other parts of the program:
8130
8131 @table @code
8132 @item edit @var{location}
8133 Edit the source file specified by @code{location}.  Editing starts at
8134 that @var{location}, e.g., at the specified source line of the
8135 specified file.  @xref{Specify Location}, for all the possible forms
8136 of the @var{location} argument; here are the forms of the @code{edit}
8137 command most commonly used:
8138
8139 @table @code
8140 @item edit @var{number}
8141 Edit the current source file with @var{number} as the active line number.
8142
8143 @item edit @var{function}
8144 Edit the file containing @var{function} at the beginning of its definition.
8145 @end table
8146
8147 @end table
8148
8149 @subsection Choosing your Editor
8150 You can customize @value{GDBN} to use any editor you want
8151 @footnote{
8152 The only restriction is that your editor (say @code{ex}), recognizes the
8153 following command-line syntax:
8154 @smallexample
8155 ex +@var{number} file
8156 @end smallexample
8157 The optional numeric value +@var{number} specifies the number of the line in
8158 the file where to start editing.}.
8159 By default, it is @file{@value{EDITOR}}, but you can change this
8160 by setting the environment variable @code{EDITOR} before using
8161 @value{GDBN}.  For example, to configure @value{GDBN} to use the
8162 @code{vi} editor, you could use these commands with the @code{sh} shell:
8163 @smallexample
8164 EDITOR=/usr/bin/vi
8165 export EDITOR
8166 gdb @dots{}
8167 @end smallexample
8168 or in the @code{csh} shell,
8169 @smallexample
8170 setenv EDITOR /usr/bin/vi
8171 gdb @dots{}
8172 @end smallexample
8173
8174 @node Search
8175 @section Searching Source Files
8176 @cindex searching source files
8177
8178 There are two commands for searching through the current source file for a
8179 regular expression.
8180
8181 @table @code
8182 @kindex search
8183 @kindex forward-search
8184 @kindex fo @r{(@code{forward-search})}
8185 @item forward-search @var{regexp}
8186 @itemx search @var{regexp}
8187 The command @samp{forward-search @var{regexp}} checks each line,
8188 starting with the one following the last line listed, for a match for
8189 @var{regexp}.  It lists the line that is found.  You can use the
8190 synonym @samp{search @var{regexp}} or abbreviate the command name as
8191 @code{fo}.
8192
8193 @kindex reverse-search
8194 @item reverse-search @var{regexp}
8195 The command @samp{reverse-search @var{regexp}} checks each line, starting
8196 with the one before the last line listed and going backward, for a match
8197 for @var{regexp}.  It lists the line that is found.  You can abbreviate
8198 this command as @code{rev}.
8199 @end table
8200
8201 @node Source Path
8202 @section Specifying Source Directories
8203
8204 @cindex source path
8205 @cindex directories for source files
8206 Executable programs sometimes do not record the directories of the source
8207 files from which they were compiled, just the names.  Even when they do,
8208 the directories could be moved between the compilation and your debugging
8209 session.  @value{GDBN} has a list of directories to search for source files;
8210 this is called the @dfn{source path}.  Each time @value{GDBN} wants a source file,
8211 it tries all the directories in the list, in the order they are present
8212 in the list, until it finds a file with the desired name.
8213
8214 For example, suppose an executable references the file
8215 @file{/usr/src/foo-1.0/lib/foo.c}, and our source path is
8216 @file{/mnt/cross}.  The file is first looked up literally; if this
8217 fails, @file{/mnt/cross/usr/src/foo-1.0/lib/foo.c} is tried; if this
8218 fails, @file{/mnt/cross/foo.c} is opened; if this fails, an error
8219 message is printed.  @value{GDBN} does not look up the parts of the
8220 source file name, such as @file{/mnt/cross/src/foo-1.0/lib/foo.c}.
8221 Likewise, the subdirectories of the source path are not searched: if
8222 the source path is @file{/mnt/cross}, and the binary refers to
8223 @file{foo.c}, @value{GDBN} would not find it under
8224 @file{/mnt/cross/usr/src/foo-1.0/lib}.
8225
8226 Plain file names, relative file names with leading directories, file
8227 names containing dots, etc.@: are all treated as described above; for
8228 instance, if the source path is @file{/mnt/cross}, and the source file
8229 is recorded as @file{../lib/foo.c}, @value{GDBN} would first try
8230 @file{../lib/foo.c}, then @file{/mnt/cross/../lib/foo.c}, and after
8231 that---@file{/mnt/cross/foo.c}.
8232
8233 Note that the executable search path is @emph{not} used to locate the
8234 source files.
8235
8236 Whenever you reset or rearrange the source path, @value{GDBN} clears out
8237 any information it has cached about where source files are found and where
8238 each line is in the file.
8239
8240 @kindex directory
8241 @kindex dir
8242 When you start @value{GDBN}, its source path includes only @samp{cdir}
8243 and @samp{cwd}, in that order.
8244 To add other directories, use the @code{directory} command.
8245
8246 The search path is used to find both program source files and @value{GDBN}
8247 script files (read using the @samp{-command} option and @samp{source} command).
8248
8249 In addition to the source path, @value{GDBN} provides a set of commands
8250 that manage a list of source path substitution rules.  A @dfn{substitution
8251 rule} specifies how to rewrite source directories stored in the program's
8252 debug information in case the sources were moved to a different
8253 directory between compilation and debugging.  A rule is made of
8254 two strings, the first specifying what needs to be rewritten in
8255 the path, and the second specifying how it should be rewritten.
8256 In @ref{set substitute-path}, we name these two parts @var{from} and
8257 @var{to} respectively.  @value{GDBN} does a simple string replacement
8258 of @var{from} with @var{to} at the start of the directory part of the
8259 source file name, and uses that result instead of the original file
8260 name to look up the sources.
8261
8262 Using the previous example, suppose the @file{foo-1.0} tree has been
8263 moved from @file{/usr/src} to @file{/mnt/cross}, then you can tell
8264 @value{GDBN} to replace @file{/usr/src} in all source path names with
8265 @file{/mnt/cross}.  The first lookup will then be
8266 @file{/mnt/cross/foo-1.0/lib/foo.c} in place of the original location
8267 of @file{/usr/src/foo-1.0/lib/foo.c}.  To define a source path
8268 substitution rule, use the @code{set substitute-path} command
8269 (@pxref{set substitute-path}).
8270
8271 To avoid unexpected substitution results, a rule is applied only if the
8272 @var{from} part of the directory name ends at a directory separator.
8273 For instance, a rule substituting  @file{/usr/source} into
8274 @file{/mnt/cross} will be applied to @file{/usr/source/foo-1.0} but
8275 not to @file{/usr/sourceware/foo-2.0}.  And because the substitution
8276 is applied only at the beginning of the directory name, this rule will
8277 not be applied to @file{/root/usr/source/baz.c} either.
8278
8279 In many cases, you can achieve the same result using the @code{directory}
8280 command.  However, @code{set substitute-path} can be more efficient in
8281 the case where the sources are organized in a complex tree with multiple
8282 subdirectories.  With the @code{directory} command, you need to add each
8283 subdirectory of your project.  If you moved the entire tree while
8284 preserving its internal organization, then @code{set substitute-path}
8285 allows you to direct the debugger to all the sources with one single
8286 command.
8287
8288 @code{set substitute-path} is also more than just a shortcut command.
8289 The source path is only used if the file at the original location no
8290 longer exists.  On the other hand, @code{set substitute-path} modifies
8291 the debugger behavior to look at the rewritten location instead.  So, if
8292 for any reason a source file that is not relevant to your executable is
8293 located at the original location, a substitution rule is the only
8294 method available to point @value{GDBN} at the new location.
8295
8296 @cindex @samp{--with-relocated-sources}
8297 @cindex default source path substitution
8298 You can configure a default source path substitution rule by
8299 configuring @value{GDBN} with the
8300 @samp{--with-relocated-sources=@var{dir}} option.  The @var{dir}
8301 should be the name of a directory under @value{GDBN}'s configured
8302 prefix (set with @samp{--prefix} or @samp{--exec-prefix}), and
8303 directory names in debug information under @var{dir} will be adjusted
8304 automatically if the installed @value{GDBN} is moved to a new
8305 location.  This is useful if @value{GDBN}, libraries or executables
8306 with debug information and corresponding source code are being moved
8307 together.
8308
8309 @table @code
8310 @item directory @var{dirname} @dots{}
8311 @item dir @var{dirname} @dots{}
8312 Add directory @var{dirname} to the front of the source path.  Several
8313 directory names may be given to this command, separated by @samp{:}
8314 (@samp{;} on MS-DOS and MS-Windows, where @samp{:} usually appears as
8315 part of absolute file names) or
8316 whitespace.  You may specify a directory that is already in the source
8317 path; this moves it forward, so @value{GDBN} searches it sooner.
8318
8319 @kindex cdir
8320 @kindex cwd
8321 @vindex $cdir@r{, convenience variable}
8322 @vindex $cwd@r{, convenience variable}
8323 @cindex compilation directory
8324 @cindex current directory
8325 @cindex working directory
8326 @cindex directory, current
8327 @cindex directory, compilation
8328 You can use the string @samp{$cdir} to refer to the compilation
8329 directory (if one is recorded), and @samp{$cwd} to refer to the current
8330 working directory.  @samp{$cwd} is not the same as @samp{.}---the former
8331 tracks the current working directory as it changes during your @value{GDBN}
8332 session, while the latter is immediately expanded to the current
8333 directory at the time you add an entry to the source path.
8334
8335 @item directory
8336 Reset the source path to its default value (@samp{$cdir:$cwd} on Unix systems).  This requires confirmation.
8337
8338 @c RET-repeat for @code{directory} is explicitly disabled, but since
8339 @c repeating it would be a no-op we do not say that.  (thanks to RMS)
8340
8341 @item set directories @var{path-list}
8342 @kindex set directories
8343 Set the source path to @var{path-list}.
8344 @samp{$cdir:$cwd} are added if missing.
8345
8346 @item show directories
8347 @kindex show directories
8348 Print the source path: show which directories it contains.
8349
8350 @anchor{set substitute-path}
8351 @item set substitute-path @var{from} @var{to}
8352 @kindex set substitute-path
8353 Define a source path substitution rule, and add it at the end of the
8354 current list of existing substitution rules.  If a rule with the same
8355 @var{from} was already defined, then the old rule is also deleted.
8356
8357 For example, if the file @file{/foo/bar/baz.c} was moved to
8358 @file{/mnt/cross/baz.c}, then the command
8359
8360 @smallexample
8361 (@value{GDBP}) set substitute-path /foo/bar /mnt/cross
8362 @end smallexample
8363
8364 @noindent
8365 will tell @value{GDBN} to replace @samp{/foo/bar} with
8366 @samp{/mnt/cross}, which will allow @value{GDBN} to find the file
8367 @file{baz.c} even though it was moved.
8368
8369 In the case when more than one substitution rule have been defined,
8370 the rules are evaluated one by one in the order where they have been
8371 defined.  The first one matching, if any, is selected to perform
8372 the substitution.
8373
8374 For instance, if we had entered the following commands:
8375
8376 @smallexample
8377 (@value{GDBP}) set substitute-path /usr/src/include /mnt/include
8378 (@value{GDBP}) set substitute-path /usr/src /mnt/src
8379 @end smallexample
8380
8381 @noindent
8382 @value{GDBN} would then rewrite @file{/usr/src/include/defs.h} into
8383 @file{/mnt/include/defs.h} by using the first rule.  However, it would
8384 use the second rule to rewrite @file{/usr/src/lib/foo.c} into
8385 @file{/mnt/src/lib/foo.c}.
8386
8387
8388 @item unset substitute-path [path]
8389 @kindex unset substitute-path
8390 If a path is specified, search the current list of substitution rules
8391 for a rule that would rewrite that path.  Delete that rule if found.
8392 A warning is emitted by the debugger if no rule could be found.
8393
8394 If no path is specified, then all substitution rules are deleted.
8395
8396 @item show substitute-path [path]
8397 @kindex show substitute-path
8398 If a path is specified, then print the source path substitution rule
8399 which would rewrite that path, if any.
8400
8401 If no path is specified, then print all existing source path substitution
8402 rules.
8403
8404 @end table
8405
8406 If your source path is cluttered with directories that are no longer of
8407 interest, @value{GDBN} may sometimes cause confusion by finding the wrong
8408 versions of source.  You can correct the situation as follows:
8409
8410 @enumerate
8411 @item
8412 Use @code{directory} with no argument to reset the source path to its default value.
8413
8414 @item
8415 Use @code{directory} with suitable arguments to reinstall the
8416 directories you want in the source path.  You can add all the
8417 directories in one command.
8418 @end enumerate
8419
8420 @node Machine Code
8421 @section Source and Machine Code
8422 @cindex source line and its code address
8423
8424 You can use the command @code{info line} to map source lines to program
8425 addresses (and vice versa), and the command @code{disassemble} to display
8426 a range of addresses as machine instructions.  You can use the command
8427 @code{set disassemble-next-line} to set whether to disassemble next
8428 source line when execution stops.  When run under @sc{gnu} Emacs
8429 mode, the @code{info line} command causes the arrow to point to the
8430 line specified.  Also, @code{info line} prints addresses in symbolic form as
8431 well as hex.
8432
8433 @table @code
8434 @kindex info line
8435 @item info line @var{location}
8436 Print the starting and ending addresses of the compiled code for
8437 source line @var{location}.  You can specify source lines in any of
8438 the ways documented in @ref{Specify Location}.
8439 @end table
8440
8441 For example, we can use @code{info line} to discover the location of
8442 the object code for the first line of function
8443 @code{m4_changequote}:
8444
8445 @c FIXME: I think this example should also show the addresses in
8446 @c symbolic form, as they usually would be displayed.
8447 @smallexample
8448 (@value{GDBP}) info line m4_changequote
8449 Line 895 of "builtin.c" starts at pc 0x634c and ends at 0x6350.
8450 @end smallexample
8451
8452 @noindent
8453 @cindex code address and its source line
8454 We can also inquire (using @code{*@var{addr}} as the form for
8455 @var{location}) what source line covers a particular address:
8456 @smallexample
8457 (@value{GDBP}) info line *0x63ff
8458 Line 926 of "builtin.c" starts at pc 0x63e4 and ends at 0x6404.
8459 @end smallexample
8460
8461 @cindex @code{$_} and @code{info line}
8462 @cindex @code{x} command, default address
8463 @kindex x@r{(examine), and} info line
8464 After @code{info line}, the default address for the @code{x} command
8465 is changed to the starting address of the line, so that @samp{x/i} is
8466 sufficient to begin examining the machine code (@pxref{Memory,
8467 ,Examining Memory}).  Also, this address is saved as the value of the
8468 convenience variable @code{$_} (@pxref{Convenience Vars, ,Convenience
8469 Variables}).
8470
8471 @table @code
8472 @kindex disassemble
8473 @cindex assembly instructions
8474 @cindex instructions, assembly
8475 @cindex machine instructions
8476 @cindex listing machine instructions
8477 @item disassemble
8478 @itemx disassemble /m
8479 @itemx disassemble /s
8480 @itemx disassemble /r
8481 This specialized command dumps a range of memory as machine
8482 instructions.  It can also print mixed source+disassembly by specifying
8483 the @code{/m} or @code{/s} modifier and print the raw instructions in hex
8484 as well as in symbolic form by specifying the @code{/r} modifier.
8485 The default memory range is the function surrounding the
8486 program counter of the selected frame.  A single argument to this
8487 command is a program counter value; @value{GDBN} dumps the function
8488 surrounding this value.  When two arguments are given, they should
8489 be separated by a comma, possibly surrounded by whitespace.  The
8490 arguments specify a range of addresses to dump, in one of two forms:
8491
8492 @table @code
8493 @item @var{start},@var{end}
8494 the addresses from @var{start} (inclusive) to @var{end} (exclusive)
8495 @item @var{start},+@var{length}
8496 the addresses from @var{start} (inclusive) to
8497 @code{@var{start}+@var{length}} (exclusive).
8498 @end table
8499
8500 @noindent
8501 When 2 arguments are specified, the name of the function is also
8502 printed (since there could be several functions in the given range).
8503
8504 The argument(s) can be any expression yielding a numeric value, such as
8505 @samp{0x32c4}, @samp{&main+10} or @samp{$pc - 8}.
8506
8507 If the range of memory being disassembled contains current program counter,
8508 the instruction at that location is shown with a @code{=>} marker.
8509 @end table
8510
8511 The following example shows the disassembly of a range of addresses of
8512 HP PA-RISC 2.0 code:
8513
8514 @smallexample
8515 (@value{GDBP}) disas 0x32c4, 0x32e4
8516 Dump of assembler code from 0x32c4 to 0x32e4:
8517    0x32c4 <main+204>:      addil 0,dp
8518    0x32c8 <main+208>:      ldw 0x22c(sr0,r1),r26
8519    0x32cc <main+212>:      ldil 0x3000,r31
8520    0x32d0 <main+216>:      ble 0x3f8(sr4,r31)
8521    0x32d4 <main+220>:      ldo 0(r31),rp
8522    0x32d8 <main+224>:      addil -0x800,dp
8523    0x32dc <main+228>:      ldo 0x588(r1),r26
8524    0x32e0 <main+232>:      ldil 0x3000,r31
8525 End of assembler dump.
8526 @end smallexample
8527
8528 Here is an example showing mixed source+assembly for Intel x86
8529 with @code{/m} or @code{/s}, when the program is stopped just after
8530 function prologue in a non-optimized function with no inline code.
8531
8532 @smallexample
8533 (@value{GDBP}) disas /m main
8534 Dump of assembler code for function main:
8535 5       @{
8536    0x08048330 <+0>:    push   %ebp
8537    0x08048331 <+1>:    mov    %esp,%ebp
8538    0x08048333 <+3>:    sub    $0x8,%esp
8539    0x08048336 <+6>:    and    $0xfffffff0,%esp
8540    0x08048339 <+9>:    sub    $0x10,%esp
8541
8542 6         printf ("Hello.\n");
8543 => 0x0804833c <+12>:   movl   $0x8048440,(%esp)
8544    0x08048343 <+19>:   call   0x8048284 <puts@@plt>
8545
8546 7         return 0;
8547 8       @}
8548    0x08048348 <+24>:   mov    $0x0,%eax
8549    0x0804834d <+29>:   leave
8550    0x0804834e <+30>:   ret
8551
8552 End of assembler dump.
8553 @end smallexample
8554
8555 The @code{/m} option is deprecated as its output is not useful when
8556 there is either inlined code or re-ordered code.
8557 The @code{/s} option is the preferred choice.
8558 Here is an example for AMD x86-64 showing the difference between
8559 @code{/m} output and @code{/s} output.
8560 This example has one inline function defined in a header file,
8561 and the code is compiled with @samp{-O2} optimization.
8562 Note how the @code{/m} output is missing the disassembly of
8563 several instructions that are present in the @code{/s} output.
8564
8565 @file{foo.h}:
8566
8567 @smallexample
8568 int
8569 foo (int a)
8570 @{
8571   if (a < 0)
8572     return a * 2;
8573   if (a == 0)
8574     return 1;
8575   return a + 10;
8576 @}
8577 @end smallexample
8578
8579 @file{foo.c}:
8580
8581 @smallexample
8582 #include "foo.h"
8583 volatile int x, y;
8584 int
8585 main ()
8586 @{
8587   x = foo (y);
8588   return 0;
8589 @}
8590 @end smallexample
8591
8592 @smallexample
8593 (@value{GDBP}) disas /m main
8594 Dump of assembler code for function main:
8595 5       @{
8596
8597 6         x = foo (y);
8598    0x0000000000400400 <+0>:     mov    0x200c2e(%rip),%eax # 0x601034 <y>
8599    0x0000000000400417 <+23>:    mov    %eax,0x200c13(%rip) # 0x601030 <x>
8600
8601 7         return 0;
8602 8       @}
8603    0x000000000040041d <+29>:    xor    %eax,%eax
8604    0x000000000040041f <+31>:    retq
8605    0x0000000000400420 <+32>:    add    %eax,%eax
8606    0x0000000000400422 <+34>:    jmp    0x400417 <main+23>
8607
8608 End of assembler dump.
8609 (@value{GDBP}) disas /s main
8610 Dump of assembler code for function main:
8611 foo.c:
8612 5       @{
8613 6         x = foo (y);
8614    0x0000000000400400 <+0>:     mov    0x200c2e(%rip),%eax # 0x601034 <y>
8615
8616 foo.h:
8617 4         if (a < 0)
8618    0x0000000000400406 <+6>:     test   %eax,%eax
8619    0x0000000000400408 <+8>:     js     0x400420 <main+32>
8620
8621 6         if (a == 0)
8622 7           return 1;
8623 8         return a + 10;
8624    0x000000000040040a <+10>:    lea    0xa(%rax),%edx
8625    0x000000000040040d <+13>:    test   %eax,%eax
8626    0x000000000040040f <+15>:    mov    $0x1,%eax
8627    0x0000000000400414 <+20>:    cmovne %edx,%eax
8628
8629 foo.c:
8630 6         x = foo (y);
8631    0x0000000000400417 <+23>:    mov    %eax,0x200c13(%rip) # 0x601030 <x>
8632
8633 7         return 0;
8634 8       @}
8635    0x000000000040041d <+29>:    xor    %eax,%eax
8636    0x000000000040041f <+31>:    retq
8637
8638 foo.h:
8639 5           return a * 2;
8640    0x0000000000400420 <+32>:    add    %eax,%eax
8641    0x0000000000400422 <+34>:    jmp    0x400417 <main+23>
8642 End of assembler dump.
8643 @end smallexample
8644
8645 Here is another example showing raw instructions in hex for AMD x86-64,
8646
8647 @smallexample
8648 (gdb) disas /r 0x400281,+10
8649 Dump of assembler code from 0x400281 to 0x40028b:
8650    0x0000000000400281:  38 36  cmp    %dh,(%rsi)
8651    0x0000000000400283:  2d 36 34 2e 73 sub    $0x732e3436,%eax
8652    0x0000000000400288:  6f     outsl  %ds:(%rsi),(%dx)
8653    0x0000000000400289:  2e 32 00       xor    %cs:(%rax),%al
8654 End of assembler dump.
8655 @end smallexample
8656
8657 Addresses cannot be specified as a location (@pxref{Specify Location}).
8658 So, for example, if you want to disassemble function @code{bar}
8659 in file @file{foo.c}, you must type @samp{disassemble 'foo.c'::bar}
8660 and not @samp{disassemble foo.c:bar}.
8661
8662 Some architectures have more than one commonly-used set of instruction
8663 mnemonics or other syntax.
8664
8665 For programs that were dynamically linked and use shared libraries,
8666 instructions that call functions or branch to locations in the shared
8667 libraries might show a seemingly bogus location---it's actually a
8668 location of the relocation table.  On some architectures, @value{GDBN}
8669 might be able to resolve these to actual function names.
8670
8671 @table @code
8672 @kindex set disassembler-options
8673 @cindex disassembler options
8674 @item set disassembler-options @var{option1}[,@var{option2}@dots{}]
8675 This command controls the passing of target specific information to
8676 the disassembler.  For a list of valid options, please refer to the
8677 @code{-M}/@code{--disassembler-options} section of the @samp{objdump}
8678 manual and/or the output of @kbd{objdump --help}
8679 (@pxref{objdump,,objdump,binutils.info,The GNU Binary Utilities}).
8680 The default value is the empty string.
8681
8682 If it is necessary to specify more than one disassembler option, then
8683 multiple options can be placed together into a comma separated list.
8684 Currently this command is only supported on targets ARM, PowerPC
8685 and S/390.
8686
8687 @kindex show disassembler-options
8688 @item show disassembler-options
8689 Show the current setting of the disassembler options.
8690 @end table
8691
8692 @table @code
8693 @kindex set disassembly-flavor
8694 @cindex Intel disassembly flavor
8695 @cindex AT&T disassembly flavor
8696 @item set disassembly-flavor @var{instruction-set}
8697 Select the instruction set to use when disassembling the
8698 program via the @code{disassemble} or @code{x/i} commands.
8699
8700 Currently this command is only defined for the Intel x86 family.  You
8701 can set @var{instruction-set} to either @code{intel} or @code{att}.
8702 The default is @code{att}, the AT&T flavor used by default by Unix
8703 assemblers for x86-based targets.
8704
8705 @kindex show disassembly-flavor
8706 @item show disassembly-flavor
8707 Show the current setting of the disassembly flavor.
8708 @end table
8709
8710 @table @code
8711 @kindex set disassemble-next-line
8712 @kindex show disassemble-next-line
8713 @item set disassemble-next-line
8714 @itemx show disassemble-next-line
8715 Control whether or not @value{GDBN} will disassemble the next source
8716 line or instruction when execution stops.  If ON, @value{GDBN} will
8717 display disassembly of the next source line when execution of the
8718 program being debugged stops.  This is @emph{in addition} to
8719 displaying the source line itself, which @value{GDBN} always does if
8720 possible.  If the next source line cannot be displayed for some reason
8721 (e.g., if @value{GDBN} cannot find the source file, or there's no line
8722 info in the debug info), @value{GDBN} will display disassembly of the
8723 next @emph{instruction} instead of showing the next source line.  If
8724 AUTO, @value{GDBN} will display disassembly of next instruction only
8725 if the source line cannot be displayed.  This setting causes
8726 @value{GDBN} to display some feedback when you step through a function
8727 with no line info or whose source file is unavailable.  The default is
8728 OFF, which means never display the disassembly of the next line or
8729 instruction.
8730 @end table
8731
8732
8733 @node Data
8734 @chapter Examining Data
8735
8736 @cindex printing data
8737 @cindex examining data
8738 @kindex print
8739 @kindex inspect
8740 The usual way to examine data in your program is with the @code{print}
8741 command (abbreviated @code{p}), or its synonym @code{inspect}.  It
8742 evaluates and prints the value of an expression of the language your
8743 program is written in (@pxref{Languages, ,Using @value{GDBN} with
8744 Different Languages}).  It may also print the expression using a
8745 Python-based pretty-printer (@pxref{Pretty Printing}).
8746
8747 @table @code
8748 @item print @var{expr}
8749 @itemx print /@var{f} @var{expr}
8750 @var{expr} is an expression (in the source language).  By default the
8751 value of @var{expr} is printed in a format appropriate to its data type;
8752 you can choose a different format by specifying @samp{/@var{f}}, where
8753 @var{f} is a letter specifying the format; see @ref{Output Formats,,Output
8754 Formats}.
8755
8756 @item print
8757 @itemx print /@var{f}
8758 @cindex reprint the last value
8759 If you omit @var{expr}, @value{GDBN} displays the last value again (from the
8760 @dfn{value history}; @pxref{Value History, ,Value History}).  This allows you to
8761 conveniently inspect the same value in an alternative format.
8762 @end table
8763
8764 A more low-level way of examining data is with the @code{x} command.
8765 It examines data in memory at a specified address and prints it in a
8766 specified format.  @xref{Memory, ,Examining Memory}.
8767
8768 If you are interested in information about types, or about how the
8769 fields of a struct or a class are declared, use the @code{ptype @var{exp}}
8770 command rather than @code{print}.  @xref{Symbols, ,Examining the Symbol
8771 Table}.
8772
8773 @cindex exploring hierarchical data structures
8774 @kindex explore
8775 Another way of examining values of expressions and type information is
8776 through the Python extension command @code{explore} (available only if
8777 the @value{GDBN} build is configured with @code{--with-python}).  It
8778 offers an interactive way to start at the highest level (or, the most
8779 abstract level) of the data type of an expression (or, the data type
8780 itself) and explore all the way down to leaf scalar values/fields
8781 embedded in the higher level data types.
8782
8783 @table @code
8784 @item explore @var{arg}
8785 @var{arg} is either an expression (in the source language), or a type
8786 visible in the current context of the program being debugged.
8787 @end table
8788
8789 The working of the @code{explore} command can be illustrated with an
8790 example.  If a data type @code{struct ComplexStruct} is defined in your
8791 C program as
8792
8793 @smallexample
8794 struct SimpleStruct
8795 @{
8796   int i;
8797   double d;
8798 @};
8799
8800 struct ComplexStruct
8801 @{
8802   struct SimpleStruct *ss_p;
8803   int arr[10];
8804 @};
8805 @end smallexample
8806
8807 @noindent
8808 followed by variable declarations as
8809
8810 @smallexample
8811 struct SimpleStruct ss = @{ 10, 1.11 @};
8812 struct ComplexStruct cs = @{ &ss, @{ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 @} @};
8813 @end smallexample
8814
8815 @noindent
8816 then, the value of the variable @code{cs} can be explored using the
8817 @code{explore} command as follows.
8818
8819 @smallexample
8820 (gdb) explore cs
8821 The value of `cs' is a struct/class of type `struct ComplexStruct' with
8822 the following fields:
8823
8824   ss_p = <Enter 0 to explore this field of type `struct SimpleStruct *'>
8825    arr = <Enter 1 to explore this field of type `int [10]'>
8826
8827 Enter the field number of choice:
8828 @end smallexample
8829
8830 @noindent
8831 Since the fields of @code{cs} are not scalar values, you are being
8832 prompted to chose the field you want to explore.  Let's say you choose
8833 the field @code{ss_p} by entering @code{0}.  Then, since this field is a
8834 pointer, you will be asked if it is pointing to a single value.  From
8835 the declaration of @code{cs} above, it is indeed pointing to a single
8836 value, hence you enter @code{y}.  If you enter @code{n}, then you will
8837 be asked if it were pointing to an array of values, in which case this
8838 field will be explored as if it were an array.
8839
8840 @smallexample
8841 `cs.ss_p' is a pointer to a value of type `struct SimpleStruct'
8842 Continue exploring it as a pointer to a single value [y/n]: y
8843 The value of `*(cs.ss_p)' is a struct/class of type `struct
8844 SimpleStruct' with the following fields:
8845
8846   i = 10 .. (Value of type `int')
8847   d = 1.1100000000000001 .. (Value of type `double')
8848
8849 Press enter to return to parent value:
8850 @end smallexample
8851
8852 @noindent
8853 If the field @code{arr} of @code{cs} was chosen for exploration by
8854 entering @code{1} earlier, then since it is as array, you will be
8855 prompted to enter the index of the element in the array that you want
8856 to explore.
8857
8858 @smallexample
8859 `cs.arr' is an array of `int'.
8860 Enter the index of the element you want to explore in `cs.arr': 5
8861
8862 `(cs.arr)[5]' is a scalar value of type `int'.
8863
8864 (cs.arr)[5] = 4
8865
8866 Press enter to return to parent value: 
8867 @end smallexample
8868
8869 In general, at any stage of exploration, you can go deeper towards the
8870 leaf values by responding to the prompts appropriately, or hit the
8871 return key to return to the enclosing data structure (the @i{higher}
8872 level data structure).
8873
8874 Similar to exploring values, you can use the @code{explore} command to
8875 explore types.  Instead of specifying a value (which is typically a
8876 variable name or an expression valid in the current context of the
8877 program being debugged), you specify a type name.  If you consider the
8878 same example as above, your can explore the type
8879 @code{struct ComplexStruct} by passing the argument
8880 @code{struct ComplexStruct} to the @code{explore} command.
8881
8882 @smallexample
8883 (gdb) explore struct ComplexStruct
8884 @end smallexample
8885
8886 @noindent
8887 By responding to the prompts appropriately in the subsequent interactive
8888 session, you can explore the type @code{struct ComplexStruct} in a
8889 manner similar to how the value @code{cs} was explored in the above
8890 example.
8891
8892 The @code{explore} command also has two sub-commands,
8893 @code{explore value} and @code{explore type}. The former sub-command is
8894 a way to explicitly specify that value exploration of the argument is
8895 being invoked, while the latter is a way to explicitly specify that type
8896 exploration of the argument is being invoked.
8897
8898 @table @code
8899 @item explore value @var{expr}
8900 @cindex explore value
8901 This sub-command of @code{explore} explores the value of the
8902 expression @var{expr} (if @var{expr} is an expression valid in the
8903 current context of the program being debugged).  The behavior of this
8904 command is identical to that of the behavior of the @code{explore}
8905 command being passed the argument @var{expr}.
8906
8907 @item explore type @var{arg}
8908 @cindex explore type
8909 This sub-command of @code{explore} explores the type of @var{arg} (if
8910 @var{arg} is a type visible in the current context of program being
8911 debugged), or the type of the value/expression @var{arg} (if @var{arg}
8912 is an expression valid in the current context of the program being
8913 debugged).  If @var{arg} is a type, then the behavior of this command is
8914 identical to that of the @code{explore} command being passed the
8915 argument @var{arg}.  If @var{arg} is an expression, then the behavior of
8916 this command will be identical to that of the @code{explore} command
8917 being passed the type of @var{arg} as the argument.
8918 @end table
8919
8920 @menu
8921 * Expressions::                 Expressions
8922 * Ambiguous Expressions::       Ambiguous Expressions
8923 * Variables::                   Program variables
8924 * Arrays::                      Artificial arrays
8925 * Output Formats::              Output formats
8926 * Memory::                      Examining memory
8927 * Auto Display::                Automatic display
8928 * Print Settings::              Print settings
8929 * Pretty Printing::             Python pretty printing
8930 * Value History::               Value history
8931 * Convenience Vars::            Convenience variables
8932 * Convenience Funs::            Convenience functions
8933 * Registers::                   Registers
8934 * Floating Point Hardware::     Floating point hardware
8935 * Vector Unit::                 Vector Unit
8936 * OS Information::              Auxiliary data provided by operating system
8937 * Memory Region Attributes::    Memory region attributes
8938 * Dump/Restore Files::          Copy between memory and a file
8939 * Core File Generation::        Cause a program dump its core
8940 * Character Sets::              Debugging programs that use a different
8941                                 character set than GDB does
8942 * Caching Target Data::         Data caching for targets
8943 * Searching Memory::            Searching memory for a sequence of bytes
8944 * Value Sizes::                 Managing memory allocated for values
8945 @end menu
8946
8947 @node Expressions
8948 @section Expressions
8949
8950 @cindex expressions
8951 @code{print} and many other @value{GDBN} commands accept an expression and
8952 compute its value.  Any kind of constant, variable or operator defined
8953 by the programming language you are using is valid in an expression in
8954 @value{GDBN}.  This includes conditional expressions, function calls,
8955 casts, and string constants.  It also includes preprocessor macros, if
8956 you compiled your program to include this information; see
8957 @ref{Compilation}.
8958
8959 @cindex arrays in expressions
8960 @value{GDBN} supports array constants in expressions input by
8961 the user.  The syntax is @{@var{element}, @var{element}@dots{}@}.  For example,
8962 you can use the command @code{print @{1, 2, 3@}} to create an array
8963 of three integers.  If you pass an array to a function or assign it
8964 to a program variable, @value{GDBN} copies the array to memory that
8965 is @code{malloc}ed in the target program.
8966
8967 Because C is so widespread, most of the expressions shown in examples in
8968 this manual are in C.  @xref{Languages, , Using @value{GDBN} with Different
8969 Languages}, for information on how to use expressions in other
8970 languages.
8971
8972 In this section, we discuss operators that you can use in @value{GDBN}
8973 expressions regardless of your programming language.
8974
8975 @cindex casts, in expressions
8976 Casts are supported in all languages, not just in C, because it is so
8977 useful to cast a number into a pointer in order to examine a structure
8978 at that address in memory.
8979 @c FIXME: casts supported---Mod2 true?
8980
8981 @value{GDBN} supports these operators, in addition to those common
8982 to programming languages:
8983
8984 @table @code
8985 @item @@
8986 @samp{@@} is a binary operator for treating parts of memory as arrays.
8987 @xref{Arrays, ,Artificial Arrays}, for more information.
8988
8989 @item ::
8990 @samp{::} allows you to specify a variable in terms of the file or
8991 function where it is defined.  @xref{Variables, ,Program Variables}.
8992
8993 @cindex @{@var{type}@}
8994 @cindex type casting memory
8995 @cindex memory, viewing as typed object
8996 @cindex casts, to view memory
8997 @item @{@var{type}@} @var{addr}
8998 Refers to an object of type @var{type} stored at address @var{addr} in
8999 memory.  The address @var{addr} may be any expression whose value is
9000 an integer or pointer (but parentheses are required around binary
9001 operators, just as in a cast).  This construct is allowed regardless
9002 of what kind of data is normally supposed to reside at @var{addr}.
9003 @end table
9004
9005 @node Ambiguous Expressions
9006 @section Ambiguous Expressions
9007 @cindex ambiguous expressions
9008
9009 Expressions can sometimes contain some ambiguous elements.  For instance,
9010 some programming languages (notably Ada, C@t{++} and Objective-C) permit
9011 a single function name to be defined several times, for application in
9012 different contexts.  This is called @dfn{overloading}.  Another example
9013 involving Ada is generics.  A @dfn{generic package} is similar to C@t{++}
9014 templates and is typically instantiated several times, resulting in
9015 the same function name being defined in different contexts.
9016
9017 In some cases and depending on the language, it is possible to adjust
9018 the expression to remove the ambiguity.  For instance in C@t{++}, you
9019 can specify the signature of the function you want to break on, as in
9020 @kbd{break @var{function}(@var{types})}.  In Ada, using the fully
9021 qualified name of your function often makes the expression unambiguous
9022 as well.
9023
9024 When an ambiguity that needs to be resolved is detected, the debugger
9025 has the capability to display a menu of numbered choices for each
9026 possibility, and then waits for the selection with the prompt @samp{>}.
9027 The first option is always @samp{[0] cancel}, and typing @kbd{0 @key{RET}}
9028 aborts the current command.  If the command in which the expression was
9029 used allows more than one choice to be selected, the next option in the
9030 menu is @samp{[1] all}, and typing @kbd{1 @key{RET}} selects all possible
9031 choices.
9032
9033 For example, the following session excerpt shows an attempt to set a
9034 breakpoint at the overloaded symbol @code{String::after}.
9035 We choose three particular definitions of that function name:
9036
9037 @c FIXME! This is likely to change to show arg type lists, at least
9038 @smallexample
9039 @group
9040 (@value{GDBP}) b String::after
9041 [0] cancel
9042 [1] all
9043 [2] file:String.cc; line number:867
9044 [3] file:String.cc; line number:860
9045 [4] file:String.cc; line number:875
9046 [5] file:String.cc; line number:853
9047 [6] file:String.cc; line number:846
9048 [7] file:String.cc; line number:735
9049 > 2 4 6
9050 Breakpoint 1 at 0xb26c: file String.cc, line 867.
9051 Breakpoint 2 at 0xb344: file String.cc, line 875.
9052 Breakpoint 3 at 0xafcc: file String.cc, line 846.
9053 Multiple breakpoints were set.
9054 Use the "delete" command to delete unwanted
9055  breakpoints.
9056 (@value{GDBP})
9057 @end group
9058 @end smallexample
9059
9060 @table @code
9061 @kindex set multiple-symbols
9062 @item set multiple-symbols @var{mode}
9063 @cindex multiple-symbols menu
9064
9065 This option allows you to adjust the debugger behavior when an expression
9066 is ambiguous.
9067
9068 By default, @var{mode} is set to @code{all}.  If the command with which
9069 the expression is used allows more than one choice, then @value{GDBN}
9070 automatically selects all possible choices.  For instance, inserting
9071 a breakpoint on a function using an ambiguous name results in a breakpoint
9072 inserted on each possible match.  However, if a unique choice must be made,
9073 then @value{GDBN} uses the menu to help you disambiguate the expression.
9074 For instance, printing the address of an overloaded function will result
9075 in the use of the menu.
9076
9077 When @var{mode} is set to @code{ask}, the debugger always uses the menu
9078 when an ambiguity is detected.
9079
9080 Finally, when @var{mode} is set to @code{cancel}, the debugger reports
9081 an error due to the ambiguity and the command is aborted.
9082
9083 @kindex show multiple-symbols
9084 @item show multiple-symbols
9085 Show the current value of the @code{multiple-symbols} setting.
9086 @end table
9087
9088 @node Variables
9089 @section Program Variables
9090
9091 The most common kind of expression to use is the name of a variable
9092 in your program.
9093
9094 Variables in expressions are understood in the selected stack frame
9095 (@pxref{Selection, ,Selecting a Frame}); they must be either:
9096
9097 @itemize @bullet
9098 @item
9099 global (or file-static)
9100 @end itemize
9101
9102 @noindent or
9103
9104 @itemize @bullet
9105 @item
9106 visible according to the scope rules of the
9107 programming language from the point of execution in that frame
9108 @end itemize
9109
9110 @noindent This means that in the function
9111
9112 @smallexample
9113 foo (a)
9114      int a;
9115 @{
9116   bar (a);
9117   @{
9118     int b = test ();
9119     bar (b);
9120   @}
9121 @}
9122 @end smallexample
9123
9124 @noindent
9125 you can examine and use the variable @code{a} whenever your program is
9126 executing within the function @code{foo}, but you can only use or
9127 examine the variable @code{b} while your program is executing inside
9128 the block where @code{b} is declared.
9129
9130 @cindex variable name conflict
9131 There is an exception: you can refer to a variable or function whose
9132 scope is a single source file even if the current execution point is not
9133 in this file.  But it is possible to have more than one such variable or
9134 function with the same name (in different source files).  If that
9135 happens, referring to that name has unpredictable effects.  If you wish,
9136 you can specify a static variable in a particular function or file by
9137 using the colon-colon (@code{::}) notation:
9138
9139 @cindex colon-colon, context for variables/functions
9140 @ifnotinfo
9141 @c info cannot cope with a :: index entry, but why deprive hard copy readers?
9142 @cindex @code{::}, context for variables/functions
9143 @end ifnotinfo
9144 @smallexample
9145 @var{file}::@var{variable}
9146 @var{function}::@var{variable}
9147 @end smallexample
9148
9149 @noindent
9150 Here @var{file} or @var{function} is the name of the context for the
9151 static @var{variable}.  In the case of file names, you can use quotes to
9152 make sure @value{GDBN} parses the file name as a single word---for example,
9153 to print a global value of @code{x} defined in @file{f2.c}:
9154
9155 @smallexample
9156 (@value{GDBP}) p 'f2.c'::x
9157 @end smallexample
9158
9159 The @code{::} notation is normally used for referring to
9160 static variables, since you typically disambiguate uses of local variables
9161 in functions by selecting the appropriate frame and using the
9162 simple name of the variable.  However, you may also use this notation
9163 to refer to local variables in frames enclosing the selected frame:
9164
9165 @smallexample
9166 void
9167 foo (int a)
9168 @{
9169   if (a < 10)
9170     bar (a);
9171   else
9172     process (a);    /* Stop here */
9173 @}
9174
9175 int
9176 bar (int a)
9177 @{
9178   foo (a + 5);
9179 @}
9180 @end smallexample
9181
9182 @noindent
9183 For example, if there is a breakpoint at the commented line,
9184 here is what you might see
9185 when the program stops after executing the call @code{bar(0)}:
9186
9187 @smallexample
9188 (@value{GDBP}) p a
9189 $1 = 10
9190 (@value{GDBP}) p bar::a
9191 $2 = 5
9192 (@value{GDBP}) up 2
9193 #2  0x080483d0 in foo (a=5) at foobar.c:12
9194 (@value{GDBP}) p a
9195 $3 = 5
9196 (@value{GDBP}) p bar::a
9197 $4 = 0
9198 @end smallexample
9199
9200 @cindex C@t{++} scope resolution
9201 These uses of @samp{::} are very rarely in conflict with the very
9202 similar use of the same notation in C@t{++}.  When they are in
9203 conflict, the C@t{++} meaning takes precedence; however, this can be
9204 overridden by quoting the file or function name with single quotes.
9205
9206 For example, suppose the program is stopped in a method of a class
9207 that has a field named @code{includefile}, and there is also an
9208 include file named @file{includefile} that defines a variable,
9209 @code{some_global}.
9210
9211 @smallexample
9212 (@value{GDBP}) p includefile
9213 $1 = 23
9214 (@value{GDBP}) p includefile::some_global
9215 A syntax error in expression, near `'.
9216 (@value{GDBP}) p 'includefile'::some_global
9217 $2 = 27
9218 @end smallexample
9219
9220 @cindex wrong values
9221 @cindex variable values, wrong
9222 @cindex function entry/exit, wrong values of variables
9223 @cindex optimized code, wrong values of variables
9224 @quotation
9225 @emph{Warning:} Occasionally, a local variable may appear to have the
9226 wrong value at certain points in a function---just after entry to a new
9227 scope, and just before exit.
9228 @end quotation
9229 You may see this problem when you are stepping by machine instructions.
9230 This is because, on most machines, it takes more than one instruction to
9231 set up a stack frame (including local variable definitions); if you are
9232 stepping by machine instructions, variables may appear to have the wrong
9233 values until the stack frame is completely built.  On exit, it usually
9234 also takes more than one machine instruction to destroy a stack frame;
9235 after you begin stepping through that group of instructions, local
9236 variable definitions may be gone.
9237
9238 This may also happen when the compiler does significant optimizations.
9239 To be sure of always seeing accurate values, turn off all optimization
9240 when compiling.
9241
9242 @cindex ``No symbol "foo" in current context''
9243 Another possible effect of compiler optimizations is to optimize
9244 unused variables out of existence, or assign variables to registers (as
9245 opposed to memory addresses).  Depending on the support for such cases
9246 offered by the debug info format used by the compiler, @value{GDBN}
9247 might not be able to display values for such local variables.  If that
9248 happens, @value{GDBN} will print a message like this:
9249
9250 @smallexample
9251 No symbol "foo" in current context.
9252 @end smallexample
9253
9254 To solve such problems, either recompile without optimizations, or use a
9255 different debug info format, if the compiler supports several such
9256 formats.  @xref{Compilation}, for more information on choosing compiler
9257 options.  @xref{C, ,C and C@t{++}}, for more information about debug
9258 info formats that are best suited to C@t{++} programs.
9259
9260 If you ask to print an object whose contents are unknown to
9261 @value{GDBN}, e.g., because its data type is not completely specified
9262 by the debug information, @value{GDBN} will say @samp{<incomplete
9263 type>}.  @xref{Symbols, incomplete type}, for more about this.
9264
9265 @cindex no debug info variables
9266 If you try to examine or use the value of a (global) variable for
9267 which @value{GDBN} has no type information, e.g., because the program
9268 includes no debug information, @value{GDBN} displays an error message.
9269 @xref{Symbols, unknown type}, for more about unknown types.  If you
9270 cast the variable to its declared type, @value{GDBN} gets the
9271 variable's value using the cast-to type as the variable's type.  For
9272 example, in a C program:
9273
9274 @smallexample
9275   (@value{GDBP}) p var
9276   'var' has unknown type; cast it to its declared type
9277   (@value{GDBP}) p (float) var
9278   $1 = 3.14
9279 @end smallexample
9280
9281 If you append @kbd{@@entry} string to a function parameter name you get its
9282 value at the time the function got called.  If the value is not available an
9283 error message is printed.  Entry values are available only with some compilers.
9284 Entry values are normally also printed at the function parameter list according
9285 to @ref{set print entry-values}.
9286
9287 @smallexample
9288 Breakpoint 1, d (i=30) at gdb.base/entry-value.c:29
9289 29        i++;
9290 (gdb) next
9291 30        e (i);
9292 (gdb) print i
9293 $1 = 31
9294 (gdb) print i@@entry
9295 $2 = 30
9296 @end smallexample
9297
9298 Strings are identified as arrays of @code{char} values without specified
9299 signedness.  Arrays of either @code{signed char} or @code{unsigned char} get
9300 printed as arrays of 1 byte sized integers.  @code{-fsigned-char} or
9301 @code{-funsigned-char} @value{NGCC} options have no effect as @value{GDBN}
9302 defines literal string type @code{"char"} as @code{char} without a sign.
9303 For program code
9304
9305 @smallexample
9306 char var0[] = "A";
9307 signed char var1[] = "A";
9308 @end smallexample
9309
9310 You get during debugging
9311 @smallexample
9312 (gdb) print var0
9313 $1 = "A"
9314 (gdb) print var1
9315 $2 = @{65 'A', 0 '\0'@}
9316 @end smallexample
9317
9318 @node Arrays
9319 @section Artificial Arrays
9320
9321 @cindex artificial array
9322 @cindex arrays
9323 @kindex @@@r{, referencing memory as an array}
9324 It is often useful to print out several successive objects of the
9325 same type in memory; a section of an array, or an array of
9326 dynamically determined size for which only a pointer exists in the
9327 program.
9328
9329 You can do this by referring to a contiguous span of memory as an
9330 @dfn{artificial array}, using the binary operator @samp{@@}.  The left
9331 operand of @samp{@@} should be the first element of the desired array
9332 and be an individual object.  The right operand should be the desired length
9333 of the array.  The result is an array value whose elements are all of
9334 the type of the left argument.  The first element is actually the left
9335 argument; the second element comes from bytes of memory immediately
9336 following those that hold the first element, and so on.  Here is an
9337 example.  If a program says
9338
9339 @smallexample
9340 int *array = (int *) malloc (len * sizeof (int));
9341 @end smallexample
9342
9343 @noindent
9344 you can print the contents of @code{array} with
9345
9346 @smallexample
9347 p *array@@len
9348 @end smallexample
9349
9350 The left operand of @samp{@@} must reside in memory.  Array values made
9351 with @samp{@@} in this way behave just like other arrays in terms of
9352 subscripting, and are coerced to pointers when used in expressions.
9353 Artificial arrays most often appear in expressions via the value history
9354 (@pxref{Value History, ,Value History}), after printing one out.
9355
9356 Another way to create an artificial array is to use a cast.
9357 This re-interprets a value as if it were an array.
9358 The value need not be in memory:
9359 @smallexample
9360 (@value{GDBP}) p/x (short[2])0x12345678
9361 $1 = @{0x1234, 0x5678@}
9362 @end smallexample
9363
9364 As a convenience, if you leave the array length out (as in
9365 @samp{(@var{type}[])@var{value}}) @value{GDBN} calculates the size to fill
9366 the value (as @samp{sizeof(@var{value})/sizeof(@var{type})}:
9367 @smallexample
9368 (@value{GDBP}) p/x (short[])0x12345678
9369 $2 = @{0x1234, 0x5678@}
9370 @end smallexample
9371
9372 Sometimes the artificial array mechanism is not quite enough; in
9373 moderately complex data structures, the elements of interest may not
9374 actually be adjacent---for example, if you are interested in the values
9375 of pointers in an array.  One useful work-around in this situation is
9376 to use a convenience variable (@pxref{Convenience Vars, ,Convenience
9377 Variables}) as a counter in an expression that prints the first
9378 interesting value, and then repeat that expression via @key{RET}.  For
9379 instance, suppose you have an array @code{dtab} of pointers to
9380 structures, and you are interested in the values of a field @code{fv}
9381 in each structure.  Here is an example of what you might type:
9382
9383 @smallexample
9384 set $i = 0
9385 p dtab[$i++]->fv
9386 @key{RET}
9387 @key{RET}
9388 @dots{}
9389 @end smallexample
9390
9391 @node Output Formats
9392 @section Output Formats
9393
9394 @cindex formatted output
9395 @cindex output formats
9396 By default, @value{GDBN} prints a value according to its data type.  Sometimes
9397 this is not what you want.  For example, you might want to print a number
9398 in hex, or a pointer in decimal.  Or you might want to view data in memory
9399 at a certain address as a character string or as an instruction.  To do
9400 these things, specify an @dfn{output format} when you print a value.
9401
9402 The simplest use of output formats is to say how to print a value
9403 already computed.  This is done by starting the arguments of the
9404 @code{print} command with a slash and a format letter.  The format
9405 letters supported are:
9406
9407 @table @code
9408 @item x
9409 Regard the bits of the value as an integer, and print the integer in
9410 hexadecimal.
9411
9412 @item d
9413 Print as integer in signed decimal.
9414
9415 @item u
9416 Print as integer in unsigned decimal.
9417
9418 @item o
9419 Print as integer in octal.
9420
9421 @item t
9422 Print as integer in binary.  The letter @samp{t} stands for ``two''.
9423 @footnote{@samp{b} cannot be used because these format letters are also
9424 used with the @code{x} command, where @samp{b} stands for ``byte'';
9425 see @ref{Memory,,Examining Memory}.}
9426
9427 @item a
9428 @cindex unknown address, locating
9429 @cindex locate address
9430 Print as an address, both absolute in hexadecimal and as an offset from
9431 the nearest preceding symbol.  You can use this format used to discover
9432 where (in what function) an unknown address is located:
9433
9434 @smallexample
9435 (@value{GDBP}) p/a 0x54320
9436 $3 = 0x54320 <_initialize_vx+396>
9437 @end smallexample
9438
9439 @noindent
9440 The command @code{info symbol 0x54320} yields similar results.
9441 @xref{Symbols, info symbol}.
9442
9443 @item c
9444 Regard as an integer and print it as a character constant.  This
9445 prints both the numerical value and its character representation.  The
9446 character representation is replaced with the octal escape @samp{\nnn}
9447 for characters outside the 7-bit @sc{ascii} range.
9448
9449 Without this format, @value{GDBN} displays @code{char},
9450 @w{@code{unsigned char}}, and @w{@code{signed char}} data as character
9451 constants.  Single-byte members of vectors are displayed as integer
9452 data.
9453
9454 @item f
9455 Regard the bits of the value as a floating point number and print
9456 using typical floating point syntax.
9457
9458 @item s
9459 @cindex printing strings
9460 @cindex printing byte arrays
9461 Regard as a string, if possible.  With this format, pointers to single-byte
9462 data are displayed as null-terminated strings and arrays of single-byte data
9463 are displayed as fixed-length strings.  Other values are displayed in their
9464 natural types.
9465
9466 Without this format, @value{GDBN} displays pointers to and arrays of
9467 @code{char}, @w{@code{unsigned char}}, and @w{@code{signed char}} as
9468 strings.  Single-byte members of a vector are displayed as an integer
9469 array.
9470
9471 @item z
9472 Like @samp{x} formatting, the value is treated as an integer and
9473 printed as hexadecimal, but leading zeros are printed to pad the value
9474 to the size of the integer type.
9475
9476 @item r
9477 @cindex raw printing
9478 Print using the @samp{raw} formatting.  By default, @value{GDBN} will
9479 use a Python-based pretty-printer, if one is available (@pxref{Pretty
9480 Printing}).  This typically results in a higher-level display of the
9481 value's contents.  The @samp{r} format bypasses any Python
9482 pretty-printer which might exist.
9483 @end table
9484
9485 For example, to print the program counter in hex (@pxref{Registers}), type
9486
9487 @smallexample
9488 p/x $pc
9489 @end smallexample
9490
9491 @noindent
9492 Note that no space is required before the slash; this is because command
9493 names in @value{GDBN} cannot contain a slash.
9494
9495 To reprint the last value in the value history with a different format,
9496 you can use the @code{print} command with just a format and no
9497 expression.  For example, @samp{p/x} reprints the last value in hex.
9498
9499 @node Memory
9500 @section Examining Memory
9501
9502 You can use the command @code{x} (for ``examine'') to examine memory in
9503 any of several formats, independently of your program's data types.
9504
9505 @cindex examining memory
9506 @table @code
9507 @kindex x @r{(examine memory)}
9508 @item x/@var{nfu} @var{addr}
9509 @itemx x @var{addr}
9510 @itemx x
9511 Use the @code{x} command to examine memory.
9512 @end table
9513
9514 @var{n}, @var{f}, and @var{u} are all optional parameters that specify how
9515 much memory to display and how to format it; @var{addr} is an
9516 expression giving the address where you want to start displaying memory.
9517 If you use defaults for @var{nfu}, you need not type the slash @samp{/}.
9518 Several commands set convenient defaults for @var{addr}.
9519
9520 @table @r
9521 @item @var{n}, the repeat count
9522 The repeat count is a decimal integer; the default is 1.  It specifies
9523 how much memory (counting by units @var{u}) to display.  If a negative
9524 number is specified, memory is examined backward from @var{addr}.
9525 @c This really is **decimal**; unaffected by 'set radix' as of GDB
9526 @c 4.1.2.
9527
9528 @item @var{f}, the display format
9529 The display format is one of the formats used by @code{print}
9530 (@samp{x}, @samp{d}, @samp{u}, @samp{o}, @samp{t}, @samp{a}, @samp{c},
9531 @samp{f}, @samp{s}), and in addition @samp{i} (for machine instructions).
9532 The default is @samp{x} (hexadecimal) initially.  The default changes
9533 each time you use either @code{x} or @code{print}.
9534
9535 @item @var{u}, the unit size
9536 The unit size is any of
9537
9538 @table @code
9539 @item b
9540 Bytes.
9541 @item h
9542 Halfwords (two bytes).
9543 @item w
9544 Words (four bytes).  This is the initial default.
9545 @item g
9546 Giant words (eight bytes).
9547 @end table
9548
9549 Each time you specify a unit size with @code{x}, that size becomes the
9550 default unit the next time you use @code{x}.  For the @samp{i} format,
9551 the unit size is ignored and is normally not written.  For the @samp{s} format,
9552 the unit size defaults to @samp{b}, unless it is explicitly given.
9553 Use @kbd{x /hs} to display 16-bit char strings and @kbd{x /ws} to display
9554 32-bit strings.  The next use of @kbd{x /s} will again display 8-bit strings.
9555 Note that the results depend on the programming language of the
9556 current compilation unit.  If the language is C, the @samp{s}
9557 modifier will use the UTF-16 encoding while @samp{w} will use
9558 UTF-32.  The encoding is set by the programming language and cannot
9559 be altered.
9560
9561 @item @var{addr}, starting display address
9562 @var{addr} is the address where you want @value{GDBN} to begin displaying
9563 memory.  The expression need not have a pointer value (though it may);
9564 it is always interpreted as an integer address of a byte of memory.
9565 @xref{Expressions, ,Expressions}, for more information on expressions.  The default for
9566 @var{addr} is usually just after the last address examined---but several
9567 other commands also set the default address: @code{info breakpoints} (to
9568 the address of the last breakpoint listed), @code{info line} (to the
9569 starting address of a line), and @code{print} (if you use it to display
9570 a value from memory).
9571 @end table
9572
9573 For example, @samp{x/3uh 0x54320} is a request to display three halfwords
9574 (@code{h}) of memory, formatted as unsigned decimal integers (@samp{u}),
9575 starting at address @code{0x54320}.  @samp{x/4xw $sp} prints the four
9576 words (@samp{w}) of memory above the stack pointer (here, @samp{$sp};
9577 @pxref{Registers, ,Registers}) in hexadecimal (@samp{x}).
9578
9579 You can also specify a negative repeat count to examine memory backward
9580 from the given address.  For example, @samp{x/-3uh 0x54320} prints three
9581 halfwords (@code{h}) at @code{0x54314}, @code{0x54328}, and @code{0x5431c}.
9582
9583 Since the letters indicating unit sizes are all distinct from the
9584 letters specifying output formats, you do not have to remember whether
9585 unit size or format comes first; either order works.  The output
9586 specifications @samp{4xw} and @samp{4wx} mean exactly the same thing.
9587 (However, the count @var{n} must come first; @samp{wx4} does not work.)
9588
9589 Even though the unit size @var{u} is ignored for the formats @samp{s}
9590 and @samp{i}, you might still want to use a count @var{n}; for example,
9591 @samp{3i} specifies that you want to see three machine instructions,
9592 including any operands.  For convenience, especially when used with
9593 the @code{display} command, the @samp{i} format also prints branch delay
9594 slot instructions, if any, beyond the count specified, which immediately
9595 follow the last instruction that is within the count.  The command
9596 @code{disassemble} gives an alternative way of inspecting machine
9597 instructions; see @ref{Machine Code,,Source and Machine Code}.
9598
9599 If a negative repeat count is specified for the formats @samp{s} or @samp{i},
9600 the command displays null-terminated strings or instructions before the given
9601 address as many as the absolute value of the given number.  For the @samp{i}
9602 format, we use line number information in the debug info to accurately locate
9603 instruction boundaries while disassembling backward.  If line info is not
9604 available, the command stops examining memory with an error message.
9605
9606 All the defaults for the arguments to @code{x} are designed to make it
9607 easy to continue scanning memory with minimal specifications each time
9608 you use @code{x}.  For example, after you have inspected three machine
9609 instructions with @samp{x/3i @var{addr}}, you can inspect the next seven
9610 with just @samp{x/7}.  If you use @key{RET} to repeat the @code{x} command,
9611 the repeat count @var{n} is used again; the other arguments default as
9612 for successive uses of @code{x}.
9613
9614 When examining machine instructions, the instruction at current program
9615 counter is shown with a @code{=>} marker. For example:
9616
9617 @smallexample
9618 (@value{GDBP}) x/5i $pc-6
9619    0x804837f <main+11>: mov    %esp,%ebp
9620    0x8048381 <main+13>: push   %ecx
9621    0x8048382 <main+14>: sub    $0x4,%esp
9622 => 0x8048385 <main+17>: movl   $0x8048460,(%esp)
9623    0x804838c <main+24>: call   0x80482d4 <puts@@plt>
9624 @end smallexample
9625
9626 @cindex @code{$_}, @code{$__}, and value history
9627 The addresses and contents printed by the @code{x} command are not saved
9628 in the value history because there is often too much of them and they
9629 would get in the way.  Instead, @value{GDBN} makes these values available for
9630 subsequent use in expressions as values of the convenience variables
9631 @code{$_} and @code{$__}.  After an @code{x} command, the last address
9632 examined is available for use in expressions in the convenience variable
9633 @code{$_}.  The contents of that address, as examined, are available in
9634 the convenience variable @code{$__}.
9635
9636 If the @code{x} command has a repeat count, the address and contents saved
9637 are from the last memory unit printed; this is not the same as the last
9638 address printed if several units were printed on the last line of output.
9639
9640 @anchor{addressable memory unit}
9641 @cindex addressable memory unit
9642 Most targets have an addressable memory unit size of 8 bits.  This means
9643 that to each memory address are associated 8 bits of data.  Some
9644 targets, however, have other addressable memory unit sizes.
9645 Within @value{GDBN} and this document, the term
9646 @dfn{addressable memory unit} (or @dfn{memory unit} for short) is used
9647 when explicitly referring to a chunk of data of that size.  The word
9648 @dfn{byte} is used to refer to a chunk of data of 8 bits, regardless of
9649 the addressable memory unit size of the target.  For most systems,
9650 addressable memory unit is a synonym of byte.
9651
9652 @cindex remote memory comparison
9653 @cindex target memory comparison
9654 @cindex verify remote memory image
9655 @cindex verify target memory image
9656 When you are debugging a program running on a remote target machine
9657 (@pxref{Remote Debugging}), you may wish to verify the program's image
9658 in the remote machine's memory against the executable file you
9659 downloaded to the target.  Or, on any target, you may want to check
9660 whether the program has corrupted its own read-only sections.  The
9661 @code{compare-sections} command is provided for such situations.
9662
9663 @table @code
9664 @kindex compare-sections
9665 @item compare-sections @r{[}@var{section-name}@r{|}@code{-r}@r{]}
9666 Compare the data of a loadable section @var{section-name} in the
9667 executable file of the program being debugged with the same section in
9668 the target machine's memory, and report any mismatches.  With no
9669 arguments, compares all loadable sections.  With an argument of
9670 @code{-r}, compares all loadable read-only sections.
9671
9672 Note: for remote targets, this command can be accelerated if the
9673 target supports computing the CRC checksum of a block of memory
9674 (@pxref{qCRC packet}).
9675 @end table
9676
9677 @node Auto Display
9678 @section Automatic Display
9679 @cindex automatic display
9680 @cindex display of expressions
9681
9682 If you find that you want to print the value of an expression frequently
9683 (to see how it changes), you might want to add it to the @dfn{automatic
9684 display list} so that @value{GDBN} prints its value each time your program stops.
9685 Each expression added to the list is given a number to identify it;
9686 to remove an expression from the list, you specify that number.
9687 The automatic display looks like this:
9688
9689 @smallexample
9690 2: foo = 38
9691 3: bar[5] = (struct hack *) 0x3804
9692 @end smallexample
9693
9694 @noindent
9695 This display shows item numbers, expressions and their current values.  As with
9696 displays you request manually using @code{x} or @code{print}, you can
9697 specify the output format you prefer; in fact, @code{display} decides
9698 whether to use @code{print} or @code{x} depending your format
9699 specification---it uses @code{x} if you specify either the @samp{i}
9700 or @samp{s} format, or a unit size; otherwise it uses @code{print}.
9701
9702 @table @code
9703 @kindex display
9704 @item display @var{expr}
9705 Add the expression @var{expr} to the list of expressions to display
9706 each time your program stops.  @xref{Expressions, ,Expressions}.
9707
9708 @code{display} does not repeat if you press @key{RET} again after using it.
9709
9710 @item display/@var{fmt} @var{expr}
9711 For @var{fmt} specifying only a display format and not a size or
9712 count, add the expression @var{expr} to the auto-display list but
9713 arrange to display it each time in the specified format @var{fmt}.
9714 @xref{Output Formats,,Output Formats}.
9715
9716 @item display/@var{fmt} @var{addr}
9717 For @var{fmt} @samp{i} or @samp{s}, or including a unit-size or a
9718 number of units, add the expression @var{addr} as a memory address to
9719 be examined each time your program stops.  Examining means in effect
9720 doing @samp{x/@var{fmt} @var{addr}}.  @xref{Memory, ,Examining Memory}.
9721 @end table
9722
9723 For example, @samp{display/i $pc} can be helpful, to see the machine
9724 instruction about to be executed each time execution stops (@samp{$pc}
9725 is a common name for the program counter; @pxref{Registers, ,Registers}).
9726
9727 @table @code
9728 @kindex delete display
9729 @kindex undisplay
9730 @item undisplay @var{dnums}@dots{}
9731 @itemx delete display @var{dnums}@dots{}
9732 Remove items from the list of expressions to display.  Specify the
9733 numbers of the displays that you want affected with the command
9734 argument @var{dnums}.  It can be a single display number, one of the
9735 numbers shown in the first field of the @samp{info display} display;
9736 or it could be a range of display numbers, as in @code{2-4}.
9737
9738 @code{undisplay} does not repeat if you press @key{RET} after using it.
9739 (Otherwise you would just get the error @samp{No display number @dots{}}.)
9740
9741 @kindex disable display
9742 @item disable display @var{dnums}@dots{}
9743 Disable the display of item numbers @var{dnums}.  A disabled display
9744 item is not printed automatically, but is not forgotten.  It may be
9745 enabled again later.  Specify the numbers of the displays that you
9746 want affected with the command argument @var{dnums}.  It can be a
9747 single display number, one of the numbers shown in the first field of
9748 the @samp{info display} display; or it could be a range of display
9749 numbers, as in @code{2-4}.
9750
9751 @kindex enable display
9752 @item enable display @var{dnums}@dots{}
9753 Enable display of item numbers @var{dnums}.  It becomes effective once
9754 again in auto display of its expression, until you specify otherwise.
9755 Specify the numbers of the displays that you want affected with the
9756 command argument @var{dnums}.  It can be a single display number, one
9757 of the numbers shown in the first field of the @samp{info display}
9758 display; or it could be a range of display numbers, as in @code{2-4}.
9759
9760 @item display
9761 Display the current values of the expressions on the list, just as is
9762 done when your program stops.
9763
9764 @kindex info display
9765 @item info display
9766 Print the list of expressions previously set up to display
9767 automatically, each one with its item number, but without showing the
9768 values.  This includes disabled expressions, which are marked as such.
9769 It also includes expressions which would not be displayed right now
9770 because they refer to automatic variables not currently available.
9771 @end table
9772
9773 @cindex display disabled out of scope
9774 If a display expression refers to local variables, then it does not make
9775 sense outside the lexical context for which it was set up.  Such an
9776 expression is disabled when execution enters a context where one of its
9777 variables is not defined.  For example, if you give the command
9778 @code{display last_char} while inside a function with an argument
9779 @code{last_char}, @value{GDBN} displays this argument while your program
9780 continues to stop inside that function.  When it stops elsewhere---where
9781 there is no variable @code{last_char}---the display is disabled
9782 automatically.  The next time your program stops where @code{last_char}
9783 is meaningful, you can enable the display expression once again.
9784
9785 @node Print Settings
9786 @section Print Settings
9787
9788 @cindex format options
9789 @cindex print settings
9790 @value{GDBN} provides the following ways to control how arrays, structures,
9791 and symbols are printed.
9792
9793 @noindent
9794 These settings are useful for debugging programs in any language:
9795
9796 @table @code
9797 @kindex set print
9798 @item set print address
9799 @itemx set print address on
9800 @cindex print/don't print memory addresses
9801 @value{GDBN} prints memory addresses showing the location of stack
9802 traces, structure values, pointer values, breakpoints, and so forth,
9803 even when it also displays the contents of those addresses.  The default
9804 is @code{on}.  For example, this is what a stack frame display looks like with
9805 @code{set print address on}:
9806
9807 @smallexample
9808 @group
9809 (@value{GDBP}) f
9810 #0  set_quotes (lq=0x34c78 "<<", rq=0x34c88 ">>")
9811     at input.c:530
9812 530         if (lquote != def_lquote)
9813 @end group
9814 @end smallexample
9815
9816 @item set print address off
9817 Do not print addresses when displaying their contents.  For example,
9818 this is the same stack frame displayed with @code{set print address off}:
9819
9820 @smallexample
9821 @group
9822 (@value{GDBP}) set print addr off
9823 (@value{GDBP}) f
9824 #0  set_quotes (lq="<<", rq=">>") at input.c:530
9825 530         if (lquote != def_lquote)
9826 @end group
9827 @end smallexample
9828
9829 You can use @samp{set print address off} to eliminate all machine
9830 dependent displays from the @value{GDBN} interface.  For example, with
9831 @code{print address off}, you should get the same text for backtraces on
9832 all machines---whether or not they involve pointer arguments.
9833
9834 @kindex show print
9835 @item show print address
9836 Show whether or not addresses are to be printed.
9837 @end table
9838
9839 When @value{GDBN} prints a symbolic address, it normally prints the
9840 closest earlier symbol plus an offset.  If that symbol does not uniquely
9841 identify the address (for example, it is a name whose scope is a single
9842 source file), you may need to clarify.  One way to do this is with
9843 @code{info line}, for example @samp{info line *0x4537}.  Alternately,
9844 you can set @value{GDBN} to print the source file and line number when
9845 it prints a symbolic address:
9846
9847 @table @code
9848 @item set print symbol-filename on
9849 @cindex source file and line of a symbol
9850 @cindex symbol, source file and line
9851 Tell @value{GDBN} to print the source file name and line number of a
9852 symbol in the symbolic form of an address.
9853
9854 @item set print symbol-filename off
9855 Do not print source file name and line number of a symbol.  This is the
9856 default.
9857
9858 @item show print symbol-filename
9859 Show whether or not @value{GDBN} will print the source file name and
9860 line number of a symbol in the symbolic form of an address.
9861 @end table
9862
9863 Another situation where it is helpful to show symbol filenames and line
9864 numbers is when disassembling code; @value{GDBN} shows you the line
9865 number and source file that corresponds to each instruction.
9866
9867 Also, you may wish to see the symbolic form only if the address being
9868 printed is reasonably close to the closest earlier symbol:
9869
9870 @table @code
9871 @item set print max-symbolic-offset @var{max-offset}
9872 @itemx set print max-symbolic-offset unlimited
9873 @cindex maximum value for offset of closest symbol
9874 Tell @value{GDBN} to only display the symbolic form of an address if the
9875 offset between the closest earlier symbol and the address is less than
9876 @var{max-offset}.  The default is @code{unlimited}, which tells @value{GDBN}
9877 to always print the symbolic form of an address if any symbol precedes
9878 it.  Zero is equivalent to @code{unlimited}.
9879
9880 @item show print max-symbolic-offset
9881 Ask how large the maximum offset is that @value{GDBN} prints in a
9882 symbolic address.
9883 @end table
9884
9885 @cindex wild pointer, interpreting
9886 @cindex pointer, finding referent
9887 If you have a pointer and you are not sure where it points, try
9888 @samp{set print symbol-filename on}.  Then you can determine the name
9889 and source file location of the variable where it points, using
9890 @samp{p/a @var{pointer}}.  This interprets the address in symbolic form.
9891 For example, here @value{GDBN} shows that a variable @code{ptt} points
9892 at another variable @code{t}, defined in @file{hi2.c}:
9893
9894 @smallexample
9895 (@value{GDBP}) set print symbol-filename on
9896 (@value{GDBP}) p/a ptt
9897 $4 = 0xe008 <t in hi2.c>
9898 @end smallexample
9899
9900 @quotation
9901 @emph{Warning:} For pointers that point to a local variable, @samp{p/a}
9902 does not show the symbol name and filename of the referent, even with
9903 the appropriate @code{set print} options turned on.
9904 @end quotation
9905
9906 You can also enable @samp{/a}-like formatting all the time using
9907 @samp{set print symbol on}:
9908
9909 @table @code
9910 @item set print symbol on
9911 Tell @value{GDBN} to print the symbol corresponding to an address, if
9912 one exists.
9913
9914 @item set print symbol off
9915 Tell @value{GDBN} not to print the symbol corresponding to an
9916 address.  In this mode, @value{GDBN} will still print the symbol
9917 corresponding to pointers to functions.  This is the default.
9918
9919 @item show print symbol
9920 Show whether @value{GDBN} will display the symbol corresponding to an
9921 address.
9922 @end table
9923
9924 Other settings control how different kinds of objects are printed:
9925
9926 @table @code
9927 @item set print array
9928 @itemx set print array on
9929 @cindex pretty print arrays
9930 Pretty print arrays.  This format is more convenient to read,
9931 but uses more space.  The default is off.
9932
9933 @item set print array off
9934 Return to compressed format for arrays.
9935
9936 @item show print array
9937 Show whether compressed or pretty format is selected for displaying
9938 arrays.
9939
9940 @cindex print array indexes
9941 @item set print array-indexes
9942 @itemx set print array-indexes on
9943 Print the index of each element when displaying arrays.  May be more
9944 convenient to locate a given element in the array or quickly find the
9945 index of a given element in that printed array.  The default is off.
9946
9947 @item set print array-indexes off
9948 Stop printing element indexes when displaying arrays.
9949
9950 @item show print array-indexes
9951 Show whether the index of each element is printed when displaying
9952 arrays.
9953
9954 @item set print elements @var{number-of-elements}
9955 @itemx set print elements unlimited
9956 @cindex number of array elements to print
9957 @cindex limit on number of printed array elements
9958 Set a limit on how many elements of an array @value{GDBN} will print.
9959 If @value{GDBN} is printing a large array, it stops printing after it has
9960 printed the number of elements set by the @code{set print elements} command.
9961 This limit also applies to the display of strings.
9962 When @value{GDBN} starts, this limit is set to 200.
9963 Setting @var{number-of-elements} to @code{unlimited} or zero means
9964 that the number of elements to print is unlimited.
9965
9966 @item show print elements
9967 Display the number of elements of a large array that @value{GDBN} will print.
9968 If the number is 0, then the printing is unlimited.
9969
9970 @item set print frame-arguments @var{value}
9971 @kindex set print frame-arguments
9972 @cindex printing frame argument values
9973 @cindex print all frame argument values
9974 @cindex print frame argument values for scalars only
9975 @cindex do not print frame argument values
9976 This command allows to control how the values of arguments are printed
9977 when the debugger prints a frame (@pxref{Frames}).  The possible
9978 values are:
9979
9980 @table @code
9981 @item all
9982 The values of all arguments are printed.
9983
9984 @item scalars
9985 Print the value of an argument only if it is a scalar.  The value of more
9986 complex arguments such as arrays, structures, unions, etc, is replaced
9987 by @code{@dots{}}.  This is the default.  Here is an example where
9988 only scalar arguments are shown:
9989
9990 @smallexample
9991 #1  0x08048361 in call_me (i=3, s=@dots{}, ss=0xbf8d508c, u=@dots{}, e=green)
9992   at frame-args.c:23
9993 @end smallexample
9994
9995 @item none
9996 None of the argument values are printed.  Instead, the value of each argument
9997 is replaced by @code{@dots{}}.  In this case, the example above now becomes:
9998
9999 @smallexample
10000 #1  0x08048361 in call_me (i=@dots{}, s=@dots{}, ss=@dots{}, u=@dots{}, e=@dots{})
10001   at frame-args.c:23
10002 @end smallexample
10003 @end table
10004
10005 By default, only scalar arguments are printed.  This command can be used
10006 to configure the debugger to print the value of all arguments, regardless
10007 of their type.  However, it is often advantageous to not print the value
10008 of more complex parameters.  For instance, it reduces the amount of
10009 information printed in each frame, making the backtrace more readable.
10010 Also, it improves performance when displaying Ada frames, because
10011 the computation of large arguments can sometimes be CPU-intensive,
10012 especially in large applications.  Setting @code{print frame-arguments}
10013 to @code{scalars} (the default) or @code{none} avoids this computation,
10014 thus speeding up the display of each Ada frame.
10015
10016 @item show print frame-arguments
10017 Show how the value of arguments should be displayed when printing a frame.
10018
10019 @item set print raw frame-arguments on
10020 Print frame arguments in raw, non pretty-printed, form.
10021
10022 @item set print raw frame-arguments off
10023 Print frame arguments in pretty-printed form, if there is a pretty-printer
10024 for the value (@pxref{Pretty Printing}),
10025 otherwise print the value in raw form.
10026 This is the default.
10027
10028 @item show print raw frame-arguments
10029 Show whether to print frame arguments in raw form.
10030
10031 @anchor{set print entry-values}
10032 @item set print entry-values @var{value}
10033 @kindex set print entry-values
10034 Set printing of frame argument values at function entry.  In some cases
10035 @value{GDBN} can determine the value of function argument which was passed by
10036 the function caller, even if the value was modified inside the called function
10037 and therefore is different.  With optimized code, the current value could be
10038 unavailable, but the entry value may still be known.
10039
10040 The default value is @code{default} (see below for its description).  Older
10041 @value{GDBN} behaved as with the setting @code{no}.  Compilers not supporting
10042 this feature will behave in the @code{default} setting the same way as with the
10043 @code{no} setting.
10044
10045 This functionality is currently supported only by DWARF 2 debugging format and
10046 the compiler has to produce @samp{DW_TAG_call_site} tags.  With
10047 @value{NGCC}, you need to specify @option{-O -g} during compilation, to get
10048 this information.
10049
10050 The @var{value} parameter can be one of the following:
10051
10052 @table @code
10053 @item no
10054 Print only actual parameter values, never print values from function entry
10055 point.
10056 @smallexample
10057 #0  equal (val=5)
10058 #0  different (val=6)
10059 #0  lost (val=<optimized out>)
10060 #0  born (val=10)
10061 #0  invalid (val=<optimized out>)
10062 @end smallexample
10063
10064 @item only
10065 Print only parameter values from function entry point.  The actual parameter
10066 values are never printed.
10067 @smallexample
10068 #0  equal (val@@entry=5)
10069 #0  different (val@@entry=5)
10070 #0  lost (val@@entry=5)
10071 #0  born (val@@entry=<optimized out>)
10072 #0  invalid (val@@entry=<optimized out>)
10073 @end smallexample
10074
10075 @item preferred
10076 Print only parameter values from function entry point.  If value from function
10077 entry point is not known while the actual value is known, print the actual
10078 value for such parameter.
10079 @smallexample
10080 #0  equal (val@@entry=5)
10081 #0  different (val@@entry=5)
10082 #0  lost (val@@entry=5)
10083 #0  born (val=10)
10084 #0  invalid (val@@entry=<optimized out>)
10085 @end smallexample
10086
10087 @item if-needed
10088 Print actual parameter values.  If actual parameter value is not known while
10089 value from function entry point is known, print the entry point value for such
10090 parameter.
10091 @smallexample
10092 #0  equal (val=5)
10093 #0  different (val=6)
10094 #0  lost (val@@entry=5)
10095 #0  born (val=10)
10096 #0  invalid (val=<optimized out>)
10097 @end smallexample
10098
10099 @item both
10100 Always print both the actual parameter value and its value from function entry
10101 point, even if values of one or both are not available due to compiler
10102 optimizations.
10103 @smallexample
10104 #0  equal (val=5, val@@entry=5)
10105 #0  different (val=6, val@@entry=5)
10106 #0  lost (val=<optimized out>, val@@entry=5)
10107 #0  born (val=10, val@@entry=<optimized out>)
10108 #0  invalid (val=<optimized out>, val@@entry=<optimized out>)
10109 @end smallexample
10110
10111 @item compact
10112 Print the actual parameter value if it is known and also its value from
10113 function entry point if it is known.  If neither is known, print for the actual
10114 value @code{<optimized out>}.  If not in MI mode (@pxref{GDB/MI}) and if both
10115 values are known and identical, print the shortened
10116 @code{param=param@@entry=VALUE} notation.
10117 @smallexample
10118 #0  equal (val=val@@entry=5)
10119 #0  different (val=6, val@@entry=5)
10120 #0  lost (val@@entry=5)
10121 #0  born (val=10)
10122 #0  invalid (val=<optimized out>)
10123 @end smallexample
10124
10125 @item default
10126 Always print the actual parameter value.  Print also its value from function
10127 entry point, but only if it is known.  If not in MI mode (@pxref{GDB/MI}) and
10128 if both values are known and identical, print the shortened
10129 @code{param=param@@entry=VALUE} notation.
10130 @smallexample
10131 #0  equal (val=val@@entry=5)
10132 #0  different (val=6, val@@entry=5)
10133 #0  lost (val=<optimized out>, val@@entry=5)
10134 #0  born (val=10)
10135 #0  invalid (val=<optimized out>)
10136 @end smallexample
10137 @end table
10138
10139 For analysis messages on possible failures of frame argument values at function
10140 entry resolution see @ref{set debug entry-values}.
10141
10142 @item show print entry-values
10143 Show the method being used for printing of frame argument values at function
10144 entry.
10145
10146 @item set print repeats @var{number-of-repeats}
10147 @itemx set print repeats unlimited
10148 @cindex repeated array elements
10149 Set the threshold for suppressing display of repeated array
10150 elements.  When the number of consecutive identical elements of an
10151 array exceeds the threshold, @value{GDBN} prints the string
10152 @code{"<repeats @var{n} times>"}, where @var{n} is the number of
10153 identical repetitions, instead of displaying the identical elements
10154 themselves.  Setting the threshold to @code{unlimited} or zero will
10155 cause all elements to be individually printed.  The default threshold
10156 is 10.
10157
10158 @item show print repeats
10159 Display the current threshold for printing repeated identical
10160 elements.
10161
10162 @item set print null-stop
10163 @cindex @sc{null} elements in arrays
10164 Cause @value{GDBN} to stop printing the characters of an array when the first
10165 @sc{null} is encountered.  This is useful when large arrays actually
10166 contain only short strings.
10167 The default is off.
10168
10169 @item show print null-stop
10170 Show whether @value{GDBN} stops printing an array on the first
10171 @sc{null} character.
10172
10173 @item set print pretty on
10174 @cindex print structures in indented form
10175 @cindex indentation in structure display
10176 Cause @value{GDBN} to print structures in an indented format with one member
10177 per line, like this:
10178
10179 @smallexample
10180 @group
10181 $1 = @{
10182   next = 0x0,
10183   flags = @{
10184     sweet = 1,
10185     sour = 1
10186   @},
10187   meat = 0x54 "Pork"
10188 @}
10189 @end group
10190 @end smallexample
10191
10192 @item set print pretty off
10193 Cause @value{GDBN} to print structures in a compact format, like this:
10194
10195 @smallexample
10196 @group
10197 $1 = @{next = 0x0, flags = @{sweet = 1, sour = 1@}, \
10198 meat = 0x54 "Pork"@}
10199 @end group
10200 @end smallexample
10201
10202 @noindent
10203 This is the default format.
10204
10205 @item show print pretty
10206 Show which format @value{GDBN} is using to print structures.
10207
10208 @item set print sevenbit-strings on
10209 @cindex eight-bit characters in strings
10210 @cindex octal escapes in strings
10211 Print using only seven-bit characters; if this option is set,
10212 @value{GDBN} displays any eight-bit characters (in strings or
10213 character values) using the notation @code{\}@var{nnn}.  This setting is
10214 best if you are working in English (@sc{ascii}) and you use the
10215 high-order bit of characters as a marker or ``meta'' bit.
10216
10217 @item set print sevenbit-strings off
10218 Print full eight-bit characters.  This allows the use of more
10219 international character sets, and is the default.
10220
10221 @item show print sevenbit-strings
10222 Show whether or not @value{GDBN} is printing only seven-bit characters.
10223
10224 @item set print union on
10225 @cindex unions in structures, printing
10226 Tell @value{GDBN} to print unions which are contained in structures
10227 and other unions.  This is the default setting.
10228
10229 @item set print union off
10230 Tell @value{GDBN} not to print unions which are contained in
10231 structures and other unions.  @value{GDBN} will print @code{"@{...@}"}
10232 instead.
10233
10234 @item show print union
10235 Ask @value{GDBN} whether or not it will print unions which are contained in
10236 structures and other unions.
10237
10238 For example, given the declarations
10239
10240 @smallexample
10241 typedef enum @{Tree, Bug@} Species;
10242 typedef enum @{Big_tree, Acorn, Seedling@} Tree_forms;
10243 typedef enum @{Caterpillar, Cocoon, Butterfly@}
10244               Bug_forms;
10245
10246 struct thing @{
10247   Species it;
10248   union @{
10249     Tree_forms tree;
10250     Bug_forms bug;
10251   @} form;
10252 @};
10253
10254 struct thing foo = @{Tree, @{Acorn@}@};
10255 @end smallexample
10256
10257 @noindent
10258 with @code{set print union on} in effect @samp{p foo} would print
10259
10260 @smallexample
10261 $1 = @{it = Tree, form = @{tree = Acorn, bug = Cocoon@}@}
10262 @end smallexample
10263
10264 @noindent
10265 and with @code{set print union off} in effect it would print
10266
10267 @smallexample
10268 $1 = @{it = Tree, form = @{...@}@}
10269 @end smallexample
10270
10271 @noindent
10272 @code{set print union} affects programs written in C-like languages
10273 and in Pascal.
10274 @end table
10275
10276 @need 1000
10277 @noindent
10278 These settings are of interest when debugging C@t{++} programs:
10279
10280 @table @code
10281 @cindex demangling C@t{++} names
10282 @item set print demangle
10283 @itemx set print demangle on
10284 Print C@t{++} names in their source form rather than in the encoded
10285 (``mangled'') form passed to the assembler and linker for type-safe
10286 linkage.  The default is on.
10287
10288 @item show print demangle
10289 Show whether C@t{++} names are printed in mangled or demangled form.
10290
10291 @item set print asm-demangle
10292 @itemx set print asm-demangle on
10293 Print C@t{++} names in their source form rather than their mangled form, even
10294 in assembler code printouts such as instruction disassemblies.
10295 The default is off.
10296
10297 @item show print asm-demangle
10298 Show whether C@t{++} names in assembly listings are printed in mangled
10299 or demangled form.
10300
10301 @cindex C@t{++} symbol decoding style
10302 @cindex symbol decoding style, C@t{++}
10303 @kindex set demangle-style
10304 @item set demangle-style @var{style}
10305 Choose among several encoding schemes used by different compilers to
10306 represent C@t{++} names.  The choices for @var{style} are currently:
10307
10308 @table @code
10309 @item auto
10310 Allow @value{GDBN} to choose a decoding style by inspecting your program.
10311 This is the default.
10312
10313 @item gnu
10314 Decode based on the @sc{gnu} C@t{++} compiler (@code{g++}) encoding algorithm.
10315
10316 @item hp
10317 Decode based on the HP ANSI C@t{++} (@code{aCC}) encoding algorithm.
10318
10319 @item lucid
10320 Decode based on the Lucid C@t{++} compiler (@code{lcc}) encoding algorithm.
10321
10322 @item arm
10323 Decode using the algorithm in the @cite{C@t{++} Annotated Reference Manual}.
10324 @strong{Warning:} this setting alone is not sufficient to allow
10325 debugging @code{cfront}-generated executables.  @value{GDBN} would
10326 require further enhancement to permit that.
10327
10328 @end table
10329 If you omit @var{style}, you will see a list of possible formats.
10330
10331 @item show demangle-style
10332 Display the encoding style currently in use for decoding C@t{++} symbols.
10333
10334 @item set print object
10335 @itemx set print object on
10336 @cindex derived type of an object, printing
10337 @cindex display derived types
10338 When displaying a pointer to an object, identify the @emph{actual}
10339 (derived) type of the object rather than the @emph{declared} type, using
10340 the virtual function table.  Note that the virtual function table is
10341 required---this feature can only work for objects that have run-time
10342 type identification; a single virtual method in the object's declared
10343 type is sufficient.  Note that this setting is also taken into account when
10344 working with variable objects via MI (@pxref{GDB/MI}).
10345
10346 @item set print object off
10347 Display only the declared type of objects, without reference to the
10348 virtual function table.  This is the default setting.
10349
10350 @item show print object
10351 Show whether actual, or declared, object types are displayed.
10352
10353 @item set print static-members
10354 @itemx set print static-members on
10355 @cindex static members of C@t{++} objects
10356 Print static members when displaying a C@t{++} object.  The default is on.
10357
10358 @item set print static-members off
10359 Do not print static members when displaying a C@t{++} object.
10360
10361 @item show print static-members
10362 Show whether C@t{++} static members are printed or not.
10363
10364 @item set print pascal_static-members
10365 @itemx set print pascal_static-members on
10366 @cindex static members of Pascal objects
10367 @cindex Pascal objects, static members display
10368 Print static members when displaying a Pascal object.  The default is on.
10369
10370 @item set print pascal_static-members off
10371 Do not print static members when displaying a Pascal object.
10372
10373 @item show print pascal_static-members
10374 Show whether Pascal static members are printed or not.
10375
10376 @c These don't work with HP ANSI C++ yet.
10377 @item set print vtbl
10378 @itemx set print vtbl on
10379 @cindex pretty print C@t{++} virtual function tables
10380 @cindex virtual functions (C@t{++}) display
10381 @cindex VTBL display
10382 Pretty print C@t{++} virtual function tables.  The default is off.
10383 (The @code{vtbl} commands do not work on programs compiled with the HP
10384 ANSI C@t{++} compiler (@code{aCC}).)
10385
10386 @item set print vtbl off
10387 Do not pretty print C@t{++} virtual function tables.
10388
10389 @item show print vtbl
10390 Show whether C@t{++} virtual function tables are pretty printed, or not.
10391 @end table
10392
10393 @node Pretty Printing
10394 @section Pretty Printing
10395
10396 @value{GDBN} provides a mechanism to allow pretty-printing of values using
10397 Python code.  It greatly simplifies the display of complex objects.  This
10398 mechanism works for both MI and the CLI.
10399
10400 @menu
10401 * Pretty-Printer Introduction::  Introduction to pretty-printers
10402 * Pretty-Printer Example::       An example pretty-printer
10403 * Pretty-Printer Commands::      Pretty-printer commands
10404 @end menu
10405
10406 @node Pretty-Printer Introduction
10407 @subsection Pretty-Printer Introduction
10408
10409 When @value{GDBN} prints a value, it first sees if there is a pretty-printer
10410 registered for the value.  If there is then @value{GDBN} invokes the
10411 pretty-printer to print the value.  Otherwise the value is printed normally.
10412
10413 Pretty-printers are normally named.  This makes them easy to manage.
10414 The @samp{info pretty-printer} command will list all the installed
10415 pretty-printers with their names.
10416 If a pretty-printer can handle multiple data types, then its
10417 @dfn{subprinters} are the printers for the individual data types.
10418 Each such subprinter has its own name.
10419 The format of the name is @var{printer-name};@var{subprinter-name}.
10420
10421 Pretty-printers are installed by @dfn{registering} them with @value{GDBN}.
10422 Typically they are automatically loaded and registered when the corresponding
10423 debug information is loaded, thus making them available without having to
10424 do anything special.
10425
10426 There are three places where a pretty-printer can be registered.
10427
10428 @itemize @bullet
10429 @item
10430 Pretty-printers registered globally are available when debugging
10431 all inferiors.
10432
10433 @item
10434 Pretty-printers registered with a program space are available only
10435 when debugging that program.
10436 @xref{Progspaces In Python}, for more details on program spaces in Python.
10437
10438 @item
10439 Pretty-printers registered with an objfile are loaded and unloaded
10440 with the corresponding objfile (e.g., shared library).
10441 @xref{Objfiles In Python}, for more details on objfiles in Python.
10442 @end itemize
10443
10444 @xref{Selecting Pretty-Printers}, for further information on how 
10445 pretty-printers are selected,
10446
10447 @xref{Writing a Pretty-Printer}, for implementing pretty printers
10448 for new types.
10449
10450 @node Pretty-Printer Example
10451 @subsection Pretty-Printer Example
10452
10453 Here is how a C@t{++} @code{std::string} looks without a pretty-printer:
10454
10455 @smallexample
10456 (@value{GDBP}) print s
10457 $1 = @{
10458   static npos = 4294967295, 
10459   _M_dataplus = @{
10460     <std::allocator<char>> = @{
10461       <__gnu_cxx::new_allocator<char>> = @{
10462         <No data fields>@}, <No data fields>
10463       @},
10464     members of std::basic_string<char, std::char_traits<char>,
10465       std::allocator<char> >::_Alloc_hider:
10466     _M_p = 0x804a014 "abcd"
10467   @}
10468 @}
10469 @end smallexample
10470
10471 With a pretty-printer for @code{std::string} only the contents are printed:
10472
10473 @smallexample
10474 (@value{GDBP}) print s
10475 $2 = "abcd"
10476 @end smallexample
10477
10478 @node Pretty-Printer Commands
10479 @subsection Pretty-Printer Commands
10480 @cindex pretty-printer commands
10481
10482 @table @code
10483 @kindex info pretty-printer
10484 @item info pretty-printer [@var{object-regexp} [@var{name-regexp}]]
10485 Print the list of installed pretty-printers.
10486 This includes disabled pretty-printers, which are marked as such.
10487
10488 @var{object-regexp} is a regular expression matching the objects
10489 whose pretty-printers to list.
10490 Objects can be @code{global}, the program space's file
10491 (@pxref{Progspaces In Python}),
10492 and the object files within that program space (@pxref{Objfiles In Python}).
10493 @xref{Selecting Pretty-Printers}, for details on how @value{GDBN}
10494 looks up a printer from these three objects.
10495
10496 @var{name-regexp} is a regular expression matching the name of the printers
10497 to list.
10498
10499 @kindex disable pretty-printer
10500 @item disable pretty-printer [@var{object-regexp} [@var{name-regexp}]]
10501 Disable pretty-printers matching @var{object-regexp} and @var{name-regexp}.
10502 A disabled pretty-printer is not forgotten, it may be enabled again later.
10503
10504 @kindex enable pretty-printer
10505 @item enable pretty-printer [@var{object-regexp} [@var{name-regexp}]]
10506 Enable pretty-printers matching @var{object-regexp} and @var{name-regexp}.
10507 @end table
10508
10509 Example:
10510
10511 Suppose we have three pretty-printers installed: one from library1.so
10512 named @code{foo} that prints objects of type @code{foo}, and
10513 another from library2.so named @code{bar} that prints two types of objects,
10514 @code{bar1} and @code{bar2}.
10515
10516 @smallexample
10517 (gdb) info pretty-printer
10518 library1.so:
10519   foo
10520 library2.so:
10521   bar
10522     bar1
10523     bar2
10524 (gdb) info pretty-printer library2
10525 library2.so:
10526   bar
10527     bar1
10528     bar2
10529 (gdb) disable pretty-printer library1
10530 1 printer disabled
10531 2 of 3 printers enabled
10532 (gdb) info pretty-printer
10533 library1.so:
10534   foo [disabled]
10535 library2.so:
10536   bar
10537     bar1
10538     bar2
10539 (gdb) disable pretty-printer library2 bar:bar1
10540 1 printer disabled
10541 1 of 3 printers enabled
10542 (gdb) info pretty-printer library2
10543 library1.so:
10544   foo [disabled]
10545 library2.so:
10546   bar
10547     bar1 [disabled]
10548     bar2
10549 (gdb) disable pretty-printer library2 bar
10550 1 printer disabled
10551 0 of 3 printers enabled
10552 (gdb) info pretty-printer library2
10553 library1.so:
10554   foo [disabled]
10555 library2.so:
10556   bar [disabled]
10557     bar1 [disabled]
10558     bar2
10559 @end smallexample
10560
10561 Note that for @code{bar} the entire printer can be disabled,
10562 as can each individual subprinter.
10563
10564 @node Value History
10565 @section Value History
10566
10567 @cindex value history
10568 @cindex history of values printed by @value{GDBN}
10569 Values printed by the @code{print} command are saved in the @value{GDBN}
10570 @dfn{value history}.  This allows you to refer to them in other expressions.
10571 Values are kept until the symbol table is re-read or discarded
10572 (for example with the @code{file} or @code{symbol-file} commands).
10573 When the symbol table changes, the value history is discarded,
10574 since the values may contain pointers back to the types defined in the
10575 symbol table.
10576
10577 @cindex @code{$}
10578 @cindex @code{$$}
10579 @cindex history number
10580 The values printed are given @dfn{history numbers} by which you can
10581 refer to them.  These are successive integers starting with one.
10582 @code{print} shows you the history number assigned to a value by
10583 printing @samp{$@var{num} = } before the value; here @var{num} is the
10584 history number.
10585
10586 To refer to any previous value, use @samp{$} followed by the value's
10587 history number.  The way @code{print} labels its output is designed to
10588 remind you of this.  Just @code{$} refers to the most recent value in
10589 the history, and @code{$$} refers to the value before that.
10590 @code{$$@var{n}} refers to the @var{n}th value from the end; @code{$$2}
10591 is the value just prior to @code{$$}, @code{$$1} is equivalent to
10592 @code{$$}, and @code{$$0} is equivalent to @code{$}.
10593
10594 For example, suppose you have just printed a pointer to a structure and
10595 want to see the contents of the structure.  It suffices to type
10596
10597 @smallexample
10598 p *$
10599 @end smallexample
10600
10601 If you have a chain of structures where the component @code{next} points
10602 to the next one, you can print the contents of the next one with this:
10603
10604 @smallexample
10605 p *$.next
10606 @end smallexample
10607
10608 @noindent
10609 You can print successive links in the chain by repeating this
10610 command---which you can do by just typing @key{RET}.
10611
10612 Note that the history records values, not expressions.  If the value of
10613 @code{x} is 4 and you type these commands:
10614
10615 @smallexample
10616 print x
10617 set x=5
10618 @end smallexample
10619
10620 @noindent
10621 then the value recorded in the value history by the @code{print} command
10622 remains 4 even though the value of @code{x} has changed.
10623
10624 @table @code
10625 @kindex show values
10626 @item show values
10627 Print the last ten values in the value history, with their item numbers.
10628 This is like @samp{p@ $$9} repeated ten times, except that @code{show
10629 values} does not change the history.
10630
10631 @item show values @var{n}
10632 Print ten history values centered on history item number @var{n}.
10633
10634 @item show values +
10635 Print ten history values just after the values last printed.  If no more
10636 values are available, @code{show values +} produces no display.
10637 @end table
10638
10639 Pressing @key{RET} to repeat @code{show values @var{n}} has exactly the
10640 same effect as @samp{show values +}.
10641
10642 @node Convenience Vars
10643 @section Convenience Variables
10644
10645 @cindex convenience variables
10646 @cindex user-defined variables
10647 @value{GDBN} provides @dfn{convenience variables} that you can use within
10648 @value{GDBN} to hold on to a value and refer to it later.  These variables
10649 exist entirely within @value{GDBN}; they are not part of your program, and
10650 setting a convenience variable has no direct effect on further execution
10651 of your program.  That is why you can use them freely.
10652
10653 Convenience variables are prefixed with @samp{$}.  Any name preceded by
10654 @samp{$} can be used for a convenience variable, unless it is one of
10655 the predefined machine-specific register names (@pxref{Registers, ,Registers}).
10656 (Value history references, in contrast, are @emph{numbers} preceded
10657 by @samp{$}.  @xref{Value History, ,Value History}.)
10658
10659 You can save a value in a convenience variable with an assignment
10660 expression, just as you would set a variable in your program.
10661 For example:
10662
10663 @smallexample
10664 set $foo = *object_ptr
10665 @end smallexample
10666
10667 @noindent
10668 would save in @code{$foo} the value contained in the object pointed to by
10669 @code{object_ptr}.
10670
10671 Using a convenience variable for the first time creates it, but its
10672 value is @code{void} until you assign a new value.  You can alter the
10673 value with another assignment at any time.
10674
10675 Convenience variables have no fixed types.  You can assign a convenience
10676 variable any type of value, including structures and arrays, even if
10677 that variable already has a value of a different type.  The convenience
10678 variable, when used as an expression, has the type of its current value.
10679
10680 @table @code
10681 @kindex show convenience
10682 @cindex show all user variables and functions
10683 @item show convenience
10684 Print a list of convenience variables used so far, and their values,
10685 as well as a list of the convenience functions.
10686 Abbreviated @code{show conv}.
10687
10688 @kindex init-if-undefined
10689 @cindex convenience variables, initializing
10690 @item init-if-undefined $@var{variable} = @var{expression}
10691 Set a convenience variable if it has not already been set.  This is useful
10692 for user-defined commands that keep some state.  It is similar, in concept,
10693 to using local static variables with initializers in C (except that
10694 convenience variables are global).  It can also be used to allow users to
10695 override default values used in a command script.
10696
10697 If the variable is already defined then the expression is not evaluated so
10698 any side-effects do not occur.
10699 @end table
10700
10701 One of the ways to use a convenience variable is as a counter to be
10702 incremented or a pointer to be advanced.  For example, to print
10703 a field from successive elements of an array of structures:
10704
10705 @smallexample
10706 set $i = 0
10707 print bar[$i++]->contents
10708 @end smallexample
10709
10710 @noindent
10711 Repeat that command by typing @key{RET}.
10712
10713 Some convenience variables are created automatically by @value{GDBN} and given
10714 values likely to be useful.
10715
10716 @table @code
10717 @vindex $_@r{, convenience variable}
10718 @item $_
10719 The variable @code{$_} is automatically set by the @code{x} command to
10720 the last address examined (@pxref{Memory, ,Examining Memory}).  Other
10721 commands which provide a default address for @code{x} to examine also
10722 set @code{$_} to that address; these commands include @code{info line}
10723 and @code{info breakpoint}.  The type of @code{$_} is @code{void *}
10724 except when set by the @code{x} command, in which case it is a pointer
10725 to the type of @code{$__}.
10726
10727 @vindex $__@r{, convenience variable}
10728 @item $__
10729 The variable @code{$__} is automatically set by the @code{x} command
10730 to the value found in the last address examined.  Its type is chosen
10731 to match the format in which the data was printed.
10732
10733 @item $_exitcode
10734 @vindex $_exitcode@r{, convenience variable}
10735 When the program being debugged terminates normally, @value{GDBN}
10736 automatically sets this variable to the exit code of the program, and
10737 resets @code{$_exitsignal} to @code{void}.
10738
10739 @item $_exitsignal
10740 @vindex $_exitsignal@r{, convenience variable}
10741 When the program being debugged dies due to an uncaught signal,
10742 @value{GDBN} automatically sets this variable to that signal's number,
10743 and resets @code{$_exitcode} to @code{void}.
10744
10745 To distinguish between whether the program being debugged has exited
10746 (i.e., @code{$_exitcode} is not @code{void}) or signalled (i.e.,
10747 @code{$_exitsignal} is not @code{void}), the convenience function
10748 @code{$_isvoid} can be used (@pxref{Convenience Funs,, Convenience
10749 Functions}).  For example, considering the following source code:
10750
10751 @smallexample
10752 #include <signal.h>
10753
10754 int
10755 main (int argc, char *argv[])
10756 @{
10757   raise (SIGALRM);
10758   return 0;
10759 @}
10760 @end smallexample
10761
10762 A valid way of telling whether the program being debugged has exited
10763 or signalled would be:
10764
10765 @smallexample
10766 (@value{GDBP}) define has_exited_or_signalled
10767 Type commands for definition of ``has_exited_or_signalled''.
10768 End with a line saying just ``end''.
10769 >if $_isvoid ($_exitsignal)
10770  >echo The program has exited\n
10771  >else
10772  >echo The program has signalled\n
10773  >end
10774 >end
10775 (@value{GDBP}) run
10776 Starting program:
10777
10778 Program terminated with signal SIGALRM, Alarm clock.
10779 The program no longer exists.
10780 (@value{GDBP}) has_exited_or_signalled
10781 The program has signalled
10782 @end smallexample
10783
10784 As can be seen, @value{GDBN} correctly informs that the program being
10785 debugged has signalled, since it calls @code{raise} and raises a
10786 @code{SIGALRM} signal.  If the program being debugged had not called
10787 @code{raise}, then @value{GDBN} would report a normal exit:
10788
10789 @smallexample
10790 (@value{GDBP}) has_exited_or_signalled
10791 The program has exited
10792 @end smallexample
10793
10794 @item $_exception
10795 The variable @code{$_exception} is set to the exception object being
10796 thrown at an exception-related catchpoint.  @xref{Set Catchpoints}.
10797
10798 @item $_probe_argc
10799 @itemx $_probe_arg0@dots{}$_probe_arg11
10800 Arguments to a static probe.  @xref{Static Probe Points}.
10801
10802 @item $_sdata
10803 @vindex $_sdata@r{, inspect, convenience variable}
10804 The variable @code{$_sdata} contains extra collected static tracepoint
10805 data.  @xref{Tracepoint Actions,,Tracepoint Action Lists}.  Note that
10806 @code{$_sdata} could be empty, if not inspecting a trace buffer, or
10807 if extra static tracepoint data has not been collected.
10808
10809 @item $_siginfo
10810 @vindex $_siginfo@r{, convenience variable}
10811 The variable @code{$_siginfo} contains extra signal information
10812 (@pxref{extra signal information}).  Note that @code{$_siginfo}
10813 could be empty, if the application has not yet received any signals.
10814 For example, it will be empty before you execute the @code{run} command.
10815
10816 @item $_tlb
10817 @vindex $_tlb@r{, convenience variable}
10818 The variable @code{$_tlb} is automatically set when debugging
10819 applications running on MS-Windows in native mode or connected to
10820 gdbserver that supports the @code{qGetTIBAddr} request. 
10821 @xref{General Query Packets}.
10822 This variable contains the address of the thread information block.
10823
10824 @item $_inferior
10825 The number of the current inferior.  @xref{Inferiors and
10826 Programs, ,Debugging Multiple Inferiors and Programs}.
10827
10828 @item $_thread
10829 The thread number of the current thread.  @xref{thread numbers}.
10830
10831 @item $_gthread
10832 The global number of the current thread.  @xref{global thread numbers}.
10833
10834 @end table
10835
10836 @node Convenience Funs
10837 @section Convenience Functions
10838
10839 @cindex convenience functions
10840 @value{GDBN} also supplies some @dfn{convenience functions}.  These
10841 have a syntax similar to convenience variables.  A convenience
10842 function can be used in an expression just like an ordinary function;
10843 however, a convenience function is implemented internally to
10844 @value{GDBN}.
10845
10846 These functions do not require @value{GDBN} to be configured with
10847 @code{Python} support, which means that they are always available.
10848
10849 @table @code
10850
10851 @item $_isvoid (@var{expr})
10852 @findex $_isvoid@r{, convenience function}
10853 Return one if the expression @var{expr} is @code{void}.  Otherwise it
10854 returns zero.
10855
10856 A @code{void} expression is an expression where the type of the result
10857 is @code{void}.  For example, you can examine a convenience variable
10858 (see @ref{Convenience Vars,, Convenience Variables}) to check whether
10859 it is @code{void}:
10860
10861 @smallexample
10862 (@value{GDBP}) print $_exitcode
10863 $1 = void
10864 (@value{GDBP}) print $_isvoid ($_exitcode)
10865 $2 = 1
10866 (@value{GDBP}) run
10867 Starting program: ./a.out
10868 [Inferior 1 (process 29572) exited normally]
10869 (@value{GDBP}) print $_exitcode
10870 $3 = 0
10871 (@value{GDBP}) print $_isvoid ($_exitcode)
10872 $4 = 0
10873 @end smallexample
10874
10875 In the example above, we used @code{$_isvoid} to check whether
10876 @code{$_exitcode} is @code{void} before and after the execution of the
10877 program being debugged.  Before the execution there is no exit code to
10878 be examined, therefore @code{$_exitcode} is @code{void}.  After the
10879 execution the program being debugged returned zero, therefore
10880 @code{$_exitcode} is zero, which means that it is not @code{void}
10881 anymore.
10882
10883 The @code{void} expression can also be a call of a function from the
10884 program being debugged.  For example, given the following function:
10885
10886 @smallexample
10887 void
10888 foo (void)
10889 @{
10890 @}
10891 @end smallexample
10892
10893 The result of calling it inside @value{GDBN} is @code{void}:
10894
10895 @smallexample
10896 (@value{GDBP}) print foo ()
10897 $1 = void
10898 (@value{GDBP}) print $_isvoid (foo ())
10899 $2 = 1
10900 (@value{GDBP}) set $v = foo ()
10901 (@value{GDBP}) print $v
10902 $3 = void
10903 (@value{GDBP}) print $_isvoid ($v)
10904 $4 = 1
10905 @end smallexample
10906
10907 @end table
10908
10909 These functions require @value{GDBN} to be configured with
10910 @code{Python} support.
10911
10912 @table @code
10913
10914 @item $_memeq(@var{buf1}, @var{buf2}, @var{length})
10915 @findex $_memeq@r{, convenience function}
10916 Returns one if the @var{length} bytes at the addresses given by
10917 @var{buf1} and @var{buf2} are equal.
10918 Otherwise it returns zero.
10919
10920 @item $_regex(@var{str}, @var{regex})
10921 @findex $_regex@r{, convenience function}
10922 Returns one if the string @var{str} matches the regular expression
10923 @var{regex}.  Otherwise it returns zero.
10924 The syntax of the regular expression is that specified by @code{Python}'s
10925 regular expression support.
10926
10927 @item $_streq(@var{str1}, @var{str2})
10928 @findex $_streq@r{, convenience function}
10929 Returns one if the strings @var{str1} and @var{str2} are equal.
10930 Otherwise it returns zero.
10931
10932 @item $_strlen(@var{str})
10933 @findex $_strlen@r{, convenience function}
10934 Returns the length of string @var{str}.
10935
10936 @item $_caller_is(@var{name}@r{[}, @var{number_of_frames}@r{]})
10937 @findex $_caller_is@r{, convenience function}
10938 Returns one if the calling function's name is equal to @var{name}.
10939 Otherwise it returns zero.
10940
10941 If the optional argument @var{number_of_frames} is provided,
10942 it is the number of frames up in the stack to look.
10943 The default is 1.
10944
10945 Example:
10946
10947 @smallexample
10948 (gdb) backtrace
10949 #0  bottom_func ()
10950     at testsuite/gdb.python/py-caller-is.c:21
10951 #1  0x00000000004005a0 in middle_func ()
10952     at testsuite/gdb.python/py-caller-is.c:27
10953 #2  0x00000000004005ab in top_func ()
10954     at testsuite/gdb.python/py-caller-is.c:33
10955 #3  0x00000000004005b6 in main ()
10956     at testsuite/gdb.python/py-caller-is.c:39
10957 (gdb) print $_caller_is ("middle_func")
10958 $1 = 1
10959 (gdb) print $_caller_is ("top_func", 2)
10960 $1 = 1
10961 @end smallexample
10962
10963 @item $_caller_matches(@var{regexp}@r{[}, @var{number_of_frames}@r{]})
10964 @findex $_caller_matches@r{, convenience function}
10965 Returns one if the calling function's name matches the regular expression
10966 @var{regexp}.  Otherwise it returns zero.
10967
10968 If the optional argument @var{number_of_frames} is provided,
10969 it is the number of frames up in the stack to look.
10970 The default is 1.
10971
10972 @item $_any_caller_is(@var{name}@r{[}, @var{number_of_frames}@r{]})
10973 @findex $_any_caller_is@r{, convenience function}
10974 Returns one if any calling function's name is equal to @var{name}.
10975 Otherwise it returns zero.
10976
10977 If the optional argument @var{number_of_frames} is provided,
10978 it is the number of frames up in the stack to look.
10979 The default is 1.
10980
10981 This function differs from @code{$_caller_is} in that this function
10982 checks all stack frames from the immediate caller to the frame specified
10983 by @var{number_of_frames}, whereas @code{$_caller_is} only checks the
10984 frame specified by @var{number_of_frames}.
10985
10986 @item $_any_caller_matches(@var{regexp}@r{[}, @var{number_of_frames}@r{]})
10987 @findex $_any_caller_matches@r{, convenience function}
10988 Returns one if any calling function's name matches the regular expression
10989 @var{regexp}.  Otherwise it returns zero.
10990
10991 If the optional argument @var{number_of_frames} is provided,
10992 it is the number of frames up in the stack to look.
10993 The default is 1.
10994
10995 This function differs from @code{$_caller_matches} in that this function
10996 checks all stack frames from the immediate caller to the frame specified
10997 by @var{number_of_frames}, whereas @code{$_caller_matches} only checks the
10998 frame specified by @var{number_of_frames}.
10999
11000 @item $_as_string(@var{value})
11001 @findex $_as_string@r{, convenience function}
11002 Return the string representation of @var{value}.
11003
11004 This function is useful to obtain the textual label (enumerator) of an
11005 enumeration value.  For example, assuming the variable @var{node} is of
11006 an enumerated type:
11007
11008 @smallexample
11009 (gdb) printf "Visiting node of type %s\n", $_as_string(node)
11010 Visiting node of type NODE_INTEGER
11011 @end smallexample
11012
11013 @end table
11014
11015 @value{GDBN} provides the ability to list and get help on
11016 convenience functions.
11017
11018 @table @code
11019 @item help function
11020 @kindex help function
11021 @cindex show all convenience functions
11022 Print a list of all convenience functions.
11023 @end table
11024
11025 @node Registers
11026 @section Registers
11027
11028 @cindex registers
11029 You can refer to machine register contents, in expressions, as variables
11030 with names starting with @samp{$}.  The names of registers are different
11031 for each machine; use @code{info registers} to see the names used on
11032 your machine.
11033
11034 @table @code
11035 @kindex info registers
11036 @item info registers
11037 Print the names and values of all registers except floating-point
11038 and vector registers (in the selected stack frame).
11039
11040 @kindex info all-registers
11041 @cindex floating point registers
11042 @item info all-registers
11043 Print the names and values of all registers, including floating-point
11044 and vector registers (in the selected stack frame).
11045
11046 @item info registers @var{reggroup} @dots{}
11047 Print the name and value of the registers in each of the specified
11048 @var{reggroup}s.  The @var{reggoup} can be any of those returned by
11049 @code{maint print reggroups} (@pxref{Maintenance Commands}).
11050
11051 @item info registers @var{regname} @dots{}
11052 Print the @dfn{relativized} value of each specified register @var{regname}.
11053 As discussed in detail below, register values are normally relative to
11054 the selected stack frame.  The @var{regname} may be any register name valid on
11055 the machine you are using, with or without the initial @samp{$}.
11056 @end table
11057
11058 @anchor{standard registers}
11059 @cindex stack pointer register
11060 @cindex program counter register
11061 @cindex process status register
11062 @cindex frame pointer register
11063 @cindex standard registers
11064 @value{GDBN} has four ``standard'' register names that are available (in
11065 expressions) on most machines---whenever they do not conflict with an
11066 architecture's canonical mnemonics for registers.  The register names
11067 @code{$pc} and @code{$sp} are used for the program counter register and
11068 the stack pointer.  @code{$fp} is used for a register that contains a
11069 pointer to the current stack frame, and @code{$ps} is used for a
11070 register that contains the processor status.  For example,
11071 you could print the program counter in hex with
11072
11073 @smallexample
11074 p/x $pc
11075 @end smallexample
11076
11077 @noindent
11078 or print the instruction to be executed next with
11079
11080 @smallexample
11081 x/i $pc
11082 @end smallexample
11083
11084 @noindent
11085 or add four to the stack pointer@footnote{This is a way of removing
11086 one word from the stack, on machines where stacks grow downward in
11087 memory (most machines, nowadays).  This assumes that the innermost
11088 stack frame is selected; setting @code{$sp} is not allowed when other
11089 stack frames are selected.  To pop entire frames off the stack,
11090 regardless of machine architecture, use @code{return};
11091 see @ref{Returning, ,Returning from a Function}.} with
11092
11093 @smallexample
11094 set $sp += 4
11095 @end smallexample
11096
11097 Whenever possible, these four standard register names are available on
11098 your machine even though the machine has different canonical mnemonics,
11099 so long as there is no conflict.  The @code{info registers} command
11100 shows the canonical names.  For example, on the SPARC, @code{info
11101 registers} displays the processor status register as @code{$psr} but you
11102 can also refer to it as @code{$ps}; and on x86-based machines @code{$ps}
11103 is an alias for the @sc{eflags} register.
11104
11105 @value{GDBN} always considers the contents of an ordinary register as an
11106 integer when the register is examined in this way.  Some machines have
11107 special registers which can hold nothing but floating point; these
11108 registers are considered to have floating point values.  There is no way
11109 to refer to the contents of an ordinary register as floating point value
11110 (although you can @emph{print} it as a floating point value with
11111 @samp{print/f $@var{regname}}).
11112
11113 Some registers have distinct ``raw'' and ``virtual'' data formats.  This
11114 means that the data format in which the register contents are saved by
11115 the operating system is not the same one that your program normally
11116 sees.  For example, the registers of the 68881 floating point
11117 coprocessor are always saved in ``extended'' (raw) format, but all C
11118 programs expect to work with ``double'' (virtual) format.  In such
11119 cases, @value{GDBN} normally works with the virtual format only (the format
11120 that makes sense for your program), but the @code{info registers} command
11121 prints the data in both formats.
11122
11123 @cindex SSE registers (x86)
11124 @cindex MMX registers (x86)
11125 Some machines have special registers whose contents can be interpreted
11126 in several different ways.  For example, modern x86-based machines
11127 have SSE and MMX registers that can hold several values packed
11128 together in several different formats.  @value{GDBN} refers to such
11129 registers in @code{struct} notation:
11130
11131 @smallexample
11132 (@value{GDBP}) print $xmm1
11133 $1 = @{
11134   v4_float = @{0, 3.43859137e-038, 1.54142831e-044, 1.821688e-044@},
11135   v2_double = @{9.92129282474342e-303, 2.7585945287983262e-313@},
11136   v16_int8 = "\000\000\000\000\3706;\001\v\000\000\000\r\000\000",
11137   v8_int16 = @{0, 0, 14072, 315, 11, 0, 13, 0@},
11138   v4_int32 = @{0, 20657912, 11, 13@},
11139   v2_int64 = @{88725056443645952, 55834574859@},
11140   uint128 = 0x0000000d0000000b013b36f800000000
11141 @}
11142 @end smallexample
11143
11144 @noindent
11145 To set values of such registers, you need to tell @value{GDBN} which
11146 view of the register you wish to change, as if you were assigning
11147 value to a @code{struct} member:
11148
11149 @smallexample
11150  (@value{GDBP}) set $xmm1.uint128 = 0x000000000000000000000000FFFFFFFF
11151 @end smallexample
11152
11153 Normally, register values are relative to the selected stack frame
11154 (@pxref{Selection, ,Selecting a Frame}).  This means that you get the
11155 value that the register would contain if all stack frames farther in
11156 were exited and their saved registers restored.  In order to see the
11157 true contents of hardware registers, you must select the innermost
11158 frame (with @samp{frame 0}).
11159
11160 @cindex caller-saved registers
11161 @cindex call-clobbered registers
11162 @cindex volatile registers
11163 @cindex <not saved> values
11164 Usually ABIs reserve some registers as not needed to be saved by the
11165 callee (a.k.a.: ``caller-saved'', ``call-clobbered'' or ``volatile''
11166 registers).  It may therefore not be possible for @value{GDBN} to know
11167 the value a register had before the call (in other words, in the outer
11168 frame), if the register value has since been changed by the callee.
11169 @value{GDBN} tries to deduce where the inner frame saved
11170 (``callee-saved'') registers, from the debug info, unwind info, or the
11171 machine code generated by your compiler.  If some register is not
11172 saved, and @value{GDBN} knows the register is ``caller-saved'' (via
11173 its own knowledge of the ABI, or because the debug/unwind info
11174 explicitly says the register's value is undefined), @value{GDBN}
11175 displays @w{@samp{<not saved>}} as the register's value.  With targets
11176 that @value{GDBN} has no knowledge of the register saving convention,
11177 if a register was not saved by the callee, then its value and location
11178 in the outer frame are assumed to be the same of the inner frame.
11179 This is usually harmless, because if the register is call-clobbered,
11180 the caller either does not care what is in the register after the
11181 call, or has code to restore the value that it does care about.  Note,
11182 however, that if you change such a register in the outer frame, you
11183 may also be affecting the inner frame.  Also, the more ``outer'' the
11184 frame is you're looking at, the more likely a call-clobbered
11185 register's value is to be wrong, in the sense that it doesn't actually
11186 represent the value the register had just before the call.
11187
11188 @node Floating Point Hardware
11189 @section Floating Point Hardware
11190 @cindex floating point
11191
11192 Depending on the configuration, @value{GDBN} may be able to give
11193 you more information about the status of the floating point hardware.
11194
11195 @table @code
11196 @kindex info float
11197 @item info float
11198 Display hardware-dependent information about the floating
11199 point unit.  The exact contents and layout vary depending on the
11200 floating point chip.  Currently, @samp{info float} is supported on
11201 the ARM and x86 machines.
11202 @end table
11203
11204 @node Vector Unit
11205 @section Vector Unit
11206 @cindex vector unit
11207
11208 Depending on the configuration, @value{GDBN} may be able to give you
11209 more information about the status of the vector unit.
11210
11211 @table @code
11212 @kindex info vector
11213 @item info vector
11214 Display information about the vector unit.  The exact contents and
11215 layout vary depending on the hardware.
11216 @end table
11217
11218 @node OS Information
11219 @section Operating System Auxiliary Information
11220 @cindex OS information
11221
11222 @value{GDBN} provides interfaces to useful OS facilities that can help
11223 you debug your program.
11224
11225 @cindex auxiliary vector
11226 @cindex vector, auxiliary
11227 Some operating systems supply an @dfn{auxiliary vector} to programs at
11228 startup.  This is akin to the arguments and environment that you
11229 specify for a program, but contains a system-dependent variety of
11230 binary values that tell system libraries important details about the
11231 hardware, operating system, and process.  Each value's purpose is
11232 identified by an integer tag; the meanings are well-known but system-specific.
11233 Depending on the configuration and operating system facilities,
11234 @value{GDBN} may be able to show you this information.  For remote
11235 targets, this functionality may further depend on the remote stub's
11236 support of the @samp{qXfer:auxv:read} packet, see
11237 @ref{qXfer auxiliary vector read}.
11238
11239 @table @code
11240 @kindex info auxv
11241 @item info auxv
11242 Display the auxiliary vector of the inferior, which can be either a
11243 live process or a core dump file.  @value{GDBN} prints each tag value
11244 numerically, and also shows names and text descriptions for recognized
11245 tags.  Some values in the vector are numbers, some bit masks, and some
11246 pointers to strings or other data.  @value{GDBN} displays each value in the
11247 most appropriate form for a recognized tag, and in hexadecimal for
11248 an unrecognized tag.
11249 @end table
11250
11251 On some targets, @value{GDBN} can access operating system-specific
11252 information and show it to you.  The types of information available
11253 will differ depending on the type of operating system running on the
11254 target.  The mechanism used to fetch the data is described in
11255 @ref{Operating System Information}.  For remote targets, this
11256 functionality depends on the remote stub's support of the
11257 @samp{qXfer:osdata:read} packet, see @ref{qXfer osdata read}.
11258
11259 @table @code
11260 @kindex info os
11261 @item info os @var{infotype}
11262
11263 Display OS information of the requested type.
11264
11265 On @sc{gnu}/Linux, the following values of @var{infotype} are valid:
11266
11267 @anchor{linux info os infotypes}
11268 @table @code
11269 @kindex info os cpus
11270 @item cpus
11271 Display the list of all CPUs/cores. For each CPU/core, @value{GDBN} prints
11272 the available fields from /proc/cpuinfo. For each supported architecture
11273 different fields are available. Two common entries are processor which gives
11274 CPU number and bogomips; a system constant that is calculated during
11275 kernel initialization.
11276
11277 @kindex info os files
11278 @item files
11279 Display the list of open file descriptors on the target.  For each
11280 file descriptor, @value{GDBN} prints the identifier of the process
11281 owning the descriptor, the command of the owning process, the value
11282 of the descriptor, and the target of the descriptor.
11283
11284 @kindex info os modules
11285 @item modules
11286 Display the list of all loaded kernel modules on the target.  For each
11287 module, @value{GDBN} prints the module name, the size of the module in
11288 bytes, the number of times the module is used, the dependencies of the
11289 module, the status of the module, and the address of the loaded module
11290 in memory.
11291
11292 @kindex info os msg
11293 @item msg
11294 Display the list of all System V message queues on the target.  For each
11295 message queue, @value{GDBN} prints the message queue key, the message
11296 queue identifier, the access permissions, the current number of bytes
11297 on the queue, the current number of messages on the queue, the processes
11298 that last sent and received a message on the queue, the user and group
11299 of the owner and creator of the message queue, the times at which a
11300 message was last sent and received on the queue, and the time at which
11301 the message queue was last changed.
11302
11303 @kindex info os processes
11304 @item processes
11305 Display the list of processes on the target.  For each process,
11306 @value{GDBN} prints the process identifier, the name of the user, the
11307 command corresponding to the process, and the list of processor cores
11308 that the process is currently running on.  (To understand what these
11309 properties mean, for this and the following info types, please consult
11310 the general @sc{gnu}/Linux documentation.)
11311
11312 @kindex info os procgroups
11313 @item procgroups
11314 Display the list of process groups on the target.  For each process,
11315 @value{GDBN} prints the identifier of the process group that it belongs
11316 to, the command corresponding to the process group leader, the process
11317 identifier, and the command line of the process.  The list is sorted
11318 first by the process group identifier, then by the process identifier,
11319 so that processes belonging to the same process group are grouped together
11320 and the process group leader is listed first.
11321
11322 @kindex info os semaphores
11323 @item semaphores
11324 Display the list of all System V semaphore sets on the target.  For each
11325 semaphore set, @value{GDBN} prints the semaphore set key, the semaphore
11326 set identifier, the access permissions, the number of semaphores in the
11327 set, the user and group of the owner and creator of the semaphore set,
11328 and the times at which the semaphore set was operated upon and changed.
11329
11330 @kindex info os shm
11331 @item shm
11332 Display the list of all System V shared-memory regions on the target.
11333 For each shared-memory region, @value{GDBN} prints the region key,
11334 the shared-memory identifier, the access permissions, the size of the
11335 region, the process that created the region, the process that last
11336 attached to or detached from the region, the current number of live
11337 attaches to the region, and the times at which the region was last
11338 attached to, detach from, and changed.
11339
11340 @kindex info os sockets
11341 @item sockets
11342 Display the list of Internet-domain sockets on the target.  For each
11343 socket, @value{GDBN} prints the address and port of the local and
11344 remote endpoints, the current state of the connection, the creator of
11345 the socket, the IP address family of the socket, and the type of the
11346 connection.
11347
11348 @kindex info os threads
11349 @item threads
11350 Display the list of threads running on the target.  For each thread,
11351 @value{GDBN} prints the identifier of the process that the thread
11352 belongs to, the command of the process, the thread identifier, and the
11353 processor core that it is currently running on.  The main thread of a
11354 process is not listed.
11355 @end table
11356
11357 @item info os
11358 If @var{infotype} is omitted, then list the possible values for
11359 @var{infotype} and the kind of OS information available for each
11360 @var{infotype}.  If the target does not return a list of possible
11361 types, this command will report an error.
11362 @end table
11363
11364 @node Memory Region Attributes
11365 @section Memory Region Attributes
11366 @cindex memory region attributes
11367
11368 @dfn{Memory region attributes} allow you to describe special handling
11369 required by regions of your target's memory.  @value{GDBN} uses
11370 attributes to determine whether to allow certain types of memory
11371 accesses; whether to use specific width accesses; and whether to cache
11372 target memory.  By default the description of memory regions is
11373 fetched from the target (if the current target supports this), but the
11374 user can override the fetched regions.
11375
11376 Defined memory regions can be individually enabled and disabled.  When a
11377 memory region is disabled, @value{GDBN} uses the default attributes when
11378 accessing memory in that region.  Similarly, if no memory regions have
11379 been defined, @value{GDBN} uses the default attributes when accessing
11380 all memory.
11381
11382 When a memory region is defined, it is given a number to identify it;
11383 to enable, disable, or remove a memory region, you specify that number.
11384
11385 @table @code
11386 @kindex mem
11387 @item mem @var{lower} @var{upper} @var{attributes}@dots{}
11388 Define a memory region bounded by @var{lower} and @var{upper} with
11389 attributes @var{attributes}@dots{}, and add it to the list of regions
11390 monitored by @value{GDBN}.  Note that @var{upper} == 0 is a special
11391 case: it is treated as the target's maximum memory address.
11392 (0xffff on 16 bit targets, 0xffffffff on 32 bit targets, etc.)
11393
11394 @item mem auto
11395 Discard any user changes to the memory regions and use target-supplied
11396 regions, if available, or no regions if the target does not support.
11397
11398 @kindex delete mem
11399 @item delete mem @var{nums}@dots{}
11400 Remove memory regions @var{nums}@dots{} from the list of regions
11401 monitored by @value{GDBN}.
11402
11403 @kindex disable mem
11404 @item disable mem @var{nums}@dots{}
11405 Disable monitoring of memory regions @var{nums}@dots{}.
11406 A disabled memory region is not forgotten.
11407 It may be enabled again later.
11408
11409 @kindex enable mem
11410 @item enable mem @var{nums}@dots{}
11411 Enable monitoring of memory regions @var{nums}@dots{}.
11412
11413 @kindex info mem
11414 @item info mem
11415 Print a table of all defined memory regions, with the following columns
11416 for each region:
11417
11418 @table @emph
11419 @item Memory Region Number
11420 @item Enabled or Disabled.
11421 Enabled memory regions are marked with @samp{y}.
11422 Disabled memory regions are marked with @samp{n}.
11423
11424 @item Lo Address
11425 The address defining the inclusive lower bound of the memory region.
11426
11427 @item Hi Address
11428 The address defining the exclusive upper bound of the memory region.
11429
11430 @item Attributes
11431 The list of attributes set for this memory region.
11432 @end table
11433 @end table
11434
11435
11436 @subsection Attributes
11437
11438 @subsubsection Memory Access Mode
11439 The access mode attributes set whether @value{GDBN} may make read or
11440 write accesses to a memory region.
11441
11442 While these attributes prevent @value{GDBN} from performing invalid
11443 memory accesses, they do nothing to prevent the target system, I/O DMA,
11444 etc.@: from accessing memory.
11445
11446 @table @code
11447 @item ro
11448 Memory is read only.
11449 @item wo
11450 Memory is write only.
11451 @item rw
11452 Memory is read/write.  This is the default.
11453 @end table
11454
11455 @subsubsection Memory Access Size
11456 The access size attribute tells @value{GDBN} to use specific sized
11457 accesses in the memory region.  Often memory mapped device registers
11458 require specific sized accesses.  If no access size attribute is
11459 specified, @value{GDBN} may use accesses of any size.
11460
11461 @table @code
11462 @item 8
11463 Use 8 bit memory accesses.
11464 @item 16
11465 Use 16 bit memory accesses.
11466 @item 32
11467 Use 32 bit memory accesses.
11468 @item 64
11469 Use 64 bit memory accesses.
11470 @end table
11471
11472 @c @subsubsection Hardware/Software Breakpoints
11473 @c The hardware/software breakpoint attributes set whether @value{GDBN}
11474 @c will use hardware or software breakpoints for the internal breakpoints
11475 @c used by the step, next, finish, until, etc. commands.
11476 @c
11477 @c @table @code
11478 @c @item hwbreak
11479 @c Always use hardware breakpoints
11480 @c @item swbreak (default)
11481 @c @end table
11482
11483 @subsubsection Data Cache
11484 The data cache attributes set whether @value{GDBN} will cache target
11485 memory.  While this generally improves performance by reducing debug
11486 protocol overhead, it can lead to incorrect results because @value{GDBN}
11487 does not know about volatile variables or memory mapped device
11488 registers.
11489
11490 @table @code
11491 @item cache
11492 Enable @value{GDBN} to cache target memory.
11493 @item nocache
11494 Disable @value{GDBN} from caching target memory.  This is the default.
11495 @end table
11496
11497 @subsection Memory Access Checking
11498 @value{GDBN} can be instructed to refuse accesses to memory that is
11499 not explicitly described.  This can be useful if accessing such
11500 regions has undesired effects for a specific target, or to provide
11501 better error checking.  The following commands control this behaviour.
11502
11503 @table @code
11504 @kindex set mem inaccessible-by-default
11505 @item set mem inaccessible-by-default [on|off]
11506 If @code{on} is specified, make  @value{GDBN} treat memory not
11507 explicitly described by the memory ranges as non-existent and refuse accesses
11508 to such memory.  The checks are only performed if there's at least one
11509 memory range defined.  If @code{off} is specified, make @value{GDBN}
11510 treat the memory not explicitly described by the memory ranges as RAM.
11511 The default value is @code{on}.
11512 @kindex show mem inaccessible-by-default
11513 @item show mem inaccessible-by-default
11514 Show the current handling of accesses to unknown memory.
11515 @end table
11516
11517
11518 @c @subsubsection Memory Write Verification
11519 @c The memory write verification attributes set whether @value{GDBN}
11520 @c will re-reads data after each write to verify the write was successful.
11521 @c
11522 @c @table @code
11523 @c @item verify
11524 @c @item noverify (default)
11525 @c @end table
11526
11527 @node Dump/Restore Files
11528 @section Copy Between Memory and a File
11529 @cindex dump/restore files
11530 @cindex append data to a file
11531 @cindex dump data to a file
11532 @cindex restore data from a file
11533
11534 You can use the commands @code{dump}, @code{append}, and
11535 @code{restore} to copy data between target memory and a file.  The
11536 @code{dump} and @code{append} commands write data to a file, and the
11537 @code{restore} command reads data from a file back into the inferior's
11538 memory.  Files may be in binary, Motorola S-record, Intel hex,
11539 Tektronix Hex, or Verilog Hex format; however, @value{GDBN} can only
11540 append to binary files, and cannot read from Verilog Hex files.
11541
11542 @table @code
11543
11544 @kindex dump
11545 @item dump @r{[}@var{format}@r{]} memory @var{filename} @var{start_addr} @var{end_addr}
11546 @itemx dump @r{[}@var{format}@r{]} value @var{filename} @var{expr}
11547 Dump the contents of memory from @var{start_addr} to @var{end_addr},
11548 or the value of @var{expr}, to @var{filename} in the given format.
11549
11550 The @var{format} parameter may be any one of:
11551 @table @code
11552 @item binary
11553 Raw binary form.
11554 @item ihex
11555 Intel hex format.
11556 @item srec
11557 Motorola S-record format.
11558 @item tekhex
11559 Tektronix Hex format.
11560 @item verilog
11561 Verilog Hex format.
11562 @end table
11563
11564 @value{GDBN} uses the same definitions of these formats as the
11565 @sc{gnu} binary utilities, like @samp{objdump} and @samp{objcopy}.  If
11566 @var{format} is omitted, @value{GDBN} dumps the data in raw binary
11567 form.
11568
11569 @kindex append
11570 @item append @r{[}binary@r{]} memory @var{filename} @var{start_addr} @var{end_addr}
11571 @itemx append @r{[}binary@r{]} value @var{filename} @var{expr}
11572 Append the contents of memory from @var{start_addr} to @var{end_addr},
11573 or the value of @var{expr}, to the file @var{filename}, in raw binary form.
11574 (@value{GDBN} can only append data to files in raw binary form.)
11575
11576 @kindex restore
11577 @item restore @var{filename} @r{[}binary@r{]} @var{bias} @var{start} @var{end}
11578 Restore the contents of file @var{filename} into memory.  The
11579 @code{restore} command can automatically recognize any known @sc{bfd}
11580 file format, except for raw binary.  To restore a raw binary file you
11581 must specify the optional keyword @code{binary} after the filename.
11582
11583 If @var{bias} is non-zero, its value will be added to the addresses
11584 contained in the file.  Binary files always start at address zero, so
11585 they will be restored at address @var{bias}.  Other bfd files have
11586 a built-in location; they will be restored at offset @var{bias}
11587 from that location.
11588
11589 If @var{start} and/or @var{end} are non-zero, then only data between
11590 file offset @var{start} and file offset @var{end} will be restored.
11591 These offsets are relative to the addresses in the file, before
11592 the @var{bias} argument is applied.
11593
11594 @end table
11595
11596 @node Core File Generation
11597 @section How to Produce a Core File from Your Program
11598 @cindex dump core from inferior
11599
11600 A @dfn{core file} or @dfn{core dump} is a file that records the memory
11601 image of a running process and its process status (register values
11602 etc.).  Its primary use is post-mortem debugging of a program that
11603 crashed while it ran outside a debugger.  A program that crashes
11604 automatically produces a core file, unless this feature is disabled by
11605 the user.  @xref{Files}, for information on invoking @value{GDBN} in
11606 the post-mortem debugging mode.
11607
11608 Occasionally, you may wish to produce a core file of the program you
11609 are debugging in order to preserve a snapshot of its state.
11610 @value{GDBN} has a special command for that.
11611
11612 @table @code
11613 @kindex gcore
11614 @kindex generate-core-file
11615 @item generate-core-file [@var{file}]
11616 @itemx gcore [@var{file}]
11617 Produce a core dump of the inferior process.  The optional argument
11618 @var{file} specifies the file name where to put the core dump.  If not
11619 specified, the file name defaults to @file{core.@var{pid}}, where
11620 @var{pid} is the inferior process ID.
11621
11622 Note that this command is implemented only for some systems (as of
11623 this writing, @sc{gnu}/Linux, FreeBSD, Solaris, and S390).
11624
11625 On @sc{gnu}/Linux, this command can take into account the value of the
11626 file @file{/proc/@var{pid}/coredump_filter} when generating the core
11627 dump (@pxref{set use-coredump-filter}), and by default honors the
11628 @code{VM_DONTDUMP} flag for mappings where it is present in the file
11629 @file{/proc/@var{pid}/smaps} (@pxref{set dump-excluded-mappings}).
11630
11631 @kindex set use-coredump-filter
11632 @anchor{set use-coredump-filter}
11633 @item set use-coredump-filter on
11634 @itemx set use-coredump-filter off
11635 Enable or disable the use of the file
11636 @file{/proc/@var{pid}/coredump_filter} when generating core dump
11637 files.  This file is used by the Linux kernel to decide what types of
11638 memory mappings will be dumped or ignored when generating a core dump
11639 file.  @var{pid} is the process ID of a currently running process.
11640
11641 To make use of this feature, you have to write in the
11642 @file{/proc/@var{pid}/coredump_filter} file a value, in hexadecimal,
11643 which is a bit mask representing the memory mapping types.  If a bit
11644 is set in the bit mask, then the memory mappings of the corresponding
11645 types will be dumped; otherwise, they will be ignored.  This
11646 configuration is inherited by child processes.  For more information
11647 about the bits that can be set in the
11648 @file{/proc/@var{pid}/coredump_filter} file, please refer to the
11649 manpage of @code{core(5)}.
11650
11651 By default, this option is @code{on}.  If this option is turned
11652 @code{off}, @value{GDBN} does not read the @file{coredump_filter} file
11653 and instead uses the same default value as the Linux kernel in order
11654 to decide which pages will be dumped in the core dump file.  This
11655 value is currently @code{0x33}, which means that bits @code{0}
11656 (anonymous private mappings), @code{1} (anonymous shared mappings),
11657 @code{4} (ELF headers) and @code{5} (private huge pages) are active.
11658 This will cause these memory mappings to be dumped automatically.
11659
11660 @kindex set dump-excluded-mappings
11661 @anchor{set dump-excluded-mappings}
11662 @item set dump-excluded-mappings on
11663 @itemx set dump-excluded-mappings off
11664 If @code{on} is specified, @value{GDBN} will dump memory mappings
11665 marked with the @code{VM_DONTDUMP} flag.  This flag is represented in
11666 the file @file{/proc/@var{pid}/smaps} with the acronym @code{dd}.
11667
11668 The default value is @code{off}.
11669 @end table
11670
11671 @node Character Sets
11672 @section Character Sets
11673 @cindex character sets
11674 @cindex charset
11675 @cindex translating between character sets
11676 @cindex host character set
11677 @cindex target character set
11678
11679 If the program you are debugging uses a different character set to
11680 represent characters and strings than the one @value{GDBN} uses itself,
11681 @value{GDBN} can automatically translate between the character sets for
11682 you.  The character set @value{GDBN} uses we call the @dfn{host
11683 character set}; the one the inferior program uses we call the
11684 @dfn{target character set}.
11685
11686 For example, if you are running @value{GDBN} on a @sc{gnu}/Linux system, which
11687 uses the ISO Latin 1 character set, but you are using @value{GDBN}'s
11688 remote protocol (@pxref{Remote Debugging}) to debug a program
11689 running on an IBM mainframe, which uses the @sc{ebcdic} character set,
11690 then the host character set is Latin-1, and the target character set is
11691 @sc{ebcdic}.  If you give @value{GDBN} the command @code{set
11692 target-charset EBCDIC-US}, then @value{GDBN} translates between
11693 @sc{ebcdic} and Latin 1 as you print character or string values, or use
11694 character and string literals in expressions.
11695
11696 @value{GDBN} has no way to automatically recognize which character set
11697 the inferior program uses; you must tell it, using the @code{set
11698 target-charset} command, described below.
11699
11700 Here are the commands for controlling @value{GDBN}'s character set
11701 support:
11702
11703 @table @code
11704 @item set target-charset @var{charset}
11705 @kindex set target-charset
11706 Set the current target character set to @var{charset}.  To display the
11707 list of supported target character sets, type
11708 @kbd{@w{set target-charset @key{TAB}@key{TAB}}}.
11709
11710 @item set host-charset @var{charset}
11711 @kindex set host-charset
11712 Set the current host character set to @var{charset}.
11713
11714 By default, @value{GDBN} uses a host character set appropriate to the
11715 system it is running on; you can override that default using the
11716 @code{set host-charset} command.  On some systems, @value{GDBN} cannot
11717 automatically determine the appropriate host character set.  In this
11718 case, @value{GDBN} uses @samp{UTF-8}.
11719
11720 @value{GDBN} can only use certain character sets as its host character
11721 set.  If you type @kbd{@w{set host-charset @key{TAB}@key{TAB}}},
11722 @value{GDBN} will list the host character sets it supports.
11723
11724 @item set charset @var{charset}
11725 @kindex set charset
11726 Set the current host and target character sets to @var{charset}.  As
11727 above, if you type @kbd{@w{set charset @key{TAB}@key{TAB}}},
11728 @value{GDBN} will list the names of the character sets that can be used
11729 for both host and target.
11730
11731 @item show charset
11732 @kindex show charset
11733 Show the names of the current host and target character sets.
11734
11735 @item show host-charset
11736 @kindex show host-charset
11737 Show the name of the current host character set.
11738
11739 @item show target-charset
11740 @kindex show target-charset
11741 Show the name of the current target character set.
11742
11743 @item set target-wide-charset @var{charset}
11744 @kindex set target-wide-charset
11745 Set the current target's wide character set to @var{charset}.  This is
11746 the character set used by the target's @code{wchar_t} type.  To
11747 display the list of supported wide character sets, type
11748 @kbd{@w{set target-wide-charset @key{TAB}@key{TAB}}}.
11749
11750 @item show target-wide-charset
11751 @kindex show target-wide-charset
11752 Show the name of the current target's wide character set.
11753 @end table
11754
11755 Here is an example of @value{GDBN}'s character set support in action.
11756 Assume that the following source code has been placed in the file
11757 @file{charset-test.c}:
11758
11759 @smallexample
11760 #include <stdio.h>
11761
11762 char ascii_hello[]
11763   = @{72, 101, 108, 108, 111, 44, 32, 119,
11764      111, 114, 108, 100, 33, 10, 0@};
11765 char ibm1047_hello[]
11766   = @{200, 133, 147, 147, 150, 107, 64, 166,
11767      150, 153, 147, 132, 90, 37, 0@};
11768
11769 main ()
11770 @{
11771   printf ("Hello, world!\n");
11772 @}
11773 @end smallexample
11774
11775 In this program, @code{ascii_hello} and @code{ibm1047_hello} are arrays
11776 containing the string @samp{Hello, world!} followed by a newline,
11777 encoded in the @sc{ascii} and @sc{ibm1047} character sets.
11778
11779 We compile the program, and invoke the debugger on it:
11780
11781 @smallexample
11782 $ gcc -g charset-test.c -o charset-test
11783 $ gdb -nw charset-test
11784 GNU gdb 2001-12-19-cvs
11785 Copyright 2001 Free Software Foundation, Inc.
11786 @dots{}
11787 (@value{GDBP})
11788 @end smallexample
11789
11790 We can use the @code{show charset} command to see what character sets
11791 @value{GDBN} is currently using to interpret and display characters and
11792 strings:
11793
11794 @smallexample
11795 (@value{GDBP}) show charset
11796 The current host and target character set is `ISO-8859-1'.
11797 (@value{GDBP})
11798 @end smallexample
11799
11800 For the sake of printing this manual, let's use @sc{ascii} as our
11801 initial character set:
11802 @smallexample
11803 (@value{GDBP}) set charset ASCII
11804 (@value{GDBP}) show charset
11805 The current host and target character set is `ASCII'.
11806 (@value{GDBP})
11807 @end smallexample
11808
11809 Let's assume that @sc{ascii} is indeed the correct character set for our
11810 host system --- in other words, let's assume that if @value{GDBN} prints
11811 characters using the @sc{ascii} character set, our terminal will display
11812 them properly.  Since our current target character set is also
11813 @sc{ascii}, the contents of @code{ascii_hello} print legibly:
11814
11815 @smallexample
11816 (@value{GDBP}) print ascii_hello
11817 $1 = 0x401698 "Hello, world!\n"
11818 (@value{GDBP}) print ascii_hello[0]
11819 $2 = 72 'H'
11820 (@value{GDBP})
11821 @end smallexample
11822
11823 @value{GDBN} uses the target character set for character and string
11824 literals you use in expressions:
11825
11826 @smallexample
11827 (@value{GDBP}) print '+'
11828 $3 = 43 '+'
11829 (@value{GDBP})
11830 @end smallexample
11831
11832 The @sc{ascii} character set uses the number 43 to encode the @samp{+}
11833 character.
11834
11835 @value{GDBN} relies on the user to tell it which character set the
11836 target program uses.  If we print @code{ibm1047_hello} while our target
11837 character set is still @sc{ascii}, we get jibberish:
11838
11839 @smallexample
11840 (@value{GDBP}) print ibm1047_hello
11841 $4 = 0x4016a8 "\310\205\223\223\226k@@\246\226\231\223\204Z%"
11842 (@value{GDBP}) print ibm1047_hello[0]
11843 $5 = 200 '\310'
11844 (@value{GDBP})
11845 @end smallexample
11846
11847 If we invoke the @code{set target-charset} followed by @key{TAB}@key{TAB},
11848 @value{GDBN} tells us the character sets it supports:
11849
11850 @smallexample
11851 (@value{GDBP}) set target-charset
11852 ASCII       EBCDIC-US   IBM1047     ISO-8859-1
11853 (@value{GDBP}) set target-charset
11854 @end smallexample
11855
11856 We can select @sc{ibm1047} as our target character set, and examine the
11857 program's strings again.  Now the @sc{ascii} string is wrong, but
11858 @value{GDBN} translates the contents of @code{ibm1047_hello} from the
11859 target character set, @sc{ibm1047}, to the host character set,
11860 @sc{ascii}, and they display correctly:
11861
11862 @smallexample
11863 (@value{GDBP}) set target-charset IBM1047
11864 (@value{GDBP}) show charset
11865 The current host character set is `ASCII'.
11866 The current target character set is `IBM1047'.
11867 (@value{GDBP}) print ascii_hello
11868 $6 = 0x401698 "\110\145%%?\054\040\167?\162%\144\041\012"
11869 (@value{GDBP}) print ascii_hello[0]
11870 $7 = 72 '\110'
11871 (@value{GDBP}) print ibm1047_hello
11872 $8 = 0x4016a8 "Hello, world!\n"
11873 (@value{GDBP}) print ibm1047_hello[0]
11874 $9 = 200 'H'
11875 (@value{GDBP})
11876 @end smallexample
11877
11878 As above, @value{GDBN} uses the target character set for character and
11879 string literals you use in expressions:
11880
11881 @smallexample
11882 (@value{GDBP}) print '+'
11883 $10 = 78 '+'
11884 (@value{GDBP})
11885 @end smallexample
11886
11887 The @sc{ibm1047} character set uses the number 78 to encode the @samp{+}
11888 character.
11889
11890 @node Caching Target Data
11891 @section Caching Data of Targets
11892 @cindex caching data of targets
11893
11894 @value{GDBN} caches data exchanged between the debugger and a target.
11895 Each cache is associated with the address space of the inferior.
11896 @xref{Inferiors and Programs}, about inferior and address space.
11897 Such caching generally improves performance in remote debugging
11898 (@pxref{Remote Debugging}), because it reduces the overhead of the
11899 remote protocol by bundling memory reads and writes into large chunks.
11900 Unfortunately, simply caching everything would lead to incorrect results,
11901 since @value{GDBN} does not necessarily know anything about volatile
11902 values, memory-mapped I/O addresses, etc.  Furthermore, in non-stop mode
11903 (@pxref{Non-Stop Mode}) memory can be changed @emph{while} a gdb command
11904 is executing.
11905 Therefore, by default, @value{GDBN} only caches data
11906 known to be on the stack@footnote{In non-stop mode, it is moderately
11907 rare for a running thread to modify the stack of a stopped thread
11908 in a way that would interfere with a backtrace, and caching of
11909 stack reads provides a significant speed up of remote backtraces.} or
11910 in the code segment.
11911 Other regions of memory can be explicitly marked as
11912 cacheable; @pxref{Memory Region Attributes}.
11913
11914 @table @code
11915 @kindex set remotecache
11916 @item set remotecache on
11917 @itemx set remotecache off
11918 This option no longer does anything; it exists for compatibility
11919 with old scripts.
11920
11921 @kindex show remotecache
11922 @item show remotecache
11923 Show the current state of the obsolete remotecache flag.
11924
11925 @kindex set stack-cache
11926 @item set stack-cache on
11927 @itemx set stack-cache off
11928 Enable or disable caching of stack accesses.  When @code{on}, use
11929 caching.  By default, this option is @code{on}.
11930
11931 @kindex show stack-cache
11932 @item show stack-cache
11933 Show the current state of data caching for memory accesses.
11934
11935 @kindex set code-cache
11936 @item set code-cache on
11937 @itemx set code-cache off
11938 Enable or disable caching of code segment accesses.  When @code{on},
11939 use caching.  By default, this option is @code{on}.  This improves
11940 performance of disassembly in remote debugging.
11941
11942 @kindex show code-cache
11943 @item show code-cache
11944 Show the current state of target memory cache for code segment
11945 accesses.
11946
11947 @kindex info dcache
11948 @item info dcache @r{[}line@r{]}
11949 Print the information about the performance of data cache of the
11950 current inferior's address space.  The information displayed
11951 includes the dcache width and depth, and for each cache line, its
11952 number, address, and how many times it was referenced.  This
11953 command is useful for debugging the data cache operation.
11954
11955 If a line number is specified, the contents of that line will be
11956 printed in hex.
11957
11958 @item set dcache size @var{size}
11959 @cindex dcache size
11960 @kindex set dcache size
11961 Set maximum number of entries in dcache (dcache depth above).
11962
11963 @item set dcache line-size @var{line-size}
11964 @cindex dcache line-size
11965 @kindex set dcache line-size
11966 Set number of bytes each dcache entry caches (dcache width above).
11967 Must be a power of 2.
11968
11969 @item show dcache size
11970 @kindex show dcache size
11971 Show maximum number of dcache entries.  @xref{Caching Target Data, info dcache}.
11972
11973 @item show dcache line-size
11974 @kindex show dcache line-size
11975 Show default size of dcache lines.
11976
11977 @end table
11978
11979 @node Searching Memory
11980 @section Search Memory
11981 @cindex searching memory
11982
11983 Memory can be searched for a particular sequence of bytes with the
11984 @code{find} command.
11985
11986 @table @code
11987 @kindex find
11988 @item find @r{[}/@var{sn}@r{]} @var{start_addr}, +@var{len}, @var{val1} @r{[}, @var{val2}, @dots{}@r{]}
11989 @itemx find @r{[}/@var{sn}@r{]} @var{start_addr}, @var{end_addr}, @var{val1} @r{[}, @var{val2}, @dots{}@r{]}
11990 Search memory for the sequence of bytes specified by @var{val1}, @var{val2},
11991 etc.  The search begins at address @var{start_addr} and continues for either
11992 @var{len} bytes or through to @var{end_addr} inclusive.
11993 @end table
11994
11995 @var{s} and @var{n} are optional parameters.
11996 They may be specified in either order, apart or together.
11997
11998 @table @r
11999 @item @var{s}, search query size
12000 The size of each search query value.
12001
12002 @table @code
12003 @item b
12004 bytes
12005 @item h
12006 halfwords (two bytes)
12007 @item w
12008 words (four bytes)
12009 @item g
12010 giant words (eight bytes)
12011 @end table
12012
12013 All values are interpreted in the current language.
12014 This means, for example, that if the current source language is C/C@t{++}
12015 then searching for the string ``hello'' includes the trailing '\0'.
12016 The null terminator can be removed from searching by using casts,
12017 e.g.: @samp{@{char[5]@}"hello"}.
12018
12019 If the value size is not specified, it is taken from the
12020 value's type in the current language.
12021 This is useful when one wants to specify the search
12022 pattern as a mixture of types.
12023 Note that this means, for example, that in the case of C-like languages
12024 a search for an untyped 0x42 will search for @samp{(int) 0x42}
12025 which is typically four bytes.
12026
12027 @item @var{n}, maximum number of finds
12028 The maximum number of matches to print.  The default is to print all finds.
12029 @end table
12030
12031 You can use strings as search values.  Quote them with double-quotes
12032  (@code{"}).
12033 The string value is copied into the search pattern byte by byte,
12034 regardless of the endianness of the target and the size specification.
12035
12036 The address of each match found is printed as well as a count of the
12037 number of matches found.
12038
12039 The address of the last value found is stored in convenience variable
12040 @samp{$_}.
12041 A count of the number of matches is stored in @samp{$numfound}.
12042
12043 For example, if stopped at the @code{printf} in this function:
12044
12045 @smallexample
12046 void
12047 hello ()
12048 @{
12049   static char hello[] = "hello-hello";
12050   static struct @{ char c; short s; int i; @}
12051     __attribute__ ((packed)) mixed
12052     = @{ 'c', 0x1234, 0x87654321 @};
12053   printf ("%s\n", hello);
12054 @}
12055 @end smallexample
12056
12057 @noindent
12058 you get during debugging:
12059
12060 @smallexample
12061 (gdb) find &hello[0], +sizeof(hello), "hello"
12062 0x804956d <hello.1620+6>
12063 1 pattern found
12064 (gdb) find &hello[0], +sizeof(hello), 'h', 'e', 'l', 'l', 'o'
12065 0x8049567 <hello.1620>
12066 0x804956d <hello.1620+6>
12067 2 patterns found.
12068 (gdb) find &hello[0], +sizeof(hello), @{char[5]@}"hello"
12069 0x8049567 <hello.1620>
12070 0x804956d <hello.1620+6>
12071 2 patterns found.
12072 (gdb) find /b1 &hello[0], +sizeof(hello), 'h', 0x65, 'l'
12073 0x8049567 <hello.1620>
12074 1 pattern found
12075 (gdb) find &mixed, +sizeof(mixed), (char) 'c', (short) 0x1234, (int) 0x87654321
12076 0x8049560 <mixed.1625>
12077 1 pattern found
12078 (gdb) print $numfound
12079 $1 = 1
12080 (gdb) print $_
12081 $2 = (void *) 0x8049560
12082 @end smallexample
12083
12084 @node Value Sizes
12085 @section Value Sizes
12086
12087 Whenever @value{GDBN} prints a value memory will be allocated within
12088 @value{GDBN} to hold the contents of the value.  It is possible in
12089 some languages with dynamic typing systems, that an invalid program
12090 may indicate a value that is incorrectly large, this in turn may cause
12091 @value{GDBN} to try and allocate an overly large ammount of memory.
12092
12093 @table @code
12094 @kindex set max-value-size
12095 @item set max-value-size @var{bytes}
12096 @itemx set max-value-size unlimited
12097 Set the maximum size of memory that @value{GDBN} will allocate for the
12098 contents of a value to @var{bytes}, trying to display a value that
12099 requires more memory than that will result in an error.
12100
12101 Setting this variable does not effect values that have already been
12102 allocated within @value{GDBN}, only future allocations.
12103
12104 There's a minimum size that @code{max-value-size} can be set to in
12105 order that @value{GDBN} can still operate correctly, this minimum is
12106 currently 16 bytes.
12107
12108 The limit applies to the results of some subexpressions as well as to
12109 complete expressions.  For example, an expression denoting a simple
12110 integer component, such as @code{x.y.z}, may fail if the size of
12111 @var{x.y} is dynamic and exceeds @var{bytes}.  On the other hand,
12112 @value{GDBN} is sometimes clever; the expression @code{A[i]}, where
12113 @var{A} is an array variable with non-constant size, will generally
12114 succeed regardless of the bounds on @var{A}, as long as the component
12115 size is less than @var{bytes}.
12116
12117 The default value of @code{max-value-size} is currently 64k.
12118
12119 @kindex show max-value-size
12120 @item show max-value-size
12121 Show the maximum size of memory, in bytes, that @value{GDBN} will
12122 allocate for the contents of a value.
12123 @end table
12124
12125 @node Optimized Code
12126 @chapter Debugging Optimized Code
12127 @cindex optimized code, debugging
12128 @cindex debugging optimized code
12129
12130 Almost all compilers support optimization.  With optimization
12131 disabled, the compiler generates assembly code that corresponds
12132 directly to your source code, in a simplistic way.  As the compiler
12133 applies more powerful optimizations, the generated assembly code
12134 diverges from your original source code.  With help from debugging
12135 information generated by the compiler, @value{GDBN} can map from
12136 the running program back to constructs from your original source.
12137
12138 @value{GDBN} is more accurate with optimization disabled.  If you
12139 can recompile without optimization, it is easier to follow the
12140 progress of your program during debugging.  But, there are many cases
12141 where you may need to debug an optimized version.
12142
12143 When you debug a program compiled with @samp{-g -O}, remember that the
12144 optimizer has rearranged your code; the debugger shows you what is
12145 really there.  Do not be too surprised when the execution path does not
12146 exactly match your source file!  An extreme example: if you define a
12147 variable, but never use it, @value{GDBN} never sees that
12148 variable---because the compiler optimizes it out of existence.
12149
12150 Some things do not work as well with @samp{-g -O} as with just
12151 @samp{-g}, particularly on machines with instruction scheduling.  If in
12152 doubt, recompile with @samp{-g} alone, and if this fixes the problem,
12153 please report it to us as a bug (including a test case!).
12154 @xref{Variables}, for more information about debugging optimized code.
12155
12156 @menu
12157 * Inline Functions::            How @value{GDBN} presents inlining
12158 * Tail Call Frames::            @value{GDBN} analysis of jumps to functions
12159 @end menu
12160
12161 @node Inline Functions
12162 @section Inline Functions
12163 @cindex inline functions, debugging
12164
12165 @dfn{Inlining} is an optimization that inserts a copy of the function
12166 body directly at each call site, instead of jumping to a shared
12167 routine.  @value{GDBN} displays inlined functions just like
12168 non-inlined functions.  They appear in backtraces.  You can view their
12169 arguments and local variables, step into them with @code{step}, skip
12170 them with @code{next}, and escape from them with @code{finish}.
12171 You can check whether a function was inlined by using the
12172 @code{info frame} command.
12173
12174 For @value{GDBN} to support inlined functions, the compiler must
12175 record information about inlining in the debug information ---
12176 @value{NGCC} using the @sc{dwarf 2} format does this, and several
12177 other compilers do also.  @value{GDBN} only supports inlined functions
12178 when using @sc{dwarf 2}.  Versions of @value{NGCC} before 4.1
12179 do not emit two required attributes (@samp{DW_AT_call_file} and
12180 @samp{DW_AT_call_line}); @value{GDBN} does not display inlined
12181 function calls with earlier versions of @value{NGCC}.  It instead
12182 displays the arguments and local variables of inlined functions as
12183 local variables in the caller.
12184
12185 The body of an inlined function is directly included at its call site;
12186 unlike a non-inlined function, there are no instructions devoted to
12187 the call.  @value{GDBN} still pretends that the call site and the
12188 start of the inlined function are different instructions.  Stepping to
12189 the call site shows the call site, and then stepping again shows
12190 the first line of the inlined function, even though no additional
12191 instructions are executed.
12192
12193 This makes source-level debugging much clearer; you can see both the
12194 context of the call and then the effect of the call.  Only stepping by
12195 a single instruction using @code{stepi} or @code{nexti} does not do
12196 this; single instruction steps always show the inlined body.
12197
12198 There are some ways that @value{GDBN} does not pretend that inlined
12199 function calls are the same as normal calls:
12200
12201 @itemize @bullet
12202 @item
12203 Setting breakpoints at the call site of an inlined function may not
12204 work, because the call site does not contain any code.  @value{GDBN}
12205 may incorrectly move the breakpoint to the next line of the enclosing
12206 function, after the call.  This limitation will be removed in a future
12207 version of @value{GDBN}; until then, set a breakpoint on an earlier line
12208 or inside the inlined function instead.
12209
12210 @item
12211 @value{GDBN} cannot locate the return value of inlined calls after
12212 using the @code{finish} command.  This is a limitation of compiler-generated
12213 debugging information; after @code{finish}, you can step to the next line
12214 and print a variable where your program stored the return value.
12215
12216 @end itemize
12217
12218 @node Tail Call Frames
12219 @section Tail Call Frames
12220 @cindex tail call frames, debugging
12221
12222 Function @code{B} can call function @code{C} in its very last statement.  In
12223 unoptimized compilation the call of @code{C} is immediately followed by return
12224 instruction at the end of @code{B} code.  Optimizing compiler may replace the
12225 call and return in function @code{B} into one jump to function @code{C}
12226 instead.  Such use of a jump instruction is called @dfn{tail call}.
12227
12228 During execution of function @code{C}, there will be no indication in the
12229 function call stack frames that it was tail-called from @code{B}.  If function
12230 @code{A} regularly calls function @code{B} which tail-calls function @code{C},
12231 then @value{GDBN} will see @code{A} as the caller of @code{C}.  However, in
12232 some cases @value{GDBN} can determine that @code{C} was tail-called from
12233 @code{B}, and it will then create fictitious call frame for that, with the
12234 return address set up as if @code{B} called @code{C} normally.
12235
12236 This functionality is currently supported only by DWARF 2 debugging format and
12237 the compiler has to produce @samp{DW_TAG_call_site} tags.  With
12238 @value{NGCC}, you need to specify @option{-O -g} during compilation, to get
12239 this information.
12240
12241 @kbd{info frame} command (@pxref{Frame Info}) will indicate the tail call frame
12242 kind by text @code{tail call frame} such as in this sample @value{GDBN} output:
12243
12244 @smallexample
12245 (gdb) x/i $pc - 2
12246    0x40066b <b(int, double)+11>: jmp 0x400640 <c(int, double)>
12247 (gdb) info frame
12248 Stack level 1, frame at 0x7fffffffda30:
12249  rip = 0x40066d in b (amd64-entry-value.cc:59); saved rip 0x4004c5
12250  tail call frame, caller of frame at 0x7fffffffda30
12251  source language c++.
12252  Arglist at unknown address.
12253  Locals at unknown address, Previous frame's sp is 0x7fffffffda30
12254 @end smallexample
12255
12256 The detection of all the possible code path executions can find them ambiguous.
12257 There is no execution history stored (possible @ref{Reverse Execution} is never
12258 used for this purpose) and the last known caller could have reached the known
12259 callee by multiple different jump sequences.  In such case @value{GDBN} still
12260 tries to show at least all the unambiguous top tail callers and all the
12261 unambiguous bottom tail calees, if any.
12262
12263 @table @code
12264 @anchor{set debug entry-values}
12265 @item set debug entry-values
12266 @kindex set debug entry-values
12267 When set to on, enables printing of analysis messages for both frame argument
12268 values at function entry and tail calls.  It will show all the possible valid
12269 tail calls code paths it has considered.  It will also print the intersection
12270 of them with the final unambiguous (possibly partial or even empty) code path
12271 result.
12272
12273 @item show debug entry-values
12274 @kindex show debug entry-values
12275 Show the current state of analysis messages printing for both frame argument
12276 values at function entry and tail calls.
12277 @end table
12278
12279 The analysis messages for tail calls can for example show why the virtual tail
12280 call frame for function @code{c} has not been recognized (due to the indirect
12281 reference by variable @code{x}):
12282
12283 @smallexample
12284 static void __attribute__((noinline, noclone)) c (void);
12285 void (*x) (void) = c;
12286 static void __attribute__((noinline, noclone)) a (void) @{ x++; @}
12287 static void __attribute__((noinline, noclone)) c (void) @{ a (); @}
12288 int main (void) @{ x (); return 0; @}
12289
12290 Breakpoint 1, DW_OP_entry_value resolving cannot find
12291 DW_TAG_call_site 0x40039a in main
12292 a () at t.c:3
12293 3       static void __attribute__((noinline, noclone)) a (void) @{ x++; @}
12294 (gdb) bt
12295 #0  a () at t.c:3
12296 #1  0x000000000040039a in main () at t.c:5
12297 @end smallexample
12298
12299 Another possibility is an ambiguous virtual tail call frames resolution:
12300
12301 @smallexample
12302 int i;
12303 static void __attribute__((noinline, noclone)) f (void) @{ i++; @}
12304 static void __attribute__((noinline, noclone)) e (void) @{ f (); @}
12305 static void __attribute__((noinline, noclone)) d (void) @{ f (); @}
12306 static void __attribute__((noinline, noclone)) c (void) @{ d (); @}
12307 static void __attribute__((noinline, noclone)) b (void)
12308 @{ if (i) c (); else e (); @}
12309 static void __attribute__((noinline, noclone)) a (void) @{ b (); @}
12310 int main (void) @{ a (); return 0; @}
12311
12312 tailcall: initial: 0x4004d2(a) 0x4004ce(b) 0x4004b2(c) 0x4004a2(d)
12313 tailcall: compare: 0x4004d2(a) 0x4004cc(b) 0x400492(e)
12314 tailcall: reduced: 0x4004d2(a) |
12315 (gdb) bt
12316 #0  f () at t.c:2
12317 #1  0x00000000004004d2 in a () at t.c:8
12318 #2  0x0000000000400395 in main () at t.c:9
12319 @end smallexample
12320
12321 @set CALLSEQ1A @code{main@value{ARROW}a@value{ARROW}b@value{ARROW}c@value{ARROW}d@value{ARROW}f}
12322 @set CALLSEQ2A @code{main@value{ARROW}a@value{ARROW}b@value{ARROW}e@value{ARROW}f}
12323
12324 @c Convert CALLSEQ#A to CALLSEQ#B depending on HAVE_MAKEINFO_CLICK.
12325 @ifset HAVE_MAKEINFO_CLICK
12326 @set ARROW @click{}
12327 @set CALLSEQ1B @clicksequence{@value{CALLSEQ1A}}
12328 @set CALLSEQ2B @clicksequence{@value{CALLSEQ2A}}
12329 @end ifset
12330 @ifclear HAVE_MAKEINFO_CLICK
12331 @set ARROW ->
12332 @set CALLSEQ1B @value{CALLSEQ1A}
12333 @set CALLSEQ2B @value{CALLSEQ2A}
12334 @end ifclear
12335
12336 Frames #0 and #2 are real, #1 is a virtual tail call frame.
12337 The code can have possible execution paths @value{CALLSEQ1B} or
12338 @value{CALLSEQ2B}, @value{GDBN} cannot find which one from the inferior state.
12339
12340 @code{initial:} state shows some random possible calling sequence @value{GDBN}
12341 has found.  It then finds another possible calling sequcen - that one is
12342 prefixed by @code{compare:}.  The non-ambiguous intersection of these two is
12343 printed as the @code{reduced:} calling sequence.  That one could have many
12344 futher @code{compare:} and @code{reduced:} statements as long as there remain
12345 any non-ambiguous sequence entries.
12346
12347 For the frame of function @code{b} in both cases there are different possible
12348 @code{$pc} values (@code{0x4004cc} or @code{0x4004ce}), therefore this frame is
12349 also ambigous.  The only non-ambiguous frame is the one for function @code{a},
12350 therefore this one is displayed to the user while the ambiguous frames are
12351 omitted.
12352
12353 There can be also reasons why printing of frame argument values at function
12354 entry may fail:
12355
12356 @smallexample
12357 int v;
12358 static void __attribute__((noinline, noclone)) c (int i) @{ v++; @}
12359 static void __attribute__((noinline, noclone)) a (int i);
12360 static void __attribute__((noinline, noclone)) b (int i) @{ a (i); @}
12361 static void __attribute__((noinline, noclone)) a (int i)
12362 @{ if (i) b (i - 1); else c (0); @}
12363 int main (void) @{ a (5); return 0; @}
12364
12365 (gdb) bt
12366 #0  c (i=i@@entry=0) at t.c:2
12367 #1  0x0000000000400428 in a (DW_OP_entry_value resolving has found
12368 function "a" at 0x400420 can call itself via tail calls
12369 i=<optimized out>) at t.c:6
12370 #2  0x000000000040036e in main () at t.c:7
12371 @end smallexample
12372
12373 @value{GDBN} cannot find out from the inferior state if and how many times did
12374 function @code{a} call itself (via function @code{b}) as these calls would be
12375 tail calls.  Such tail calls would modify thue @code{i} variable, therefore
12376 @value{GDBN} cannot be sure the value it knows would be right - @value{GDBN}
12377 prints @code{<optimized out>} instead.
12378
12379 @node Macros
12380 @chapter C Preprocessor Macros
12381
12382 Some languages, such as C and C@t{++}, provide a way to define and invoke
12383 ``preprocessor macros'' which expand into strings of tokens.
12384 @value{GDBN} can evaluate expressions containing macro invocations, show
12385 the result of macro expansion, and show a macro's definition, including
12386 where it was defined.
12387
12388 You may need to compile your program specially to provide @value{GDBN}
12389 with information about preprocessor macros.  Most compilers do not
12390 include macros in their debugging information, even when you compile
12391 with the @option{-g} flag.  @xref{Compilation}.
12392
12393 A program may define a macro at one point, remove that definition later,
12394 and then provide a different definition after that.  Thus, at different
12395 points in the program, a macro may have different definitions, or have
12396 no definition at all.  If there is a current stack frame, @value{GDBN}
12397 uses the macros in scope at that frame's source code line.  Otherwise,
12398 @value{GDBN} uses the macros in scope at the current listing location;
12399 see @ref{List}.
12400
12401 Whenever @value{GDBN} evaluates an expression, it always expands any
12402 macro invocations present in the expression.  @value{GDBN} also provides
12403 the following commands for working with macros explicitly.
12404
12405 @table @code
12406
12407 @kindex macro expand
12408 @cindex macro expansion, showing the results of preprocessor
12409 @cindex preprocessor macro expansion, showing the results of
12410 @cindex expanding preprocessor macros
12411 @item macro expand @var{expression}
12412 @itemx macro exp @var{expression}
12413 Show the results of expanding all preprocessor macro invocations in
12414 @var{expression}.  Since @value{GDBN} simply expands macros, but does
12415 not parse the result, @var{expression} need not be a valid expression;
12416 it can be any string of tokens.
12417
12418 @kindex macro exp1
12419 @item macro expand-once @var{expression}
12420 @itemx macro exp1 @var{expression}
12421 @cindex expand macro once
12422 @i{(This command is not yet implemented.)}  Show the results of
12423 expanding those preprocessor macro invocations that appear explicitly in
12424 @var{expression}.  Macro invocations appearing in that expansion are
12425 left unchanged.  This command allows you to see the effect of a
12426 particular macro more clearly, without being confused by further
12427 expansions.  Since @value{GDBN} simply expands macros, but does not
12428 parse the result, @var{expression} need not be a valid expression; it
12429 can be any string of tokens.
12430
12431 @kindex info macro
12432 @cindex macro definition, showing
12433 @cindex definition of a macro, showing
12434 @cindex macros, from debug info
12435 @item info macro [-a|-all] [--] @var{macro}
12436 Show the current definition or all definitions of the named @var{macro},
12437 and describe the source location or compiler command-line where that
12438 definition was established.  The optional double dash is to signify the end of
12439 argument processing and the beginning of @var{macro} for non C-like macros where
12440 the macro may begin with a hyphen.
12441
12442 @kindex info macros
12443 @item info macros @var{location}
12444 Show all macro definitions that are in effect at the location specified
12445 by @var{location},  and describe the source location or compiler
12446 command-line where those definitions were established.
12447
12448 @kindex macro define
12449 @cindex user-defined macros
12450 @cindex defining macros interactively
12451 @cindex macros, user-defined
12452 @item macro define @var{macro} @var{replacement-list}
12453 @itemx macro define @var{macro}(@var{arglist}) @var{replacement-list}
12454 Introduce a definition for a preprocessor macro named @var{macro},
12455 invocations of which are replaced by the tokens given in
12456 @var{replacement-list}.  The first form of this command defines an
12457 ``object-like'' macro, which takes no arguments; the second form
12458 defines a ``function-like'' macro, which takes the arguments given in
12459 @var{arglist}.
12460
12461 A definition introduced by this command is in scope in every
12462 expression evaluated in @value{GDBN}, until it is removed with the
12463 @code{macro undef} command, described below.  The definition overrides
12464 all definitions for @var{macro} present in the program being debugged,
12465 as well as any previous user-supplied definition.
12466
12467 @kindex macro undef
12468 @item macro undef @var{macro}
12469 Remove any user-supplied definition for the macro named @var{macro}.
12470 This command only affects definitions provided with the @code{macro
12471 define} command, described above; it cannot remove definitions present
12472 in the program being debugged.
12473
12474 @kindex macro list
12475 @item macro list
12476 List all the macros defined using the @code{macro define} command.
12477 @end table
12478
12479 @cindex macros, example of debugging with
12480 Here is a transcript showing the above commands in action.  First, we
12481 show our source files:
12482
12483 @smallexample
12484 $ cat sample.c
12485 #include <stdio.h>
12486 #include "sample.h"
12487
12488 #define M 42
12489 #define ADD(x) (M + x)
12490
12491 main ()
12492 @{
12493 #define N 28
12494   printf ("Hello, world!\n");
12495 #undef N
12496   printf ("We're so creative.\n");
12497 #define N 1729
12498   printf ("Goodbye, world!\n");
12499 @}
12500 $ cat sample.h
12501 #define Q <
12502 $
12503 @end smallexample
12504
12505 Now, we compile the program using the @sc{gnu} C compiler,
12506 @value{NGCC}.  We pass the @option{-gdwarf-2}@footnote{This is the
12507 minimum.  Recent versions of @value{NGCC} support @option{-gdwarf-3}
12508 and @option{-gdwarf-4}; we recommend always choosing the most recent
12509 version of DWARF.} @emph{and} @option{-g3} flags to ensure the compiler
12510 includes information about preprocessor macros in the debugging
12511 information.
12512
12513 @smallexample
12514 $ gcc -gdwarf-2 -g3 sample.c -o sample
12515 $
12516 @end smallexample
12517
12518 Now, we start @value{GDBN} on our sample program:
12519
12520 @smallexample
12521 $ gdb -nw sample
12522 GNU gdb 2002-05-06-cvs
12523 Copyright 2002 Free Software Foundation, Inc.
12524 GDB is free software, @dots{}
12525 (@value{GDBP})
12526 @end smallexample
12527
12528 We can expand macros and examine their definitions, even when the
12529 program is not running.  @value{GDBN} uses the current listing position
12530 to decide which macro definitions are in scope:
12531
12532 @smallexample
12533 (@value{GDBP}) list main
12534 3
12535 4       #define M 42
12536 5       #define ADD(x) (M + x)
12537 6
12538 7       main ()
12539 8       @{
12540 9       #define N 28
12541 10        printf ("Hello, world!\n");
12542 11      #undef N
12543 12        printf ("We're so creative.\n");
12544 (@value{GDBP}) info macro ADD
12545 Defined at /home/jimb/gdb/macros/play/sample.c:5
12546 #define ADD(x) (M + x)
12547 (@value{GDBP}) info macro Q
12548 Defined at /home/jimb/gdb/macros/play/sample.h:1
12549   included at /home/jimb/gdb/macros/play/sample.c:2
12550 #define Q <
12551 (@value{GDBP}) macro expand ADD(1)
12552 expands to: (42 + 1)
12553 (@value{GDBP}) macro expand-once ADD(1)
12554 expands to: once (M + 1)
12555 (@value{GDBP})
12556 @end smallexample
12557
12558 In the example above, note that @code{macro expand-once} expands only
12559 the macro invocation explicit in the original text --- the invocation of
12560 @code{ADD} --- but does not expand the invocation of the macro @code{M},
12561 which was introduced by @code{ADD}.
12562
12563 Once the program is running, @value{GDBN} uses the macro definitions in
12564 force at the source line of the current stack frame:
12565
12566 @smallexample
12567 (@value{GDBP}) break main
12568 Breakpoint 1 at 0x8048370: file sample.c, line 10.
12569 (@value{GDBP}) run
12570 Starting program: /home/jimb/gdb/macros/play/sample
12571
12572 Breakpoint 1, main () at sample.c:10
12573 10        printf ("Hello, world!\n");
12574 (@value{GDBP})
12575 @end smallexample
12576
12577 At line 10, the definition of the macro @code{N} at line 9 is in force:
12578
12579 @smallexample
12580 (@value{GDBP}) info macro N
12581 Defined at /home/jimb/gdb/macros/play/sample.c:9
12582 #define N 28
12583 (@value{GDBP}) macro expand N Q M
12584 expands to: 28 < 42
12585 (@value{GDBP}) print N Q M
12586 $1 = 1
12587 (@value{GDBP})
12588 @end smallexample
12589
12590 As we step over directives that remove @code{N}'s definition, and then
12591 give it a new definition, @value{GDBN} finds the definition (or lack
12592 thereof) in force at each point:
12593
12594 @smallexample
12595 (@value{GDBP}) next
12596 Hello, world!
12597 12        printf ("We're so creative.\n");
12598 (@value{GDBP}) info macro N
12599 The symbol `N' has no definition as a C/C++ preprocessor macro
12600 at /home/jimb/gdb/macros/play/sample.c:12
12601 (@value{GDBP}) next
12602 We're so creative.
12603 14        printf ("Goodbye, world!\n");
12604 (@value{GDBP}) info macro N
12605 Defined at /home/jimb/gdb/macros/play/sample.c:13
12606 #define N 1729
12607 (@value{GDBP}) macro expand N Q M
12608 expands to: 1729 < 42
12609 (@value{GDBP}) print N Q M
12610 $2 = 0
12611 (@value{GDBP})
12612 @end smallexample
12613
12614 In addition to source files, macros can be defined on the compilation command
12615 line using the @option{-D@var{name}=@var{value}} syntax.  For macros defined in
12616 such a way, @value{GDBN} displays the location of their definition as line zero
12617 of the source file submitted to the compiler.
12618
12619 @smallexample
12620 (@value{GDBP}) info macro __STDC__
12621 Defined at /home/jimb/gdb/macros/play/sample.c:0
12622 -D__STDC__=1
12623 (@value{GDBP})
12624 @end smallexample
12625
12626
12627 @node Tracepoints
12628 @chapter Tracepoints
12629 @c This chapter is based on the documentation written by Michael
12630 @c Snyder, David Taylor, Jim Blandy, and Elena Zannoni.
12631
12632 @cindex tracepoints
12633 In some applications, it is not feasible for the debugger to interrupt
12634 the program's execution long enough for the developer to learn
12635 anything helpful about its behavior.  If the program's correctness
12636 depends on its real-time behavior, delays introduced by a debugger
12637 might cause the program to change its behavior drastically, or perhaps
12638 fail, even when the code itself is correct.  It is useful to be able
12639 to observe the program's behavior without interrupting it.
12640
12641 Using @value{GDBN}'s @code{trace} and @code{collect} commands, you can
12642 specify locations in the program, called @dfn{tracepoints}, and
12643 arbitrary expressions to evaluate when those tracepoints are reached.
12644 Later, using the @code{tfind} command, you can examine the values
12645 those expressions had when the program hit the tracepoints.  The
12646 expressions may also denote objects in memory---structures or arrays,
12647 for example---whose values @value{GDBN} should record; while visiting
12648 a particular tracepoint, you may inspect those objects as if they were
12649 in memory at that moment.  However, because @value{GDBN} records these
12650 values without interacting with you, it can do so quickly and
12651 unobtrusively, hopefully not disturbing the program's behavior.
12652
12653 The tracepoint facility is currently available only for remote
12654 targets.  @xref{Targets}.  In addition, your remote target must know
12655 how to collect trace data.  This functionality is implemented in the
12656 remote stub; however, none of the stubs distributed with @value{GDBN}
12657 support tracepoints as of this writing.  The format of the remote
12658 packets used to implement tracepoints are described in @ref{Tracepoint
12659 Packets}.
12660
12661 It is also possible to get trace data from a file, in a manner reminiscent
12662 of corefiles; you specify the filename, and use @code{tfind} to search
12663 through the file.  @xref{Trace Files}, for more details.
12664
12665 This chapter describes the tracepoint commands and features.
12666
12667 @menu
12668 * Set Tracepoints::
12669 * Analyze Collected Data::
12670 * Tracepoint Variables::
12671 * Trace Files::
12672 @end menu
12673
12674 @node Set Tracepoints
12675 @section Commands to Set Tracepoints
12676
12677 Before running such a @dfn{trace experiment}, an arbitrary number of
12678 tracepoints can be set.  A tracepoint is actually a special type of
12679 breakpoint (@pxref{Set Breaks}), so you can manipulate it using
12680 standard breakpoint commands.  For instance, as with breakpoints,
12681 tracepoint numbers are successive integers starting from one, and many
12682 of the commands associated with tracepoints take the tracepoint number
12683 as their argument, to identify which tracepoint to work on.
12684
12685 For each tracepoint, you can specify, in advance, some arbitrary set
12686 of data that you want the target to collect in the trace buffer when
12687 it hits that tracepoint.  The collected data can include registers,
12688 local variables, or global data.  Later, you can use @value{GDBN}
12689 commands to examine the values these data had at the time the
12690 tracepoint was hit.
12691
12692 Tracepoints do not support every breakpoint feature.  Ignore counts on
12693 tracepoints have no effect, and tracepoints cannot run @value{GDBN}
12694 commands when they are hit.  Tracepoints may not be thread-specific
12695 either.
12696
12697 @cindex fast tracepoints
12698 Some targets may support @dfn{fast tracepoints}, which are inserted in
12699 a different way (such as with a jump instead of a trap), that is
12700 faster but possibly restricted in where they may be installed.
12701
12702 @cindex static tracepoints
12703 @cindex markers, static tracepoints
12704 @cindex probing markers, static tracepoints
12705 Regular and fast tracepoints are dynamic tracing facilities, meaning
12706 that they can be used to insert tracepoints at (almost) any location
12707 in the target.  Some targets may also support controlling @dfn{static
12708 tracepoints} from @value{GDBN}.  With static tracing, a set of
12709 instrumentation points, also known as @dfn{markers}, are embedded in
12710 the target program, and can be activated or deactivated by name or
12711 address.  These are usually placed at locations which facilitate
12712 investigating what the target is actually doing.  @value{GDBN}'s
12713 support for static tracing includes being able to list instrumentation
12714 points, and attach them with @value{GDBN} defined high level
12715 tracepoints that expose the whole range of convenience of
12716 @value{GDBN}'s tracepoints support.  Namely, support for collecting
12717 registers values and values of global or local (to the instrumentation
12718 point) variables; tracepoint conditions and trace state variables.
12719 The act of installing a @value{GDBN} static tracepoint on an
12720 instrumentation point, or marker, is referred to as @dfn{probing} a
12721 static tracepoint marker.
12722
12723 @code{gdbserver} supports tracepoints on some target systems.
12724 @xref{Server,,Tracepoints support in @code{gdbserver}}.
12725
12726 This section describes commands to set tracepoints and associated
12727 conditions and actions.
12728
12729 @menu
12730 * Create and Delete Tracepoints::
12731 * Enable and Disable Tracepoints::
12732 * Tracepoint Passcounts::
12733 * Tracepoint Conditions::
12734 * Trace State Variables::
12735 * Tracepoint Actions::
12736 * Listing Tracepoints::
12737 * Listing Static Tracepoint Markers::
12738 * Starting and Stopping Trace Experiments::
12739 * Tracepoint Restrictions::
12740 @end menu
12741
12742 @node Create and Delete Tracepoints
12743 @subsection Create and Delete Tracepoints
12744
12745 @table @code
12746 @cindex set tracepoint
12747 @kindex trace
12748 @item trace @var{location}
12749 The @code{trace} command is very similar to the @code{break} command.
12750 Its argument @var{location} can be any valid location.
12751 @xref{Specify Location}.  The @code{trace} command defines a tracepoint,
12752 which is a point in the target program where the debugger will briefly stop,
12753 collect some data, and then allow the program to continue.  Setting a tracepoint
12754 or changing its actions takes effect immediately if the remote stub
12755 supports the @samp{InstallInTrace} feature (@pxref{install tracepoint
12756 in tracing}).
12757 If remote stub doesn't support the @samp{InstallInTrace} feature, all
12758 these changes don't take effect until the next @code{tstart}
12759 command, and once a trace experiment is running, further changes will
12760 not have any effect until the next trace experiment starts.  In addition,
12761 @value{GDBN} supports @dfn{pending tracepoints}---tracepoints whose
12762 address is not yet resolved.  (This is similar to pending breakpoints.)
12763 Pending tracepoints are not downloaded to the target and not installed
12764 until they are resolved.  The resolution of pending tracepoints requires
12765 @value{GDBN} support---when debugging with the remote target, and
12766 @value{GDBN} disconnects from the remote stub (@pxref{disconnected
12767 tracing}), pending tracepoints can not be resolved (and downloaded to
12768 the remote stub) while @value{GDBN} is disconnected.
12769
12770 Here are some examples of using the @code{trace} command:
12771
12772 @smallexample
12773 (@value{GDBP}) @b{trace foo.c:121}    // a source file and line number
12774
12775 (@value{GDBP}) @b{trace +2}           // 2 lines forward
12776
12777 (@value{GDBP}) @b{trace my_function}  // first source line of function
12778
12779 (@value{GDBP}) @b{trace *my_function} // EXACT start address of function
12780
12781 (@value{GDBP}) @b{trace *0x2117c4}    // an address
12782 @end smallexample
12783
12784 @noindent
12785 You can abbreviate @code{trace} as @code{tr}.
12786
12787 @item trace @var{location} if @var{cond}
12788 Set a tracepoint with condition @var{cond}; evaluate the expression
12789 @var{cond} each time the tracepoint is reached, and collect data only
12790 if the value is nonzero---that is, if @var{cond} evaluates as true.
12791 @xref{Tracepoint Conditions, ,Tracepoint Conditions}, for more
12792 information on tracepoint conditions.
12793
12794 @item ftrace @var{location} [ if @var{cond} ]
12795 @cindex set fast tracepoint
12796 @cindex fast tracepoints, setting
12797 @kindex ftrace
12798 The @code{ftrace} command sets a fast tracepoint.  For targets that
12799 support them, fast tracepoints will use a more efficient but possibly
12800 less general technique to trigger data collection, such as a jump
12801 instruction instead of a trap, or some sort of hardware support.  It
12802 may not be possible to create a fast tracepoint at the desired
12803 location, in which case the command will exit with an explanatory
12804 message.
12805
12806 @value{GDBN} handles arguments to @code{ftrace} exactly as for
12807 @code{trace}.
12808
12809 On 32-bit x86-architecture systems, fast tracepoints normally need to
12810 be placed at an instruction that is 5 bytes or longer, but can be
12811 placed at 4-byte instructions if the low 64K of memory of the target
12812 program is available to install trampolines.  Some Unix-type systems,
12813 such as @sc{gnu}/Linux, exclude low addresses from the program's
12814 address space; but for instance with the Linux kernel it is possible
12815 to let @value{GDBN} use this area by doing a @command{sysctl} command
12816 to set the @code{mmap_min_addr} kernel parameter, as in
12817
12818 @example
12819 sudo sysctl -w vm.mmap_min_addr=32768
12820 @end example
12821
12822 @noindent
12823 which sets the low address to 32K, which leaves plenty of room for
12824 trampolines.  The minimum address should be set to a page boundary.
12825
12826 @item strace @var{location} [ if @var{cond} ]
12827 @cindex set static tracepoint
12828 @cindex static tracepoints, setting
12829 @cindex probe static tracepoint marker
12830 @kindex strace
12831 The @code{strace} command sets a static tracepoint.  For targets that
12832 support it, setting a static tracepoint probes a static
12833 instrumentation point, or marker, found at @var{location}.  It may not
12834 be possible to set a static tracepoint at the desired location, in
12835 which case the command will exit with an explanatory message.
12836
12837 @value{GDBN} handles arguments to @code{strace} exactly as for
12838 @code{trace}, with the addition that the user can also specify
12839 @code{-m @var{marker}} as @var{location}.  This probes the marker
12840 identified by the @var{marker} string identifier.  This identifier
12841 depends on the static tracepoint backend library your program is
12842 using.  You can find all the marker identifiers in the @samp{ID} field
12843 of the @code{info static-tracepoint-markers} command output.
12844 @xref{Listing Static Tracepoint Markers,,Listing Static Tracepoint
12845 Markers}.  For example, in the following small program using the UST
12846 tracing engine:
12847
12848 @smallexample
12849 main ()
12850 @{
12851   trace_mark(ust, bar33, "str %s", "FOOBAZ");
12852 @}
12853 @end smallexample
12854
12855 @noindent
12856 the marker id is composed of joining the first two arguments to the
12857 @code{trace_mark} call with a slash, which translates to:
12858
12859 @smallexample
12860 (@value{GDBP}) info static-tracepoint-markers
12861 Cnt Enb ID         Address            What
12862 1   n   ust/bar33  0x0000000000400ddc in main at stexample.c:22
12863          Data: "str %s"
12864 [etc...]
12865 @end smallexample
12866
12867 @noindent
12868 so you may probe the marker above with:
12869
12870 @smallexample
12871 (@value{GDBP}) strace -m ust/bar33
12872 @end smallexample
12873
12874 Static tracepoints accept an extra collect action --- @code{collect
12875 $_sdata}.  This collects arbitrary user data passed in the probe point
12876 call to the tracing library.  In the UST example above, you'll see
12877 that the third argument to @code{trace_mark} is a printf-like format
12878 string.  The user data is then the result of running that formating
12879 string against the following arguments.  Note that @code{info
12880 static-tracepoint-markers} command output lists that format string in
12881 the @samp{Data:} field.
12882
12883 You can inspect this data when analyzing the trace buffer, by printing
12884 the $_sdata variable like any other variable available to
12885 @value{GDBN}.  @xref{Tracepoint Actions,,Tracepoint Action Lists}.
12886
12887 @vindex $tpnum
12888 @cindex last tracepoint number
12889 @cindex recent tracepoint number
12890 @cindex tracepoint number
12891 The convenience variable @code{$tpnum} records the tracepoint number
12892 of the most recently set tracepoint.
12893
12894 @kindex delete tracepoint
12895 @cindex tracepoint deletion
12896 @item delete tracepoint @r{[}@var{num}@r{]}
12897 Permanently delete one or more tracepoints.  With no argument, the
12898 default is to delete all tracepoints.  Note that the regular
12899 @code{delete} command can remove tracepoints also.
12900
12901 Examples:
12902
12903 @smallexample
12904 (@value{GDBP}) @b{delete trace 1 2 3} // remove three tracepoints
12905
12906 (@value{GDBP}) @b{delete trace}       // remove all tracepoints
12907 @end smallexample
12908
12909 @noindent
12910 You can abbreviate this command as @code{del tr}.
12911 @end table
12912
12913 @node Enable and Disable Tracepoints
12914 @subsection Enable and Disable Tracepoints
12915
12916 These commands are deprecated; they are equivalent to plain @code{disable} and @code{enable}.
12917
12918 @table @code
12919 @kindex disable tracepoint
12920 @item disable tracepoint @r{[}@var{num}@r{]}
12921 Disable tracepoint @var{num}, or all tracepoints if no argument
12922 @var{num} is given.  A disabled tracepoint will have no effect during
12923 a trace experiment, but it is not forgotten.  You can re-enable
12924 a disabled tracepoint using the @code{enable tracepoint} command.
12925 If the command is issued during a trace experiment and the debug target
12926 has support for disabling tracepoints during a trace experiment, then the
12927 change will be effective immediately.  Otherwise, it will be applied to the
12928 next trace experiment.
12929
12930 @kindex enable tracepoint
12931 @item enable tracepoint @r{[}@var{num}@r{]}
12932 Enable tracepoint @var{num}, or all tracepoints.  If this command is
12933 issued during a trace experiment and the debug target supports enabling
12934 tracepoints during a trace experiment, then the enabled tracepoints will
12935 become effective immediately.  Otherwise, they will become effective the
12936 next time a trace experiment is run.
12937 @end table
12938
12939 @node Tracepoint Passcounts
12940 @subsection Tracepoint Passcounts
12941
12942 @table @code
12943 @kindex passcount
12944 @cindex tracepoint pass count
12945 @item passcount @r{[}@var{n} @r{[}@var{num}@r{]]}
12946 Set the @dfn{passcount} of a tracepoint.  The passcount is a way to
12947 automatically stop a trace experiment.  If a tracepoint's passcount is
12948 @var{n}, then the trace experiment will be automatically stopped on
12949 the @var{n}'th time that tracepoint is hit.  If the tracepoint number
12950 @var{num} is not specified, the @code{passcount} command sets the
12951 passcount of the most recently defined tracepoint.  If no passcount is
12952 given, the trace experiment will run until stopped explicitly by the
12953 user.
12954
12955 Examples:
12956
12957 @smallexample
12958 (@value{GDBP}) @b{passcount 5 2} // Stop on the 5th execution of
12959 @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// tracepoint 2}
12960
12961 (@value{GDBP}) @b{passcount 12}  // Stop on the 12th execution of the
12962 @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// most recently defined tracepoint.}
12963 (@value{GDBP}) @b{trace foo}
12964 (@value{GDBP}) @b{pass 3}
12965 (@value{GDBP}) @b{trace bar}
12966 (@value{GDBP}) @b{pass 2}
12967 (@value{GDBP}) @b{trace baz}
12968 (@value{GDBP}) @b{pass 1}        // Stop tracing when foo has been
12969 @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// executed 3 times OR when bar has}
12970 @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// been executed 2 times}
12971 @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// OR when baz has been executed 1 time.}
12972 @end smallexample
12973 @end table
12974
12975 @node Tracepoint Conditions
12976 @subsection Tracepoint Conditions
12977 @cindex conditional tracepoints
12978 @cindex tracepoint conditions
12979
12980 The simplest sort of tracepoint collects data every time your program
12981 reaches a specified place.  You can also specify a @dfn{condition} for
12982 a tracepoint.  A condition is just a Boolean expression in your
12983 programming language (@pxref{Expressions, ,Expressions}).  A
12984 tracepoint with a condition evaluates the expression each time your
12985 program reaches it, and data collection happens only if the condition
12986 is true.
12987
12988 Tracepoint conditions can be specified when a tracepoint is set, by
12989 using @samp{if} in the arguments to the @code{trace} command.
12990 @xref{Create and Delete Tracepoints, ,Setting Tracepoints}.  They can
12991 also be set or changed at any time with the @code{condition} command,
12992 just as with breakpoints.
12993
12994 Unlike breakpoint conditions, @value{GDBN} does not actually evaluate
12995 the conditional expression itself.  Instead, @value{GDBN} encodes the
12996 expression into an agent expression (@pxref{Agent Expressions})
12997 suitable for execution on the target, independently of @value{GDBN}.
12998 Global variables become raw memory locations, locals become stack
12999 accesses, and so forth.
13000
13001 For instance, suppose you have a function that is usually called
13002 frequently, but should not be called after an error has occurred.  You
13003 could use the following tracepoint command to collect data about calls
13004 of that function that happen while the error code is propagating
13005 through the program; an unconditional tracepoint could end up
13006 collecting thousands of useless trace frames that you would have to
13007 search through.
13008
13009 @smallexample
13010 (@value{GDBP}) @kbd{trace normal_operation if errcode > 0}
13011 @end smallexample
13012
13013 @node Trace State Variables
13014 @subsection Trace State Variables
13015 @cindex trace state variables
13016
13017 A @dfn{trace state variable} is a special type of variable that is
13018 created and managed by target-side code.  The syntax is the same as
13019 that for GDB's convenience variables (a string prefixed with ``$''),
13020 but they are stored on the target.  They must be created explicitly,
13021 using a @code{tvariable} command.  They are always 64-bit signed
13022 integers.
13023
13024 Trace state variables are remembered by @value{GDBN}, and downloaded
13025 to the target along with tracepoint information when the trace
13026 experiment starts.  There are no intrinsic limits on the number of
13027 trace state variables, beyond memory limitations of the target.
13028
13029 @cindex convenience variables, and trace state variables
13030 Although trace state variables are managed by the target, you can use
13031 them in print commands and expressions as if they were convenience
13032 variables; @value{GDBN} will get the current value from the target
13033 while the trace experiment is running.  Trace state variables share
13034 the same namespace as other ``$'' variables, which means that you
13035 cannot have trace state variables with names like @code{$23} or
13036 @code{$pc}, nor can you have a trace state variable and a convenience
13037 variable with the same name.
13038
13039 @table @code
13040
13041 @item tvariable $@var{name} [ = @var{expression} ]
13042 @kindex tvariable
13043 The @code{tvariable} command creates a new trace state variable named
13044 @code{$@var{name}}, and optionally gives it an initial value of
13045 @var{expression}.  The @var{expression} is evaluated when this command is
13046 entered; the result will be converted to an integer if possible,
13047 otherwise @value{GDBN} will report an error. A subsequent
13048 @code{tvariable} command specifying the same name does not create a
13049 variable, but instead assigns the supplied initial value to the
13050 existing variable of that name, overwriting any previous initial
13051 value. The default initial value is 0.
13052
13053 @item info tvariables
13054 @kindex info tvariables
13055 List all the trace state variables along with their initial values.
13056 Their current values may also be displayed, if the trace experiment is
13057 currently running.
13058
13059 @item delete tvariable @r{[} $@var{name} @dots{} @r{]}
13060 @kindex delete tvariable
13061 Delete the given trace state variables, or all of them if no arguments
13062 are specified.
13063
13064 @end table
13065
13066 @node Tracepoint Actions
13067 @subsection Tracepoint Action Lists
13068
13069 @table @code
13070 @kindex actions
13071 @cindex tracepoint actions
13072 @item actions @r{[}@var{num}@r{]}
13073 This command will prompt for a list of actions to be taken when the
13074 tracepoint is hit.  If the tracepoint number @var{num} is not
13075 specified, this command sets the actions for the one that was most
13076 recently defined (so that you can define a tracepoint and then say
13077 @code{actions} without bothering about its number).  You specify the
13078 actions themselves on the following lines, one action at a time, and
13079 terminate the actions list with a line containing just @code{end}.  So
13080 far, the only defined actions are @code{collect}, @code{teval}, and
13081 @code{while-stepping}.
13082
13083 @code{actions} is actually equivalent to @code{commands} (@pxref{Break
13084 Commands, ,Breakpoint Command Lists}), except that only the defined
13085 actions are allowed; any other @value{GDBN} command is rejected.
13086
13087 @cindex remove actions from a tracepoint
13088 To remove all actions from a tracepoint, type @samp{actions @var{num}}
13089 and follow it immediately with @samp{end}.
13090
13091 @smallexample
13092 (@value{GDBP}) @b{collect @var{data}} // collect some data
13093
13094 (@value{GDBP}) @b{while-stepping 5} // single-step 5 times, collect data
13095
13096 (@value{GDBP}) @b{end}              // signals the end of actions.
13097 @end smallexample
13098
13099 In the following example, the action list begins with @code{collect}
13100 commands indicating the things to be collected when the tracepoint is
13101 hit.  Then, in order to single-step and collect additional data
13102 following the tracepoint, a @code{while-stepping} command is used,
13103 followed by the list of things to be collected after each step in a
13104 sequence of single steps.  The @code{while-stepping} command is
13105 terminated by its own separate @code{end} command.  Lastly, the action
13106 list is terminated by an @code{end} command.
13107
13108 @smallexample
13109 (@value{GDBP}) @b{trace foo}
13110 (@value{GDBP}) @b{actions}
13111 Enter actions for tracepoint 1, one per line:
13112 > collect bar,baz
13113 > collect $regs
13114 > while-stepping 12
13115   > collect $pc, arr[i]
13116   > end
13117 end
13118 @end smallexample
13119
13120 @kindex collect @r{(tracepoints)}
13121 @item collect@r{[}/@var{mods}@r{]} @var{expr1}, @var{expr2}, @dots{}
13122 Collect values of the given expressions when the tracepoint is hit.
13123 This command accepts a comma-separated list of any valid expressions.
13124 In addition to global, static, or local variables, the following
13125 special arguments are supported:
13126
13127 @table @code
13128 @item $regs
13129 Collect all registers.
13130
13131 @item $args
13132 Collect all function arguments.
13133
13134 @item $locals
13135 Collect all local variables.
13136
13137 @item $_ret
13138 Collect the return address.  This is helpful if you want to see more
13139 of a backtrace.
13140
13141 @emph{Note:} The return address location can not always be reliably
13142 determined up front, and the wrong address / registers may end up
13143 collected instead.  On some architectures the reliability is higher
13144 for tracepoints at function entry, while on others it's the opposite.
13145 When this happens, backtracing will stop because the return address is
13146 found unavailable (unless another collect rule happened to match it).
13147
13148 @item $_probe_argc
13149 Collects the number of arguments from the static probe at which the
13150 tracepoint is located.
13151 @xref{Static Probe Points}.
13152
13153 @item $_probe_arg@var{n}
13154 @var{n} is an integer between 0 and 11.  Collects the @var{n}th argument
13155 from the static probe at which the tracepoint is located.
13156 @xref{Static Probe Points}.
13157
13158 @item $_sdata
13159 @vindex $_sdata@r{, collect}
13160 Collect static tracepoint marker specific data.  Only available for
13161 static tracepoints.  @xref{Tracepoint Actions,,Tracepoint Action
13162 Lists}.  On the UST static tracepoints library backend, an
13163 instrumentation point resembles a @code{printf} function call.  The
13164 tracing library is able to collect user specified data formatted to a
13165 character string using the format provided by the programmer that
13166 instrumented the program.  Other backends have similar mechanisms.
13167 Here's an example of a UST marker call:
13168
13169 @smallexample
13170  const char master_name[] = "$your_name";
13171  trace_mark(channel1, marker1, "hello %s", master_name)
13172 @end smallexample
13173
13174 In this case, collecting @code{$_sdata} collects the string
13175 @samp{hello $yourname}.  When analyzing the trace buffer, you can
13176 inspect @samp{$_sdata} like any other variable available to
13177 @value{GDBN}.
13178 @end table
13179
13180 You can give several consecutive @code{collect} commands, each one
13181 with a single argument, or one @code{collect} command with several
13182 arguments separated by commas; the effect is the same.
13183
13184 The optional @var{mods} changes the usual handling of the arguments.
13185 @code{s} requests that pointers to chars be handled as strings, in
13186 particular collecting the contents of the memory being pointed at, up
13187 to the first zero.  The upper bound is by default the value of the
13188 @code{print elements} variable; if @code{s} is followed by a decimal
13189 number, that is the upper bound instead.  So for instance
13190 @samp{collect/s25 mystr} collects as many as 25 characters at
13191 @samp{mystr}.
13192
13193 The command @code{info scope} (@pxref{Symbols, info scope}) is
13194 particularly useful for figuring out what data to collect.
13195
13196 @kindex teval @r{(tracepoints)}
13197 @item teval @var{expr1}, @var{expr2}, @dots{}
13198 Evaluate the given expressions when the tracepoint is hit.  This
13199 command accepts a comma-separated list of expressions.  The results
13200 are discarded, so this is mainly useful for assigning values to trace
13201 state variables (@pxref{Trace State Variables}) without adding those
13202 values to the trace buffer, as would be the case if the @code{collect}
13203 action were used.
13204
13205 @kindex while-stepping @r{(tracepoints)}
13206 @item while-stepping @var{n}
13207 Perform @var{n} single-step instruction traces after the tracepoint,
13208 collecting new data after each step.  The @code{while-stepping}
13209 command is followed by the list of what to collect while stepping
13210 (followed by its own @code{end} command):
13211
13212 @smallexample
13213 > while-stepping 12
13214   > collect $regs, myglobal
13215   > end
13216 >
13217 @end smallexample
13218
13219 @noindent
13220 Note that @code{$pc} is not automatically collected by
13221 @code{while-stepping}; you need to explicitly collect that register if
13222 you need it.  You may abbreviate @code{while-stepping} as @code{ws} or
13223 @code{stepping}.
13224
13225 @item set default-collect @var{expr1}, @var{expr2}, @dots{}
13226 @kindex set default-collect
13227 @cindex default collection action
13228 This variable is a list of expressions to collect at each tracepoint
13229 hit.  It is effectively an additional @code{collect} action prepended
13230 to every tracepoint action list.  The expressions are parsed
13231 individually for each tracepoint, so for instance a variable named
13232 @code{xyz} may be interpreted as a global for one tracepoint, and a
13233 local for another, as appropriate to the tracepoint's location.
13234
13235 @item show default-collect
13236 @kindex show default-collect
13237 Show the list of expressions that are collected by default at each
13238 tracepoint hit.
13239
13240 @end table
13241
13242 @node Listing Tracepoints
13243 @subsection Listing Tracepoints
13244
13245 @table @code
13246 @kindex info tracepoints @r{[}@var{n}@dots{}@r{]}
13247 @kindex info tp @r{[}@var{n}@dots{}@r{]}
13248 @cindex information about tracepoints
13249 @item info tracepoints @r{[}@var{num}@dots{}@r{]}
13250 Display information about the tracepoint @var{num}.  If you don't
13251 specify a tracepoint number, displays information about all the
13252 tracepoints defined so far.  The format is similar to that used for
13253 @code{info breakpoints}; in fact, @code{info tracepoints} is the same
13254 command, simply restricting itself to tracepoints.
13255
13256 A tracepoint's listing may include additional information specific to
13257 tracing:
13258
13259 @itemize @bullet
13260 @item
13261 its passcount as given by the @code{passcount @var{n}} command
13262
13263 @item
13264 the state about installed on target of each location
13265 @end itemize
13266
13267 @smallexample
13268 (@value{GDBP}) @b{info trace}
13269 Num     Type           Disp Enb Address    What
13270 1       tracepoint     keep y   0x0804ab57 in foo() at main.cxx:7
13271         while-stepping 20
13272           collect globfoo, $regs
13273         end
13274         collect globfoo2
13275         end
13276         pass count 1200 
13277 2       tracepoint     keep y   <MULTIPLE>
13278         collect $eip
13279 2.1                         y     0x0804859c in func4 at change-loc.h:35
13280         installed on target
13281 2.2                         y     0xb7ffc480 in func4 at change-loc.h:35
13282         installed on target
13283 2.3                         y     <PENDING>  set_tracepoint
13284 3       tracepoint     keep y   0x080485b1 in foo at change-loc.c:29
13285         not installed on target
13286 (@value{GDBP})
13287 @end smallexample
13288
13289 @noindent
13290 This command can be abbreviated @code{info tp}.
13291 @end table
13292
13293 @node Listing Static Tracepoint Markers
13294 @subsection Listing Static Tracepoint Markers
13295
13296 @table @code
13297 @kindex info static-tracepoint-markers
13298 @cindex information about static tracepoint markers
13299 @item info static-tracepoint-markers
13300 Display information about all static tracepoint markers defined in the
13301 program.
13302
13303 For each marker, the following columns are printed:
13304
13305 @table @emph
13306 @item Count
13307 An incrementing counter, output to help readability.  This is not a
13308 stable identifier.
13309 @item ID
13310 The marker ID, as reported by the target.
13311 @item Enabled or Disabled
13312 Probed markers are tagged with @samp{y}.  @samp{n} identifies marks
13313 that are not enabled.
13314 @item Address
13315 Where the marker is in your program, as a memory address.
13316 @item What
13317 Where the marker is in the source for your program, as a file and line
13318 number.  If the debug information included in the program does not
13319 allow @value{GDBN} to locate the source of the marker, this column
13320 will be left blank.
13321 @end table
13322
13323 @noindent
13324 In addition, the following information may be printed for each marker:
13325
13326 @table @emph
13327 @item Data
13328 User data passed to the tracing library by the marker call.  In the
13329 UST backend, this is the format string passed as argument to the
13330 marker call.
13331 @item Static tracepoints probing the marker
13332 The list of static tracepoints attached to the marker.
13333 @end table
13334
13335 @smallexample
13336 (@value{GDBP}) info static-tracepoint-markers
13337 Cnt ID         Enb Address            What
13338 1   ust/bar2   y   0x0000000000400e1a in main at stexample.c:25
13339      Data: number1 %d number2 %d
13340      Probed by static tracepoints: #2
13341 2   ust/bar33  n   0x0000000000400c87 in main at stexample.c:24
13342      Data: str %s
13343 (@value{GDBP})
13344 @end smallexample
13345 @end table
13346
13347 @node Starting and Stopping Trace Experiments
13348 @subsection Starting and Stopping Trace Experiments
13349
13350 @table @code
13351 @kindex tstart [ @var{notes} ]
13352 @cindex start a new trace experiment
13353 @cindex collected data discarded
13354 @item tstart
13355 This command starts the trace experiment, and begins collecting data.
13356 It has the side effect of discarding all the data collected in the
13357 trace buffer during the previous trace experiment.  If any arguments
13358 are supplied, they are taken as a note and stored with the trace
13359 experiment's state.  The notes may be arbitrary text, and are
13360 especially useful with disconnected tracing in a multi-user context;
13361 the notes can explain what the trace is doing, supply user contact
13362 information, and so forth.
13363
13364 @kindex tstop [ @var{notes} ]
13365 @cindex stop a running trace experiment
13366 @item tstop
13367 This command stops the trace experiment.  If any arguments are
13368 supplied, they are recorded with the experiment as a note.  This is
13369 useful if you are stopping a trace started by someone else, for
13370 instance if the trace is interfering with the system's behavior and
13371 needs to be stopped quickly.
13372
13373 @strong{Note}: a trace experiment and data collection may stop
13374 automatically if any tracepoint's passcount is reached
13375 (@pxref{Tracepoint Passcounts}), or if the trace buffer becomes full.
13376
13377 @kindex tstatus
13378 @cindex status of trace data collection
13379 @cindex trace experiment, status of
13380 @item tstatus
13381 This command displays the status of the current trace data
13382 collection.
13383 @end table
13384
13385 Here is an example of the commands we described so far:
13386
13387 @smallexample
13388 (@value{GDBP}) @b{trace gdb_c_test}
13389 (@value{GDBP}) @b{actions}
13390 Enter actions for tracepoint #1, one per line.
13391 > collect $regs,$locals,$args
13392 > while-stepping 11
13393   > collect $regs
13394   > end
13395 > end
13396 (@value{GDBP}) @b{tstart}
13397         [time passes @dots{}]
13398 (@value{GDBP}) @b{tstop}
13399 @end smallexample
13400
13401 @anchor{disconnected tracing}
13402 @cindex disconnected tracing
13403 You can choose to continue running the trace experiment even if
13404 @value{GDBN} disconnects from the target, voluntarily or
13405 involuntarily.  For commands such as @code{detach}, the debugger will
13406 ask what you want to do with the trace.  But for unexpected
13407 terminations (@value{GDBN} crash, network outage), it would be
13408 unfortunate to lose hard-won trace data, so the variable
13409 @code{disconnected-tracing} lets you decide whether the trace should
13410 continue running without @value{GDBN}.
13411
13412 @table @code
13413 @item set disconnected-tracing on
13414 @itemx set disconnected-tracing off
13415 @kindex set disconnected-tracing
13416 Choose whether a tracing run should continue to run if @value{GDBN}
13417 has disconnected from the target.  Note that @code{detach} or
13418 @code{quit} will ask you directly what to do about a running trace no
13419 matter what this variable's setting, so the variable is mainly useful
13420 for handling unexpected situations, such as loss of the network.
13421
13422 @item show disconnected-tracing
13423 @kindex show disconnected-tracing
13424 Show the current choice for disconnected tracing.
13425
13426 @end table
13427
13428 When you reconnect to the target, the trace experiment may or may not
13429 still be running; it might have filled the trace buffer in the
13430 meantime, or stopped for one of the other reasons.  If it is running,
13431 it will continue after reconnection.
13432
13433 Upon reconnection, the target will upload information about the
13434 tracepoints in effect.  @value{GDBN} will then compare that
13435 information to the set of tracepoints currently defined, and attempt
13436 to match them up, allowing for the possibility that the numbers may
13437 have changed due to creation and deletion in the meantime.  If one of
13438 the target's tracepoints does not match any in @value{GDBN}, the
13439 debugger will create a new tracepoint, so that you have a number with
13440 which to specify that tracepoint.  This matching-up process is
13441 necessarily heuristic, and it may result in useless tracepoints being
13442 created; you may simply delete them if they are of no use.
13443
13444 @cindex circular trace buffer
13445 If your target agent supports a @dfn{circular trace buffer}, then you
13446 can run a trace experiment indefinitely without filling the trace
13447 buffer; when space runs out, the agent deletes already-collected trace
13448 frames, oldest first, until there is enough room to continue
13449 collecting.  This is especially useful if your tracepoints are being
13450 hit too often, and your trace gets terminated prematurely because the
13451 buffer is full.  To ask for a circular trace buffer, simply set
13452 @samp{circular-trace-buffer} to on.  You can set this at any time,
13453 including during tracing; if the agent can do it, it will change
13454 buffer handling on the fly, otherwise it will not take effect until
13455 the next run.
13456
13457 @table @code
13458 @item set circular-trace-buffer on
13459 @itemx set circular-trace-buffer off
13460 @kindex set circular-trace-buffer
13461 Choose whether a tracing run should use a linear or circular buffer
13462 for trace data.  A linear buffer will not lose any trace data, but may
13463 fill up prematurely, while a circular buffer will discard old trace
13464 data, but it will have always room for the latest tracepoint hits.
13465
13466 @item show circular-trace-buffer
13467 @kindex show circular-trace-buffer
13468 Show the current choice for the trace buffer.  Note that this may not
13469 match the agent's current buffer handling, nor is it guaranteed to
13470 match the setting that might have been in effect during a past run,
13471 for instance if you are looking at frames from a trace file.
13472
13473 @end table
13474
13475 @table @code
13476 @item set trace-buffer-size @var{n}
13477 @itemx set trace-buffer-size unlimited
13478 @kindex set trace-buffer-size
13479 Request that the target use a trace buffer of @var{n} bytes.  Not all
13480 targets will honor the request; they may have a compiled-in size for
13481 the trace buffer, or some other limitation.  Set to a value of
13482 @code{unlimited} or @code{-1} to let the target use whatever size it
13483 likes.  This is also the default.
13484
13485 @item show trace-buffer-size
13486 @kindex show trace-buffer-size
13487 Show the current requested size for the trace buffer.  Note that this
13488 will only match the actual size if the target supports size-setting,
13489 and was able to handle the requested size.  For instance, if the
13490 target can only change buffer size between runs, this variable will
13491 not reflect the change until the next run starts.  Use @code{tstatus}
13492 to get a report of the actual buffer size.
13493 @end table
13494
13495 @table @code
13496 @item set trace-user @var{text}
13497 @kindex set trace-user
13498
13499 @item show trace-user
13500 @kindex show trace-user
13501
13502 @item set trace-notes @var{text}
13503 @kindex set trace-notes
13504 Set the trace run's notes.
13505
13506 @item show trace-notes
13507 @kindex show trace-notes
13508 Show the trace run's notes.
13509
13510 @item set trace-stop-notes @var{text}
13511 @kindex set trace-stop-notes
13512 Set the trace run's stop notes.  The handling of the note is as for
13513 @code{tstop} arguments; the set command is convenient way to fix a
13514 stop note that is mistaken or incomplete.
13515
13516 @item show trace-stop-notes
13517 @kindex show trace-stop-notes
13518 Show the trace run's stop notes.
13519
13520 @end table
13521
13522 @node Tracepoint Restrictions
13523 @subsection Tracepoint Restrictions
13524
13525 @cindex tracepoint restrictions
13526 There are a number of restrictions on the use of tracepoints.  As
13527 described above, tracepoint data gathering occurs on the target
13528 without interaction from @value{GDBN}.  Thus the full capabilities of
13529 the debugger are not available during data gathering, and then at data
13530 examination time, you will be limited by only having what was
13531 collected.  The following items describe some common problems, but it
13532 is not exhaustive, and you may run into additional difficulties not
13533 mentioned here.
13534
13535 @itemize @bullet
13536
13537 @item
13538 Tracepoint expressions are intended to gather objects (lvalues).  Thus
13539 the full flexibility of GDB's expression evaluator is not available.
13540 You cannot call functions, cast objects to aggregate types, access
13541 convenience variables or modify values (except by assignment to trace
13542 state variables).  Some language features may implicitly call
13543 functions (for instance Objective-C fields with accessors), and therefore
13544 cannot be collected either.
13545
13546 @item
13547 Collection of local variables, either individually or in bulk with
13548 @code{$locals} or @code{$args}, during @code{while-stepping} may
13549 behave erratically.  The stepping action may enter a new scope (for
13550 instance by stepping into a function), or the location of the variable
13551 may change (for instance it is loaded into a register).  The
13552 tracepoint data recorded uses the location information for the
13553 variables that is correct for the tracepoint location.  When the
13554 tracepoint is created, it is not possible, in general, to determine
13555 where the steps of a @code{while-stepping} sequence will advance the
13556 program---particularly if a conditional branch is stepped.
13557
13558 @item
13559 Collection of an incompletely-initialized or partially-destroyed object
13560 may result in something that @value{GDBN} cannot display, or displays
13561 in a misleading way.
13562
13563 @item
13564 When @value{GDBN} displays a pointer to character it automatically
13565 dereferences the pointer to also display characters of the string
13566 being pointed to.  However, collecting the pointer during tracing does
13567 not automatically collect the string.  You need to explicitly
13568 dereference the pointer and provide size information if you want to
13569 collect not only the pointer, but the memory pointed to.  For example,
13570 @code{*ptr@@50} can be used to collect the 50 element array pointed to
13571 by @code{ptr}.
13572
13573 @item
13574 It is not possible to collect a complete stack backtrace at a
13575 tracepoint.  Instead, you may collect the registers and a few hundred
13576 bytes from the stack pointer with something like @code{*(unsigned char *)$esp@@300}
13577 (adjust to use the name of the actual stack pointer register on your
13578 target architecture, and the amount of stack you wish to capture).
13579 Then the @code{backtrace} command will show a partial backtrace when
13580 using a trace frame.  The number of stack frames that can be examined
13581 depends on the sizes of the frames in the collected stack.  Note that
13582 if you ask for a block so large that it goes past the bottom of the
13583 stack, the target agent may report an error trying to read from an
13584 invalid address.
13585
13586 @item
13587 If you do not collect registers at a tracepoint, @value{GDBN} can
13588 infer that the value of @code{$pc} must be the same as the address of
13589 the tracepoint and use that when you are looking at a trace frame
13590 for that tracepoint.  However, this cannot work if the tracepoint has
13591 multiple locations (for instance if it was set in a function that was
13592 inlined), or if it has a @code{while-stepping} loop.  In those cases
13593 @value{GDBN} will warn you that it can't infer @code{$pc}, and default
13594 it to zero.
13595
13596 @end itemize
13597
13598 @node Analyze Collected Data
13599 @section Using the Collected Data
13600
13601 After the tracepoint experiment ends, you use @value{GDBN} commands
13602 for examining the trace data.  The basic idea is that each tracepoint
13603 collects a trace @dfn{snapshot} every time it is hit and another
13604 snapshot every time it single-steps.  All these snapshots are
13605 consecutively numbered from zero and go into a buffer, and you can
13606 examine them later.  The way you examine them is to @dfn{focus} on a
13607 specific trace snapshot.  When the remote stub is focused on a trace
13608 snapshot, it will respond to all @value{GDBN} requests for memory and
13609 registers by reading from the buffer which belongs to that snapshot,
13610 rather than from @emph{real} memory or registers of the program being
13611 debugged.  This means that @strong{all} @value{GDBN} commands
13612 (@code{print}, @code{info registers}, @code{backtrace}, etc.) will
13613 behave as if we were currently debugging the program state as it was
13614 when the tracepoint occurred.  Any requests for data that are not in
13615 the buffer will fail.
13616
13617 @menu
13618 * tfind::                       How to select a trace snapshot
13619 * tdump::                       How to display all data for a snapshot
13620 * save tracepoints::            How to save tracepoints for a future run
13621 @end menu
13622
13623 @node tfind
13624 @subsection @code{tfind @var{n}}
13625
13626 @kindex tfind
13627 @cindex select trace snapshot
13628 @cindex find trace snapshot
13629 The basic command for selecting a trace snapshot from the buffer is
13630 @code{tfind @var{n}}, which finds trace snapshot number @var{n},
13631 counting from zero.  If no argument @var{n} is given, the next
13632 snapshot is selected.
13633
13634 Here are the various forms of using the @code{tfind} command.
13635
13636 @table @code
13637 @item tfind start
13638 Find the first snapshot in the buffer.  This is a synonym for
13639 @code{tfind 0} (since 0 is the number of the first snapshot).
13640
13641 @item tfind none
13642 Stop debugging trace snapshots, resume @emph{live} debugging.
13643
13644 @item tfind end
13645 Same as @samp{tfind none}.
13646
13647 @item tfind
13648 No argument means find the next trace snapshot or find the first
13649 one if no trace snapshot is selected.
13650
13651 @item tfind -
13652 Find the previous trace snapshot before the current one.  This permits
13653 retracing earlier steps.
13654
13655 @item tfind tracepoint @var{num}
13656 Find the next snapshot associated with tracepoint @var{num}.  Search
13657 proceeds forward from the last examined trace snapshot.  If no
13658 argument @var{num} is given, it means find the next snapshot collected
13659 for the same tracepoint as the current snapshot.
13660
13661 @item tfind pc @var{addr}
13662 Find the next snapshot associated with the value @var{addr} of the
13663 program counter.  Search proceeds forward from the last examined trace
13664 snapshot.  If no argument @var{addr} is given, it means find the next
13665 snapshot with the same value of PC as the current snapshot.
13666
13667 @item tfind outside @var{addr1}, @var{addr2}
13668 Find the next snapshot whose PC is outside the given range of
13669 addresses (exclusive).
13670
13671 @item tfind range @var{addr1}, @var{addr2}
13672 Find the next snapshot whose PC is between @var{addr1} and
13673 @var{addr2} (inclusive).
13674
13675 @item tfind line @r{[}@var{file}:@r{]}@var{n}
13676 Find the next snapshot associated with the source line @var{n}.  If
13677 the optional argument @var{file} is given, refer to line @var{n} in
13678 that source file.  Search proceeds forward from the last examined
13679 trace snapshot.  If no argument @var{n} is given, it means find the
13680 next line other than the one currently being examined; thus saying
13681 @code{tfind line} repeatedly can appear to have the same effect as
13682 stepping from line to line in a @emph{live} debugging session.
13683 @end table
13684
13685 The default arguments for the @code{tfind} commands are specifically
13686 designed to make it easy to scan through the trace buffer.  For
13687 instance, @code{tfind} with no argument selects the next trace
13688 snapshot, and @code{tfind -} with no argument selects the previous
13689 trace snapshot.  So, by giving one @code{tfind} command, and then
13690 simply hitting @key{RET} repeatedly you can examine all the trace
13691 snapshots in order.  Or, by saying @code{tfind -} and then hitting
13692 @key{RET} repeatedly you can examine the snapshots in reverse order.
13693 The @code{tfind line} command with no argument selects the snapshot
13694 for the next source line executed.  The @code{tfind pc} command with
13695 no argument selects the next snapshot with the same program counter
13696 (PC) as the current frame.  The @code{tfind tracepoint} command with
13697 no argument selects the next trace snapshot collected by the same
13698 tracepoint as the current one.
13699
13700 In addition to letting you scan through the trace buffer manually,
13701 these commands make it easy to construct @value{GDBN} scripts that
13702 scan through the trace buffer and print out whatever collected data
13703 you are interested in.  Thus, if we want to examine the PC, FP, and SP
13704 registers from each trace frame in the buffer, we can say this:
13705
13706 @smallexample
13707 (@value{GDBP}) @b{tfind start}
13708 (@value{GDBP}) @b{while ($trace_frame != -1)}
13709 > printf "Frame %d, PC = %08X, SP = %08X, FP = %08X\n", \
13710           $trace_frame, $pc, $sp, $fp
13711 > tfind
13712 > end
13713
13714 Frame 0, PC = 0020DC64, SP = 0030BF3C, FP = 0030BF44
13715 Frame 1, PC = 0020DC6C, SP = 0030BF38, FP = 0030BF44
13716 Frame 2, PC = 0020DC70, SP = 0030BF34, FP = 0030BF44
13717 Frame 3, PC = 0020DC74, SP = 0030BF30, FP = 0030BF44
13718 Frame 4, PC = 0020DC78, SP = 0030BF2C, FP = 0030BF44
13719 Frame 5, PC = 0020DC7C, SP = 0030BF28, FP = 0030BF44
13720 Frame 6, PC = 0020DC80, SP = 0030BF24, FP = 0030BF44
13721 Frame 7, PC = 0020DC84, SP = 0030BF20, FP = 0030BF44
13722 Frame 8, PC = 0020DC88, SP = 0030BF1C, FP = 0030BF44
13723 Frame 9, PC = 0020DC8E, SP = 0030BF18, FP = 0030BF44
13724 Frame 10, PC = 00203F6C, SP = 0030BE3C, FP = 0030BF14
13725 @end smallexample
13726
13727 Or, if we want to examine the variable @code{X} at each source line in
13728 the buffer:
13729
13730 @smallexample
13731 (@value{GDBP}) @b{tfind start}
13732 (@value{GDBP}) @b{while ($trace_frame != -1)}
13733 > printf "Frame %d, X == %d\n", $trace_frame, X
13734 > tfind line
13735 > end
13736
13737 Frame 0, X = 1
13738 Frame 7, X = 2
13739 Frame 13, X = 255
13740 @end smallexample
13741
13742 @node tdump
13743 @subsection @code{tdump}
13744 @kindex tdump
13745 @cindex dump all data collected at tracepoint
13746 @cindex tracepoint data, display
13747
13748 This command takes no arguments.  It prints all the data collected at
13749 the current trace snapshot.
13750
13751 @smallexample
13752 (@value{GDBP}) @b{trace 444}
13753 (@value{GDBP}) @b{actions}
13754 Enter actions for tracepoint #2, one per line:
13755 > collect $regs, $locals, $args, gdb_long_test
13756 > end
13757
13758 (@value{GDBP}) @b{tstart}
13759
13760 (@value{GDBP}) @b{tfind line 444}
13761 #0  gdb_test (p1=0x11, p2=0x22, p3=0x33, p4=0x44, p5=0x55, p6=0x66)
13762 at gdb_test.c:444
13763 444        printp( "%s: arguments = 0x%X 0x%X 0x%X 0x%X 0x%X 0x%X\n", )
13764
13765 (@value{GDBP}) @b{tdump}
13766 Data collected at tracepoint 2, trace frame 1:
13767 d0             0xc4aa0085       -995491707
13768 d1             0x18     24
13769 d2             0x80     128
13770 d3             0x33     51
13771 d4             0x71aea3d        119204413
13772 d5             0x22     34
13773 d6             0xe0     224
13774 d7             0x380035 3670069
13775 a0             0x19e24a 1696330
13776 a1             0x3000668        50333288
13777 a2             0x100    256
13778 a3             0x322000 3284992
13779 a4             0x3000698        50333336
13780 a5             0x1ad3cc 1758156
13781 fp             0x30bf3c 0x30bf3c
13782 sp             0x30bf34 0x30bf34
13783 ps             0x0      0
13784 pc             0x20b2c8 0x20b2c8
13785 fpcontrol      0x0      0
13786 fpstatus       0x0      0
13787 fpiaddr        0x0      0
13788 p = 0x20e5b4 "gdb-test"
13789 p1 = (void *) 0x11
13790 p2 = (void *) 0x22
13791 p3 = (void *) 0x33
13792 p4 = (void *) 0x44
13793 p5 = (void *) 0x55
13794 p6 = (void *) 0x66
13795 gdb_long_test = 17 '\021'
13796
13797 (@value{GDBP})
13798 @end smallexample
13799
13800 @code{tdump} works by scanning the tracepoint's current collection
13801 actions and printing the value of each expression listed.  So
13802 @code{tdump} can fail, if after a run, you change the tracepoint's
13803 actions to mention variables that were not collected during the run.
13804
13805 Also, for tracepoints with @code{while-stepping} loops, @code{tdump}
13806 uses the collected value of @code{$pc} to distinguish between trace
13807 frames that were collected at the tracepoint hit, and frames that were
13808 collected while stepping.  This allows it to correctly choose whether
13809 to display the basic list of collections, or the collections from the
13810 body of the while-stepping loop.  However, if @code{$pc} was not collected,
13811 then @code{tdump} will always attempt to dump using the basic collection
13812 list, and may fail if a while-stepping frame does not include all the
13813 same data that is collected at the tracepoint hit.
13814 @c This is getting pretty arcane, example would be good.
13815
13816 @node save tracepoints
13817 @subsection @code{save tracepoints @var{filename}}
13818 @kindex save tracepoints
13819 @kindex save-tracepoints
13820 @cindex save tracepoints for future sessions
13821
13822 This command saves all current tracepoint definitions together with
13823 their actions and passcounts, into a file @file{@var{filename}}
13824 suitable for use in a later debugging session.  To read the saved
13825 tracepoint definitions, use the @code{source} command (@pxref{Command
13826 Files}).  The @w{@code{save-tracepoints}} command is a deprecated
13827 alias for @w{@code{save tracepoints}}
13828
13829 @node Tracepoint Variables
13830 @section Convenience Variables for Tracepoints
13831 @cindex tracepoint variables
13832 @cindex convenience variables for tracepoints
13833
13834 @table @code
13835 @vindex $trace_frame
13836 @item (int) $trace_frame
13837 The current trace snapshot (a.k.a.@: @dfn{frame}) number, or -1 if no
13838 snapshot is selected.
13839
13840 @vindex $tracepoint
13841 @item (int) $tracepoint
13842 The tracepoint for the current trace snapshot.
13843
13844 @vindex $trace_line
13845 @item (int) $trace_line
13846 The line number for the current trace snapshot.
13847
13848 @vindex $trace_file
13849 @item (char []) $trace_file
13850 The source file for the current trace snapshot.
13851
13852 @vindex $trace_func
13853 @item (char []) $trace_func
13854 The name of the function containing @code{$tracepoint}.
13855 @end table
13856
13857 Note: @code{$trace_file} is not suitable for use in @code{printf},
13858 use @code{output} instead.
13859
13860 Here's a simple example of using these convenience variables for
13861 stepping through all the trace snapshots and printing some of their
13862 data.  Note that these are not the same as trace state variables,
13863 which are managed by the target.
13864
13865 @smallexample
13866 (@value{GDBP}) @b{tfind start}
13867
13868 (@value{GDBP}) @b{while $trace_frame != -1}
13869 > output $trace_file
13870 > printf ", line %d (tracepoint #%d)\n", $trace_line, $tracepoint
13871 > tfind
13872 > end
13873 @end smallexample
13874
13875 @node Trace Files
13876 @section Using Trace Files
13877 @cindex trace files
13878
13879 In some situations, the target running a trace experiment may no
13880 longer be available; perhaps it crashed, or the hardware was needed
13881 for a different activity.  To handle these cases, you can arrange to
13882 dump the trace data into a file, and later use that file as a source
13883 of trace data, via the @code{target tfile} command.
13884
13885 @table @code
13886
13887 @kindex tsave
13888 @item tsave [ -r ] @var{filename}
13889 @itemx tsave [-ctf] @var{dirname}
13890 Save the trace data to @var{filename}.  By default, this command
13891 assumes that @var{filename} refers to the host filesystem, so if
13892 necessary @value{GDBN} will copy raw trace data up from the target and
13893 then save it.  If the target supports it, you can also supply the
13894 optional argument @code{-r} (``remote'') to direct the target to save
13895 the data directly into @var{filename} in its own filesystem, which may be
13896 more efficient if the trace buffer is very large.  (Note, however, that
13897 @code{target tfile} can only read from files accessible to the host.)
13898 By default, this command will save trace frame in tfile format.
13899 You can supply the optional argument @code{-ctf} to save data in CTF
13900 format.  The @dfn{Common Trace Format} (CTF) is proposed as a trace format
13901 that can be shared by multiple debugging and tracing tools.  Please go to
13902 @indicateurl{http://www.efficios.com/ctf} to get more information.
13903
13904 @kindex target tfile
13905 @kindex tfile
13906 @kindex target ctf
13907 @kindex ctf
13908 @item target tfile @var{filename}
13909 @itemx target ctf @var{dirname}
13910 Use the file named @var{filename} or directory named @var{dirname} as
13911 a source of trace data.  Commands that examine data work as they do with
13912 a live target, but it is not possible to run any new trace experiments.
13913 @code{tstatus} will report the state of the trace run at the moment
13914 the data was saved, as well as the current trace frame you are examining.
13915 Both @var{filename} and @var{dirname} must be on a filesystem accessible to
13916 the host.
13917
13918 @smallexample
13919 (@value{GDBP}) target ctf ctf.ctf
13920 (@value{GDBP}) tfind
13921 Found trace frame 0, tracepoint 2
13922 39            ++a;  /* set tracepoint 1 here */
13923 (@value{GDBP}) tdump
13924 Data collected at tracepoint 2, trace frame 0:
13925 i = 0
13926 a = 0
13927 b = 1 '\001'
13928 c = @{"123", "456", "789", "123", "456", "789"@}
13929 d = @{@{@{a = 1, b = 2@}, @{a = 3, b = 4@}@}, @{@{a = 5, b = 6@}, @{a = 7, b = 8@}@}@}
13930 (@value{GDBP}) p b
13931 $1 = 1
13932 @end smallexample
13933
13934 @end table
13935
13936 @node Overlays
13937 @chapter Debugging Programs That Use Overlays
13938 @cindex overlays
13939
13940 If your program is too large to fit completely in your target system's
13941 memory, you can sometimes use @dfn{overlays} to work around this
13942 problem.  @value{GDBN} provides some support for debugging programs that
13943 use overlays.
13944
13945 @menu
13946 * How Overlays Work::              A general explanation of overlays.
13947 * Overlay Commands::               Managing overlays in @value{GDBN}.
13948 * Automatic Overlay Debugging::    @value{GDBN} can find out which overlays are
13949                                    mapped by asking the inferior.
13950 * Overlay Sample Program::         A sample program using overlays.
13951 @end menu
13952
13953 @node How Overlays Work
13954 @section How Overlays Work
13955 @cindex mapped overlays
13956 @cindex unmapped overlays
13957 @cindex load address, overlay's
13958 @cindex mapped address
13959 @cindex overlay area
13960
13961 Suppose you have a computer whose instruction address space is only 64
13962 kilobytes long, but which has much more memory which can be accessed by
13963 other means: special instructions, segment registers, or memory
13964 management hardware, for example.  Suppose further that you want to
13965 adapt a program which is larger than 64 kilobytes to run on this system.
13966
13967 One solution is to identify modules of your program which are relatively
13968 independent, and need not call each other directly; call these modules
13969 @dfn{overlays}.  Separate the overlays from the main program, and place
13970 their machine code in the larger memory.  Place your main program in
13971 instruction memory, but leave at least enough space there to hold the
13972 largest overlay as well.
13973
13974 Now, to call a function located in an overlay, you must first copy that
13975 overlay's machine code from the large memory into the space set aside
13976 for it in the instruction memory, and then jump to its entry point
13977 there.
13978
13979 @c NB:  In the below the mapped area's size is greater or equal to the
13980 @c size of all overlays.  This is intentional to remind the developer
13981 @c that overlays don't necessarily need to be the same size.
13982
13983 @smallexample
13984 @group
13985     Data             Instruction            Larger
13986 Address Space       Address Space        Address Space
13987 +-----------+       +-----------+        +-----------+
13988 |           |       |           |        |           |
13989 +-----------+       +-----------+        +-----------+<-- overlay 1
13990 | program   |       |   main    |   .----| overlay 1 | load address
13991 | variables |       |  program  |   |    +-----------+
13992 | and heap  |       |           |   |    |           |
13993 +-----------+       |           |   |    +-----------+<-- overlay 2
13994 |           |       +-----------+   |    |           | load address
13995 +-----------+       |           |   |  .-| overlay 2 |
13996                     |           |   |  | |           |
13997          mapped --->+-----------+   |  | +-----------+
13998          address    |           |   |  | |           |
13999                     |  overlay  | <-'  | |           |
14000                     |   area    |  <---' +-----------+<-- overlay 3
14001                     |           | <---.  |           | load address
14002                     +-----------+     `--| overlay 3 |
14003                     |           |        |           |
14004                     +-----------+        |           |
14005                                          +-----------+
14006                                          |           |
14007                                          +-----------+
14008
14009                     @anchor{A code overlay}A code overlay
14010 @end group
14011 @end smallexample
14012
14013 The diagram (@pxref{A code overlay}) shows a system with separate data
14014 and instruction address spaces.  To map an overlay, the program copies
14015 its code from the larger address space to the instruction address space.
14016 Since the overlays shown here all use the same mapped address, only one
14017 may be mapped at a time.  For a system with a single address space for
14018 data and instructions, the diagram would be similar, except that the
14019 program variables and heap would share an address space with the main
14020 program and the overlay area.
14021
14022 An overlay loaded into instruction memory and ready for use is called a
14023 @dfn{mapped} overlay; its @dfn{mapped address} is its address in the
14024 instruction memory.  An overlay not present (or only partially present)
14025 in instruction memory is called @dfn{unmapped}; its @dfn{load address}
14026 is its address in the larger memory.  The mapped address is also called
14027 the @dfn{virtual memory address}, or @dfn{VMA}; the load address is also
14028 called the @dfn{load memory address}, or @dfn{LMA}.
14029
14030 Unfortunately, overlays are not a completely transparent way to adapt a
14031 program to limited instruction memory.  They introduce a new set of
14032 global constraints you must keep in mind as you design your program:
14033
14034 @itemize @bullet
14035
14036 @item
14037 Before calling or returning to a function in an overlay, your program
14038 must make sure that overlay is actually mapped.  Otherwise, the call or
14039 return will transfer control to the right address, but in the wrong
14040 overlay, and your program will probably crash.
14041
14042 @item
14043 If the process of mapping an overlay is expensive on your system, you
14044 will need to choose your overlays carefully to minimize their effect on
14045 your program's performance.
14046
14047 @item
14048 The executable file you load onto your system must contain each
14049 overlay's instructions, appearing at the overlay's load address, not its
14050 mapped address.  However, each overlay's instructions must be relocated
14051 and its symbols defined as if the overlay were at its mapped address.
14052 You can use GNU linker scripts to specify different load and relocation
14053 addresses for pieces of your program; see @ref{Overlay Description,,,
14054 ld.info, Using ld: the GNU linker}.
14055
14056 @item
14057 The procedure for loading executable files onto your system must be able
14058 to load their contents into the larger address space as well as the
14059 instruction and data spaces.
14060
14061 @end itemize
14062
14063 The overlay system described above is rather simple, and could be
14064 improved in many ways:
14065
14066 @itemize @bullet
14067
14068 @item
14069 If your system has suitable bank switch registers or memory management
14070 hardware, you could use those facilities to make an overlay's load area
14071 contents simply appear at their mapped address in instruction space.
14072 This would probably be faster than copying the overlay to its mapped
14073 area in the usual way.
14074
14075 @item
14076 If your overlays are small enough, you could set aside more than one
14077 overlay area, and have more than one overlay mapped at a time.
14078
14079 @item
14080 You can use overlays to manage data, as well as instructions.  In
14081 general, data overlays are even less transparent to your design than
14082 code overlays: whereas code overlays only require care when you call or
14083 return to functions, data overlays require care every time you access
14084 the data.  Also, if you change the contents of a data overlay, you
14085 must copy its contents back out to its load address before you can copy a
14086 different data overlay into the same mapped area.
14087
14088 @end itemize
14089
14090
14091 @node Overlay Commands
14092 @section Overlay Commands
14093
14094 To use @value{GDBN}'s overlay support, each overlay in your program must
14095 correspond to a separate section of the executable file.  The section's
14096 virtual memory address and load memory address must be the overlay's
14097 mapped and load addresses.  Identifying overlays with sections allows
14098 @value{GDBN} to determine the appropriate address of a function or
14099 variable, depending on whether the overlay is mapped or not.
14100
14101 @value{GDBN}'s overlay commands all start with the word @code{overlay};
14102 you can abbreviate this as @code{ov} or @code{ovly}.  The commands are:
14103
14104 @table @code
14105 @item overlay off
14106 @kindex overlay
14107 Disable @value{GDBN}'s overlay support.  When overlay support is
14108 disabled, @value{GDBN} assumes that all functions and variables are
14109 always present at their mapped addresses.  By default, @value{GDBN}'s
14110 overlay support is disabled.
14111
14112 @item overlay manual
14113 @cindex manual overlay debugging
14114 Enable @dfn{manual} overlay debugging.  In this mode, @value{GDBN}
14115 relies on you to tell it which overlays are mapped, and which are not,
14116 using the @code{overlay map-overlay} and @code{overlay unmap-overlay}
14117 commands described below.
14118
14119 @item overlay map-overlay @var{overlay}
14120 @itemx overlay map @var{overlay}
14121 @cindex map an overlay
14122 Tell @value{GDBN} that @var{overlay} is now mapped; @var{overlay} must
14123 be the name of the object file section containing the overlay.  When an
14124 overlay is mapped, @value{GDBN} assumes it can find the overlay's
14125 functions and variables at their mapped addresses.  @value{GDBN} assumes
14126 that any other overlays whose mapped ranges overlap that of
14127 @var{overlay} are now unmapped.
14128
14129 @item overlay unmap-overlay @var{overlay}
14130 @itemx overlay unmap @var{overlay}
14131 @cindex unmap an overlay
14132 Tell @value{GDBN} that @var{overlay} is no longer mapped; @var{overlay}
14133 must be the name of the object file section containing the overlay.
14134 When an overlay is unmapped, @value{GDBN} assumes it can find the
14135 overlay's functions and variables at their load addresses.
14136
14137 @item overlay auto
14138 Enable @dfn{automatic} overlay debugging.  In this mode, @value{GDBN}
14139 consults a data structure the overlay manager maintains in the inferior
14140 to see which overlays are mapped.  For details, see @ref{Automatic
14141 Overlay Debugging}.
14142
14143 @item overlay load-target
14144 @itemx overlay load
14145 @cindex reloading the overlay table
14146 Re-read the overlay table from the inferior.  Normally, @value{GDBN}
14147 re-reads the table @value{GDBN} automatically each time the inferior
14148 stops, so this command should only be necessary if you have changed the
14149 overlay mapping yourself using @value{GDBN}.  This command is only
14150 useful when using automatic overlay debugging.
14151
14152 @item overlay list-overlays
14153 @itemx overlay list
14154 @cindex listing mapped overlays
14155 Display a list of the overlays currently mapped, along with their mapped
14156 addresses, load addresses, and sizes.
14157
14158 @end table
14159
14160 Normally, when @value{GDBN} prints a code address, it includes the name
14161 of the function the address falls in:
14162
14163 @smallexample
14164 (@value{GDBP}) print main
14165 $3 = @{int ()@} 0x11a0 <main>
14166 @end smallexample
14167 @noindent
14168 When overlay debugging is enabled, @value{GDBN} recognizes code in
14169 unmapped overlays, and prints the names of unmapped functions with
14170 asterisks around them.  For example, if @code{foo} is a function in an
14171 unmapped overlay, @value{GDBN} prints it this way:
14172
14173 @smallexample
14174 (@value{GDBP}) overlay list
14175 No sections are mapped.
14176 (@value{GDBP}) print foo
14177 $5 = @{int (int)@} 0x100000 <*foo*>
14178 @end smallexample
14179 @noindent
14180 When @code{foo}'s overlay is mapped, @value{GDBN} prints the function's
14181 name normally:
14182
14183 @smallexample
14184 (@value{GDBP}) overlay list
14185 Section .ov.foo.text, loaded at 0x100000 - 0x100034,
14186         mapped at 0x1016 - 0x104a
14187 (@value{GDBP}) print foo
14188 $6 = @{int (int)@} 0x1016 <foo>
14189 @end smallexample
14190
14191 When overlay debugging is enabled, @value{GDBN} can find the correct
14192 address for functions and variables in an overlay, whether or not the
14193 overlay is mapped.  This allows most @value{GDBN} commands, like
14194 @code{break} and @code{disassemble}, to work normally, even on unmapped
14195 code.  However, @value{GDBN}'s breakpoint support has some limitations:
14196
14197 @itemize @bullet
14198 @item
14199 @cindex breakpoints in overlays
14200 @cindex overlays, setting breakpoints in
14201 You can set breakpoints in functions in unmapped overlays, as long as
14202 @value{GDBN} can write to the overlay at its load address.
14203 @item
14204 @value{GDBN} can not set hardware or simulator-based breakpoints in
14205 unmapped overlays.  However, if you set a breakpoint at the end of your
14206 overlay manager (and tell @value{GDBN} which overlays are now mapped, if
14207 you are using manual overlay management), @value{GDBN} will re-set its
14208 breakpoints properly.
14209 @end itemize
14210
14211
14212 @node Automatic Overlay Debugging
14213 @section Automatic Overlay Debugging
14214 @cindex automatic overlay debugging
14215
14216 @value{GDBN} can automatically track which overlays are mapped and which
14217 are not, given some simple co-operation from the overlay manager in the
14218 inferior.  If you enable automatic overlay debugging with the
14219 @code{overlay auto} command (@pxref{Overlay Commands}), @value{GDBN}
14220 looks in the inferior's memory for certain variables describing the
14221 current state of the overlays.
14222
14223 Here are the variables your overlay manager must define to support
14224 @value{GDBN}'s automatic overlay debugging:
14225
14226 @table @asis
14227
14228 @item @code{_ovly_table}:
14229 This variable must be an array of the following structures:
14230
14231 @smallexample
14232 struct
14233 @{
14234   /* The overlay's mapped address.  */
14235   unsigned long vma;
14236
14237   /* The size of the overlay, in bytes.  */
14238   unsigned long size;
14239
14240   /* The overlay's load address.  */
14241   unsigned long lma;
14242
14243   /* Non-zero if the overlay is currently mapped;
14244      zero otherwise.  */
14245   unsigned long mapped;
14246 @}
14247 @end smallexample
14248
14249 @item @code{_novlys}:
14250 This variable must be a four-byte signed integer, holding the total
14251 number of elements in @code{_ovly_table}.
14252
14253 @end table
14254
14255 To decide whether a particular overlay is mapped or not, @value{GDBN}
14256 looks for an entry in @w{@code{_ovly_table}} whose @code{vma} and
14257 @code{lma} members equal the VMA and LMA of the overlay's section in the
14258 executable file.  When @value{GDBN} finds a matching entry, it consults
14259 the entry's @code{mapped} member to determine whether the overlay is
14260 currently mapped.
14261
14262 In addition, your overlay manager may define a function called
14263 @code{_ovly_debug_event}.  If this function is defined, @value{GDBN}
14264 will silently set a breakpoint there.  If the overlay manager then
14265 calls this function whenever it has changed the overlay table, this
14266 will enable @value{GDBN} to accurately keep track of which overlays
14267 are in program memory, and update any breakpoints that may be set
14268 in overlays.  This will allow breakpoints to work even if the
14269 overlays are kept in ROM or other non-writable memory while they
14270 are not being executed.
14271
14272 @node Overlay Sample Program
14273 @section Overlay Sample Program
14274 @cindex overlay example program
14275
14276 When linking a program which uses overlays, you must place the overlays
14277 at their load addresses, while relocating them to run at their mapped
14278 addresses.  To do this, you must write a linker script (@pxref{Overlay
14279 Description,,, ld.info, Using ld: the GNU linker}).  Unfortunately,
14280 since linker scripts are specific to a particular host system, target
14281 architecture, and target memory layout, this manual cannot provide
14282 portable sample code demonstrating @value{GDBN}'s overlay support.
14283
14284 However, the @value{GDBN} source distribution does contain an overlaid
14285 program, with linker scripts for a few systems, as part of its test
14286 suite.  The program consists of the following files from
14287 @file{gdb/testsuite/gdb.base}:
14288
14289 @table @file
14290 @item overlays.c
14291 The main program file.
14292 @item ovlymgr.c
14293 A simple overlay manager, used by @file{overlays.c}.
14294 @item foo.c
14295 @itemx bar.c
14296 @itemx baz.c
14297 @itemx grbx.c
14298 Overlay modules, loaded and used by @file{overlays.c}.
14299 @item d10v.ld
14300 @itemx m32r.ld
14301 Linker scripts for linking the test program on the @code{d10v-elf}
14302 and @code{m32r-elf} targets.
14303 @end table
14304
14305 You can build the test program using the @code{d10v-elf} GCC
14306 cross-compiler like this:
14307
14308 @smallexample
14309 $ d10v-elf-gcc -g -c overlays.c
14310 $ d10v-elf-gcc -g -c ovlymgr.c
14311 $ d10v-elf-gcc -g -c foo.c
14312 $ d10v-elf-gcc -g -c bar.c
14313 $ d10v-elf-gcc -g -c baz.c
14314 $ d10v-elf-gcc -g -c grbx.c
14315 $ d10v-elf-gcc -g overlays.o ovlymgr.o foo.o bar.o \
14316                   baz.o grbx.o -Wl,-Td10v.ld -o overlays
14317 @end smallexample
14318
14319 The build process is identical for any other architecture, except that
14320 you must substitute the appropriate compiler and linker script for the
14321 target system for @code{d10v-elf-gcc} and @code{d10v.ld}.
14322
14323
14324 @node Languages
14325 @chapter Using @value{GDBN} with Different Languages
14326 @cindex languages
14327
14328 Although programming languages generally have common aspects, they are
14329 rarely expressed in the same manner.  For instance, in ANSI C,
14330 dereferencing a pointer @code{p} is accomplished by @code{*p}, but in
14331 Modula-2, it is accomplished by @code{p^}.  Values can also be
14332 represented (and displayed) differently.  Hex numbers in C appear as
14333 @samp{0x1ae}, while in Modula-2 they appear as @samp{1AEH}.
14334
14335 @cindex working language
14336 Language-specific information is built into @value{GDBN} for some languages,
14337 allowing you to express operations like the above in your program's
14338 native language, and allowing @value{GDBN} to output values in a manner
14339 consistent with the syntax of your program's native language.  The
14340 language you use to build expressions is called the @dfn{working
14341 language}.
14342
14343 @menu
14344 * Setting::                     Switching between source languages
14345 * Show::                        Displaying the language
14346 * Checks::                      Type and range checks
14347 * Supported Languages::         Supported languages
14348 * Unsupported Languages::       Unsupported languages
14349 @end menu
14350
14351 @node Setting
14352 @section Switching Between Source Languages
14353
14354 There are two ways to control the working language---either have @value{GDBN}
14355 set it automatically, or select it manually yourself.  You can use the
14356 @code{set language} command for either purpose.  On startup, @value{GDBN}
14357 defaults to setting the language automatically.  The working language is
14358 used to determine how expressions you type are interpreted, how values
14359 are printed, etc.
14360
14361 In addition to the working language, every source file that
14362 @value{GDBN} knows about has its own working language.  For some object
14363 file formats, the compiler might indicate which language a particular
14364 source file is in.  However, most of the time @value{GDBN} infers the
14365 language from the name of the file.  The language of a source file
14366 controls whether C@t{++} names are demangled---this way @code{backtrace} can
14367 show each frame appropriately for its own language.  There is no way to
14368 set the language of a source file from within @value{GDBN}, but you can
14369 set the language associated with a filename extension.  @xref{Show, ,
14370 Displaying the Language}.
14371
14372 This is most commonly a problem when you use a program, such
14373 as @code{cfront} or @code{f2c}, that generates C but is written in
14374 another language.  In that case, make the
14375 program use @code{#line} directives in its C output; that way
14376 @value{GDBN} will know the correct language of the source code of the original
14377 program, and will display that source code, not the generated C code.
14378
14379 @menu
14380 * Filenames::                   Filename extensions and languages.
14381 * Manually::                    Setting the working language manually
14382 * Automatically::               Having @value{GDBN} infer the source language
14383 @end menu
14384
14385 @node Filenames
14386 @subsection List of Filename Extensions and Languages
14387
14388 If a source file name ends in one of the following extensions, then
14389 @value{GDBN} infers that its language is the one indicated.
14390
14391 @table @file
14392 @item .ada
14393 @itemx .ads
14394 @itemx .adb
14395 @itemx .a
14396 Ada source file.
14397
14398 @item .c
14399 C source file
14400
14401 @item .C
14402 @itemx .cc
14403 @itemx .cp
14404 @itemx .cpp
14405 @itemx .cxx
14406 @itemx .c++
14407 C@t{++} source file
14408
14409 @item .d
14410 D source file
14411
14412 @item .m
14413 Objective-C source file
14414
14415 @item .f
14416 @itemx .F
14417 Fortran source file
14418
14419 @item .mod
14420 Modula-2 source file
14421
14422 @item .s
14423 @itemx .S
14424 Assembler source file.  This actually behaves almost like C, but
14425 @value{GDBN} does not skip over function prologues when stepping.
14426 @end table
14427
14428 In addition, you may set the language associated with a filename
14429 extension.  @xref{Show, , Displaying the Language}.
14430
14431 @node Manually
14432 @subsection Setting the Working Language
14433
14434 If you allow @value{GDBN} to set the language automatically,
14435 expressions are interpreted the same way in your debugging session and
14436 your program.
14437
14438 @kindex set language
14439 If you wish, you may set the language manually.  To do this, issue the
14440 command @samp{set language @var{lang}}, where @var{lang} is the name of
14441 a language, such as
14442 @code{c} or @code{modula-2}.
14443 For a list of the supported languages, type @samp{set language}.
14444
14445 Setting the language manually prevents @value{GDBN} from updating the working
14446 language automatically.  This can lead to confusion if you try
14447 to debug a program when the working language is not the same as the
14448 source language, when an expression is acceptable to both
14449 languages---but means different things.  For instance, if the current
14450 source file were written in C, and @value{GDBN} was parsing Modula-2, a
14451 command such as:
14452
14453 @smallexample
14454 print a = b + c
14455 @end smallexample
14456
14457 @noindent
14458 might not have the effect you intended.  In C, this means to add
14459 @code{b} and @code{c} and place the result in @code{a}.  The result
14460 printed would be the value of @code{a}.  In Modula-2, this means to compare
14461 @code{a} to the result of @code{b+c}, yielding a @code{BOOLEAN} value.
14462
14463 @node Automatically
14464 @subsection Having @value{GDBN} Infer the Source Language
14465
14466 To have @value{GDBN} set the working language automatically, use
14467 @samp{set language local} or @samp{set language auto}.  @value{GDBN}
14468 then infers the working language.  That is, when your program stops in a
14469 frame (usually by encountering a breakpoint), @value{GDBN} sets the
14470 working language to the language recorded for the function in that
14471 frame.  If the language for a frame is unknown (that is, if the function
14472 or block corresponding to the frame was defined in a source file that
14473 does not have a recognized extension), the current working language is
14474 not changed, and @value{GDBN} issues a warning.
14475
14476 This may not seem necessary for most programs, which are written
14477 entirely in one source language.  However, program modules and libraries
14478 written in one source language can be used by a main program written in
14479 a different source language.  Using @samp{set language auto} in this
14480 case frees you from having to set the working language manually.
14481
14482 @node Show
14483 @section Displaying the Language
14484
14485 The following commands help you find out which language is the
14486 working language, and also what language source files were written in.
14487
14488 @table @code
14489 @item show language
14490 @anchor{show language}
14491 @kindex show language
14492 Display the current working language.  This is the
14493 language you can use with commands such as @code{print} to
14494 build and compute expressions that may involve variables in your program.
14495
14496 @item info frame
14497 @kindex info frame@r{, show the source language}
14498 Display the source language for this frame.  This language becomes the
14499 working language if you use an identifier from this frame.
14500 @xref{Frame Info, ,Information about a Frame}, to identify the other
14501 information listed here.
14502
14503 @item info source
14504 @kindex info source@r{, show the source language}
14505 Display the source language of this source file.
14506 @xref{Symbols, ,Examining the Symbol Table}, to identify the other
14507 information listed here.
14508 @end table
14509
14510 In unusual circumstances, you may have source files with extensions
14511 not in the standard list.  You can then set the extension associated
14512 with a language explicitly:
14513
14514 @table @code
14515 @item set extension-language @var{ext} @var{language}
14516 @kindex set extension-language
14517 Tell @value{GDBN} that source files with extension @var{ext} are to be
14518 assumed as written in the source language @var{language}.
14519
14520 @item info extensions
14521 @kindex info extensions
14522 List all the filename extensions and the associated languages.
14523 @end table
14524
14525 @node Checks
14526 @section Type and Range Checking
14527
14528 Some languages are designed to guard you against making seemingly common
14529 errors through a series of compile- and run-time checks.  These include
14530 checking the type of arguments to functions and operators and making
14531 sure mathematical overflows are caught at run time.  Checks such as
14532 these help to ensure a program's correctness once it has been compiled
14533 by eliminating type mismatches and providing active checks for range
14534 errors when your program is running.
14535
14536 By default @value{GDBN} checks for these errors according to the
14537 rules of the current source language.  Although @value{GDBN} does not check
14538 the statements in your program, it can check expressions entered directly
14539 into @value{GDBN} for evaluation via the @code{print} command, for example.
14540
14541 @menu
14542 * Type Checking::               An overview of type checking
14543 * Range Checking::              An overview of range checking
14544 @end menu
14545
14546 @cindex type checking
14547 @cindex checks, type
14548 @node Type Checking
14549 @subsection An Overview of Type Checking
14550
14551 Some languages, such as C and C@t{++}, are strongly typed, meaning that the
14552 arguments to operators and functions have to be of the correct type,
14553 otherwise an error occurs.  These checks prevent type mismatch
14554 errors from ever causing any run-time problems.  For example,
14555
14556 @smallexample
14557 int klass::my_method(char *b) @{ return  b ? 1 : 2; @}
14558
14559 (@value{GDBP}) print obj.my_method (0)
14560 $1 = 2
14561 @exdent but
14562 (@value{GDBP}) print obj.my_method (0x1234)
14563 Cannot resolve method klass::my_method to any overloaded instance
14564 @end smallexample
14565
14566 The second example fails because in C@t{++} the integer constant
14567 @samp{0x1234} is not type-compatible with the pointer parameter type.
14568
14569 For the expressions you use in @value{GDBN} commands, you can tell
14570 @value{GDBN} to not enforce strict type checking or
14571 to treat any mismatches as errors and abandon the expression;
14572 When type checking is disabled, @value{GDBN} successfully evaluates
14573 expressions like the second example above.
14574
14575 Even if type checking is off, there may be other reasons
14576 related to type that prevent @value{GDBN} from evaluating an expression.
14577 For instance, @value{GDBN} does not know how to add an @code{int} and
14578 a @code{struct foo}.  These particular type errors have nothing to do
14579 with the language in use and usually arise from expressions which make
14580 little sense to evaluate anyway.
14581
14582 @value{GDBN} provides some additional commands for controlling type checking:
14583
14584 @kindex set check type
14585 @kindex show check type
14586 @table @code
14587 @item set check type on
14588 @itemx set check type off
14589 Set strict type checking on or off.  If any type mismatches occur in
14590 evaluating an expression while type checking is on, @value{GDBN} prints a
14591 message and aborts evaluation of the expression.
14592
14593 @item show check type
14594 Show the current setting of type checking and whether @value{GDBN}
14595 is enforcing strict type checking rules.
14596 @end table
14597
14598 @cindex range checking
14599 @cindex checks, range
14600 @node Range Checking
14601 @subsection An Overview of Range Checking
14602
14603 In some languages (such as Modula-2), it is an error to exceed the
14604 bounds of a type; this is enforced with run-time checks.  Such range
14605 checking is meant to ensure program correctness by making sure
14606 computations do not overflow, or indices on an array element access do
14607 not exceed the bounds of the array.
14608
14609 For expressions you use in @value{GDBN} commands, you can tell
14610 @value{GDBN} to treat range errors in one of three ways: ignore them,
14611 always treat them as errors and abandon the expression, or issue
14612 warnings but evaluate the expression anyway.
14613
14614 A range error can result from numerical overflow, from exceeding an
14615 array index bound, or when you type a constant that is not a member
14616 of any type.  Some languages, however, do not treat overflows as an
14617 error.  In many implementations of C, mathematical overflow causes the
14618 result to ``wrap around'' to lower values---for example, if @var{m} is
14619 the largest integer value, and @var{s} is the smallest, then
14620
14621 @smallexample
14622 @var{m} + 1 @result{} @var{s}
14623 @end smallexample
14624
14625 This, too, is specific to individual languages, and in some cases
14626 specific to individual compilers or machines.  @xref{Supported Languages, ,
14627 Supported Languages}, for further details on specific languages.
14628
14629 @value{GDBN} provides some additional commands for controlling the range checker:
14630
14631 @kindex set check range
14632 @kindex show check range
14633 @table @code
14634 @item set check range auto
14635 Set range checking on or off based on the current working language.
14636 @xref{Supported Languages, ,Supported Languages}, for the default settings for
14637 each language.
14638
14639 @item set check range on
14640 @itemx set check range off
14641 Set range checking on or off, overriding the default setting for the
14642 current working language.  A warning is issued if the setting does not
14643 match the language default.  If a range error occurs and range checking is on,
14644 then a message is printed and evaluation of the expression is aborted.
14645
14646 @item set check range warn
14647 Output messages when the @value{GDBN} range checker detects a range error,
14648 but attempt to evaluate the expression anyway.  Evaluating the
14649 expression may still be impossible for other reasons, such as accessing
14650 memory that the process does not own (a typical example from many Unix
14651 systems).
14652
14653 @item show range
14654 Show the current setting of the range checker, and whether or not it is
14655 being set automatically by @value{GDBN}.
14656 @end table
14657
14658 @node Supported Languages
14659 @section Supported Languages
14660
14661 @value{GDBN} supports C, C@t{++}, D, Go, Objective-C, Fortran,
14662 OpenCL C, Pascal, Rust, assembly, Modula-2, and Ada.
14663 @c This is false ...
14664 Some @value{GDBN} features may be used in expressions regardless of the
14665 language you use: the @value{GDBN} @code{@@} and @code{::} operators,
14666 and the @samp{@{type@}addr} construct (@pxref{Expressions,
14667 ,Expressions}) can be used with the constructs of any supported
14668 language.
14669
14670 The following sections detail to what degree each source language is
14671 supported by @value{GDBN}.  These sections are not meant to be language
14672 tutorials or references, but serve only as a reference guide to what the
14673 @value{GDBN} expression parser accepts, and what input and output
14674 formats should look like for different languages.  There are many good
14675 books written on each of these languages; please look to these for a
14676 language reference or tutorial.
14677
14678 @menu
14679 * C::                           C and C@t{++}
14680 * D::                           D
14681 * Go::                          Go
14682 * Objective-C::                 Objective-C
14683 * OpenCL C::                    OpenCL C
14684 * Fortran::                     Fortran
14685 * Pascal::                      Pascal
14686 * Rust::                        Rust
14687 * Modula-2::                    Modula-2
14688 * Ada::                         Ada
14689 @end menu
14690
14691 @node C
14692 @subsection C and C@t{++}
14693
14694 @cindex C and C@t{++}
14695 @cindex expressions in C or C@t{++}
14696
14697 Since C and C@t{++} are so closely related, many features of @value{GDBN} apply
14698 to both languages.  Whenever this is the case, we discuss those languages
14699 together.
14700
14701 @cindex C@t{++}
14702 @cindex @code{g++}, @sc{gnu} C@t{++} compiler
14703 @cindex @sc{gnu} C@t{++}
14704 The C@t{++} debugging facilities are jointly implemented by the C@t{++}
14705 compiler and @value{GDBN}.  Therefore, to debug your C@t{++} code
14706 effectively, you must compile your C@t{++} programs with a supported
14707 C@t{++} compiler, such as @sc{gnu} @code{g++}, or the HP ANSI C@t{++}
14708 compiler (@code{aCC}).
14709
14710 @menu
14711 * C Operators::                 C and C@t{++} operators
14712 * C Constants::                 C and C@t{++} constants
14713 * C Plus Plus Expressions::     C@t{++} expressions
14714 * C Defaults::                  Default settings for C and C@t{++}
14715 * C Checks::                    C and C@t{++} type and range checks
14716 * Debugging C::                 @value{GDBN} and C
14717 * Debugging C Plus Plus::       @value{GDBN} features for C@t{++}
14718 * Decimal Floating Point::      Numbers in Decimal Floating Point format
14719 @end menu
14720
14721 @node C Operators
14722 @subsubsection C and C@t{++} Operators
14723
14724 @cindex C and C@t{++} operators
14725
14726 Operators must be defined on values of specific types.  For instance,
14727 @code{+} is defined on numbers, but not on structures.  Operators are
14728 often defined on groups of types.
14729
14730 For the purposes of C and C@t{++}, the following definitions hold:
14731
14732 @itemize @bullet
14733
14734 @item
14735 @emph{Integral types} include @code{int} with any of its storage-class
14736 specifiers; @code{char}; @code{enum}; and, for C@t{++}, @code{bool}.
14737
14738 @item
14739 @emph{Floating-point types} include @code{float}, @code{double}, and
14740 @code{long double} (if supported by the target platform).
14741
14742 @item
14743 @emph{Pointer types} include all types defined as @code{(@var{type} *)}.
14744
14745 @item
14746 @emph{Scalar types} include all of the above.
14747
14748 @end itemize
14749
14750 @noindent
14751 The following operators are supported.  They are listed here
14752 in order of increasing precedence:
14753
14754 @table @code
14755 @item ,
14756 The comma or sequencing operator.  Expressions in a comma-separated list
14757 are evaluated from left to right, with the result of the entire
14758 expression being the last expression evaluated.
14759
14760 @item =
14761 Assignment.  The value of an assignment expression is the value
14762 assigned.  Defined on scalar types.
14763
14764 @item @var{op}=
14765 Used in an expression of the form @w{@code{@var{a} @var{op}= @var{b}}},
14766 and translated to @w{@code{@var{a} = @var{a op b}}}.
14767 @w{@code{@var{op}=}} and @code{=} have the same precedence.  The operator
14768 @var{op} is any one of the operators @code{|}, @code{^}, @code{&},
14769 @code{<<}, @code{>>}, @code{+}, @code{-}, @code{*}, @code{/}, @code{%}.
14770
14771 @item ?:
14772 The ternary operator.  @code{@var{a} ? @var{b} : @var{c}} can be thought
14773 of as:  if @var{a} then @var{b} else @var{c}.  The argument @var{a}
14774 should be of an integral type.
14775
14776 @item ||
14777 Logical @sc{or}.  Defined on integral types.
14778
14779 @item &&
14780 Logical @sc{and}.  Defined on integral types.
14781
14782 @item |
14783 Bitwise @sc{or}.  Defined on integral types.
14784
14785 @item ^
14786 Bitwise exclusive-@sc{or}.  Defined on integral types.
14787
14788 @item &
14789 Bitwise @sc{and}.  Defined on integral types.
14790
14791 @item ==@r{, }!=
14792 Equality and inequality.  Defined on scalar types.  The value of these
14793 expressions is 0 for false and non-zero for true.
14794
14795 @item <@r{, }>@r{, }<=@r{, }>=
14796 Less than, greater than, less than or equal, greater than or equal.
14797 Defined on scalar types.  The value of these expressions is 0 for false
14798 and non-zero for true.
14799
14800 @item <<@r{, }>>
14801 left shift, and right shift.  Defined on integral types.
14802
14803 @item @@
14804 The @value{GDBN} ``artificial array'' operator (@pxref{Expressions, ,Expressions}).
14805
14806 @item +@r{, }-
14807 Addition and subtraction.  Defined on integral types, floating-point types and
14808 pointer types.
14809
14810 @item *@r{, }/@r{, }%
14811 Multiplication, division, and modulus.  Multiplication and division are
14812 defined on integral and floating-point types.  Modulus is defined on
14813 integral types.
14814
14815 @item ++@r{, }--
14816 Increment and decrement.  When appearing before a variable, the
14817 operation is performed before the variable is used in an expression;
14818 when appearing after it, the variable's value is used before the
14819 operation takes place.
14820
14821 @item *
14822 Pointer dereferencing.  Defined on pointer types.  Same precedence as
14823 @code{++}.
14824
14825 @item &
14826 Address operator.  Defined on variables.  Same precedence as @code{++}.
14827
14828 For debugging C@t{++}, @value{GDBN} implements a use of @samp{&} beyond what is
14829 allowed in the C@t{++} language itself: you can use @samp{&(&@var{ref})}
14830 to examine the address
14831 where a C@t{++} reference variable (declared with @samp{&@var{ref}}) is
14832 stored.
14833
14834 @item -
14835 Negative.  Defined on integral and floating-point types.  Same
14836 precedence as @code{++}.
14837
14838 @item !
14839 Logical negation.  Defined on integral types.  Same precedence as
14840 @code{++}.
14841
14842 @item ~
14843 Bitwise complement operator.  Defined on integral types.  Same precedence as
14844 @code{++}.
14845
14846
14847 @item .@r{, }->
14848 Structure member, and pointer-to-structure member.  For convenience,
14849 @value{GDBN} regards the two as equivalent, choosing whether to dereference a
14850 pointer based on the stored type information.
14851 Defined on @code{struct} and @code{union} data.
14852
14853 @item .*@r{, }->*
14854 Dereferences of pointers to members.
14855
14856 @item []
14857 Array indexing.  @code{@var{a}[@var{i}]} is defined as
14858 @code{*(@var{a}+@var{i})}.  Same precedence as @code{->}.
14859
14860 @item ()
14861 Function parameter list.  Same precedence as @code{->}.
14862
14863 @item ::
14864 C@t{++} scope resolution operator.  Defined on @code{struct}, @code{union},
14865 and @code{class} types.
14866
14867 @item ::
14868 Doubled colons also represent the @value{GDBN} scope operator
14869 (@pxref{Expressions, ,Expressions}).  Same precedence as @code{::},
14870 above.
14871 @end table
14872
14873 If an operator is redefined in the user code, @value{GDBN} usually
14874 attempts to invoke the redefined version instead of using the operator's
14875 predefined meaning.
14876
14877 @node C Constants
14878 @subsubsection C and C@t{++} Constants
14879
14880 @cindex C and C@t{++} constants
14881
14882 @value{GDBN} allows you to express the constants of C and C@t{++} in the
14883 following ways:
14884
14885 @itemize @bullet
14886 @item
14887 Integer constants are a sequence of digits.  Octal constants are
14888 specified by a leading @samp{0} (i.e.@: zero), and hexadecimal constants
14889 by a leading @samp{0x} or @samp{0X}.  Constants may also end with a letter
14890 @samp{l}, specifying that the constant should be treated as a
14891 @code{long} value.
14892
14893 @item
14894 Floating point constants are a sequence of digits, followed by a decimal
14895 point, followed by a sequence of digits, and optionally followed by an
14896 exponent.  An exponent is of the form:
14897 @samp{@w{e@r{[[}+@r{]|}-@r{]}@var{nnn}}}, where @var{nnn} is another
14898 sequence of digits.  The @samp{+} is optional for positive exponents.
14899 A floating-point constant may also end with a letter @samp{f} or
14900 @samp{F}, specifying that the constant should be treated as being of
14901 the @code{float} (as opposed to the default @code{double}) type; or with
14902 a letter @samp{l} or @samp{L}, which specifies a @code{long double}
14903 constant.
14904
14905 @item
14906 Enumerated constants consist of enumerated identifiers, or their
14907 integral equivalents.
14908
14909 @item
14910 Character constants are a single character surrounded by single quotes
14911 (@code{'}), or a number---the ordinal value of the corresponding character
14912 (usually its @sc{ascii} value).  Within quotes, the single character may
14913 be represented by a letter or by @dfn{escape sequences}, which are of
14914 the form @samp{\@var{nnn}}, where @var{nnn} is the octal representation
14915 of the character's ordinal value; or of the form @samp{\@var{x}}, where
14916 @samp{@var{x}} is a predefined special character---for example,
14917 @samp{\n} for newline.
14918
14919 Wide character constants can be written by prefixing a character
14920 constant with @samp{L}, as in C.  For example, @samp{L'x'} is the wide
14921 form of @samp{x}.  The target wide character set is used when
14922 computing the value of this constant (@pxref{Character Sets}).
14923
14924 @item
14925 String constants are a sequence of character constants surrounded by
14926 double quotes (@code{"}).  Any valid character constant (as described
14927 above) may appear.  Double quotes within the string must be preceded by
14928 a backslash, so for instance @samp{"a\"b'c"} is a string of five
14929 characters.
14930
14931 Wide string constants can be written by prefixing a string constant
14932 with @samp{L}, as in C.  The target wide character set is used when
14933 computing the value of this constant (@pxref{Character Sets}).
14934
14935 @item
14936 Pointer constants are an integral value.  You can also write pointers
14937 to constants using the C operator @samp{&}.
14938
14939 @item
14940 Array constants are comma-separated lists surrounded by braces @samp{@{}
14941 and @samp{@}}; for example, @samp{@{1,2,3@}} is a three-element array of
14942 integers, @samp{@{@{1,2@}, @{3,4@}, @{5,6@}@}} is a three-by-two array,
14943 and @samp{@{&"hi", &"there", &"fred"@}} is a three-element array of pointers.
14944 @end itemize
14945
14946 @node C Plus Plus Expressions
14947 @subsubsection C@t{++} Expressions
14948
14949 @cindex expressions in C@t{++}
14950 @value{GDBN} expression handling can interpret most C@t{++} expressions.
14951
14952 @cindex debugging C@t{++} programs
14953 @cindex C@t{++} compilers
14954 @cindex debug formats and C@t{++}
14955 @cindex @value{NGCC} and C@t{++}
14956 @quotation
14957 @emph{Warning:} @value{GDBN} can only debug C@t{++} code if you use
14958 the proper compiler and the proper debug format.  Currently,
14959 @value{GDBN} works best when debugging C@t{++} code that is compiled
14960 with the most recent version of @value{NGCC} possible.  The DWARF
14961 debugging format is preferred; @value{NGCC} defaults to this on most
14962 popular platforms.  Other compilers and/or debug formats are likely to
14963 work badly or not at all when using @value{GDBN} to debug C@t{++}
14964 code.  @xref{Compilation}.
14965 @end quotation
14966
14967 @enumerate
14968
14969 @cindex member functions
14970 @item
14971 Member function calls are allowed; you can use expressions like
14972
14973 @smallexample
14974 count = aml->GetOriginal(x, y)
14975 @end smallexample
14976
14977 @vindex this@r{, inside C@t{++} member functions}
14978 @cindex namespace in C@t{++}
14979 @item
14980 While a member function is active (in the selected stack frame), your
14981 expressions have the same namespace available as the member function;
14982 that is, @value{GDBN} allows implicit references to the class instance
14983 pointer @code{this} following the same rules as C@t{++}.  @code{using}
14984 declarations in the current scope are also respected by @value{GDBN}.
14985
14986 @cindex call overloaded functions
14987 @cindex overloaded functions, calling
14988 @cindex type conversions in C@t{++}
14989 @item
14990 You can call overloaded functions; @value{GDBN} resolves the function
14991 call to the right definition, with some restrictions.  @value{GDBN} does not
14992 perform overload resolution involving user-defined type conversions,
14993 calls to constructors, or instantiations of templates that do not exist
14994 in the program.  It also cannot handle ellipsis argument lists or
14995 default arguments.
14996
14997 It does perform integral conversions and promotions, floating-point
14998 promotions, arithmetic conversions, pointer conversions, conversions of
14999 class objects to base classes, and standard conversions such as those of
15000 functions or arrays to pointers; it requires an exact match on the
15001 number of function arguments.
15002
15003 Overload resolution is always performed, unless you have specified
15004 @code{set overload-resolution off}.  @xref{Debugging C Plus Plus,
15005 ,@value{GDBN} Features for C@t{++}}.
15006
15007 You must specify @code{set overload-resolution off} in order to use an
15008 explicit function signature to call an overloaded function, as in
15009 @smallexample
15010 p 'foo(char,int)'('x', 13)
15011 @end smallexample
15012
15013 The @value{GDBN} command-completion facility can simplify this;
15014 see @ref{Completion, ,Command Completion}.
15015
15016 @cindex reference declarations
15017 @item
15018 @value{GDBN} understands variables declared as C@t{++} lvalue or rvalue
15019 references; you can use them in expressions just as you do in C@t{++}
15020 source---they are automatically dereferenced.
15021
15022 In the parameter list shown when @value{GDBN} displays a frame, the values of
15023 reference variables are not displayed (unlike other variables); this
15024 avoids clutter, since references are often used for large structures.
15025 The @emph{address} of a reference variable is always shown, unless
15026 you have specified @samp{set print address off}.
15027
15028 @item
15029 @value{GDBN} supports the C@t{++} name resolution operator @code{::}---your
15030 expressions can use it just as expressions in your program do.  Since
15031 one scope may be defined in another, you can use @code{::} repeatedly if
15032 necessary, for example in an expression like
15033 @samp{@var{scope1}::@var{scope2}::@var{name}}.  @value{GDBN} also allows
15034 resolving name scope by reference to source files, in both C and C@t{++}
15035 debugging (@pxref{Variables, ,Program Variables}).
15036
15037 @item
15038 @value{GDBN} performs argument-dependent lookup, following the C@t{++}
15039 specification.
15040 @end enumerate
15041
15042 @node C Defaults
15043 @subsubsection C and C@t{++} Defaults
15044
15045 @cindex C and C@t{++} defaults
15046
15047 If you allow @value{GDBN} to set range checking automatically, it
15048 defaults to @code{off} whenever the working language changes to
15049 C or C@t{++}.  This happens regardless of whether you or @value{GDBN}
15050 selects the working language.
15051
15052 If you allow @value{GDBN} to set the language automatically, it
15053 recognizes source files whose names end with @file{.c}, @file{.C}, or
15054 @file{.cc}, etc, and when @value{GDBN} enters code compiled from one of
15055 these files, it sets the working language to C or C@t{++}.
15056 @xref{Automatically, ,Having @value{GDBN} Infer the Source Language},
15057 for further details.
15058
15059 @node C Checks
15060 @subsubsection C and C@t{++} Type and Range Checks
15061
15062 @cindex C and C@t{++} checks
15063
15064 By default, when @value{GDBN} parses C or C@t{++} expressions, strict type
15065 checking is used.  However, if you turn type checking off, @value{GDBN}
15066 will allow certain non-standard conversions, such as promoting integer
15067 constants to pointers.
15068
15069 Range checking, if turned on, is done on mathematical operations.  Array
15070 indices are not checked, since they are often used to index a pointer
15071 that is not itself an array.
15072
15073 @node Debugging C
15074 @subsubsection @value{GDBN} and C
15075
15076 The @code{set print union} and @code{show print union} commands apply to
15077 the @code{union} type.  When set to @samp{on}, any @code{union} that is
15078 inside a @code{struct} or @code{class} is also printed.  Otherwise, it
15079 appears as @samp{@{...@}}.
15080
15081 The @code{@@} operator aids in the debugging of dynamic arrays, formed
15082 with pointers and a memory allocation function.  @xref{Expressions,
15083 ,Expressions}.
15084
15085 @node Debugging C Plus Plus
15086 @subsubsection @value{GDBN} Features for C@t{++}
15087
15088 @cindex commands for C@t{++}
15089
15090 Some @value{GDBN} commands are particularly useful with C@t{++}, and some are
15091 designed specifically for use with C@t{++}.  Here is a summary:
15092
15093 @table @code
15094 @cindex break in overloaded functions
15095 @item @r{breakpoint menus}
15096 When you want a breakpoint in a function whose name is overloaded,
15097 @value{GDBN} has the capability to display a menu of possible breakpoint
15098 locations to help you specify which function definition you want.
15099 @xref{Ambiguous Expressions,,Ambiguous Expressions}.
15100
15101 @cindex overloading in C@t{++}
15102 @item rbreak @var{regex}
15103 Setting breakpoints using regular expressions is helpful for setting
15104 breakpoints on overloaded functions that are not members of any special
15105 classes.
15106 @xref{Set Breaks, ,Setting Breakpoints}.
15107
15108 @cindex C@t{++} exception handling
15109 @item catch throw
15110 @itemx catch rethrow
15111 @itemx catch catch
15112 Debug C@t{++} exception handling using these commands.  @xref{Set
15113 Catchpoints, , Setting Catchpoints}.
15114
15115 @cindex inheritance
15116 @item ptype @var{typename}
15117 Print inheritance relationships as well as other information for type
15118 @var{typename}.
15119 @xref{Symbols, ,Examining the Symbol Table}.
15120
15121 @item info vtbl @var{expression}.
15122 The @code{info vtbl} command can be used to display the virtual
15123 method tables of the object computed by @var{expression}.  This shows
15124 one entry per virtual table; there may be multiple virtual tables when
15125 multiple inheritance is in use.
15126
15127 @cindex C@t{++} demangling
15128 @item demangle @var{name}
15129 Demangle @var{name}.
15130 @xref{Symbols}, for a more complete description of the @code{demangle} command.
15131
15132 @cindex C@t{++} symbol display
15133 @item set print demangle
15134 @itemx show print demangle
15135 @itemx set print asm-demangle
15136 @itemx show print asm-demangle
15137 Control whether C@t{++} symbols display in their source form, both when
15138 displaying code as C@t{++} source and when displaying disassemblies.
15139 @xref{Print Settings, ,Print Settings}.
15140
15141 @item set print object
15142 @itemx show print object
15143 Choose whether to print derived (actual) or declared types of objects.
15144 @xref{Print Settings, ,Print Settings}.
15145
15146 @item set print vtbl
15147 @itemx show print vtbl
15148 Control the format for printing virtual function tables.
15149 @xref{Print Settings, ,Print Settings}.
15150 (The @code{vtbl} commands do not work on programs compiled with the HP
15151 ANSI C@t{++} compiler (@code{aCC}).)
15152
15153 @kindex set overload-resolution
15154 @cindex overloaded functions, overload resolution
15155 @item set overload-resolution on
15156 Enable overload resolution for C@t{++} expression evaluation.  The default
15157 is on.  For overloaded functions, @value{GDBN} evaluates the arguments
15158 and searches for a function whose signature matches the argument types,
15159 using the standard C@t{++} conversion rules (see @ref{C Plus Plus
15160 Expressions, ,C@t{++} Expressions}, for details).
15161 If it cannot find a match, it emits a message.
15162
15163 @item set overload-resolution off
15164 Disable overload resolution for C@t{++} expression evaluation.  For
15165 overloaded functions that are not class member functions, @value{GDBN}
15166 chooses the first function of the specified name that it finds in the
15167 symbol table, whether or not its arguments are of the correct type.  For
15168 overloaded functions that are class member functions, @value{GDBN}
15169 searches for a function whose signature @emph{exactly} matches the
15170 argument types.
15171
15172 @kindex show overload-resolution
15173 @item show overload-resolution
15174 Show the current setting of overload resolution.
15175
15176 @item @r{Overloaded symbol names}
15177 You can specify a particular definition of an overloaded symbol, using
15178 the same notation that is used to declare such symbols in C@t{++}: type
15179 @code{@var{symbol}(@var{types})} rather than just @var{symbol}.  You can
15180 also use the @value{GDBN} command-line word completion facilities to list the
15181 available choices, or to finish the type list for you.
15182 @xref{Completion,, Command Completion}, for details on how to do this.
15183
15184 @item @r{Breakpoints in functions with ABI tags}
15185
15186 The GNU C@t{++} compiler introduced the notion of ABI ``tags'', which
15187 correspond to changes in the ABI of a type, function, or variable that
15188 would not otherwise be reflected in a mangled name.  See
15189 @url{https://developers.redhat.com/blog/2015/02/05/gcc5-and-the-c11-abi/}
15190 for more detail.
15191
15192 The ABI tags are visible in C@t{++} demangled names.  For example, a
15193 function that returns a std::string:
15194
15195 @smallexample
15196 std::string function(int);
15197 @end smallexample
15198
15199 @noindent
15200 when compiled for the C++11 ABI is marked with the @code{cxx11} ABI
15201 tag, and @value{GDBN} displays the symbol like this:
15202
15203 @smallexample
15204 function[abi:cxx11](int)
15205 @end smallexample
15206
15207 You can set a breakpoint on such functions simply as if they had no
15208 tag.  For example:
15209
15210 @smallexample
15211 (gdb) b function(int)
15212 Breakpoint 2 at 0x40060d: file main.cc, line 10.
15213 (gdb) info breakpoints
15214 Num     Type           Disp Enb Address    What
15215 1       breakpoint     keep y   0x0040060d in function[abi:cxx11](int)
15216                                            at main.cc:10
15217 @end smallexample
15218
15219 On the rare occasion you need to disambiguate between different ABI
15220 tags, you can do so by simply including the ABI tag in the function
15221 name, like:
15222
15223 @smallexample
15224 (@value{GDBP}) b ambiguous[abi:other_tag](int)
15225 @end smallexample
15226 @end table
15227
15228 @node Decimal Floating Point
15229 @subsubsection Decimal Floating Point format
15230 @cindex decimal floating point format
15231
15232 @value{GDBN} can examine, set and perform computations with numbers in
15233 decimal floating point format, which in the C language correspond to the
15234 @code{_Decimal32}, @code{_Decimal64} and @code{_Decimal128} types as
15235 specified by the extension to support decimal floating-point arithmetic.
15236
15237 There are two encodings in use, depending on the architecture: BID (Binary
15238 Integer Decimal) for x86 and x86-64, and DPD (Densely Packed Decimal) for
15239 PowerPC and S/390.  @value{GDBN} will use the appropriate encoding for the
15240 configured target.
15241
15242 Because of a limitation in @file{libdecnumber}, the library used by @value{GDBN}
15243 to manipulate decimal floating point numbers, it is not possible to convert
15244 (using a cast, for example) integers wider than 32-bit to decimal float.
15245
15246 In addition, in order to imitate @value{GDBN}'s behaviour with binary floating
15247 point computations, error checking in decimal float operations ignores
15248 underflow, overflow and divide by zero exceptions.
15249
15250 In the PowerPC architecture, @value{GDBN} provides a set of pseudo-registers
15251 to inspect @code{_Decimal128} values stored in floating point registers.
15252 See @ref{PowerPC,,PowerPC} for more details.
15253
15254 @node D
15255 @subsection D
15256
15257 @cindex D
15258 @value{GDBN} can be used to debug programs written in D and compiled with
15259 GDC, LDC or DMD compilers. Currently @value{GDBN} supports only one D
15260 specific feature --- dynamic arrays.
15261
15262 @node Go
15263 @subsection Go
15264
15265 @cindex Go (programming language)
15266 @value{GDBN} can be used to debug programs written in Go and compiled with
15267 @file{gccgo} or @file{6g} compilers.
15268
15269 Here is a summary of the Go-specific features and restrictions:
15270
15271 @table @code
15272 @cindex current Go package
15273 @item The current Go package
15274 The name of the current package does not need to be specified when
15275 specifying global variables and functions.
15276
15277 For example, given the program:
15278
15279 @example
15280 package main
15281 var myglob = "Shall we?"
15282 func main () @{
15283   // ...
15284 @}
15285 @end example
15286
15287 When stopped inside @code{main} either of these work:
15288
15289 @example
15290 (gdb) p myglob
15291 (gdb) p main.myglob
15292 @end example
15293
15294 @cindex builtin Go types
15295 @item Builtin Go types
15296 The @code{string} type is recognized by @value{GDBN} and is printed
15297 as a string.
15298
15299 @cindex builtin Go functions
15300 @item Builtin Go functions
15301 The @value{GDBN} expression parser recognizes the @code{unsafe.Sizeof}
15302 function and handles it internally.
15303
15304 @cindex restrictions on Go expressions
15305 @item Restrictions on Go expressions
15306 All Go operators are supported except @code{&^}.
15307 The Go @code{_} ``blank identifier'' is not supported.
15308 Automatic dereferencing of pointers is not supported.
15309 @end table
15310
15311 @node Objective-C
15312 @subsection Objective-C
15313
15314 @cindex Objective-C
15315 This section provides information about some commands and command
15316 options that are useful for debugging Objective-C code.  See also
15317 @ref{Symbols, info classes}, and @ref{Symbols, info selectors}, for a
15318 few more commands specific to Objective-C support.
15319
15320 @menu
15321 * Method Names in Commands::
15322 * The Print Command with Objective-C::
15323 @end menu
15324
15325 @node Method Names in Commands
15326 @subsubsection Method Names in Commands
15327
15328 The following commands have been extended to accept Objective-C method
15329 names as line specifications:
15330
15331 @kindex clear@r{, and Objective-C}
15332 @kindex break@r{, and Objective-C}
15333 @kindex info line@r{, and Objective-C}
15334 @kindex jump@r{, and Objective-C}
15335 @kindex list@r{, and Objective-C}
15336 @itemize
15337 @item @code{clear}
15338 @item @code{break}
15339 @item @code{info line}
15340 @item @code{jump}
15341 @item @code{list}
15342 @end itemize
15343
15344 A fully qualified Objective-C method name is specified as
15345
15346 @smallexample
15347 -[@var{Class} @var{methodName}]
15348 @end smallexample
15349
15350 where the minus sign is used to indicate an instance method and a
15351 plus sign (not shown) is used to indicate a class method.  The class
15352 name @var{Class} and method name @var{methodName} are enclosed in
15353 brackets, similar to the way messages are specified in Objective-C
15354 source code.  For example, to set a breakpoint at the @code{create}
15355 instance method of class @code{Fruit} in the program currently being
15356 debugged, enter:
15357
15358 @smallexample
15359 break -[Fruit create]
15360 @end smallexample
15361
15362 To list ten program lines around the @code{initialize} class method,
15363 enter:
15364
15365 @smallexample
15366 list +[NSText initialize]
15367 @end smallexample
15368
15369 In the current version of @value{GDBN}, the plus or minus sign is
15370 required.  In future versions of @value{GDBN}, the plus or minus
15371 sign will be optional, but you can use it to narrow the search.  It
15372 is also possible to specify just a method name:
15373
15374 @smallexample
15375 break create
15376 @end smallexample
15377
15378 You must specify the complete method name, including any colons.  If
15379 your program's source files contain more than one @code{create} method,
15380 you'll be presented with a numbered list of classes that implement that
15381 method.  Indicate your choice by number, or type @samp{0} to exit if
15382 none apply.
15383
15384 As another example, to clear a breakpoint established at the
15385 @code{makeKeyAndOrderFront:} method of the @code{NSWindow} class, enter:
15386
15387 @smallexample
15388 clear -[NSWindow makeKeyAndOrderFront:]
15389 @end smallexample
15390
15391 @node The Print Command with Objective-C
15392 @subsubsection The Print Command With Objective-C
15393 @cindex Objective-C, print objects
15394 @kindex print-object
15395 @kindex po @r{(@code{print-object})}
15396
15397 The print command has also been extended to accept methods.  For example:
15398
15399 @smallexample
15400 print -[@var{object} hash]
15401 @end smallexample
15402
15403 @cindex print an Objective-C object description
15404 @cindex @code{_NSPrintForDebugger}, and printing Objective-C objects
15405 @noindent
15406 will tell @value{GDBN} to send the @code{hash} message to @var{object}
15407 and print the result.  Also, an additional command has been added,
15408 @code{print-object} or @code{po} for short, which is meant to print
15409 the description of an object.  However, this command may only work
15410 with certain Objective-C libraries that have a particular hook
15411 function, @code{_NSPrintForDebugger}, defined.
15412
15413 @node OpenCL C
15414 @subsection OpenCL C
15415
15416 @cindex OpenCL C
15417 This section provides information about @value{GDBN}s OpenCL C support.
15418
15419 @menu
15420 * OpenCL C Datatypes::
15421 * OpenCL C Expressions::
15422 * OpenCL C Operators::
15423 @end menu
15424
15425 @node OpenCL C Datatypes
15426 @subsubsection OpenCL C Datatypes
15427
15428 @cindex OpenCL C Datatypes
15429 @value{GDBN} supports the builtin scalar and vector datatypes specified
15430 by OpenCL 1.1.  In addition the half- and double-precision floating point
15431 data types of the @code{cl_khr_fp16} and @code{cl_khr_fp64} OpenCL
15432 extensions are also known to @value{GDBN}.
15433
15434 @node OpenCL C Expressions
15435 @subsubsection OpenCL C Expressions
15436
15437 @cindex OpenCL C Expressions
15438 @value{GDBN} supports accesses to vector components including the access as
15439 lvalue where possible.  Since OpenCL C is based on C99 most C expressions
15440 supported by @value{GDBN} can be used as well.
15441
15442 @node OpenCL C Operators
15443 @subsubsection OpenCL C Operators
15444
15445 @cindex OpenCL C Operators
15446 @value{GDBN} supports the operators specified by OpenCL 1.1 for scalar and
15447 vector data types.
15448
15449 @node Fortran
15450 @subsection Fortran
15451 @cindex Fortran-specific support in @value{GDBN}
15452
15453 @value{GDBN} can be used to debug programs written in Fortran, but it
15454 currently supports only the features of Fortran 77 language.
15455
15456 @cindex trailing underscore, in Fortran symbols
15457 Some Fortran compilers (@sc{gnu} Fortran 77 and Fortran 95 compilers
15458 among them) append an underscore to the names of variables and
15459 functions.  When you debug programs compiled by those compilers, you
15460 will need to refer to variables and functions with a trailing
15461 underscore.
15462
15463 @menu
15464 * Fortran Operators::           Fortran operators and expressions
15465 * Fortran Defaults::            Default settings for Fortran
15466 * Special Fortran Commands::    Special @value{GDBN} commands for Fortran
15467 @end menu
15468
15469 @node Fortran Operators
15470 @subsubsection Fortran Operators and Expressions
15471
15472 @cindex Fortran operators and expressions
15473
15474 Operators must be defined on values of specific types.  For instance,
15475 @code{+} is defined on numbers, but not on characters or other non-
15476 arithmetic types.  Operators are often defined on groups of types.
15477
15478 @table @code
15479 @item **
15480 The exponentiation operator.  It raises the first operand to the power
15481 of the second one.
15482
15483 @item :
15484 The range operator.  Normally used in the form of array(low:high) to
15485 represent a section of array.
15486
15487 @item %
15488 The access component operator.  Normally used to access elements in derived
15489 types.  Also suitable for unions.  As unions aren't part of regular Fortran,
15490 this can only happen when accessing a register that uses a gdbarch-defined
15491 union type.
15492 @end table
15493
15494 @node Fortran Defaults
15495 @subsubsection Fortran Defaults
15496
15497 @cindex Fortran Defaults
15498
15499 Fortran symbols are usually case-insensitive, so @value{GDBN} by
15500 default uses case-insensitive matches for Fortran symbols.  You can
15501 change that with the @samp{set case-insensitive} command, see
15502 @ref{Symbols}, for the details.
15503
15504 @node Special Fortran Commands
15505 @subsubsection Special Fortran Commands
15506
15507 @cindex Special Fortran commands
15508
15509 @value{GDBN} has some commands to support Fortran-specific features,
15510 such as displaying common blocks.
15511
15512 @table @code
15513 @cindex @code{COMMON} blocks, Fortran
15514 @kindex info common
15515 @item info common @r{[}@var{common-name}@r{]}
15516 This command prints the values contained in the Fortran @code{COMMON}
15517 block whose name is @var{common-name}.  With no argument, the names of
15518 all @code{COMMON} blocks visible at the current program location are
15519 printed.
15520 @end table
15521
15522 @node Pascal
15523 @subsection Pascal
15524
15525 @cindex Pascal support in @value{GDBN}, limitations
15526 Debugging Pascal programs which use sets, subranges, file variables, or
15527 nested functions does not currently work.  @value{GDBN} does not support
15528 entering expressions, printing values, or similar features using Pascal
15529 syntax.
15530
15531 The Pascal-specific command @code{set print pascal_static-members}
15532 controls whether static members of Pascal objects are displayed.
15533 @xref{Print Settings, pascal_static-members}.
15534
15535 @node Rust
15536 @subsection Rust
15537
15538 @value{GDBN} supports the @url{https://www.rust-lang.org/, Rust
15539 Programming Language}.  Type- and value-printing, and expression
15540 parsing, are reasonably complete.  However, there are a few
15541 peculiarities and holes to be aware of.
15542
15543 @itemize @bullet
15544 @item
15545 Linespecs (@pxref{Specify Location}) are never relative to the current
15546 crate.  Instead, they act as if there were a global namespace of
15547 crates, somewhat similar to the way @code{extern crate} behaves.
15548
15549 That is, if @value{GDBN} is stopped at a breakpoint in a function in
15550 crate @samp{A}, module @samp{B}, then @code{break B::f} will attempt
15551 to set a breakpoint in a function named @samp{f} in a crate named
15552 @samp{B}.
15553
15554 As a consequence of this approach, linespecs also cannot refer to
15555 items using @samp{self::} or @samp{super::}.
15556
15557 @item
15558 Because @value{GDBN} implements Rust name-lookup semantics in
15559 expressions, it will sometimes prepend the current crate to a name.
15560 For example, if @value{GDBN} is stopped at a breakpoint in the crate
15561 @samp{K}, then @code{print ::x::y} will try to find the symbol
15562 @samp{K::x::y}.
15563
15564 However, since it is useful to be able to refer to other crates when
15565 debugging, @value{GDBN} provides the @code{extern} extension to
15566 circumvent this.  To use the extension, just put @code{extern} before
15567 a path expression to refer to the otherwise unavailable ``global''
15568 scope.
15569
15570 In the above example, if you wanted to refer to the symbol @samp{y} in
15571 the crate @samp{x}, you would use @code{print extern x::y}.
15572
15573 @item
15574 The Rust expression evaluator does not support ``statement-like''
15575 expressions such as @code{if} or @code{match}, or lambda expressions.
15576
15577 @item
15578 Tuple expressions are not implemented.
15579
15580 @item
15581 The Rust expression evaluator does not currently implement the
15582 @code{Drop} trait.  Objects that may be created by the evaluator will
15583 never be destroyed.
15584
15585 @item
15586 @value{GDBN} does not implement type inference for generics.  In order
15587 to call generic functions or otherwise refer to generic items, you
15588 will have to specify the type parameters manually.
15589
15590 @item
15591 @value{GDBN} currently uses the C@t{++} demangler for Rust.  In most
15592 cases this does not cause any problems.  However, in an expression
15593 context, completing a generic function name will give syntactically
15594 invalid results.  This happens because Rust requires the @samp{::}
15595 operator between the function name and its generic arguments.  For
15596 example, @value{GDBN} might provide a completion like
15597 @code{crate::f<u32>}, where the parser would require
15598 @code{crate::f::<u32>}.
15599
15600 @item
15601 As of this writing, the Rust compiler (version 1.8) has a few holes in
15602 the debugging information it generates.  These holes prevent certain
15603 features from being implemented by @value{GDBN}:
15604 @itemize @bullet
15605
15606 @item
15607 Method calls cannot be made via traits.
15608
15609 @item
15610 Operator overloading is not implemented.
15611
15612 @item
15613 When debugging in a monomorphized function, you cannot use the generic
15614 type names.
15615
15616 @item
15617 The type @code{Self} is not available.
15618
15619 @item
15620 @code{use} statements are not available, so some names may not be
15621 available in the crate.
15622 @end itemize
15623 @end itemize
15624
15625 @node Modula-2
15626 @subsection Modula-2
15627
15628 @cindex Modula-2, @value{GDBN} support
15629
15630 The extensions made to @value{GDBN} to support Modula-2 only support
15631 output from the @sc{gnu} Modula-2 compiler (which is currently being
15632 developed).  Other Modula-2 compilers are not currently supported, and
15633 attempting to debug executables produced by them is most likely
15634 to give an error as @value{GDBN} reads in the executable's symbol
15635 table.
15636
15637 @cindex expressions in Modula-2
15638 @menu
15639 * M2 Operators::                Built-in operators
15640 * Built-In Func/Proc::          Built-in functions and procedures
15641 * M2 Constants::                Modula-2 constants
15642 * M2 Types::                    Modula-2 types
15643 * M2 Defaults::                 Default settings for Modula-2
15644 * Deviations::                  Deviations from standard Modula-2
15645 * M2 Checks::                   Modula-2 type and range checks
15646 * M2 Scope::                    The scope operators @code{::} and @code{.}
15647 * GDB/M2::                      @value{GDBN} and Modula-2
15648 @end menu
15649
15650 @node M2 Operators
15651 @subsubsection Operators
15652 @cindex Modula-2 operators
15653
15654 Operators must be defined on values of specific types.  For instance,
15655 @code{+} is defined on numbers, but not on structures.  Operators are
15656 often defined on groups of types.  For the purposes of Modula-2, the
15657 following definitions hold:
15658
15659 @itemize @bullet
15660
15661 @item
15662 @emph{Integral types} consist of @code{INTEGER}, @code{CARDINAL}, and
15663 their subranges.
15664
15665 @item
15666 @emph{Character types} consist of @code{CHAR} and its subranges.
15667
15668 @item
15669 @emph{Floating-point types} consist of @code{REAL}.
15670
15671 @item
15672 @emph{Pointer types} consist of anything declared as @code{POINTER TO
15673 @var{type}}.
15674
15675 @item
15676 @emph{Scalar types} consist of all of the above.
15677
15678 @item
15679 @emph{Set types} consist of @code{SET} and @code{BITSET} types.
15680
15681 @item
15682 @emph{Boolean types} consist of @code{BOOLEAN}.
15683 @end itemize
15684
15685 @noindent
15686 The following operators are supported, and appear in order of
15687 increasing precedence:
15688
15689 @table @code
15690 @item ,
15691 Function argument or array index separator.
15692
15693 @item :=
15694 Assignment.  The value of @var{var} @code{:=} @var{value} is
15695 @var{value}.
15696
15697 @item <@r{, }>
15698 Less than, greater than on integral, floating-point, or enumerated
15699 types.
15700
15701 @item <=@r{, }>=
15702 Less than or equal to, greater than or equal to
15703 on integral, floating-point and enumerated types, or set inclusion on
15704 set types.  Same precedence as @code{<}.
15705
15706 @item =@r{, }<>@r{, }#
15707 Equality and two ways of expressing inequality, valid on scalar types.
15708 Same precedence as @code{<}.  In @value{GDBN} scripts, only @code{<>} is
15709 available for inequality, since @code{#} conflicts with the script
15710 comment character.
15711
15712 @item IN
15713 Set membership.  Defined on set types and the types of their members.
15714 Same precedence as @code{<}.
15715
15716 @item OR
15717 Boolean disjunction.  Defined on boolean types.
15718
15719 @item AND@r{, }&
15720 Boolean conjunction.  Defined on boolean types.
15721
15722 @item @@
15723 The @value{GDBN} ``artificial array'' operator (@pxref{Expressions, ,Expressions}).
15724
15725 @item +@r{, }-
15726 Addition and subtraction on integral and floating-point types, or union
15727 and difference on set types.
15728
15729 @item *
15730 Multiplication on integral and floating-point types, or set intersection
15731 on set types.
15732
15733 @item /
15734 Division on floating-point types, or symmetric set difference on set
15735 types.  Same precedence as @code{*}.
15736
15737 @item DIV@r{, }MOD
15738 Integer division and remainder.  Defined on integral types.  Same
15739 precedence as @code{*}.
15740
15741 @item -
15742 Negative.  Defined on @code{INTEGER} and @code{REAL} data.
15743
15744 @item ^
15745 Pointer dereferencing.  Defined on pointer types.
15746
15747 @item NOT
15748 Boolean negation.  Defined on boolean types.  Same precedence as
15749 @code{^}.
15750
15751 @item .
15752 @code{RECORD} field selector.  Defined on @code{RECORD} data.  Same
15753 precedence as @code{^}.
15754
15755 @item []
15756 Array indexing.  Defined on @code{ARRAY} data.  Same precedence as @code{^}.
15757
15758 @item ()
15759 Procedure argument list.  Defined on @code{PROCEDURE} objects.  Same precedence
15760 as @code{^}.
15761
15762 @item ::@r{, }.
15763 @value{GDBN} and Modula-2 scope operators.
15764 @end table
15765
15766 @quotation
15767 @emph{Warning:} Set expressions and their operations are not yet supported, so @value{GDBN}
15768 treats the use of the operator @code{IN}, or the use of operators
15769 @code{+}, @code{-}, @code{*}, @code{/}, @code{=}, , @code{<>}, @code{#},
15770 @code{<=}, and @code{>=} on sets as an error.
15771 @end quotation
15772
15773
15774 @node Built-In Func/Proc
15775 @subsubsection Built-in Functions and Procedures
15776 @cindex Modula-2 built-ins
15777
15778 Modula-2 also makes available several built-in procedures and functions.
15779 In describing these, the following metavariables are used:
15780
15781 @table @var
15782
15783 @item a
15784 represents an @code{ARRAY} variable.
15785
15786 @item c
15787 represents a @code{CHAR} constant or variable.
15788
15789 @item i
15790 represents a variable or constant of integral type.
15791
15792 @item m
15793 represents an identifier that belongs to a set.  Generally used in the
15794 same function with the metavariable @var{s}.  The type of @var{s} should
15795 be @code{SET OF @var{mtype}} (where @var{mtype} is the type of @var{m}).
15796
15797 @item n
15798 represents a variable or constant of integral or floating-point type.
15799
15800 @item r
15801 represents a variable or constant of floating-point type.
15802
15803 @item t
15804 represents a type.
15805
15806 @item v
15807 represents a variable.
15808
15809 @item x
15810 represents a variable or constant of one of many types.  See the
15811 explanation of the function for details.
15812 @end table
15813
15814 All Modula-2 built-in procedures also return a result, described below.
15815
15816 @table @code
15817 @item ABS(@var{n})
15818 Returns the absolute value of @var{n}.
15819
15820 @item CAP(@var{c})
15821 If @var{c} is a lower case letter, it returns its upper case
15822 equivalent, otherwise it returns its argument.
15823
15824 @item CHR(@var{i})
15825 Returns the character whose ordinal value is @var{i}.
15826
15827 @item DEC(@var{v})
15828 Decrements the value in the variable @var{v} by one.  Returns the new value.
15829
15830 @item DEC(@var{v},@var{i})
15831 Decrements the value in the variable @var{v} by @var{i}.  Returns the
15832 new value.
15833
15834 @item EXCL(@var{m},@var{s})
15835 Removes the element @var{m} from the set @var{s}.  Returns the new
15836 set.
15837
15838 @item FLOAT(@var{i})
15839 Returns the floating point equivalent of the integer @var{i}.
15840
15841 @item HIGH(@var{a})
15842 Returns the index of the last member of @var{a}.
15843
15844 @item INC(@var{v})
15845 Increments the value in the variable @var{v} by one.  Returns the new value.
15846
15847 @item INC(@var{v},@var{i})
15848 Increments the value in the variable @var{v} by @var{i}.  Returns the
15849 new value.
15850
15851 @item INCL(@var{m},@var{s})
15852 Adds the element @var{m} to the set @var{s} if it is not already
15853 there.  Returns the new set.
15854
15855 @item MAX(@var{t})
15856 Returns the maximum value of the type @var{t}.
15857
15858 @item MIN(@var{t})
15859 Returns the minimum value of the type @var{t}.
15860
15861 @item ODD(@var{i})
15862 Returns boolean TRUE if @var{i} is an odd number.
15863
15864 @item ORD(@var{x})
15865 Returns the ordinal value of its argument.  For example, the ordinal
15866 value of a character is its @sc{ascii} value (on machines supporting
15867 the @sc{ascii} character set).  The argument @var{x} must be of an
15868 ordered type, which include integral, character and enumerated types.
15869
15870 @item SIZE(@var{x})
15871 Returns the size of its argument.  The argument @var{x} can be a
15872 variable or a type.
15873
15874 @item TRUNC(@var{r})
15875 Returns the integral part of @var{r}.
15876
15877 @item TSIZE(@var{x})
15878 Returns the size of its argument.  The argument @var{x} can be a
15879 variable or a type.
15880
15881 @item VAL(@var{t},@var{i})
15882 Returns the member of the type @var{t} whose ordinal value is @var{i}.
15883 @end table
15884
15885 @quotation
15886 @emph{Warning:}  Sets and their operations are not yet supported, so
15887 @value{GDBN} treats the use of procedures @code{INCL} and @code{EXCL} as
15888 an error.
15889 @end quotation
15890
15891 @cindex Modula-2 constants
15892 @node M2 Constants
15893 @subsubsection Constants
15894
15895 @value{GDBN} allows you to express the constants of Modula-2 in the following
15896 ways:
15897
15898 @itemize @bullet
15899
15900 @item
15901 Integer constants are simply a sequence of digits.  When used in an
15902 expression, a constant is interpreted to be type-compatible with the
15903 rest of the expression.  Hexadecimal integers are specified by a
15904 trailing @samp{H}, and octal integers by a trailing @samp{B}.
15905
15906 @item
15907 Floating point constants appear as a sequence of digits, followed by a
15908 decimal point and another sequence of digits.  An optional exponent can
15909 then be specified, in the form @samp{E@r{[}+@r{|}-@r{]}@var{nnn}}, where
15910 @samp{@r{[}+@r{|}-@r{]}@var{nnn}} is the desired exponent.  All of the
15911 digits of the floating point constant must be valid decimal (base 10)
15912 digits.
15913
15914 @item
15915 Character constants consist of a single character enclosed by a pair of
15916 like quotes, either single (@code{'}) or double (@code{"}).  They may
15917 also be expressed by their ordinal value (their @sc{ascii} value, usually)
15918 followed by a @samp{C}.
15919
15920 @item
15921 String constants consist of a sequence of characters enclosed by a
15922 pair of like quotes, either single (@code{'}) or double (@code{"}).
15923 Escape sequences in the style of C are also allowed.  @xref{C
15924 Constants, ,C and C@t{++} Constants}, for a brief explanation of escape
15925 sequences.
15926
15927 @item
15928 Enumerated constants consist of an enumerated identifier.
15929
15930 @item
15931 Boolean constants consist of the identifiers @code{TRUE} and
15932 @code{FALSE}.
15933
15934 @item
15935 Pointer constants consist of integral values only.
15936
15937 @item
15938 Set constants are not yet supported.
15939 @end itemize
15940
15941 @node M2 Types
15942 @subsubsection Modula-2 Types
15943 @cindex Modula-2 types
15944
15945 Currently @value{GDBN} can print the following data types in Modula-2
15946 syntax: array types, record types, set types, pointer types, procedure
15947 types, enumerated types, subrange types and base types.  You can also
15948 print the contents of variables declared using these type.
15949 This section gives a number of simple source code examples together with
15950 sample @value{GDBN} sessions.
15951
15952 The first example contains the following section of code:
15953
15954 @smallexample
15955 VAR
15956    s: SET OF CHAR ;
15957    r: [20..40] ;
15958 @end smallexample
15959
15960 @noindent
15961 and you can request @value{GDBN} to interrogate the type and value of
15962 @code{r} and @code{s}.
15963
15964 @smallexample
15965 (@value{GDBP}) print s
15966 @{'A'..'C', 'Z'@}
15967 (@value{GDBP}) ptype s
15968 SET OF CHAR
15969 (@value{GDBP}) print r
15970 21
15971 (@value{GDBP}) ptype r
15972 [20..40]
15973 @end smallexample
15974
15975 @noindent
15976 Likewise if your source code declares @code{s} as:
15977
15978 @smallexample
15979 VAR
15980    s: SET ['A'..'Z'] ;
15981 @end smallexample
15982
15983 @noindent
15984 then you may query the type of @code{s} by:
15985
15986 @smallexample
15987 (@value{GDBP}) ptype s
15988 type = SET ['A'..'Z']
15989 @end smallexample
15990
15991 @noindent
15992 Note that at present you cannot interactively manipulate set
15993 expressions using the debugger.
15994
15995 The following example shows how you might declare an array in Modula-2
15996 and how you can interact with @value{GDBN} to print its type and contents:
15997
15998 @smallexample
15999 VAR
16000    s: ARRAY [-10..10] OF CHAR ;
16001 @end smallexample
16002
16003 @smallexample
16004 (@value{GDBP}) ptype s
16005 ARRAY [-10..10] OF CHAR
16006 @end smallexample
16007
16008 Note that the array handling is not yet complete and although the type
16009 is printed correctly, expression handling still assumes that all
16010 arrays have a lower bound of zero and not @code{-10} as in the example
16011 above.
16012
16013 Here are some more type related Modula-2 examples:
16014
16015 @smallexample
16016 TYPE
16017    colour = (blue, red, yellow, green) ;
16018    t = [blue..yellow] ;
16019 VAR
16020    s: t ;
16021 BEGIN
16022    s := blue ;
16023 @end smallexample
16024
16025 @noindent
16026 The @value{GDBN} interaction shows how you can query the data type
16027 and value of a variable.
16028
16029 @smallexample
16030 (@value{GDBP}) print s
16031 $1 = blue
16032 (@value{GDBP}) ptype t
16033 type = [blue..yellow]
16034 @end smallexample
16035
16036 @noindent
16037 In this example a Modula-2 array is declared and its contents
16038 displayed.  Observe that the contents are written in the same way as
16039 their @code{C} counterparts.
16040
16041 @smallexample
16042 VAR
16043    s: ARRAY [1..5] OF CARDINAL ;
16044 BEGIN
16045    s[1] := 1 ;
16046 @end smallexample
16047
16048 @smallexample
16049 (@value{GDBP}) print s
16050 $1 = @{1, 0, 0, 0, 0@}
16051 (@value{GDBP}) ptype s
16052 type = ARRAY [1..5] OF CARDINAL
16053 @end smallexample
16054
16055 The Modula-2 language interface to @value{GDBN} also understands
16056 pointer types as shown in this example:
16057
16058 @smallexample
16059 VAR
16060    s: POINTER TO ARRAY [1..5] OF CARDINAL ;
16061 BEGIN
16062    NEW(s) ;
16063    s^[1] := 1 ;
16064 @end smallexample
16065
16066 @noindent
16067 and you can request that @value{GDBN} describes the type of @code{s}.
16068
16069 @smallexample
16070 (@value{GDBP}) ptype s
16071 type = POINTER TO ARRAY [1..5] OF CARDINAL
16072 @end smallexample
16073
16074 @value{GDBN} handles compound types as we can see in this example.
16075 Here we combine array types, record types, pointer types and subrange
16076 types:
16077
16078 @smallexample
16079 TYPE
16080    foo = RECORD
16081             f1: CARDINAL ;
16082             f2: CHAR ;
16083             f3: myarray ;
16084          END ;
16085
16086    myarray = ARRAY myrange OF CARDINAL ;
16087    myrange = [-2..2] ;
16088 VAR
16089    s: POINTER TO ARRAY myrange OF foo ;
16090 @end smallexample
16091
16092 @noindent
16093 and you can ask @value{GDBN} to describe the type of @code{s} as shown
16094 below.
16095
16096 @smallexample
16097 (@value{GDBP}) ptype s
16098 type = POINTER TO ARRAY [-2..2] OF foo = RECORD
16099     f1 : CARDINAL;
16100     f2 : CHAR;
16101     f3 : ARRAY [-2..2] OF CARDINAL;
16102 END 
16103 @end smallexample
16104
16105 @node M2 Defaults
16106 @subsubsection Modula-2 Defaults
16107 @cindex Modula-2 defaults
16108
16109 If type and range checking are set automatically by @value{GDBN}, they
16110 both default to @code{on} whenever the working language changes to
16111 Modula-2.  This happens regardless of whether you or @value{GDBN}
16112 selected the working language.
16113
16114 If you allow @value{GDBN} to set the language automatically, then entering
16115 code compiled from a file whose name ends with @file{.mod} sets the
16116 working language to Modula-2.  @xref{Automatically, ,Having @value{GDBN}
16117 Infer the Source Language}, for further details.
16118
16119 @node Deviations
16120 @subsubsection Deviations from Standard Modula-2
16121 @cindex Modula-2, deviations from
16122
16123 A few changes have been made to make Modula-2 programs easier to debug.
16124 This is done primarily via loosening its type strictness:
16125
16126 @itemize @bullet
16127 @item
16128 Unlike in standard Modula-2, pointer constants can be formed by
16129 integers.  This allows you to modify pointer variables during
16130 debugging.  (In standard Modula-2, the actual address contained in a
16131 pointer variable is hidden from you; it can only be modified
16132 through direct assignment to another pointer variable or expression that
16133 returned a pointer.)
16134
16135 @item
16136 C escape sequences can be used in strings and characters to represent
16137 non-printable characters.  @value{GDBN} prints out strings with these
16138 escape sequences embedded.  Single non-printable characters are
16139 printed using the @samp{CHR(@var{nnn})} format.
16140
16141 @item
16142 The assignment operator (@code{:=}) returns the value of its right-hand
16143 argument.
16144
16145 @item
16146 All built-in procedures both modify @emph{and} return their argument.
16147 @end itemize
16148
16149 @node M2 Checks
16150 @subsubsection Modula-2 Type and Range Checks
16151 @cindex Modula-2 checks
16152
16153 @quotation
16154 @emph{Warning:} in this release, @value{GDBN} does not yet perform type or
16155 range checking.
16156 @end quotation
16157 @c FIXME remove warning when type/range checks added
16158
16159 @value{GDBN} considers two Modula-2 variables type equivalent if:
16160
16161 @itemize @bullet
16162 @item
16163 They are of types that have been declared equivalent via a @code{TYPE
16164 @var{t1} = @var{t2}} statement
16165
16166 @item
16167 They have been declared on the same line.  (Note:  This is true of the
16168 @sc{gnu} Modula-2 compiler, but it may not be true of other compilers.)
16169 @end itemize
16170
16171 As long as type checking is enabled, any attempt to combine variables
16172 whose types are not equivalent is an error.
16173
16174 Range checking is done on all mathematical operations, assignment, array
16175 index bounds, and all built-in functions and procedures.
16176
16177 @node M2 Scope
16178 @subsubsection The Scope Operators @code{::} and @code{.}
16179 @cindex scope
16180 @cindex @code{.}, Modula-2 scope operator
16181 @cindex colon, doubled as scope operator
16182 @ifinfo
16183 @vindex colon-colon@r{, in Modula-2}
16184 @c Info cannot handle :: but TeX can.
16185 @end ifinfo
16186 @ifnotinfo
16187 @vindex ::@r{, in Modula-2}
16188 @end ifnotinfo
16189
16190 There are a few subtle differences between the Modula-2 scope operator
16191 (@code{.}) and the @value{GDBN} scope operator (@code{::}).  The two have
16192 similar syntax:
16193
16194 @smallexample
16195
16196 @var{module} . @var{id}
16197 @var{scope} :: @var{id}
16198 @end smallexample
16199
16200 @noindent
16201 where @var{scope} is the name of a module or a procedure,
16202 @var{module} the name of a module, and @var{id} is any declared
16203 identifier within your program, except another module.
16204
16205 Using the @code{::} operator makes @value{GDBN} search the scope
16206 specified by @var{scope} for the identifier @var{id}.  If it is not
16207 found in the specified scope, then @value{GDBN} searches all scopes
16208 enclosing the one specified by @var{scope}.
16209
16210 Using the @code{.} operator makes @value{GDBN} search the current scope for
16211 the identifier specified by @var{id} that was imported from the
16212 definition module specified by @var{module}.  With this operator, it is
16213 an error if the identifier @var{id} was not imported from definition
16214 module @var{module}, or if @var{id} is not an identifier in
16215 @var{module}.
16216
16217 @node GDB/M2
16218 @subsubsection @value{GDBN} and Modula-2
16219
16220 Some @value{GDBN} commands have little use when debugging Modula-2 programs.
16221 Five subcommands of @code{set print} and @code{show print} apply
16222 specifically to C and C@t{++}: @samp{vtbl}, @samp{demangle},
16223 @samp{asm-demangle}, @samp{object}, and @samp{union}.  The first four
16224 apply to C@t{++}, and the last to the C @code{union} type, which has no direct
16225 analogue in Modula-2.
16226
16227 The @code{@@} operator (@pxref{Expressions, ,Expressions}), while available
16228 with any language, is not useful with Modula-2.  Its
16229 intent is to aid the debugging of @dfn{dynamic arrays}, which cannot be
16230 created in Modula-2 as they can in C or C@t{++}.  However, because an
16231 address can be specified by an integral constant, the construct
16232 @samp{@{@var{type}@}@var{adrexp}} is still useful.
16233
16234 @cindex @code{#} in Modula-2
16235 In @value{GDBN} scripts, the Modula-2 inequality operator @code{#} is
16236 interpreted as the beginning of a comment.  Use @code{<>} instead.
16237
16238 @node Ada
16239 @subsection Ada
16240 @cindex Ada
16241
16242 The extensions made to @value{GDBN} for Ada only support
16243 output from the @sc{gnu} Ada (GNAT) compiler.
16244 Other Ada compilers are not currently supported, and
16245 attempting to debug executables produced by them is most likely
16246 to be difficult.
16247
16248
16249 @cindex expressions in Ada
16250 @menu
16251 * Ada Mode Intro::              General remarks on the Ada syntax 
16252                                    and semantics supported by Ada mode 
16253                                    in @value{GDBN}.
16254 * Omissions from Ada::          Restrictions on the Ada expression syntax.
16255 * Additions to Ada::            Extensions of the Ada expression syntax.
16256 * Overloading support for Ada:: Support for expressions involving overloaded
16257                                    subprograms.
16258 * Stopping Before Main Program:: Debugging the program during elaboration.
16259 * Ada Exceptions::              Ada Exceptions
16260 * Ada Tasks::                   Listing and setting breakpoints in tasks.
16261 * Ada Tasks and Core Files::    Tasking Support when Debugging Core Files
16262 * Ravenscar Profile::           Tasking Support when using the Ravenscar
16263                                    Profile
16264 * Ada Glitches::                Known peculiarities of Ada mode.
16265 @end menu
16266
16267 @node Ada Mode Intro
16268 @subsubsection Introduction
16269 @cindex Ada mode, general
16270
16271 The Ada mode of @value{GDBN} supports a fairly large subset of Ada expression 
16272 syntax, with some extensions.
16273 The philosophy behind the design of this subset is 
16274
16275 @itemize @bullet
16276 @item
16277 That @value{GDBN} should provide basic literals and access to operations for 
16278 arithmetic, dereferencing, field selection, indexing, and subprogram calls, 
16279 leaving more sophisticated computations to subprograms written into the
16280 program (which therefore may be called from @value{GDBN}).
16281
16282 @item 
16283 That type safety and strict adherence to Ada language restrictions
16284 are not particularly important to the @value{GDBN} user.
16285
16286 @item 
16287 That brevity is important to the @value{GDBN} user.
16288 @end itemize
16289
16290 Thus, for brevity, the debugger acts as if all names declared in
16291 user-written packages are directly visible, even if they are not visible
16292 according to Ada rules, thus making it unnecessary to fully qualify most
16293 names with their packages, regardless of context.  Where this causes
16294 ambiguity, @value{GDBN} asks the user's intent.
16295
16296 The debugger will start in Ada mode if it detects an Ada main program. 
16297 As for other languages, it will enter Ada mode when stopped in a program that
16298 was translated from an Ada source file.
16299
16300 While in Ada mode, you may use `@t{--}' for comments.  This is useful 
16301 mostly for documenting command files.  The standard @value{GDBN} comment 
16302 (@samp{#}) still works at the beginning of a line in Ada mode, but not in the 
16303 middle (to allow based literals).
16304
16305 @node Omissions from Ada
16306 @subsubsection Omissions from Ada
16307 @cindex Ada, omissions from
16308
16309 Here are the notable omissions from the subset:
16310
16311 @itemize @bullet
16312 @item
16313 Only a subset of the attributes are supported:
16314
16315 @itemize @minus
16316 @item
16317 @t{'First}, @t{'Last}, and @t{'Length}
16318  on array objects (not on types and subtypes).
16319
16320 @item
16321 @t{'Min} and @t{'Max}.  
16322
16323 @item 
16324 @t{'Pos} and @t{'Val}. 
16325
16326 @item
16327 @t{'Tag}.
16328
16329 @item
16330 @t{'Range} on array objects (not subtypes), but only as the right
16331 operand of the membership (@code{in}) operator.
16332
16333 @item 
16334 @t{'Access}, @t{'Unchecked_Access}, and 
16335 @t{'Unrestricted_Access} (a GNAT extension).
16336
16337 @item
16338 @t{'Address}.
16339 @end itemize
16340
16341 @item
16342 The names in
16343 @code{Characters.Latin_1} are not available and
16344 concatenation is not implemented.  Thus, escape characters in strings are 
16345 not currently available.
16346
16347 @item
16348 Equality tests (@samp{=} and @samp{/=}) on arrays test for bitwise
16349 equality of representations.  They will generally work correctly
16350 for strings and arrays whose elements have integer or enumeration types.
16351 They may not work correctly for arrays whose element
16352 types have user-defined equality, for arrays of real values 
16353 (in particular, IEEE-conformant floating point, because of negative
16354 zeroes and NaNs), and for arrays whose elements contain unused bits with
16355 indeterminate values.  
16356
16357 @item
16358 The other component-by-component array operations (@code{and}, @code{or}, 
16359 @code{xor}, @code{not}, and relational tests other than equality)
16360 are not implemented. 
16361
16362 @item 
16363 @cindex array aggregates (Ada)
16364 @cindex record aggregates (Ada)
16365 @cindex aggregates (Ada) 
16366 There is limited support for array and record aggregates.  They are
16367 permitted only on the right sides of assignments, as in these examples:
16368
16369 @smallexample
16370 (@value{GDBP}) set An_Array := (1, 2, 3, 4, 5, 6)
16371 (@value{GDBP}) set An_Array := (1, others => 0)
16372 (@value{GDBP}) set An_Array := (0|4 => 1, 1..3 => 2, 5 => 6)
16373 (@value{GDBP}) set A_2D_Array := ((1, 2, 3), (4, 5, 6), (7, 8, 9))
16374 (@value{GDBP}) set A_Record := (1, "Peter", True);
16375 (@value{GDBP}) set A_Record := (Name => "Peter", Id => 1, Alive => True)
16376 @end smallexample
16377
16378 Changing a
16379 discriminant's value by assigning an aggregate has an
16380 undefined effect if that discriminant is used within the record.
16381 However, you can first modify discriminants by directly assigning to
16382 them (which normally would not be allowed in Ada), and then performing an
16383 aggregate assignment.  For example, given a variable @code{A_Rec} 
16384 declared to have a type such as:
16385
16386 @smallexample
16387 type Rec (Len : Small_Integer := 0) is record
16388     Id : Integer;
16389     Vals : IntArray (1 .. Len);
16390 end record;
16391 @end smallexample
16392
16393 you can assign a value with a different size of @code{Vals} with two
16394 assignments:
16395
16396 @smallexample
16397 (@value{GDBP}) set A_Rec.Len := 4
16398 (@value{GDBP}) set A_Rec := (Id => 42, Vals => (1, 2, 3, 4))
16399 @end smallexample
16400
16401 As this example also illustrates, @value{GDBN} is very loose about the usual
16402 rules concerning aggregates.  You may leave out some of the
16403 components of an array or record aggregate (such as the @code{Len} 
16404 component in the assignment to @code{A_Rec} above); they will retain their
16405 original values upon assignment.  You may freely use dynamic values as
16406 indices in component associations.  You may even use overlapping or
16407 redundant component associations, although which component values are
16408 assigned in such cases is not defined.
16409
16410 @item
16411 Calls to dispatching subprograms are not implemented.
16412
16413 @item
16414 The overloading algorithm is much more limited (i.e., less selective)
16415 than that of real Ada.  It makes only limited use of the context in
16416 which a subexpression appears to resolve its meaning, and it is much
16417 looser in its rules for allowing type matches.  As a result, some
16418 function calls will be ambiguous, and the user will be asked to choose
16419 the proper resolution.
16420
16421 @item
16422 The @code{new} operator is not implemented.
16423
16424 @item
16425 Entry calls are not implemented.
16426
16427 @item 
16428 Aside from printing, arithmetic operations on the native VAX floating-point 
16429 formats are not supported.
16430
16431 @item
16432 It is not possible to slice a packed array.
16433
16434 @item
16435 The names @code{True} and @code{False}, when not part of a qualified name, 
16436 are interpreted as if implicitly prefixed by @code{Standard}, regardless of 
16437 context.
16438 Should your program
16439 redefine these names in a package or procedure (at best a dubious practice),
16440 you will have to use fully qualified names to access their new definitions.
16441 @end itemize
16442
16443 @node Additions to Ada
16444 @subsubsection Additions to Ada
16445 @cindex Ada, deviations from 
16446
16447 As it does for other languages, @value{GDBN} makes certain generic
16448 extensions to Ada (@pxref{Expressions}):
16449
16450 @itemize @bullet
16451 @item
16452 If the expression @var{E} is a variable residing in memory (typically
16453 a local variable or array element) and @var{N} is a positive integer,
16454 then @code{@var{E}@@@var{N}} displays the values of @var{E} and the
16455 @var{N}-1 adjacent variables following it in memory as an array.  In
16456 Ada, this operator is generally not necessary, since its prime use is
16457 in displaying parts of an array, and slicing will usually do this in
16458 Ada.  However, there are occasional uses when debugging programs in
16459 which certain debugging information has been optimized away.
16460
16461 @item
16462 @code{@var{B}::@var{var}} means ``the variable named @var{var} that
16463 appears in function or file @var{B}.''  When @var{B} is a file name,
16464 you must typically surround it in single quotes.
16465
16466 @item 
16467 The expression @code{@{@var{type}@} @var{addr}} means ``the variable of type
16468 @var{type} that appears at address @var{addr}.''
16469
16470 @item
16471 A name starting with @samp{$} is a convenience variable 
16472 (@pxref{Convenience Vars}) or a machine register (@pxref{Registers}).
16473 @end itemize
16474
16475 In addition, @value{GDBN} provides a few other shortcuts and outright
16476 additions specific to Ada:
16477
16478 @itemize @bullet
16479 @item 
16480 The assignment statement is allowed as an expression, returning
16481 its right-hand operand as its value.  Thus, you may enter
16482
16483 @smallexample
16484 (@value{GDBP}) set x := y + 3
16485 (@value{GDBP}) print A(tmp := y + 1)
16486 @end smallexample
16487
16488 @item 
16489 The semicolon is allowed as an ``operator,''  returning as its value 
16490 the value of its right-hand operand.
16491 This allows, for example,
16492 complex conditional breaks:
16493
16494 @smallexample
16495 (@value{GDBP}) break f
16496 (@value{GDBP}) condition 1 (report(i); k += 1; A(k) > 100)
16497 @end smallexample
16498
16499 @item 
16500 Rather than use catenation and symbolic character names to introduce special 
16501 characters into strings, one may instead use a special bracket notation, 
16502 which is also used to print strings.  A sequence of characters of the form 
16503 @samp{["@var{XX}"]} within a string or character literal denotes the 
16504 (single) character whose numeric encoding is @var{XX} in hexadecimal.  The
16505 sequence of characters @samp{["""]} also denotes a single quotation mark 
16506 in strings.   For example,
16507 @smallexample
16508    "One line.["0a"]Next line.["0a"]"
16509 @end smallexample
16510 @noindent
16511 contains an ASCII newline character (@code{Ada.Characters.Latin_1.LF})
16512 after each period.
16513
16514 @item
16515 The subtype used as a prefix for the attributes @t{'Pos}, @t{'Min}, and
16516 @t{'Max} is optional (and is ignored in any case).  For example, it is valid
16517 to write
16518
16519 @smallexample
16520 (@value{GDBP}) print 'max(x, y)
16521 @end smallexample
16522
16523 @item
16524 When printing arrays, @value{GDBN} uses positional notation when the 
16525 array has a lower bound of 1, and uses a modified named notation otherwise.
16526 For example, a one-dimensional array of three integers with a lower bound
16527 of 3 might print as
16528
16529 @smallexample
16530 (3 => 10, 17, 1)
16531 @end smallexample
16532
16533 @noindent
16534 That is, in contrast to valid Ada, only the first component has a @code{=>} 
16535 clause.
16536
16537 @item
16538 You may abbreviate attributes in expressions with any unique,
16539 multi-character subsequence of 
16540 their names (an exact match gets preference).
16541 For example, you may use @t{a'len}, @t{a'gth}, or @t{a'lh}
16542 in place of  @t{a'length}.
16543
16544 @item
16545 @cindex quoting Ada internal identifiers
16546 Since Ada is case-insensitive, the debugger normally maps identifiers you type 
16547 to lower case.  The GNAT compiler uses upper-case characters for 
16548 some of its internal identifiers, which are normally of no interest to users.
16549 For the rare occasions when you actually have to look at them,
16550 enclose them in angle brackets to avoid the lower-case mapping. 
16551 For example,
16552 @smallexample
16553 (@value{GDBP}) print <JMPBUF_SAVE>[0]
16554 @end smallexample
16555
16556 @item
16557 Printing an object of class-wide type or dereferencing an 
16558 access-to-class-wide value will display all the components of the object's
16559 specific type (as indicated by its run-time tag).  Likewise, component
16560 selection on such a value will operate on the specific type of the
16561 object.
16562
16563 @end itemize
16564
16565 @node Overloading support for Ada
16566 @subsubsection Overloading support for Ada
16567 @cindex overloading, Ada
16568
16569 The debugger supports limited overloading.  Given a subprogram call in which
16570 the function symbol has multiple definitions, it will use the number of
16571 actual parameters and some information about their types to attempt to narrow
16572 the set of definitions.  It also makes very limited use of context, preferring
16573 procedures to functions in the context of the @code{call} command, and
16574 functions to procedures elsewhere.
16575
16576 If, after narrowing, the set of matching definitions still contains more than
16577 one definition, @value{GDBN} will display a menu to query which one it should
16578 use, for instance:
16579
16580 @smallexample
16581 (@value{GDBP}) print f(1)
16582 Multiple matches for f
16583 [0] cancel
16584 [1] foo.f (integer) return boolean at foo.adb:23
16585 [2] foo.f (foo.new_integer) return boolean at foo.adb:28
16586
16587 @end smallexample
16588
16589 In this case, just select one menu entry either to cancel expression evaluation
16590 (type @kbd{0} and press @key{RET}) or to continue evaluation with a specific
16591 instance (type the corresponding number and press @key{RET}).
16592
16593 Here are a couple of commands to customize @value{GDBN}'s behavior in this
16594 case:
16595
16596 @table @code
16597
16598 @kindex set ada print-signatures
16599 @item set ada print-signatures
16600 Control whether parameter types and return types are displayed in overloads
16601 selection menus.  It is @code{on} by default.
16602 @xref{Overloading support for Ada}.
16603
16604 @kindex show ada print-signatures
16605 @item show ada print-signatures
16606 Show the current setting for displaying parameter types and return types in
16607 overloads selection menu.
16608 @xref{Overloading support for Ada}.
16609
16610 @end table
16611
16612 @node Stopping Before Main Program
16613 @subsubsection Stopping at the Very Beginning
16614
16615 @cindex breakpointing Ada elaboration code
16616 It is sometimes necessary to debug the program during elaboration, and
16617 before reaching the main procedure.
16618 As defined in the Ada Reference
16619 Manual, the elaboration code is invoked from a procedure called
16620 @code{adainit}.  To run your program up to the beginning of
16621 elaboration, simply use the following two commands:
16622 @code{tbreak adainit} and @code{run}.
16623
16624 @node Ada Exceptions
16625 @subsubsection Ada Exceptions
16626
16627 A command is provided to list all Ada exceptions:
16628
16629 @table @code
16630 @kindex info exceptions
16631 @item info exceptions
16632 @itemx info exceptions @var{regexp}
16633 The @code{info exceptions} command allows you to list all Ada exceptions
16634 defined within the program being debugged, as well as their addresses.
16635 With a regular expression, @var{regexp}, as argument, only those exceptions
16636 whose names match @var{regexp} are listed.
16637 @end table
16638
16639 Below is a small example, showing how the command can be used, first
16640 without argument, and next with a regular expression passed as an
16641 argument.
16642
16643 @smallexample
16644 (@value{GDBP}) info exceptions
16645 All defined Ada exceptions:
16646 constraint_error: 0x613da0
16647 program_error: 0x613d20
16648 storage_error: 0x613ce0
16649 tasking_error: 0x613ca0
16650 const.aint_global_e: 0x613b00
16651 (@value{GDBP}) info exceptions const.aint
16652 All Ada exceptions matching regular expression "const.aint":
16653 constraint_error: 0x613da0
16654 const.aint_global_e: 0x613b00
16655 @end smallexample
16656
16657 It is also possible to ask @value{GDBN} to stop your program's execution
16658 when an exception is raised.  For more details, see @ref{Set Catchpoints}.
16659
16660 @node Ada Tasks
16661 @subsubsection Extensions for Ada Tasks
16662 @cindex Ada, tasking
16663
16664 Support for Ada tasks is analogous to that for threads (@pxref{Threads}).
16665 @value{GDBN} provides the following task-related commands:
16666
16667 @table @code
16668 @kindex info tasks
16669 @item info tasks
16670 This command shows a list of current Ada tasks, as in the following example:
16671
16672
16673 @smallexample
16674 @iftex
16675 @leftskip=0.5cm
16676 @end iftex
16677 (@value{GDBP}) info tasks
16678   ID       TID P-ID Pri State                 Name
16679    1   8088000   0   15 Child Activation Wait main_task
16680    2   80a4000   1   15 Accept Statement      b
16681    3   809a800   1   15 Child Activation Wait a
16682 *  4   80ae800   3   15 Runnable              c
16683
16684 @end smallexample
16685
16686 @noindent
16687 In this listing, the asterisk before the last task indicates it to be the
16688 task currently being inspected.
16689
16690 @table @asis
16691 @item ID
16692 Represents @value{GDBN}'s internal task number.
16693
16694 @item TID
16695 The Ada task ID.
16696
16697 @item P-ID
16698 The parent's task ID (@value{GDBN}'s internal task number).
16699
16700 @item Pri
16701 The base priority of the task.
16702
16703 @item State
16704 Current state of the task.
16705
16706 @table @code
16707 @item Unactivated
16708 The task has been created but has not been activated.  It cannot be
16709 executing.
16710
16711 @item Runnable
16712 The task is not blocked for any reason known to Ada.  (It may be waiting
16713 for a mutex, though.) It is conceptually "executing" in normal mode.
16714
16715 @item Terminated
16716 The task is terminated, in the sense of ARM 9.3 (5).  Any dependents
16717 that were waiting on terminate alternatives have been awakened and have
16718 terminated themselves.
16719
16720 @item Child Activation Wait
16721 The task is waiting for created tasks to complete activation.
16722
16723 @item Accept Statement
16724 The task is waiting on an accept or selective wait statement.
16725
16726 @item Waiting on entry call
16727 The task is waiting on an entry call.
16728
16729 @item Async Select Wait
16730 The task is waiting to start the abortable part of an asynchronous
16731 select statement.
16732
16733 @item Delay Sleep
16734 The task is waiting on a select statement with only a delay
16735 alternative open.
16736
16737 @item Child Termination Wait
16738 The task is sleeping having completed a master within itself, and is
16739 waiting for the tasks dependent on that master to become terminated or
16740 waiting on a terminate Phase.
16741
16742 @item Wait Child in Term Alt
16743 The task is sleeping waiting for tasks on terminate alternatives to
16744 finish terminating.
16745
16746 @item Accepting RV with @var{taskno}
16747 The task is accepting a rendez-vous with the task @var{taskno}.
16748 @end table
16749
16750 @item Name
16751 Name of the task in the program.
16752
16753 @end table
16754
16755 @kindex info task @var{taskno}
16756 @item info task @var{taskno}
16757 This command shows detailled informations on the specified task, as in
16758 the following example:
16759 @smallexample
16760 @iftex
16761 @leftskip=0.5cm
16762 @end iftex
16763 (@value{GDBP}) info tasks
16764   ID       TID P-ID Pri State                  Name
16765    1   8077880    0  15 Child Activation Wait  main_task
16766 *  2   807c468    1  15 Runnable               task_1
16767 (@value{GDBP}) info task 2
16768 Ada Task: 0x807c468
16769 Name: task_1
16770 Thread: 0x807f378
16771 Parent: 1 (main_task)
16772 Base Priority: 15
16773 State: Runnable
16774 @end smallexample
16775
16776 @item task
16777 @kindex task@r{ (Ada)}
16778 @cindex current Ada task ID
16779 This command prints the ID of the current task.
16780
16781 @smallexample
16782 @iftex
16783 @leftskip=0.5cm
16784 @end iftex
16785 (@value{GDBP}) info tasks
16786   ID       TID P-ID Pri State                  Name
16787    1   8077870    0  15 Child Activation Wait  main_task
16788 *  2   807c458    1  15 Runnable               t
16789 (@value{GDBP}) task
16790 [Current task is 2]
16791 @end smallexample
16792
16793 @item task @var{taskno}
16794 @cindex Ada task switching
16795 This command is like the @code{thread @var{thread-id}}
16796 command (@pxref{Threads}).  It switches the context of debugging
16797 from the current task to the given task.
16798
16799 @smallexample
16800 @iftex
16801 @leftskip=0.5cm
16802 @end iftex
16803 (@value{GDBP}) info tasks
16804   ID       TID P-ID Pri State                  Name
16805    1   8077870    0  15 Child Activation Wait  main_task
16806 *  2   807c458    1  15 Runnable               t
16807 (@value{GDBP}) task 1
16808 [Switching to task 1]
16809 #0  0x8067726 in pthread_cond_wait ()
16810 (@value{GDBP}) bt
16811 #0  0x8067726 in pthread_cond_wait ()
16812 #1  0x8056714 in system.os_interface.pthread_cond_wait ()
16813 #2  0x805cb63 in system.task_primitives.operations.sleep ()
16814 #3  0x806153e in system.tasking.stages.activate_tasks ()
16815 #4  0x804aacc in un () at un.adb:5
16816 @end smallexample
16817
16818 @item break @var{location} task @var{taskno}
16819 @itemx break @var{location} task @var{taskno} if @dots{}
16820 @cindex breakpoints and tasks, in Ada
16821 @cindex task breakpoints, in Ada
16822 @kindex break @dots{} task @var{taskno}@r{ (Ada)}
16823 These commands are like the @code{break @dots{} thread @dots{}}
16824 command (@pxref{Thread Stops}).  The
16825 @var{location} argument specifies source lines, as described
16826 in @ref{Specify Location}.
16827
16828 Use the qualifier @samp{task @var{taskno}} with a breakpoint command
16829 to specify that you only want @value{GDBN} to stop the program when a
16830 particular Ada task reaches this breakpoint.  The @var{taskno} is one of the
16831 numeric task identifiers assigned by @value{GDBN}, shown in the first
16832 column of the @samp{info tasks} display.
16833
16834 If you do not specify @samp{task @var{taskno}} when you set a
16835 breakpoint, the breakpoint applies to @emph{all} tasks of your
16836 program.
16837
16838 You can use the @code{task} qualifier on conditional breakpoints as
16839 well; in this case, place @samp{task @var{taskno}} before the
16840 breakpoint condition (before the @code{if}).
16841
16842 For example,
16843
16844 @smallexample
16845 @iftex
16846 @leftskip=0.5cm
16847 @end iftex
16848 (@value{GDBP}) info tasks
16849   ID       TID P-ID Pri State                 Name
16850    1 140022020   0   15 Child Activation Wait main_task
16851    2 140045060   1   15 Accept/Select Wait    t2
16852    3 140044840   1   15 Runnable              t1
16853 *  4 140056040   1   15 Runnable              t3
16854 (@value{GDBP}) b 15 task 2
16855 Breakpoint 5 at 0x120044cb0: file test_task_debug.adb, line 15.
16856 (@value{GDBP}) cont
16857 Continuing.
16858 task # 1 running
16859 task # 2 running
16860
16861 Breakpoint 5, test_task_debug () at test_task_debug.adb:15
16862 15               flush;
16863 (@value{GDBP}) info tasks
16864   ID       TID P-ID Pri State                 Name
16865    1 140022020   0   15 Child Activation Wait main_task
16866 *  2 140045060   1   15 Runnable              t2
16867    3 140044840   1   15 Runnable              t1
16868    4 140056040   1   15 Delay Sleep           t3
16869 @end smallexample
16870 @end table
16871
16872 @node Ada Tasks and Core Files
16873 @subsubsection Tasking Support when Debugging Core Files
16874 @cindex Ada tasking and core file debugging
16875
16876 When inspecting a core file, as opposed to debugging a live program,
16877 tasking support may be limited or even unavailable, depending on
16878 the platform being used.
16879 For instance, on x86-linux, the list of tasks is available, but task
16880 switching is not supported.
16881
16882 On certain platforms, the debugger needs to perform some
16883 memory writes in order to provide Ada tasking support.  When inspecting
16884 a core file, this means that the core file must be opened with read-write
16885 privileges, using the command @samp{"set write on"} (@pxref{Patching}).
16886 Under these circumstances, you should make a backup copy of the core
16887 file before inspecting it with @value{GDBN}.
16888
16889 @node Ravenscar Profile
16890 @subsubsection Tasking Support when using the Ravenscar Profile
16891 @cindex Ravenscar Profile
16892
16893 The @dfn{Ravenscar Profile} is a subset of the Ada tasking features,
16894 specifically designed for systems with safety-critical real-time
16895 requirements.
16896
16897 @table @code
16898 @kindex set ravenscar task-switching on
16899 @cindex task switching with program using Ravenscar Profile
16900 @item set ravenscar task-switching on
16901 Allows task switching when debugging a program that uses the Ravenscar
16902 Profile.  This is the default.
16903
16904 @kindex set ravenscar task-switching off
16905 @item set ravenscar task-switching off
16906 Turn off task switching when debugging a program that uses the Ravenscar
16907 Profile.  This is mostly intended to disable the code that adds support
16908 for the Ravenscar Profile, in case a bug in either @value{GDBN} or in
16909 the Ravenscar runtime is preventing @value{GDBN} from working properly.
16910 To be effective, this command should be run before the program is started.
16911
16912 @kindex show ravenscar task-switching
16913 @item show ravenscar task-switching
16914 Show whether it is possible to switch from task to task in a program
16915 using the Ravenscar Profile.
16916
16917 @end table
16918
16919 @node Ada Glitches
16920 @subsubsection Known Peculiarities of Ada Mode
16921 @cindex Ada, problems
16922
16923 Besides the omissions listed previously (@pxref{Omissions from Ada}),
16924 we know of several problems with and limitations of Ada mode in
16925 @value{GDBN},
16926 some of which will be fixed with planned future releases of the debugger 
16927 and the GNU Ada compiler.
16928
16929 @itemize @bullet
16930 @item 
16931 Static constants that the compiler chooses not to materialize as objects in 
16932 storage are invisible to the debugger.
16933
16934 @item
16935 Named parameter associations in function argument lists are ignored (the
16936 argument lists are treated as positional).
16937
16938 @item
16939 Many useful library packages are currently invisible to the debugger.
16940
16941 @item
16942 Fixed-point arithmetic, conversions, input, and output is carried out using 
16943 floating-point arithmetic, and may give results that only approximate those on 
16944 the host machine.
16945
16946 @item
16947 The GNAT compiler never generates the prefix @code{Standard} for any of 
16948 the standard symbols defined by the Ada language.  @value{GDBN} knows about 
16949 this: it will strip the prefix from names when you use it, and will never
16950 look for a name you have so qualified among local symbols, nor match against
16951 symbols in other packages or subprograms.  If you have 
16952 defined entities anywhere in your program other than parameters and 
16953 local variables whose simple names match names in @code{Standard}, 
16954 GNAT's lack of qualification here can cause confusion.  When this happens,
16955 you can usually resolve the confusion 
16956 by qualifying the problematic names with package
16957 @code{Standard} explicitly.  
16958 @end itemize
16959
16960 Older versions of the compiler sometimes generate erroneous debugging
16961 information, resulting in the debugger incorrectly printing the value
16962 of affected entities.  In some cases, the debugger is able to work
16963 around an issue automatically. In other cases, the debugger is able
16964 to work around the issue, but the work-around has to be specifically
16965 enabled.
16966
16967 @kindex set ada trust-PAD-over-XVS
16968 @kindex show ada trust-PAD-over-XVS
16969 @table @code
16970
16971 @item set ada trust-PAD-over-XVS on
16972 Configure GDB to strictly follow the GNAT encoding when computing the
16973 value of Ada entities, particularly when @code{PAD} and @code{PAD___XVS}
16974 types are involved (see @code{ada/exp_dbug.ads} in the GCC sources for
16975 a complete description of the encoding used by the GNAT compiler).
16976 This is the default.
16977
16978 @item set ada trust-PAD-over-XVS off
16979 This is related to the encoding using by the GNAT compiler.  If @value{GDBN}
16980 sometimes prints the wrong value for certain entities, changing @code{ada
16981 trust-PAD-over-XVS} to @code{off} activates a work-around which may fix
16982 the issue.  It is always safe to set @code{ada trust-PAD-over-XVS} to
16983 @code{off}, but this incurs a slight performance penalty, so it is
16984 recommended to leave this setting to @code{on} unless necessary.
16985
16986 @end table
16987
16988 @cindex GNAT descriptive types
16989 @cindex GNAT encoding
16990 Internally, the debugger also relies on the compiler following a number
16991 of conventions known as the @samp{GNAT Encoding}, all documented in
16992 @file{gcc/ada/exp_dbug.ads} in the GCC sources. This encoding describes
16993 how the debugging information should be generated for certain types.
16994 In particular, this convention makes use of @dfn{descriptive types},
16995 which are artificial types generated purely to help the debugger.
16996
16997 These encodings were defined at a time when the debugging information
16998 format used was not powerful enough to describe some of the more complex
16999 types available in Ada.  Since DWARF allows us to express nearly all
17000 Ada features, the long-term goal is to slowly replace these descriptive
17001 types by their pure DWARF equivalent.  To facilitate that transition,
17002 a new maintenance option is available to force the debugger to ignore
17003 those descriptive types.  It allows the user to quickly evaluate how
17004 well @value{GDBN} works without them.
17005
17006 @table @code
17007
17008 @kindex maint ada set ignore-descriptive-types
17009 @item maintenance ada set ignore-descriptive-types [on|off]
17010 Control whether the debugger should ignore descriptive types.
17011 The default is not to ignore descriptives types (@code{off}).
17012
17013 @kindex maint ada show ignore-descriptive-types
17014 @item maintenance ada show ignore-descriptive-types
17015 Show if descriptive types are ignored by @value{GDBN}.
17016
17017 @end table
17018
17019 @node Unsupported Languages
17020 @section Unsupported Languages
17021
17022 @cindex unsupported languages
17023 @cindex minimal language
17024 In addition to the other fully-supported programming languages,
17025 @value{GDBN} also provides a pseudo-language, called @code{minimal}.
17026 It does not represent a real programming language, but provides a set
17027 of capabilities close to what the C or assembly languages provide.
17028 This should allow most simple operations to be performed while debugging
17029 an application that uses a language currently not supported by @value{GDBN}.
17030
17031 If the language is set to @code{auto}, @value{GDBN} will automatically
17032 select this language if the current frame corresponds to an unsupported
17033 language.
17034
17035 @node Symbols
17036 @chapter Examining the Symbol Table
17037
17038 The commands described in this chapter allow you to inquire about the
17039 symbols (names of variables, functions and types) defined in your
17040 program.  This information is inherent in the text of your program and
17041 does not change as your program executes.  @value{GDBN} finds it in your
17042 program's symbol table, in the file indicated when you started @value{GDBN}
17043 (@pxref{File Options, ,Choosing Files}), or by one of the
17044 file-management commands (@pxref{Files, ,Commands to Specify Files}).
17045
17046 @cindex symbol names
17047 @cindex names of symbols
17048 @cindex quoting names
17049 @anchor{quoting names}
17050 Occasionally, you may need to refer to symbols that contain unusual
17051 characters, which @value{GDBN} ordinarily treats as word delimiters.  The
17052 most frequent case is in referring to static variables in other
17053 source files (@pxref{Variables,,Program Variables}).  File names
17054 are recorded in object files as debugging symbols, but @value{GDBN} would
17055 ordinarily parse a typical file name, like @file{foo.c}, as the three words
17056 @samp{foo} @samp{.} @samp{c}.  To allow @value{GDBN} to recognize
17057 @samp{foo.c} as a single symbol, enclose it in single quotes; for example,
17058
17059 @smallexample
17060 p 'foo.c'::x
17061 @end smallexample
17062
17063 @noindent
17064 looks up the value of @code{x} in the scope of the file @file{foo.c}.
17065
17066 @table @code
17067 @cindex case-insensitive symbol names
17068 @cindex case sensitivity in symbol names
17069 @kindex set case-sensitive
17070 @item set case-sensitive on
17071 @itemx set case-sensitive off
17072 @itemx set case-sensitive auto
17073 Normally, when @value{GDBN} looks up symbols, it matches their names
17074 with case sensitivity determined by the current source language.
17075 Occasionally, you may wish to control that.  The command @code{set
17076 case-sensitive} lets you do that by specifying @code{on} for
17077 case-sensitive matches or @code{off} for case-insensitive ones.  If
17078 you specify @code{auto}, case sensitivity is reset to the default
17079 suitable for the source language.  The default is case-sensitive
17080 matches for all languages except for Fortran, for which the default is
17081 case-insensitive matches.
17082
17083 @kindex show case-sensitive
17084 @item show case-sensitive
17085 This command shows the current setting of case sensitivity for symbols
17086 lookups.
17087
17088 @kindex set print type methods
17089 @item set print type methods
17090 @itemx set print type methods on
17091 @itemx set print type methods off
17092 Normally, when @value{GDBN} prints a class, it displays any methods
17093 declared in that class.  You can control this behavior either by
17094 passing the appropriate flag to @code{ptype}, or using @command{set
17095 print type methods}.  Specifying @code{on} will cause @value{GDBN} to
17096 display the methods; this is the default.  Specifying @code{off} will
17097 cause @value{GDBN} to omit the methods.
17098
17099 @kindex show print type methods
17100 @item show print type methods
17101 This command shows the current setting of method display when printing
17102 classes.
17103
17104 @kindex set print type nested-type-limit
17105 @item set print type nested-type-limit @var{limit}
17106 @itemx set print type nested-type-limit unlimited
17107 Set the limit of displayed nested types that the type printer will
17108 show.  A @var{limit} of @code{unlimited} or @code{-1} will show all
17109 nested definitions.  By default, the type printer will not show any nested
17110 types defined in classes.
17111
17112 @kindex show print type nested-type-limit
17113 @item show print type nested-type-limit
17114 This command shows the current display limit of nested types when
17115 printing classes.
17116
17117 @kindex set print type typedefs
17118 @item set print type typedefs
17119 @itemx set print type typedefs on
17120 @itemx set print type typedefs off
17121
17122 Normally, when @value{GDBN} prints a class, it displays any typedefs
17123 defined in that class.  You can control this behavior either by
17124 passing the appropriate flag to @code{ptype}, or using @command{set
17125 print type typedefs}.  Specifying @code{on} will cause @value{GDBN} to
17126 display the typedef definitions; this is the default.  Specifying
17127 @code{off} will cause @value{GDBN} to omit the typedef definitions.
17128 Note that this controls whether the typedef definition itself is
17129 printed, not whether typedef names are substituted when printing other
17130 types.
17131
17132 @kindex show print type typedefs
17133 @item show print type typedefs
17134 This command shows the current setting of typedef display when
17135 printing classes.
17136
17137 @kindex info address
17138 @cindex address of a symbol
17139 @item info address @var{symbol}
17140 Describe where the data for @var{symbol} is stored.  For a register
17141 variable, this says which register it is kept in.  For a non-register
17142 local variable, this prints the stack-frame offset at which the variable
17143 is always stored.
17144
17145 Note the contrast with @samp{print &@var{symbol}}, which does not work
17146 at all for a register variable, and for a stack local variable prints
17147 the exact address of the current instantiation of the variable.
17148
17149 @kindex info symbol
17150 @cindex symbol from address
17151 @cindex closest symbol and offset for an address
17152 @item info symbol @var{addr}
17153 Print the name of a symbol which is stored at the address @var{addr}.
17154 If no symbol is stored exactly at @var{addr}, @value{GDBN} prints the
17155 nearest symbol and an offset from it:
17156
17157 @smallexample
17158 (@value{GDBP}) info symbol 0x54320
17159 _initialize_vx + 396 in section .text
17160 @end smallexample
17161
17162 @noindent
17163 This is the opposite of the @code{info address} command.  You can use
17164 it to find out the name of a variable or a function given its address.
17165
17166 For dynamically linked executables, the name of executable or shared
17167 library containing the symbol is also printed:
17168
17169 @smallexample
17170 (@value{GDBP}) info symbol 0x400225
17171 _start + 5 in section .text of /tmp/a.out
17172 (@value{GDBP}) info symbol 0x2aaaac2811cf
17173 __read_nocancel + 6 in section .text of /usr/lib64/libc.so.6
17174 @end smallexample
17175
17176 @kindex demangle
17177 @cindex demangle
17178 @item demangle @r{[}-l @var{language}@r{]} @r{[}@var{--}@r{]} @var{name}
17179 Demangle @var{name}.
17180 If @var{language} is provided it is the name of the language to demangle
17181 @var{name} in.  Otherwise @var{name} is demangled in the current language.
17182
17183 The @samp{--} option specifies the end of options,
17184 and is useful when @var{name} begins with a dash.
17185
17186 The parameter @code{demangle-style} specifies how to interpret the kind
17187 of mangling used. @xref{Print Settings}.
17188
17189 @kindex whatis
17190 @item whatis[/@var{flags}] [@var{arg}]
17191 Print the data type of @var{arg}, which can be either an expression
17192 or a name of a data type.  With no argument, print the data type of
17193 @code{$}, the last value in the value history.
17194
17195 If @var{arg} is an expression (@pxref{Expressions, ,Expressions}), it
17196 is not actually evaluated, and any side-effecting operations (such as
17197 assignments or function calls) inside it do not take place.
17198
17199 If @var{arg} is a variable or an expression, @code{whatis} prints its
17200 literal type as it is used in the source code.  If the type was
17201 defined using a @code{typedef}, @code{whatis} will @emph{not} print
17202 the data type underlying the @code{typedef}.  If the type of the
17203 variable or the expression is a compound data type, such as
17204 @code{struct} or  @code{class}, @code{whatis} never prints their
17205 fields or methods.  It just prints the @code{struct}/@code{class}
17206 name (a.k.a.@: its @dfn{tag}).  If you want to see the members of
17207 such a compound data type, use @code{ptype}.
17208
17209 If @var{arg} is a type name that was defined using @code{typedef},
17210 @code{whatis} @dfn{unrolls} only one level of that @code{typedef}.
17211 Unrolling means that @code{whatis} will show the underlying type used
17212 in the @code{typedef} declaration of @var{arg}.  However, if that
17213 underlying type is also a @code{typedef}, @code{whatis} will not
17214 unroll it.
17215
17216 For C code, the type names may also have the form @samp{class
17217 @var{class-name}}, @samp{struct @var{struct-tag}}, @samp{union
17218 @var{union-tag}} or @samp{enum @var{enum-tag}}.
17219
17220 @var{flags} can be used to modify how the type is displayed.
17221 Available flags are:
17222
17223 @table @code
17224 @item r
17225 Display in ``raw'' form.  Normally, @value{GDBN} substitutes template
17226 parameters and typedefs defined in a class when printing the class'
17227 members.  The @code{/r} flag disables this.
17228
17229 @item m
17230 Do not print methods defined in the class.
17231
17232 @item M
17233 Print methods defined in the class.  This is the default, but the flag
17234 exists in case you change the default with @command{set print type methods}.
17235
17236 @item t
17237 Do not print typedefs defined in the class.  Note that this controls
17238 whether the typedef definition itself is printed, not whether typedef
17239 names are substituted when printing other types.
17240
17241 @item T
17242 Print typedefs defined in the class.  This is the default, but the flag
17243 exists in case you change the default with @command{set print type typedefs}.
17244
17245 @item o
17246 Print the offsets and sizes of fields in a struct, similar to what the
17247 @command{pahole} tool does.  This option implies the @code{/tm} flags.
17248
17249 For example, given the following declarations:
17250
17251 @smallexample
17252 struct tuv
17253 @{
17254   int a1;
17255   char *a2;
17256   int a3;
17257 @};
17258
17259 struct xyz
17260 @{
17261   int f1;
17262   char f2;
17263   void *f3;
17264   struct tuv f4;
17265 @};
17266
17267 union qwe
17268 @{
17269   struct tuv fff1;
17270   struct xyz fff2;
17271 @};
17272
17273 struct tyu
17274 @{
17275   int a1 : 1;
17276   int a2 : 3;
17277   int a3 : 23;
17278   char a4 : 2;
17279   int64_t a5;
17280   int a6 : 5;
17281   int64_t a7 : 3;
17282 @};
17283 @end smallexample
17284
17285 Issuing a @kbd{ptype /o struct tuv} command would print:
17286
17287 @smallexample
17288 (@value{GDBP}) ptype /o struct tuv
17289 /* offset    |  size */  type = struct tuv @{
17290 /*    0      |     4 */    int a1;
17291 /* XXX  4-byte hole  */
17292 /*    8      |     8 */    char *a2;
17293 /*   16      |     4 */    int a3;
17294
17295                            /* total size (bytes):   24 */
17296                          @}
17297 @end smallexample
17298
17299 Notice the format of the first column of comments.  There, you can
17300 find two parts separated by the @samp{|} character: the @emph{offset},
17301 which indicates where the field is located inside the struct, in
17302 bytes, and the @emph{size} of the field.  Another interesting line is
17303 the marker of a @emph{hole} in the struct, indicating that it may be
17304 possible to pack the struct and make it use less space by reorganizing
17305 its fields.
17306
17307 It is also possible to print offsets inside an union:
17308
17309 @smallexample
17310 (@value{GDBP}) ptype /o union qwe
17311 /* offset    |  size */  type = union qwe @{
17312 /*                24 */    struct tuv @{
17313 /*    0      |     4 */        int a1;
17314 /* XXX  4-byte hole  */
17315 /*    8      |     8 */        char *a2;
17316 /*   16      |     4 */        int a3;
17317
17318                                /* total size (bytes):   24 */
17319                            @} fff1;
17320 /*                40 */    struct xyz @{
17321 /*    0      |     4 */        int f1;
17322 /*    4      |     1 */        char f2;
17323 /* XXX  3-byte hole  */
17324 /*    8      |     8 */        void *f3;
17325 /*   16      |    24 */        struct tuv @{
17326 /*   16      |     4 */            int a1;
17327 /* XXX  4-byte hole  */
17328 /*   24      |     8 */            char *a2;
17329 /*   32      |     4 */            int a3;
17330
17331                                    /* total size (bytes):   24 */
17332                                @} f4;
17333
17334                                /* total size (bytes):   40 */
17335                            @} fff2;
17336
17337                            /* total size (bytes):   40 */
17338                          @}
17339 @end smallexample
17340
17341 In this case, since @code{struct tuv} and @code{struct xyz} occupy the
17342 same space (because we are dealing with an union), the offset is not
17343 printed for them.  However, you can still examine the offset of each
17344 of these structures' fields.
17345
17346 Another useful scenario is printing the offsets of a struct containing
17347 bitfields:
17348
17349 @smallexample
17350 (@value{GDBP}) ptype /o struct tyu
17351 /* offset    |  size */  type = struct tyu @{
17352 /*    0:31   |     4 */    int a1 : 1;
17353 /*    0:28   |     4 */    int a2 : 3;
17354 /*    0: 5   |     4 */    int a3 : 23;
17355 /*    3: 3   |     1 */    signed char a4 : 2;
17356 /* XXX  3-bit hole   */
17357 /* XXX  4-byte hole  */
17358 /*    8      |     8 */    int64_t a5;
17359 /*   16:27   |     4 */    int a6 : 5;
17360 /*   16:56   |     8 */    int64_t a7 : 3;
17361
17362                            /* total size (bytes):   24 */
17363                          @}
17364 @end smallexample
17365
17366 Note how the offset information is now extended to also include how
17367 many bits are left to be used in each bitfield.
17368 @end table
17369
17370 @kindex ptype
17371 @item ptype[/@var{flags}] [@var{arg}]
17372 @code{ptype} accepts the same arguments as @code{whatis}, but prints a
17373 detailed description of the type, instead of just the name of the type.
17374 @xref{Expressions, ,Expressions}.
17375
17376 Contrary to @code{whatis}, @code{ptype} always unrolls any
17377 @code{typedef}s in its argument declaration, whether the argument is
17378 a variable, expression, or a data type.  This means that @code{ptype}
17379 of a variable or an expression will not print literally its type as
17380 present in the source code---use @code{whatis} for that.  @code{typedef}s at
17381 the pointer or reference targets are also unrolled.  Only @code{typedef}s of
17382 fields, methods and inner @code{class typedef}s of @code{struct}s,
17383 @code{class}es and @code{union}s are not unrolled even with @code{ptype}.
17384
17385 For example, for this variable declaration:
17386
17387 @smallexample
17388 typedef double real_t;
17389 struct complex @{ real_t real; double imag; @};
17390 typedef struct complex complex_t;
17391 complex_t var;
17392 real_t *real_pointer_var;
17393 @end smallexample
17394
17395 @noindent
17396 the two commands give this output:
17397
17398 @smallexample
17399 @group
17400 (@value{GDBP}) whatis var
17401 type = complex_t
17402 (@value{GDBP}) ptype var
17403 type = struct complex @{
17404     real_t real;
17405     double imag;
17406 @}
17407 (@value{GDBP}) whatis complex_t
17408 type = struct complex
17409 (@value{GDBP}) whatis struct complex
17410 type = struct complex
17411 (@value{GDBP}) ptype struct complex
17412 type = struct complex @{
17413     real_t real;
17414     double imag;
17415 @}
17416 (@value{GDBP}) whatis real_pointer_var
17417 type = real_t *
17418 (@value{GDBP}) ptype real_pointer_var
17419 type = double *
17420 @end group
17421 @end smallexample
17422
17423 @noindent
17424 As with @code{whatis}, using @code{ptype} without an argument refers to
17425 the type of @code{$}, the last value in the value history.
17426
17427 @cindex incomplete type
17428 Sometimes, programs use opaque data types or incomplete specifications
17429 of complex data structure.  If the debug information included in the
17430 program does not allow @value{GDBN} to display a full declaration of
17431 the data type, it will say @samp{<incomplete type>}.  For example,
17432 given these declarations:
17433
17434 @smallexample
17435     struct foo;
17436     struct foo *fooptr;
17437 @end smallexample
17438
17439 @noindent
17440 but no definition for @code{struct foo} itself, @value{GDBN} will say:
17441
17442 @smallexample
17443   (@value{GDBP}) ptype foo
17444   $1 = <incomplete type>
17445 @end smallexample
17446
17447 @noindent
17448 ``Incomplete type'' is C terminology for data types that are not
17449 completely specified.
17450
17451 @cindex unknown type
17452 Othertimes, information about a variable's type is completely absent
17453 from the debug information included in the program.  This most often
17454 happens when the program or library where the variable is defined
17455 includes no debug information at all.  @value{GDBN} knows the variable
17456 exists from inspecting the linker/loader symbol table (e.g., the ELF
17457 dynamic symbol table), but such symbols do not contain type
17458 information.  Inspecting the type of a (global) variable for which
17459 @value{GDBN} has no type information shows:
17460
17461 @smallexample
17462   (@value{GDBP}) ptype var
17463   type = <data variable, no debug info>
17464 @end smallexample
17465
17466 @xref{Variables, no debug info variables}, for how to print the values
17467 of such variables.
17468
17469 @kindex info types
17470 @item info types @var{regexp}
17471 @itemx info types
17472 Print a brief description of all types whose names match the regular
17473 expression @var{regexp} (or all types in your program, if you supply
17474 no argument).  Each complete typename is matched as though it were a
17475 complete line; thus, @samp{i type value} gives information on all
17476 types in your program whose names include the string @code{value}, but
17477 @samp{i type ^value$} gives information only on types whose complete
17478 name is @code{value}.
17479
17480 This command differs from @code{ptype} in two ways: first, like
17481 @code{whatis}, it does not print a detailed description; second, it
17482 lists all source files where a type is defined.
17483
17484 @kindex info type-printers
17485 @item info type-printers
17486 Versions of @value{GDBN} that ship with Python scripting enabled may
17487 have ``type printers'' available.  When using @command{ptype} or
17488 @command{whatis}, these printers are consulted when the name of a type
17489 is needed.  @xref{Type Printing API}, for more information on writing
17490 type printers.
17491
17492 @code{info type-printers} displays all the available type printers.
17493
17494 @kindex enable type-printer
17495 @kindex disable type-printer
17496 @item enable type-printer @var{name}@dots{}
17497 @item disable type-printer @var{name}@dots{}
17498 These commands can be used to enable or disable type printers.
17499
17500 @kindex info scope
17501 @cindex local variables
17502 @item info scope @var{location}
17503 List all the variables local to a particular scope.  This command
17504 accepts a @var{location} argument---a function name, a source line, or
17505 an address preceded by a @samp{*}, and prints all the variables local
17506 to the scope defined by that location.  (@xref{Specify Location}, for
17507 details about supported forms of @var{location}.)  For example:
17508
17509 @smallexample
17510 (@value{GDBP}) @b{info scope command_line_handler}
17511 Scope for command_line_handler:
17512 Symbol rl is an argument at stack/frame offset 8, length 4.
17513 Symbol linebuffer is in static storage at address 0x150a18, length 4.
17514 Symbol linelength is in static storage at address 0x150a1c, length 4.
17515 Symbol p is a local variable in register $esi, length 4.
17516 Symbol p1 is a local variable in register $ebx, length 4.
17517 Symbol nline is a local variable in register $edx, length 4.
17518 Symbol repeat is a local variable at frame offset -8, length 4.
17519 @end smallexample
17520
17521 @noindent
17522 This command is especially useful for determining what data to collect
17523 during a @dfn{trace experiment}, see @ref{Tracepoint Actions,
17524 collect}.
17525
17526 @kindex info source
17527 @item info source
17528 Show information about the current source file---that is, the source file for
17529 the function containing the current point of execution:
17530 @itemize @bullet
17531 @item
17532 the name of the source file, and the directory containing it,
17533 @item
17534 the directory it was compiled in,
17535 @item
17536 its length, in lines,
17537 @item
17538 which programming language it is written in,
17539 @item
17540 if the debug information provides it, the program that compiled the file
17541 (which may include, e.g., the compiler version and command line arguments),
17542 @item
17543 whether the executable includes debugging information for that file, and
17544 if so, what format the information is in (e.g., STABS, Dwarf 2, etc.), and
17545 @item
17546 whether the debugging information includes information about
17547 preprocessor macros.
17548 @end itemize
17549
17550
17551 @kindex info sources
17552 @item info sources
17553 Print the names of all source files in your program for which there is
17554 debugging information, organized into two lists: files whose symbols
17555 have already been read, and files whose symbols will be read when needed.
17556
17557 @kindex info functions
17558 @item info functions
17559 Print the names and data types of all defined functions.
17560
17561 @item info functions @var{regexp}
17562 Print the names and data types of all defined functions
17563 whose names contain a match for regular expression @var{regexp}.
17564 Thus, @samp{info fun step} finds all functions whose names
17565 include @code{step}; @samp{info fun ^step} finds those whose names
17566 start with @code{step}.  If a function name contains characters
17567 that conflict with the regular expression language (e.g.@:
17568 @samp{operator*()}), they may be quoted with a backslash.
17569
17570 @kindex info variables
17571 @item info variables
17572 Print the names and data types of all variables that are defined
17573 outside of functions (i.e.@: excluding local variables).
17574
17575 @item info variables @var{regexp}
17576 Print the names and data types of all variables (except for local
17577 variables) whose names contain a match for regular expression
17578 @var{regexp}.
17579
17580 @kindex info classes
17581 @cindex Objective-C, classes and selectors
17582 @item info classes
17583 @itemx info classes @var{regexp}
17584 Display all Objective-C classes in your program, or
17585 (with the @var{regexp} argument) all those matching a particular regular
17586 expression.
17587
17588 @kindex info selectors
17589 @item info selectors
17590 @itemx info selectors @var{regexp}
17591 Display all Objective-C selectors in your program, or
17592 (with the @var{regexp} argument) all those matching a particular regular
17593 expression.
17594
17595 @ignore
17596 This was never implemented.
17597 @kindex info methods
17598 @item info methods
17599 @itemx info methods @var{regexp}
17600 The @code{info methods} command permits the user to examine all defined
17601 methods within C@t{++} program, or (with the @var{regexp} argument) a
17602 specific set of methods found in the various C@t{++} classes.  Many
17603 C@t{++} classes provide a large number of methods.  Thus, the output
17604 from the @code{ptype} command can be overwhelming and hard to use.  The
17605 @code{info-methods} command filters the methods, printing only those
17606 which match the regular-expression @var{regexp}.
17607 @end ignore
17608
17609 @cindex opaque data types
17610 @kindex set opaque-type-resolution
17611 @item set opaque-type-resolution on
17612 Tell @value{GDBN} to resolve opaque types.  An opaque type is a type
17613 declared as a pointer to a @code{struct}, @code{class}, or
17614 @code{union}---for example, @code{struct MyType *}---that is used in one
17615 source file although the full declaration of @code{struct MyType} is in
17616 another source file.  The default is on.
17617
17618 A change in the setting of this subcommand will not take effect until
17619 the next time symbols for a file are loaded.
17620
17621 @item set opaque-type-resolution off
17622 Tell @value{GDBN} not to resolve opaque types.  In this case, the type
17623 is printed as follows:
17624 @smallexample
17625 @{<no data fields>@}
17626 @end smallexample
17627
17628 @kindex show opaque-type-resolution
17629 @item show opaque-type-resolution
17630 Show whether opaque types are resolved or not.
17631
17632 @kindex set print symbol-loading
17633 @cindex print messages when symbols are loaded
17634 @item set print symbol-loading
17635 @itemx set print symbol-loading full
17636 @itemx set print symbol-loading brief
17637 @itemx set print symbol-loading off
17638 The @code{set print symbol-loading} command allows you to control the
17639 printing of messages when @value{GDBN} loads symbol information.
17640 By default a message is printed for the executable and one for each
17641 shared library, and normally this is what you want.  However, when
17642 debugging apps with large numbers of shared libraries these messages
17643 can be annoying.
17644 When set to @code{brief} a message is printed for each executable,
17645 and when @value{GDBN} loads a collection of shared libraries at once
17646 it will only print one message regardless of the number of shared
17647 libraries.  When set to @code{off} no messages are printed.
17648
17649 @kindex show print symbol-loading
17650 @item show print symbol-loading
17651 Show whether messages will be printed when a @value{GDBN} command
17652 entered from the keyboard causes symbol information to be loaded.
17653
17654 @kindex maint print symbols
17655 @cindex symbol dump
17656 @kindex maint print psymbols
17657 @cindex partial symbol dump
17658 @kindex maint print msymbols
17659 @cindex minimal symbol dump
17660 @item maint print symbols @r{[}-pc @var{address}@r{]} @r{[}@var{filename}@r{]}
17661 @itemx maint print symbols @r{[}-objfile @var{objfile}@r{]} @r{[}-source @var{source}@r{]} @r{[}--@r{]} @r{[}@var{filename}@r{]}
17662 @itemx maint print psymbols @r{[}-objfile @var{objfile}@r{]} @r{[}-pc @var{address}@r{]} @r{[}--@r{]} @r{[}@var{filename}@r{]}
17663 @itemx maint print psymbols @r{[}-objfile @var{objfile}@r{]} @r{[}-source @var{source}@r{]} @r{[}--@r{]} @r{[}@var{filename}@r{]}
17664 @itemx maint print msymbols @r{[}-objfile @var{objfile}@r{]} @r{[}--@r{]} @r{[}@var{filename}@r{]}
17665 Write a dump of debugging symbol data into the file @var{filename} or
17666 the terminal if @var{filename} is unspecified.
17667 If @code{-objfile @var{objfile}} is specified, only dump symbols for
17668 that objfile.
17669 If @code{-pc @var{address}} is specified, only dump symbols for the file
17670 with code at that address.  Note that @var{address} may be a symbol like
17671 @code{main}.
17672 If @code{-source @var{source}} is specified, only dump symbols for that
17673 source file.
17674
17675 These commands are used to debug the @value{GDBN} symbol-reading code.
17676 These commands do not modify internal @value{GDBN} state, therefore
17677 @samp{maint print symbols} will only print symbols for already expanded symbol
17678 tables.
17679 You can use the command @code{info sources} to find out which files these are.
17680 If you use @samp{maint print psymbols} instead, the dump shows information
17681 about symbols that @value{GDBN} only knows partially---that is, symbols
17682 defined in files that @value{GDBN} has skimmed, but not yet read completely.
17683 Finally, @samp{maint print msymbols} just dumps ``minimal symbols'', e.g.,
17684 ``ELF symbols''.
17685
17686 @xref{Files, ,Commands to Specify Files}, for a discussion of how
17687 @value{GDBN} reads symbols (in the description of @code{symbol-file}).
17688
17689 @kindex maint info symtabs
17690 @kindex maint info psymtabs
17691 @cindex listing @value{GDBN}'s internal symbol tables
17692 @cindex symbol tables, listing @value{GDBN}'s internal
17693 @cindex full symbol tables, listing @value{GDBN}'s internal
17694 @cindex partial symbol tables, listing @value{GDBN}'s internal
17695 @item maint info symtabs @r{[} @var{regexp} @r{]}
17696 @itemx maint info psymtabs @r{[} @var{regexp} @r{]}
17697
17698 List the @code{struct symtab} or @code{struct partial_symtab}
17699 structures whose names match @var{regexp}.  If @var{regexp} is not
17700 given, list them all.  The output includes expressions which you can
17701 copy into a @value{GDBN} debugging this one to examine a particular
17702 structure in more detail.  For example:
17703
17704 @smallexample
17705 (@value{GDBP}) maint info psymtabs dwarf2read
17706 @{ objfile /home/gnu/build/gdb/gdb
17707   ((struct objfile *) 0x82e69d0)
17708   @{ psymtab /home/gnu/src/gdb/dwarf2read.c
17709     ((struct partial_symtab *) 0x8474b10)
17710     readin no
17711     fullname (null)
17712     text addresses 0x814d3c8 -- 0x8158074
17713     globals (* (struct partial_symbol **) 0x8507a08 @@ 9)
17714     statics (* (struct partial_symbol **) 0x40e95b78 @@ 2882)
17715     dependencies (none)
17716   @}
17717 @}
17718 (@value{GDBP}) maint info symtabs
17719 (@value{GDBP})
17720 @end smallexample
17721 @noindent
17722 We see that there is one partial symbol table whose filename contains
17723 the string @samp{dwarf2read}, belonging to the @samp{gdb} executable;
17724 and we see that @value{GDBN} has not read in any symtabs yet at all.
17725 If we set a breakpoint on a function, that will cause @value{GDBN} to
17726 read the symtab for the compilation unit containing that function:
17727
17728 @smallexample
17729 (@value{GDBP}) break dwarf2_psymtab_to_symtab
17730 Breakpoint 1 at 0x814e5da: file /home/gnu/src/gdb/dwarf2read.c,
17731 line 1574.
17732 (@value{GDBP}) maint info symtabs
17733 @{ objfile /home/gnu/build/gdb/gdb
17734   ((struct objfile *) 0x82e69d0)
17735   @{ symtab /home/gnu/src/gdb/dwarf2read.c
17736     ((struct symtab *) 0x86c1f38)
17737     dirname (null)
17738     fullname (null)
17739     blockvector ((struct blockvector *) 0x86c1bd0) (primary)
17740     linetable ((struct linetable *) 0x8370fa0)
17741     debugformat DWARF 2
17742   @}
17743 @}
17744 (@value{GDBP})
17745 @end smallexample
17746
17747 @kindex maint info line-table
17748 @cindex listing @value{GDBN}'s internal line tables
17749 @cindex line tables, listing @value{GDBN}'s internal
17750 @item maint info line-table @r{[} @var{regexp} @r{]}
17751
17752 List the @code{struct linetable} from all @code{struct symtab}
17753 instances whose name matches @var{regexp}.  If @var{regexp} is not
17754 given, list the @code{struct linetable} from all @code{struct symtab}.
17755
17756 @kindex maint set symbol-cache-size
17757 @cindex symbol cache size
17758 @item maint set symbol-cache-size @var{size}
17759 Set the size of the symbol cache to @var{size}.
17760 The default size is intended to be good enough for debugging
17761 most applications.  This option exists to allow for experimenting
17762 with different sizes.
17763
17764 @kindex maint show symbol-cache-size
17765 @item maint show symbol-cache-size
17766 Show the size of the symbol cache.
17767
17768 @kindex maint print symbol-cache
17769 @cindex symbol cache, printing its contents
17770 @item maint print symbol-cache
17771 Print the contents of the symbol cache.
17772 This is useful when debugging symbol cache issues.
17773
17774 @kindex maint print symbol-cache-statistics
17775 @cindex symbol cache, printing usage statistics
17776 @item maint print symbol-cache-statistics
17777 Print symbol cache usage statistics.
17778 This helps determine how well the cache is being utilized.
17779
17780 @kindex maint flush-symbol-cache
17781 @cindex symbol cache, flushing
17782 @item maint flush-symbol-cache
17783 Flush the contents of the symbol cache, all entries are removed.
17784 This command is useful when debugging the symbol cache.
17785 It is also useful when collecting performance data.
17786
17787 @end table
17788
17789 @node Altering
17790 @chapter Altering Execution
17791
17792 Once you think you have found an error in your program, you might want to
17793 find out for certain whether correcting the apparent error would lead to
17794 correct results in the rest of the run.  You can find the answer by
17795 experiment, using the @value{GDBN} features for altering execution of the
17796 program.
17797
17798 For example, you can store new values into variables or memory
17799 locations, give your program a signal, restart it at a different
17800 address, or even return prematurely from a function.
17801
17802 @menu
17803 * Assignment::                  Assignment to variables
17804 * Jumping::                     Continuing at a different address
17805 * Signaling::                   Giving your program a signal
17806 * Returning::                   Returning from a function
17807 * Calling::                     Calling your program's functions
17808 * Patching::                    Patching your program
17809 * Compiling and Injecting Code:: Compiling and injecting code in @value{GDBN}
17810 @end menu
17811
17812 @node Assignment
17813 @section Assignment to Variables
17814
17815 @cindex assignment
17816 @cindex setting variables
17817 To alter the value of a variable, evaluate an assignment expression.
17818 @xref{Expressions, ,Expressions}.  For example,
17819
17820 @smallexample
17821 print x=4
17822 @end smallexample
17823
17824 @noindent
17825 stores the value 4 into the variable @code{x}, and then prints the
17826 value of the assignment expression (which is 4).
17827 @xref{Languages, ,Using @value{GDBN} with Different Languages}, for more
17828 information on operators in supported languages.
17829
17830 @kindex set variable
17831 @cindex variables, setting
17832 If you are not interested in seeing the value of the assignment, use the
17833 @code{set} command instead of the @code{print} command.  @code{set} is
17834 really the same as @code{print} except that the expression's value is
17835 not printed and is not put in the value history (@pxref{Value History,
17836 ,Value History}).  The expression is evaluated only for its effects.
17837
17838 If the beginning of the argument string of the @code{set} command
17839 appears identical to a @code{set} subcommand, use the @code{set
17840 variable} command instead of just @code{set}.  This command is identical
17841 to @code{set} except for its lack of subcommands.  For example, if your
17842 program has a variable @code{width}, you get an error if you try to set
17843 a new value with just @samp{set width=13}, because @value{GDBN} has the
17844 command @code{set width}:
17845
17846 @smallexample
17847 (@value{GDBP}) whatis width
17848 type = double
17849 (@value{GDBP}) p width
17850 $4 = 13
17851 (@value{GDBP}) set width=47
17852 Invalid syntax in expression.
17853 @end smallexample
17854
17855 @noindent
17856 The invalid expression, of course, is @samp{=47}.  In
17857 order to actually set the program's variable @code{width}, use
17858
17859 @smallexample
17860 (@value{GDBP}) set var width=47
17861 @end smallexample
17862
17863 Because the @code{set} command has many subcommands that can conflict
17864 with the names of program variables, it is a good idea to use the
17865 @code{set variable} command instead of just @code{set}.  For example, if
17866 your program has a variable @code{g}, you run into problems if you try
17867 to set a new value with just @samp{set g=4}, because @value{GDBN} has
17868 the command @code{set gnutarget}, abbreviated @code{set g}:
17869
17870 @smallexample
17871 @group
17872 (@value{GDBP}) whatis g
17873 type = double
17874 (@value{GDBP}) p g
17875 $1 = 1
17876 (@value{GDBP}) set g=4
17877 (@value{GDBP}) p g
17878 $2 = 1
17879 (@value{GDBP}) r
17880 The program being debugged has been started already.
17881 Start it from the beginning? (y or n) y
17882 Starting program: /home/smith/cc_progs/a.out
17883 "/home/smith/cc_progs/a.out": can't open to read symbols:
17884                                  Invalid bfd target.
17885 (@value{GDBP}) show g
17886 The current BFD target is "=4".
17887 @end group
17888 @end smallexample
17889
17890 @noindent
17891 The program variable @code{g} did not change, and you silently set the
17892 @code{gnutarget} to an invalid value.  In order to set the variable
17893 @code{g}, use
17894
17895 @smallexample
17896 (@value{GDBP}) set var g=4
17897 @end smallexample
17898
17899 @value{GDBN} allows more implicit conversions in assignments than C; you can
17900 freely store an integer value into a pointer variable or vice versa,
17901 and you can convert any structure to any other structure that is the
17902 same length or shorter.
17903 @comment FIXME: how do structs align/pad in these conversions?
17904 @comment        /doc@cygnus.com 18dec1990
17905
17906 To store values into arbitrary places in memory, use the @samp{@{@dots{}@}}
17907 construct to generate a value of specified type at a specified address
17908 (@pxref{Expressions, ,Expressions}).  For example, @code{@{int@}0x83040} refers
17909 to memory location @code{0x83040} as an integer (which implies a certain size
17910 and representation in memory), and
17911
17912 @smallexample
17913 set @{int@}0x83040 = 4
17914 @end smallexample
17915
17916 @noindent
17917 stores the value 4 into that memory location.
17918
17919 @node Jumping
17920 @section Continuing at a Different Address
17921
17922 Ordinarily, when you continue your program, you do so at the place where
17923 it stopped, with the @code{continue} command.  You can instead continue at
17924 an address of your own choosing, with the following commands:
17925
17926 @table @code
17927 @kindex jump
17928 @kindex j @r{(@code{jump})}
17929 @item jump @var{location}
17930 @itemx j @var{location}
17931 Resume execution at @var{location}.  Execution stops again immediately
17932 if there is a breakpoint there.  @xref{Specify Location}, for a description
17933 of the different forms of @var{location}.  It is common
17934 practice to use the @code{tbreak} command in conjunction with
17935 @code{jump}.  @xref{Set Breaks, ,Setting Breakpoints}.
17936
17937 The @code{jump} command does not change the current stack frame, or
17938 the stack pointer, or the contents of any memory location or any
17939 register other than the program counter.  If @var{location} is in
17940 a different function from the one currently executing, the results may
17941 be bizarre if the two functions expect different patterns of arguments or
17942 of local variables.  For this reason, the @code{jump} command requests
17943 confirmation if the specified line is not in the function currently
17944 executing.  However, even bizarre results are predictable if you are
17945 well acquainted with the machine-language code of your program.
17946 @end table
17947
17948 On many systems, you can get much the same effect as the @code{jump}
17949 command by storing a new value into the register @code{$pc}.  The
17950 difference is that this does not start your program running; it only
17951 changes the address of where it @emph{will} run when you continue.  For
17952 example,
17953
17954 @smallexample
17955 set $pc = 0x485
17956 @end smallexample
17957
17958 @noindent
17959 makes the next @code{continue} command or stepping command execute at
17960 address @code{0x485}, rather than at the address where your program stopped.
17961 @xref{Continuing and Stepping, ,Continuing and Stepping}.
17962
17963 The most common occasion to use the @code{jump} command is to back
17964 up---perhaps with more breakpoints set---over a portion of a program
17965 that has already executed, in order to examine its execution in more
17966 detail.
17967
17968 @c @group
17969 @node Signaling
17970 @section Giving your Program a Signal
17971 @cindex deliver a signal to a program
17972
17973 @table @code
17974 @kindex signal
17975 @item signal @var{signal}
17976 Resume execution where your program is stopped, but immediately give it the
17977 signal @var{signal}.  The @var{signal} can be the name or the number of a
17978 signal.  For example, on many systems @code{signal 2} and @code{signal
17979 SIGINT} are both ways of sending an interrupt signal.
17980
17981 Alternatively, if @var{signal} is zero, continue execution without
17982 giving a signal.  This is useful when your program stopped on account of
17983 a signal and would ordinarily see the signal when resumed with the
17984 @code{continue} command; @samp{signal 0} causes it to resume without a
17985 signal.
17986
17987 @emph{Note:} When resuming a multi-threaded program, @var{signal} is
17988 delivered to the currently selected thread, not the thread that last
17989 reported a stop.  This includes the situation where a thread was
17990 stopped due to a signal.  So if you want to continue execution
17991 suppressing the signal that stopped a thread, you should select that
17992 same thread before issuing the @samp{signal 0} command.  If you issue
17993 the @samp{signal 0} command with another thread as the selected one,
17994 @value{GDBN} detects that and asks for confirmation.
17995
17996 Invoking the @code{signal} command is not the same as invoking the
17997 @code{kill} utility from the shell.  Sending a signal with @code{kill}
17998 causes @value{GDBN} to decide what to do with the signal depending on
17999 the signal handling tables (@pxref{Signals}).  The @code{signal} command
18000 passes the signal directly to your program.
18001
18002 @code{signal} does not repeat when you press @key{RET} a second time
18003 after executing the command.
18004
18005 @kindex queue-signal
18006 @item queue-signal @var{signal}
18007 Queue @var{signal} to be delivered immediately to the current thread
18008 when execution of the thread resumes.  The @var{signal} can be the name or
18009 the number of a signal.  For example, on many systems @code{signal 2} and
18010 @code{signal SIGINT} are both ways of sending an interrupt signal.
18011 The handling of the signal must be set to pass the signal to the program,
18012 otherwise @value{GDBN} will report an error.
18013 You can control the handling of signals from @value{GDBN} with the
18014 @code{handle} command (@pxref{Signals}).
18015
18016 Alternatively, if @var{signal} is zero, any currently queued signal
18017 for the current thread is discarded and when execution resumes no signal
18018 will be delivered.  This is useful when your program stopped on account
18019 of a signal and would ordinarily see the signal when resumed with the
18020 @code{continue} command.
18021
18022 This command differs from the @code{signal} command in that the signal
18023 is just queued, execution is not resumed.  And @code{queue-signal} cannot
18024 be used to pass a signal whose handling state has been set to @code{nopass}
18025 (@pxref{Signals}).
18026 @end table
18027 @c @end group
18028
18029 @xref{stepping into signal handlers}, for information on how stepping
18030 commands behave when the thread has a signal queued.
18031
18032 @node Returning
18033 @section Returning from a Function
18034
18035 @table @code
18036 @cindex returning from a function
18037 @kindex return
18038 @item return
18039 @itemx return @var{expression}
18040 You can cancel execution of a function call with the @code{return}
18041 command.  If you give an
18042 @var{expression} argument, its value is used as the function's return
18043 value.
18044 @end table
18045
18046 When you use @code{return}, @value{GDBN} discards the selected stack frame
18047 (and all frames within it).  You can think of this as making the
18048 discarded frame return prematurely.  If you wish to specify a value to
18049 be returned, give that value as the argument to @code{return}.
18050
18051 This pops the selected stack frame (@pxref{Selection, ,Selecting a
18052 Frame}), and any other frames inside of it, leaving its caller as the
18053 innermost remaining frame.  That frame becomes selected.  The
18054 specified value is stored in the registers used for returning values
18055 of functions.
18056
18057 The @code{return} command does not resume execution; it leaves the
18058 program stopped in the state that would exist if the function had just
18059 returned.  In contrast, the @code{finish} command (@pxref{Continuing
18060 and Stepping, ,Continuing and Stepping}) resumes execution until the
18061 selected stack frame returns naturally.
18062
18063 @value{GDBN} needs to know how the @var{expression} argument should be set for
18064 the inferior.  The concrete registers assignment depends on the OS ABI and the
18065 type being returned by the selected stack frame.  For example it is common for
18066 OS ABI to return floating point values in FPU registers while integer values in
18067 CPU registers.  Still some ABIs return even floating point values in CPU
18068 registers.  Larger integer widths (such as @code{long long int}) also have
18069 specific placement rules.  @value{GDBN} already knows the OS ABI from its
18070 current target so it needs to find out also the type being returned to make the
18071 assignment into the right register(s).
18072
18073 Normally, the selected stack frame has debug info.  @value{GDBN} will always
18074 use the debug info instead of the implicit type of @var{expression} when the
18075 debug info is available.  For example, if you type @kbd{return -1}, and the
18076 function in the current stack frame is declared to return a @code{long long
18077 int}, @value{GDBN} transparently converts the implicit @code{int} value of -1
18078 into a @code{long long int}:
18079
18080 @smallexample
18081 Breakpoint 1, func () at gdb.base/return-nodebug.c:29
18082 29        return 31;
18083 (@value{GDBP}) return -1
18084 Make func return now? (y or n) y
18085 #0  0x004004f6 in main () at gdb.base/return-nodebug.c:43
18086 43        printf ("result=%lld\n", func ());
18087 (@value{GDBP})
18088 @end smallexample
18089
18090 However, if the selected stack frame does not have a debug info, e.g., if the
18091 function was compiled without debug info, @value{GDBN} has to find out the type
18092 to return from user.  Specifying a different type by mistake may set the value
18093 in different inferior registers than the caller code expects.  For example,
18094 typing @kbd{return -1} with its implicit type @code{int} would set only a part
18095 of a @code{long long int} result for a debug info less function (on 32-bit
18096 architectures).  Therefore the user is required to specify the return type by
18097 an appropriate cast explicitly:
18098
18099 @smallexample
18100 Breakpoint 2, 0x0040050b in func ()
18101 (@value{GDBP}) return -1
18102 Return value type not available for selected stack frame.
18103 Please use an explicit cast of the value to return.
18104 (@value{GDBP}) return (long long int) -1
18105 Make selected stack frame return now? (y or n) y
18106 #0  0x00400526 in main ()
18107 (@value{GDBP})
18108 @end smallexample
18109
18110 @node Calling
18111 @section Calling Program Functions
18112
18113 @table @code
18114 @cindex calling functions
18115 @cindex inferior functions, calling
18116 @item print @var{expr}
18117 Evaluate the expression @var{expr} and display the resulting value.
18118 The expression may include calls to functions in the program being
18119 debugged.
18120
18121 @kindex call
18122 @item call @var{expr}
18123 Evaluate the expression @var{expr} without displaying @code{void}
18124 returned values.
18125
18126 You can use this variant of the @code{print} command if you want to
18127 execute a function from your program that does not return anything
18128 (a.k.a.@: @dfn{a void function}), but without cluttering the output
18129 with @code{void} returned values that @value{GDBN} will otherwise
18130 print.  If the result is not void, it is printed and saved in the
18131 value history.
18132 @end table
18133
18134 It is possible for the function you call via the @code{print} or
18135 @code{call} command to generate a signal (e.g., if there's a bug in
18136 the function, or if you passed it incorrect arguments).  What happens
18137 in that case is controlled by the @code{set unwindonsignal} command.
18138
18139 Similarly, with a C@t{++} program it is possible for the function you
18140 call via the @code{print} or @code{call} command to generate an
18141 exception that is not handled due to the constraints of the dummy
18142 frame.  In this case, any exception that is raised in the frame, but has
18143 an out-of-frame exception handler will not be found.  GDB builds a
18144 dummy-frame for the inferior function call, and the unwinder cannot
18145 seek for exception handlers outside of this dummy-frame.  What happens
18146 in that case is controlled by the
18147 @code{set unwind-on-terminating-exception} command.
18148
18149 @table @code
18150 @item set unwindonsignal
18151 @kindex set unwindonsignal
18152 @cindex unwind stack in called functions
18153 @cindex call dummy stack unwinding
18154 Set unwinding of the stack if a signal is received while in a function
18155 that @value{GDBN} called in the program being debugged.  If set to on,
18156 @value{GDBN} unwinds the stack it created for the call and restores
18157 the context to what it was before the call.  If set to off (the
18158 default), @value{GDBN} stops in the frame where the signal was
18159 received.
18160
18161 @item show unwindonsignal
18162 @kindex show unwindonsignal
18163 Show the current setting of stack unwinding in the functions called by
18164 @value{GDBN}.
18165
18166 @item set unwind-on-terminating-exception
18167 @kindex set unwind-on-terminating-exception
18168 @cindex unwind stack in called functions with unhandled exceptions
18169 @cindex call dummy stack unwinding on unhandled exception.
18170 Set unwinding of the stack if a C@t{++} exception is raised, but left
18171 unhandled while in a function that @value{GDBN} called in the program being
18172 debugged.  If set to on (the default), @value{GDBN} unwinds the stack
18173 it created for the call and restores the context to what it was before
18174 the call.  If set to off, @value{GDBN} the exception is delivered to
18175 the default C@t{++} exception handler and the inferior terminated.
18176
18177 @item show unwind-on-terminating-exception
18178 @kindex show unwind-on-terminating-exception
18179 Show the current setting of stack unwinding in the functions called by
18180 @value{GDBN}.
18181
18182 @end table
18183
18184 @subsection Calling functions with no debug info
18185
18186 @cindex no debug info functions
18187 Sometimes, a function you wish to call is missing debug information.
18188 In such case, @value{GDBN} does not know the type of the function,
18189 including the types of the function's parameters.  To avoid calling
18190 the inferior function incorrectly, which could result in the called
18191 function functioning erroneously and even crash, @value{GDBN} refuses
18192 to call the function unless you tell it the type of the function.
18193
18194 For prototyped (i.e.@: ANSI/ISO style) functions, there are two ways
18195 to do that.  The simplest is to cast the call to the function's
18196 declared return type.  For example:
18197
18198 @smallexample
18199 (@value{GDBP}) p getenv ("PATH")
18200 'getenv' has unknown return type; cast the call to its declared return type
18201 (@value{GDBP}) p (char *) getenv ("PATH")
18202 $1 = 0x7fffffffe7ba "/usr/local/bin:/"...
18203 @end smallexample
18204
18205 Casting the return type of a no-debug function is equivalent to
18206 casting the function to a pointer to a prototyped function that has a
18207 prototype that matches the types of the passed-in arguments, and
18208 calling that.  I.e., the call above is equivalent to:
18209
18210 @smallexample
18211 (@value{GDBP}) p ((char * (*) (const char *)) getenv) ("PATH")
18212 @end smallexample
18213
18214 @noindent
18215 and given this prototyped C or C++ function with float parameters:
18216
18217 @smallexample
18218 float multiply (float v1, float v2) @{ return v1 * v2; @}
18219 @end smallexample
18220
18221 @noindent
18222 these calls are equivalent:
18223
18224 @smallexample
18225 (@value{GDBP}) p (float) multiply (2.0f, 3.0f)
18226 (@value{GDBP}) p ((float (*) (float, float)) multiply) (2.0f, 3.0f)
18227 @end smallexample
18228
18229 If the function you wish to call is declared as unprototyped (i.e.@:
18230 old K&R style), you must use the cast-to-function-pointer syntax, so
18231 that @value{GDBN} knows that it needs to apply default argument
18232 promotions (promote float arguments to double).  @xref{ABI, float
18233 promotion}.  For example, given this unprototyped C function with
18234 float parameters, and no debug info:
18235
18236 @smallexample
18237 float
18238 multiply_noproto (v1, v2)
18239   float v1, v2;
18240 @{
18241   return v1 * v2;
18242 @}
18243 @end smallexample
18244
18245 @noindent
18246 you call it like this:
18247
18248 @smallexample
18249   (@value{GDBP}) p ((float (*) ()) multiply_noproto) (2.0f, 3.0f)
18250 @end smallexample
18251
18252 @node Patching
18253 @section Patching Programs
18254
18255 @cindex patching binaries
18256 @cindex writing into executables
18257 @cindex writing into corefiles
18258
18259 By default, @value{GDBN} opens the file containing your program's
18260 executable code (or the corefile) read-only.  This prevents accidental
18261 alterations to machine code; but it also prevents you from intentionally
18262 patching your program's binary.
18263
18264 If you'd like to be able to patch the binary, you can specify that
18265 explicitly with the @code{set write} command.  For example, you might
18266 want to turn on internal debugging flags, or even to make emergency
18267 repairs.
18268
18269 @table @code
18270 @kindex set write
18271 @item set write on
18272 @itemx set write off
18273 If you specify @samp{set write on}, @value{GDBN} opens executable and
18274 core files for both reading and writing; if you specify @kbd{set write
18275 off} (the default), @value{GDBN} opens them read-only.
18276
18277 If you have already loaded a file, you must load it again (using the
18278 @code{exec-file} or @code{core-file} command) after changing @code{set
18279 write}, for your new setting to take effect.
18280
18281 @item show write
18282 @kindex show write
18283 Display whether executable files and core files are opened for writing
18284 as well as reading.
18285 @end table
18286
18287 @node Compiling and Injecting Code
18288 @section Compiling and injecting code in @value{GDBN}
18289 @cindex injecting code
18290 @cindex writing into executables
18291 @cindex compiling code
18292
18293 @value{GDBN} supports on-demand compilation and code injection into
18294 programs running under @value{GDBN}.  GCC 5.0 or higher built with
18295 @file{libcc1.so} must be installed for this functionality to be enabled.
18296 This functionality is implemented with the following commands.
18297
18298 @table @code
18299 @kindex compile code
18300 @item compile code @var{source-code}
18301 @itemx compile code -raw @var{--} @var{source-code}
18302 Compile @var{source-code} with the compiler language found as the current
18303 language in @value{GDBN} (@pxref{Languages}).  If compilation and
18304 injection is not supported with the current language specified in
18305 @value{GDBN}, or the compiler does not support this feature, an error
18306 message will be printed.  If @var{source-code} compiles and links
18307 successfully, @value{GDBN} will load the object-code emitted,
18308 and execute it within the context of the currently selected inferior.
18309 It is important to note that the compiled code is executed immediately.
18310 After execution, the compiled code is removed from @value{GDBN} and any
18311 new types or variables you have defined will be deleted.
18312
18313 The command allows you to specify @var{source-code} in two ways.
18314 The simplest method is to provide a single line of code to the command.
18315 E.g.:
18316
18317 @smallexample
18318 compile code printf ("hello world\n");
18319 @end smallexample
18320
18321 If you specify options on the command line as well as source code, they
18322 may conflict.  The @samp{--} delimiter can be used to separate options
18323 from actual source code.  E.g.:
18324
18325 @smallexample
18326 compile code -r -- printf ("hello world\n");
18327 @end smallexample
18328
18329 Alternatively you can enter source code as multiple lines of text.  To
18330 enter this mode, invoke the @samp{compile code} command without any text
18331 following the command.  This will start the multiple-line editor and
18332 allow you to type as many lines of source code as required.  When you
18333 have completed typing, enter @samp{end} on its own line to exit the
18334 editor.
18335
18336 @smallexample
18337 compile code
18338 >printf ("hello\n");
18339 >printf ("world\n");
18340 >end
18341 @end smallexample
18342
18343 Specifying @samp{-raw}, prohibits @value{GDBN} from wrapping the
18344 provided @var{source-code} in a callable scope.  In this case, you must
18345 specify the entry point of the code by defining a function named
18346 @code{_gdb_expr_}.  The @samp{-raw} code cannot access variables of the
18347 inferior.  Using @samp{-raw} option may be needed for example when
18348 @var{source-code} requires @samp{#include} lines which may conflict with
18349 inferior symbols otherwise.
18350
18351 @kindex compile file
18352 @item compile file @var{filename}
18353 @itemx compile file -raw @var{filename}
18354 Like @code{compile code}, but take the source code from @var{filename}.
18355
18356 @smallexample
18357 compile file /home/user/example.c
18358 @end smallexample
18359 @end table
18360
18361 @table @code
18362 @item compile print @var{expr}
18363 @itemx compile print /@var{f} @var{expr}
18364 Compile and execute @var{expr} with the compiler language found as the
18365 current language in @value{GDBN} (@pxref{Languages}).  By default the
18366 value of @var{expr} is printed in a format appropriate to its data type;
18367 you can choose a different format by specifying @samp{/@var{f}}, where
18368 @var{f} is a letter specifying the format; see @ref{Output Formats,,Output
18369 Formats}.
18370
18371 @item compile print
18372 @itemx compile print /@var{f}
18373 @cindex reprint the last value
18374 Alternatively you can enter the expression (source code producing it) as
18375 multiple lines of text.  To enter this mode, invoke the @samp{compile print}
18376 command without any text following the command.  This will start the
18377 multiple-line editor.
18378 @end table
18379
18380 @noindent
18381 The process of compiling and injecting the code can be inspected using:
18382
18383 @table @code
18384 @anchor{set debug compile}
18385 @item set debug compile
18386 @cindex compile command debugging info
18387 Turns on or off display of @value{GDBN} process of compiling and
18388 injecting the code.  The default is off.
18389
18390 @item show debug compile
18391 Displays the current state of displaying @value{GDBN} process of
18392 compiling and injecting the code.
18393 @end table
18394
18395 @subsection Compilation options for the @code{compile} command
18396
18397 @value{GDBN} needs to specify the right compilation options for the code
18398 to be injected, in part to make its ABI compatible with the inferior
18399 and in part to make the injected code compatible with @value{GDBN}'s
18400 injecting process.
18401
18402 @noindent
18403 The options used, in increasing precedence:
18404
18405 @table @asis
18406 @item target architecture and OS options (@code{gdbarch})
18407 These options depend on target processor type and target operating
18408 system, usually they specify at least 32-bit (@code{-m32}) or 64-bit
18409 (@code{-m64}) compilation option.
18410
18411 @item compilation options recorded in the target
18412 @value{NGCC} (since version 4.7) stores the options used for compilation
18413 into @code{DW_AT_producer} part of DWARF debugging information according
18414 to the @value{NGCC} option @code{-grecord-gcc-switches}.  One has to
18415 explicitly specify @code{-g} during inferior compilation otherwise
18416 @value{NGCC} produces no DWARF.  This feature is only relevant for
18417 platforms where @code{-g} produces DWARF by default, otherwise one may
18418 try to enforce DWARF by using @code{-gdwarf-4}.
18419
18420 @item compilation options set by @code{set compile-args}
18421 @end table
18422
18423 @noindent
18424 You can override compilation options using the following command:
18425
18426 @table @code
18427 @item set compile-args
18428 @cindex compile command options override
18429 Set compilation options used for compiling and injecting code with the
18430 @code{compile} commands.  These options override any conflicting ones
18431 from the target architecture and/or options stored during inferior
18432 compilation.
18433
18434 @item show compile-args
18435 Displays the current state of compilation options override.
18436 This does not show all the options actually used during compilation,
18437 use @ref{set debug compile} for that.
18438 @end table
18439
18440 @subsection Caveats when using the @code{compile} command
18441
18442 There are a few caveats to keep in mind when using the @code{compile}
18443 command.  As the caveats are different per language, the table below
18444 highlights specific issues on a per language basis.
18445
18446 @table @asis
18447 @item C code examples and caveats
18448 When the language in @value{GDBN} is set to @samp{C}, the compiler will
18449 attempt to compile the source code with a @samp{C} compiler.  The source
18450 code provided to the @code{compile} command will have much the same
18451 access to variables and types as it normally would if it were part of
18452 the program currently being debugged in @value{GDBN}.
18453
18454 Below is a sample program that forms the basis of the examples that
18455 follow.  This program has been compiled and loaded into @value{GDBN},
18456 much like any other normal debugging session.
18457
18458 @smallexample
18459 void function1 (void)
18460 @{
18461    int i = 42;
18462    printf ("function 1\n");
18463 @}
18464
18465 void function2 (void)
18466 @{
18467    int j = 12;
18468    function1 ();
18469 @}
18470
18471 int main(void)
18472 @{
18473    int k = 6;
18474    int *p;
18475    function2 ();
18476    return 0;
18477 @}
18478 @end smallexample
18479
18480 For the purposes of the examples in this section, the program above has
18481 been compiled, loaded into @value{GDBN}, stopped at the function
18482 @code{main}, and @value{GDBN} is awaiting input from the user.
18483
18484 To access variables and types for any program in @value{GDBN}, the
18485 program must be compiled and packaged with debug information.  The
18486 @code{compile} command is not an exception to this rule.  Without debug
18487 information, you can still use the @code{compile} command, but you will
18488 be very limited in what variables and types you can access.
18489
18490 So with that in mind, the example above has been compiled with debug
18491 information enabled.  The @code{compile} command will have access to
18492 all variables and types (except those that may have been optimized
18493 out).  Currently, as @value{GDBN} has stopped the program in the
18494 @code{main} function, the @code{compile} command would have access to
18495 the variable @code{k}.  You could invoke the @code{compile} command
18496 and type some source code to set the value of @code{k}.  You can also
18497 read it, or do anything with that variable you would normally do in
18498 @code{C}.  Be aware that changes to inferior variables in the
18499 @code{compile} command are persistent.  In the following example:
18500
18501 @smallexample
18502 compile code k = 3;
18503 @end smallexample
18504
18505 @noindent
18506 the variable @code{k} is now 3.  It will retain that value until
18507 something else in the example program changes it, or another
18508 @code{compile} command changes it.
18509
18510 Normal scope and access rules apply to source code compiled and
18511 injected by the @code{compile} command.  In the example, the variables
18512 @code{j} and @code{k} are not accessible yet, because the program is
18513 currently stopped in the @code{main} function, where these variables
18514 are not in scope.  Therefore, the following command
18515
18516 @smallexample
18517 compile code j = 3;
18518 @end smallexample
18519
18520 @noindent
18521 will result in a compilation error message.
18522
18523 Once the program is continued, execution will bring these variables in
18524 scope, and they will become accessible; then the code you specify via
18525 the @code{compile} command will be able to access them.
18526
18527 You can create variables and types with the @code{compile} command as
18528 part of your source code.  Variables and types that are created as part
18529 of the @code{compile} command are not visible to the rest of the program for
18530 the duration of its run.  This example is valid:
18531
18532 @smallexample
18533 compile code int ff = 5; printf ("ff is %d\n", ff);
18534 @end smallexample
18535
18536 However, if you were to type the following into @value{GDBN} after that
18537 command has completed:
18538
18539 @smallexample
18540 compile code printf ("ff is %d\n'', ff);
18541 @end smallexample
18542
18543 @noindent
18544 a compiler error would be raised as the variable @code{ff} no longer
18545 exists.  Object code generated and injected by the @code{compile}
18546 command is removed when its execution ends.  Caution is advised
18547 when assigning to program variables values of variables created by the
18548 code submitted to the @code{compile} command.  This example is valid:
18549
18550 @smallexample
18551 compile code int ff = 5; k = ff;
18552 @end smallexample
18553
18554 The value of the variable @code{ff} is assigned to @code{k}.  The variable
18555 @code{k} does not require the existence of @code{ff} to maintain the value
18556 it has been assigned.  However, pointers require particular care in
18557 assignment.  If the source code compiled with the @code{compile} command
18558 changed the address of a pointer in the example program, perhaps to a
18559 variable created in the @code{compile} command, that pointer would point
18560 to an invalid location when the command exits.  The following example
18561 would likely cause issues with your debugged program:
18562
18563 @smallexample
18564 compile code int ff = 5; p = &ff;
18565 @end smallexample
18566
18567 In this example, @code{p} would point to @code{ff} when the
18568 @code{compile} command is executing the source code provided to it.
18569 However, as variables in the (example) program persist with their
18570 assigned values, the variable @code{p} would point to an invalid
18571 location when the command exists.  A general rule should be followed
18572 in that you should either assign @code{NULL} to any assigned pointers,
18573 or restore a valid location to the pointer before the command exits.
18574
18575 Similar caution must be exercised with any structs, unions, and typedefs
18576 defined in @code{compile} command.  Types defined in the @code{compile}
18577 command will no longer be available in the next @code{compile} command.
18578 Therefore, if you cast a variable to a type defined in the
18579 @code{compile} command, care must be taken to ensure that any future
18580 need to resolve the type can be achieved.
18581
18582 @smallexample
18583 (gdb) compile code static struct a @{ int a; @} v = @{ 42 @}; argv = &v;
18584 (gdb) compile code printf ("%d\n", ((struct a *) argv)->a);
18585 gdb command line:1:36: error: dereferencing pointer to incomplete type â€˜struct a’
18586 Compilation failed.
18587 (gdb) compile code struct a @{ int a; @}; printf ("%d\n", ((struct a *) argv)->a);
18588 42
18589 @end smallexample
18590
18591 Variables that have been optimized away by the compiler are not
18592 accessible to the code submitted to the @code{compile} command.
18593 Access to those variables will generate a compiler error which @value{GDBN}
18594 will print to the console.
18595 @end table
18596
18597 @subsection Compiler search for the @code{compile} command
18598
18599 @value{GDBN} needs to find @value{NGCC} for the inferior being debugged
18600 which may not be obvious for remote targets of different architecture
18601 than where @value{GDBN} is running.  Environment variable @code{PATH} on
18602 @value{GDBN} host is searched for @value{NGCC} binary matching the
18603 target architecture and operating system.  This search can be overriden
18604 by @code{set compile-gcc} @value{GDBN} command below.  @code{PATH} is
18605 taken from shell that executed @value{GDBN}, it is not the value set by
18606 @value{GDBN} command @code{set environment}).  @xref{Environment}.
18607
18608
18609 Specifically @code{PATH} is searched for binaries matching regular expression
18610 @code{@var{arch}(-[^-]*)?-@var{os}-gcc} according to the inferior target being
18611 debugged.  @var{arch} is processor name --- multiarch is supported, so for
18612 example both @code{i386} and @code{x86_64} targets look for pattern
18613 @code{(x86_64|i.86)} and both @code{s390} and @code{s390x} targets look
18614 for pattern @code{s390x?}.  @var{os} is currently supported only for
18615 pattern @code{linux(-gnu)?}.
18616
18617 On Posix hosts the compiler driver @value{GDBN} needs to find also
18618 shared library @file{libcc1.so} from the compiler.  It is searched in
18619 default shared library search path (overridable with usual environment
18620 variable @code{LD_LIBRARY_PATH}), unrelated to @code{PATH} or @code{set
18621 compile-gcc} settings.  Contrary to it @file{libcc1plugin.so} is found
18622 according to the installation of the found compiler --- as possibly
18623 specified by the @code{set compile-gcc} command.
18624
18625 @table @code
18626 @item set compile-gcc
18627 @cindex compile command driver filename override
18628 Set compilation command used for compiling and injecting code with the
18629 @code{compile} commands.  If this option is not set (it is set to
18630 an empty string), the search described above will occur --- that is the
18631 default.
18632
18633 @item show compile-gcc
18634 Displays the current compile command @value{NGCC} driver filename.
18635 If set, it is the main command @command{gcc}, found usually for example
18636 under name @file{x86_64-linux-gnu-gcc}.
18637 @end table
18638
18639 @node GDB Files
18640 @chapter @value{GDBN} Files
18641
18642 @value{GDBN} needs to know the file name of the program to be debugged,
18643 both in order to read its symbol table and in order to start your
18644 program.  To debug a core dump of a previous run, you must also tell
18645 @value{GDBN} the name of the core dump file.
18646
18647 @menu
18648 * Files::                       Commands to specify files
18649 * File Caching::                Information about @value{GDBN}'s file caching
18650 * Separate Debug Files::        Debugging information in separate files
18651 * MiniDebugInfo::               Debugging information in a special section
18652 * Index Files::                 Index files speed up GDB
18653 * Symbol Errors::               Errors reading symbol files
18654 * Data Files::                  GDB data files
18655 @end menu
18656
18657 @node Files
18658 @section Commands to Specify Files
18659
18660 @cindex symbol table
18661 @cindex core dump file
18662
18663 You may want to specify executable and core dump file names.  The usual
18664 way to do this is at start-up time, using the arguments to
18665 @value{GDBN}'s start-up commands (@pxref{Invocation, , Getting In and
18666 Out of @value{GDBN}}).
18667
18668 Occasionally it is necessary to change to a different file during a
18669 @value{GDBN} session.  Or you may run @value{GDBN} and forget to
18670 specify a file you want to use.  Or you are debugging a remote target
18671 via @code{gdbserver} (@pxref{Server, file, Using the @code{gdbserver}
18672 Program}).  In these situations the @value{GDBN} commands to specify
18673 new files are useful.
18674
18675 @table @code
18676 @cindex executable file
18677 @kindex file
18678 @item file @var{filename}
18679 Use @var{filename} as the program to be debugged.  It is read for its
18680 symbols and for the contents of pure memory.  It is also the program
18681 executed when you use the @code{run} command.  If you do not specify a
18682 directory and the file is not found in the @value{GDBN} working directory,
18683 @value{GDBN} uses the environment variable @code{PATH} as a list of
18684 directories to search, just as the shell does when looking for a program
18685 to run.  You can change the value of this variable, for both @value{GDBN}
18686 and your program, using the @code{path} command.
18687
18688 @cindex unlinked object files
18689 @cindex patching object files
18690 You can load unlinked object @file{.o} files into @value{GDBN} using
18691 the @code{file} command.  You will not be able to ``run'' an object
18692 file, but you can disassemble functions and inspect variables.  Also,
18693 if the underlying BFD functionality supports it, you could use
18694 @kbd{gdb -write} to patch object files using this technique.  Note
18695 that @value{GDBN} can neither interpret nor modify relocations in this
18696 case, so branches and some initialized variables will appear to go to
18697 the wrong place.  But this feature is still handy from time to time.
18698
18699 @item file
18700 @code{file} with no argument makes @value{GDBN} discard any information it
18701 has on both executable file and the symbol table.
18702
18703 @kindex exec-file
18704 @item exec-file @r{[} @var{filename} @r{]}
18705 Specify that the program to be run (but not the symbol table) is found
18706 in @var{filename}.  @value{GDBN} searches the environment variable @code{PATH}
18707 if necessary to locate your program.  Omitting @var{filename} means to
18708 discard information on the executable file.
18709
18710 @kindex symbol-file
18711 @item symbol-file @r{[} @var{filename} @r{]}
18712 Read symbol table information from file @var{filename}.  @code{PATH} is
18713 searched when necessary.  Use the @code{file} command to get both symbol
18714 table and program to run from the same file.
18715
18716 @code{symbol-file} with no argument clears out @value{GDBN} information on your
18717 program's symbol table.
18718
18719 The @code{symbol-file} command causes @value{GDBN} to forget the contents of
18720 some breakpoints and auto-display expressions.  This is because they may
18721 contain pointers to the internal data recording symbols and data types,
18722 which are part of the old symbol table data being discarded inside
18723 @value{GDBN}.
18724
18725 @code{symbol-file} does not repeat if you press @key{RET} again after
18726 executing it once.
18727
18728 When @value{GDBN} is configured for a particular environment, it
18729 understands debugging information in whatever format is the standard
18730 generated for that environment; you may use either a @sc{gnu} compiler, or
18731 other compilers that adhere to the local conventions.
18732 Best results are usually obtained from @sc{gnu} compilers; for example,
18733 using @code{@value{NGCC}} you can generate debugging information for
18734 optimized code.
18735
18736 For most kinds of object files, with the exception of old SVR3 systems
18737 using COFF, the @code{symbol-file} command does not normally read the
18738 symbol table in full right away.  Instead, it scans the symbol table
18739 quickly to find which source files and which symbols are present.  The
18740 details are read later, one source file at a time, as they are needed.
18741
18742 The purpose of this two-stage reading strategy is to make @value{GDBN}
18743 start up faster.  For the most part, it is invisible except for
18744 occasional pauses while the symbol table details for a particular source
18745 file are being read.  (The @code{set verbose} command can turn these
18746 pauses into messages if desired.  @xref{Messages/Warnings, ,Optional
18747 Warnings and Messages}.)
18748
18749 We have not implemented the two-stage strategy for COFF yet.  When the
18750 symbol table is stored in COFF format, @code{symbol-file} reads the
18751 symbol table data in full right away.  Note that ``stabs-in-COFF''
18752 still does the two-stage strategy, since the debug info is actually
18753 in stabs format.
18754
18755 @kindex readnow
18756 @cindex reading symbols immediately
18757 @cindex symbols, reading immediately
18758 @item symbol-file @r{[} -readnow @r{]} @var{filename}
18759 @itemx file @r{[} -readnow @r{]} @var{filename}
18760 You can override the @value{GDBN} two-stage strategy for reading symbol
18761 tables by using the @samp{-readnow} option with any of the commands that
18762 load symbol table information, if you want to be sure @value{GDBN} has the
18763 entire symbol table available.
18764
18765 @cindex @code{-readnever}, option for symbol-file command
18766 @cindex never read symbols
18767 @cindex symbols, never read
18768 @item symbol-file @r{[} -readnever @r{]} @var{filename}
18769 @itemx file @r{[} -readnever @r{]} @var{filename}
18770 You can instruct @value{GDBN} to never read the symbolic information
18771 contained in @var{filename} by using the @samp{-readnever} option.
18772 @xref{--readnever}.
18773
18774 @c FIXME: for now no mention of directories, since this seems to be in
18775 @c flux.  13mar1992 status is that in theory GDB would look either in
18776 @c current dir or in same dir as myprog; but issues like competing
18777 @c GDB's, or clutter in system dirs, mean that in practice right now
18778 @c only current dir is used.  FFish says maybe a special GDB hierarchy
18779 @c (eg rooted in val of env var GDBSYMS) could exist for mappable symbol
18780 @c files.
18781
18782 @kindex core-file
18783 @item core-file @r{[}@var{filename}@r{]}
18784 @itemx core
18785 Specify the whereabouts of a core dump file to be used as the ``contents
18786 of memory''.  Traditionally, core files contain only some parts of the
18787 address space of the process that generated them; @value{GDBN} can access the
18788 executable file itself for other parts.
18789
18790 @code{core-file} with no argument specifies that no core file is
18791 to be used.
18792
18793 Note that the core file is ignored when your program is actually running
18794 under @value{GDBN}.  So, if you have been running your program and you
18795 wish to debug a core file instead, you must kill the subprocess in which
18796 the program is running.  To do this, use the @code{kill} command
18797 (@pxref{Kill Process, ,Killing the Child Process}).
18798
18799 @kindex add-symbol-file
18800 @cindex dynamic linking
18801 @item add-symbol-file @var{filename} @var{address}
18802 @itemx add-symbol-file @var{filename} @var{address} @r{[} -readnow @r{|} -readnever @r{]}
18803 @itemx add-symbol-file @var{filename} @var{address} -s @var{section} @var{address} @dots{}
18804 The @code{add-symbol-file} command reads additional symbol table
18805 information from the file @var{filename}.  You would use this command
18806 when @var{filename} has been dynamically loaded (by some other means)
18807 into the program that is running.  The @var{address} should give the memory
18808 address at which the file has been loaded; @value{GDBN} cannot figure
18809 this out for itself.  You can additionally specify an arbitrary number
18810 of @samp{-s @var{section} @var{address}} pairs, to give an explicit
18811 section name and base address for that section.  You can specify any
18812 @var{address} as an expression.
18813
18814 The symbol table of the file @var{filename} is added to the symbol table
18815 originally read with the @code{symbol-file} command.  You can use the
18816 @code{add-symbol-file} command any number of times; the new symbol data
18817 thus read is kept in addition to the old.
18818
18819 Changes can be reverted using the command @code{remove-symbol-file}.
18820
18821 @cindex relocatable object files, reading symbols from
18822 @cindex object files, relocatable, reading symbols from
18823 @cindex reading symbols from relocatable object files
18824 @cindex symbols, reading from relocatable object files
18825 @cindex @file{.o} files, reading symbols from
18826 Although @var{filename} is typically a shared library file, an
18827 executable file, or some other object file which has been fully
18828 relocated for loading into a process, you can also load symbolic
18829 information from relocatable @file{.o} files, as long as:
18830
18831 @itemize @bullet
18832 @item
18833 the file's symbolic information refers only to linker symbols defined in
18834 that file, not to symbols defined by other object files,
18835 @item
18836 every section the file's symbolic information refers to has actually
18837 been loaded into the inferior, as it appears in the file, and
18838 @item
18839 you can determine the address at which every section was loaded, and
18840 provide these to the @code{add-symbol-file} command.
18841 @end itemize
18842
18843 @noindent
18844 Some embedded operating systems, like Sun Chorus and VxWorks, can load
18845 relocatable files into an already running program; such systems
18846 typically make the requirements above easy to meet.  However, it's
18847 important to recognize that many native systems use complex link
18848 procedures (@code{.linkonce} section factoring and C@t{++} constructor table
18849 assembly, for example) that make the requirements difficult to meet.  In
18850 general, one cannot assume that using @code{add-symbol-file} to read a
18851 relocatable object file's symbolic information will have the same effect
18852 as linking the relocatable object file into the program in the normal
18853 way.
18854
18855 @code{add-symbol-file} does not repeat if you press @key{RET} after using it.
18856
18857 @kindex remove-symbol-file
18858 @item remove-symbol-file @var{filename}
18859 @item remove-symbol-file -a @var{address}
18860 Remove a symbol file added via the @code{add-symbol-file} command.  The
18861 file to remove can be identified by its @var{filename} or by an @var{address}
18862 that lies within the boundaries of this symbol file in memory.  Example:
18863
18864 @smallexample
18865 (gdb) add-symbol-file /home/user/gdb/mylib.so 0x7ffff7ff9480
18866 add symbol table from file "/home/user/gdb/mylib.so" at
18867     .text_addr = 0x7ffff7ff9480
18868 (y or n) y
18869 Reading symbols from /home/user/gdb/mylib.so...done.
18870 (gdb) remove-symbol-file -a 0x7ffff7ff9480
18871 Remove symbol table from file "/home/user/gdb/mylib.so"? (y or n) y
18872 (gdb)
18873 @end smallexample
18874
18875
18876 @code{remove-symbol-file} does not repeat if you press @key{RET} after using it.
18877
18878 @kindex add-symbol-file-from-memory
18879 @cindex @code{syscall DSO}
18880 @cindex load symbols from memory
18881 @item add-symbol-file-from-memory @var{address}
18882 Load symbols from the given @var{address} in a dynamically loaded
18883 object file whose image is mapped directly into the inferior's memory.
18884 For example, the Linux kernel maps a @code{syscall DSO} into each
18885 process's address space; this DSO provides kernel-specific code for
18886 some system calls.  The argument can be any expression whose
18887 evaluation yields the address of the file's shared object file header.
18888 For this command to work, you must have used @code{symbol-file} or
18889 @code{exec-file} commands in advance.
18890
18891 @kindex section
18892 @item section @var{section} @var{addr}
18893 The @code{section} command changes the base address of the named
18894 @var{section} of the exec file to @var{addr}.  This can be used if the
18895 exec file does not contain section addresses, (such as in the
18896 @code{a.out} format), or when the addresses specified in the file
18897 itself are wrong.  Each section must be changed separately.  The
18898 @code{info files} command, described below, lists all the sections and
18899 their addresses.
18900
18901 @kindex info files
18902 @kindex info target
18903 @item info files
18904 @itemx info target
18905 @code{info files} and @code{info target} are synonymous; both print the
18906 current target (@pxref{Targets, ,Specifying a Debugging Target}),
18907 including the names of the executable and core dump files currently in
18908 use by @value{GDBN}, and the files from which symbols were loaded.  The
18909 command @code{help target} lists all possible targets rather than
18910 current ones.
18911
18912 @kindex maint info sections
18913 @item maint info sections
18914 Another command that can give you extra information about program sections
18915 is @code{maint info sections}.  In addition to the section information
18916 displayed by @code{info files}, this command displays the flags and file
18917 offset of each section in the executable and core dump files.  In addition,
18918 @code{maint info sections} provides the following command options (which
18919 may be arbitrarily combined):
18920
18921 @table @code
18922 @item ALLOBJ
18923 Display sections for all loaded object files, including shared libraries.
18924 @item @var{sections}
18925 Display info only for named @var{sections}.
18926 @item @var{section-flags}
18927 Display info only for sections for which @var{section-flags} are true.
18928 The section flags that @value{GDBN} currently knows about are:
18929 @table @code
18930 @item ALLOC
18931 Section will have space allocated in the process when loaded.
18932 Set for all sections except those containing debug information.
18933 @item LOAD
18934 Section will be loaded from the file into the child process memory.
18935 Set for pre-initialized code and data, clear for @code{.bss} sections.
18936 @item RELOC
18937 Section needs to be relocated before loading.
18938 @item READONLY
18939 Section cannot be modified by the child process.
18940 @item CODE
18941 Section contains executable code only.
18942 @item DATA
18943 Section contains data only (no executable code).
18944 @item ROM
18945 Section will reside in ROM.
18946 @item CONSTRUCTOR
18947 Section contains data for constructor/destructor lists.
18948 @item HAS_CONTENTS
18949 Section is not empty.
18950 @item NEVER_LOAD
18951 An instruction to the linker to not output the section.
18952 @item COFF_SHARED_LIBRARY
18953 A notification to the linker that the section contains
18954 COFF shared library information.
18955 @item IS_COMMON
18956 Section contains common symbols.
18957 @end table
18958 @end table
18959 @kindex set trust-readonly-sections
18960 @cindex read-only sections
18961 @item set trust-readonly-sections on
18962 Tell @value{GDBN} that readonly sections in your object file
18963 really are read-only (i.e.@: that their contents will not change).
18964 In that case, @value{GDBN} can fetch values from these sections
18965 out of the object file, rather than from the target program.
18966 For some targets (notably embedded ones), this can be a significant
18967 enhancement to debugging performance.
18968
18969 The default is off.
18970
18971 @item set trust-readonly-sections off
18972 Tell @value{GDBN} not to trust readonly sections.  This means that
18973 the contents of the section might change while the program is running,
18974 and must therefore be fetched from the target when needed.
18975
18976 @item show trust-readonly-sections
18977 Show the current setting of trusting readonly sections.
18978 @end table
18979
18980 All file-specifying commands allow both absolute and relative file names
18981 as arguments.  @value{GDBN} always converts the file name to an absolute file
18982 name and remembers it that way.
18983
18984 @cindex shared libraries
18985 @anchor{Shared Libraries}
18986 @value{GDBN} supports @sc{gnu}/Linux, MS-Windows, SunOS,
18987 Darwin/Mach-O, SVr4, IBM RS/6000 AIX, QNX Neutrino, FDPIC (FR-V), and
18988 DSBT (TIC6X) shared libraries.
18989
18990 On MS-Windows @value{GDBN} must be linked with the Expat library to support
18991 shared libraries.  @xref{Expat}.
18992
18993 @value{GDBN} automatically loads symbol definitions from shared libraries
18994 when you use the @code{run} command, or when you examine a core file.
18995 (Before you issue the @code{run} command, @value{GDBN} does not understand
18996 references to a function in a shared library, however---unless you are
18997 debugging a core file).
18998
18999 @c FIXME: some @value{GDBN} release may permit some refs to undef
19000 @c FIXME...symbols---eg in a break cmd---assuming they are from a shared
19001 @c FIXME...lib; check this from time to time when updating manual
19002
19003 There are times, however, when you may wish to not automatically load
19004 symbol definitions from shared libraries, such as when they are
19005 particularly large or there are many of them.
19006
19007 To control the automatic loading of shared library symbols, use the
19008 commands:
19009
19010 @table @code
19011 @kindex set auto-solib-add
19012 @item set auto-solib-add @var{mode}
19013 If @var{mode} is @code{on}, symbols from all shared object libraries
19014 will be loaded automatically when the inferior begins execution, you
19015 attach to an independently started inferior, or when the dynamic linker
19016 informs @value{GDBN} that a new library has been loaded.  If @var{mode}
19017 is @code{off}, symbols must be loaded manually, using the
19018 @code{sharedlibrary} command.  The default value is @code{on}.
19019
19020 @cindex memory used for symbol tables
19021 If your program uses lots of shared libraries with debug info that
19022 takes large amounts of memory, you can decrease the @value{GDBN}
19023 memory footprint by preventing it from automatically loading the
19024 symbols from shared libraries.  To that end, type @kbd{set
19025 auto-solib-add off} before running the inferior, then load each
19026 library whose debug symbols you do need with @kbd{sharedlibrary
19027 @var{regexp}}, where @var{regexp} is a regular expression that matches
19028 the libraries whose symbols you want to be loaded.
19029
19030 @kindex show auto-solib-add
19031 @item show auto-solib-add
19032 Display the current autoloading mode.
19033 @end table
19034
19035 @cindex load shared library
19036 To explicitly load shared library symbols, use the @code{sharedlibrary}
19037 command:
19038
19039 @table @code
19040 @kindex info sharedlibrary
19041 @kindex info share
19042 @item info share @var{regex}
19043 @itemx info sharedlibrary @var{regex}
19044 Print the names of the shared libraries which are currently loaded
19045 that match @var{regex}.  If @var{regex} is omitted then print
19046 all shared libraries that are loaded.
19047
19048 @kindex info dll
19049 @item info dll @var{regex}
19050 This is an alias of @code{info sharedlibrary}.
19051
19052 @kindex sharedlibrary
19053 @kindex share
19054 @item sharedlibrary @var{regex}
19055 @itemx share @var{regex}
19056 Load shared object library symbols for files matching a
19057 Unix regular expression.
19058 As with files loaded automatically, it only loads shared libraries
19059 required by your program for a core file or after typing @code{run}.  If
19060 @var{regex} is omitted all shared libraries required by your program are
19061 loaded.
19062
19063 @item nosharedlibrary
19064 @kindex nosharedlibrary
19065 @cindex unload symbols from shared libraries
19066 Unload all shared object library symbols.  This discards all symbols
19067 that have been loaded from all shared libraries.  Symbols from shared
19068 libraries that were loaded by explicit user requests are not
19069 discarded.
19070 @end table
19071
19072 Sometimes you may wish that @value{GDBN} stops and gives you control
19073 when any of shared library events happen.  The best way to do this is
19074 to use @code{catch load} and @code{catch unload} (@pxref{Set
19075 Catchpoints}).
19076
19077 @value{GDBN} also supports the the @code{set stop-on-solib-events}
19078 command for this.  This command exists for historical reasons.  It is
19079 less useful than setting a catchpoint, because it does not allow for
19080 conditions or commands as a catchpoint does.
19081
19082 @table @code
19083 @item set stop-on-solib-events
19084 @kindex set stop-on-solib-events
19085 This command controls whether @value{GDBN} should give you control
19086 when the dynamic linker notifies it about some shared library event.
19087 The most common event of interest is loading or unloading of a new
19088 shared library.
19089
19090 @item show stop-on-solib-events
19091 @kindex show stop-on-solib-events
19092 Show whether @value{GDBN} stops and gives you control when shared
19093 library events happen.
19094 @end table
19095
19096 Shared libraries are also supported in many cross or remote debugging
19097 configurations.  @value{GDBN} needs to have access to the target's libraries;
19098 this can be accomplished either by providing copies of the libraries
19099 on the host system, or by asking @value{GDBN} to automatically retrieve the
19100 libraries from the target.  If copies of the target libraries are
19101 provided, they need to be the same as the target libraries, although the
19102 copies on the target can be stripped as long as the copies on the host are
19103 not.
19104
19105 @cindex where to look for shared libraries
19106 For remote debugging, you need to tell @value{GDBN} where the target
19107 libraries are, so that it can load the correct copies---otherwise, it
19108 may try to load the host's libraries.  @value{GDBN} has two variables
19109 to specify the search directories for target libraries.
19110
19111 @table @code
19112 @cindex prefix for executable and shared library file names
19113 @cindex system root, alternate
19114 @kindex set solib-absolute-prefix
19115 @kindex set sysroot
19116 @item set sysroot @var{path}
19117 Use @var{path} as the system root for the program being debugged.  Any
19118 absolute shared library paths will be prefixed with @var{path}; many
19119 runtime loaders store the absolute paths to the shared library in the
19120 target program's memory.  When starting processes remotely, and when
19121 attaching to already-running processes (local or remote), their
19122 executable filenames will be prefixed with @var{path} if reported to
19123 @value{GDBN} as absolute by the operating system.  If you use
19124 @code{set sysroot} to find executables and shared libraries, they need
19125 to be laid out in the same way that they are on the target, with
19126 e.g.@: a @file{/bin}, @file{/lib} and @file{/usr/lib} hierarchy under
19127 @var{path}.
19128
19129 If @var{path} starts with the sequence @file{target:} and the target
19130 system is remote then @value{GDBN} will retrieve the target binaries
19131 from the remote system.  This is only supported when using a remote
19132 target that supports the @code{remote get} command (@pxref{File
19133 Transfer,,Sending files to a remote system}).  The part of @var{path}
19134 following the initial @file{target:} (if present) is used as system
19135 root prefix on the remote file system.  If @var{path} starts with the
19136 sequence @file{remote:} this is converted to the sequence
19137 @file{target:} by @code{set sysroot}@footnote{Historically the
19138 functionality to retrieve binaries from the remote system was
19139 provided by prefixing @var{path} with @file{remote:}}.  If you want
19140 to specify a local system root using a directory that happens to be
19141 named @file{target:} or @file{remote:}, you need to use some
19142 equivalent variant of the name like @file{./target:}.
19143
19144 For targets with an MS-DOS based filesystem, such as MS-Windows and
19145 SymbianOS, @value{GDBN} tries prefixing a few variants of the target
19146 absolute file name with @var{path}.  But first, on Unix hosts,
19147 @value{GDBN} converts all backslash directory separators into forward
19148 slashes, because the backslash is not a directory separator on Unix:
19149
19150 @smallexample
19151   c:\foo\bar.dll @result{} c:/foo/bar.dll
19152 @end smallexample
19153
19154 Then, @value{GDBN} attempts prefixing the target file name with
19155 @var{path}, and looks for the resulting file name in the host file
19156 system:
19157
19158 @smallexample
19159   c:/foo/bar.dll @result{} /path/to/sysroot/c:/foo/bar.dll
19160 @end smallexample
19161
19162 If that does not find the binary, @value{GDBN} tries removing
19163 the @samp{:} character from the drive spec, both for convenience, and,
19164 for the case of the host file system not supporting file names with
19165 colons:
19166
19167 @smallexample
19168   c:/foo/bar.dll @result{} /path/to/sysroot/c/foo/bar.dll
19169 @end smallexample
19170
19171 This makes it possible to have a system root that mirrors a target
19172 with more than one drive.  E.g., you may want to setup your local
19173 copies of the target system shared libraries like so (note @samp{c} vs
19174 @samp{z}):
19175
19176 @smallexample
19177  @file{/path/to/sysroot/c/sys/bin/foo.dll}
19178  @file{/path/to/sysroot/c/sys/bin/bar.dll}
19179  @file{/path/to/sysroot/z/sys/bin/bar.dll}
19180 @end smallexample
19181
19182 @noindent
19183 and point the system root at @file{/path/to/sysroot}, so that
19184 @value{GDBN} can find the correct copies of both
19185 @file{c:\sys\bin\foo.dll}, and @file{z:\sys\bin\bar.dll}.
19186
19187 If that still does not find the binary, @value{GDBN} tries
19188 removing the whole drive spec from the target file name:
19189
19190 @smallexample
19191   c:/foo/bar.dll @result{} /path/to/sysroot/foo/bar.dll
19192 @end smallexample
19193
19194 This last lookup makes it possible to not care about the drive name,
19195 if you don't want or need to.
19196
19197 The @code{set solib-absolute-prefix} command is an alias for @code{set
19198 sysroot}.
19199
19200 @cindex default system root
19201 @cindex @samp{--with-sysroot}
19202 You can set the default system root by using the configure-time
19203 @samp{--with-sysroot} option.  If the system root is inside
19204 @value{GDBN}'s configured binary prefix (set with @samp{--prefix} or
19205 @samp{--exec-prefix}), then the default system root will be updated
19206 automatically if the installed @value{GDBN} is moved to a new
19207 location.
19208
19209 @kindex show sysroot
19210 @item show sysroot
19211 Display the current executable and shared library prefix.
19212
19213 @kindex set solib-search-path
19214 @item set solib-search-path @var{path}
19215 If this variable is set, @var{path} is a colon-separated list of
19216 directories to search for shared libraries.  @samp{solib-search-path}
19217 is used after @samp{sysroot} fails to locate the library, or if the
19218 path to the library is relative instead of absolute.  If you want to
19219 use @samp{solib-search-path} instead of @samp{sysroot}, be sure to set
19220 @samp{sysroot} to a nonexistent directory to prevent @value{GDBN} from
19221 finding your host's libraries.  @samp{sysroot} is preferred; setting
19222 it to a nonexistent directory may interfere with automatic loading
19223 of shared library symbols.
19224
19225 @kindex show solib-search-path
19226 @item show solib-search-path
19227 Display the current shared library search path.
19228
19229 @cindex DOS file-name semantics of file names.
19230 @kindex set target-file-system-kind (unix|dos-based|auto)
19231 @kindex show target-file-system-kind
19232 @item set target-file-system-kind @var{kind}
19233 Set assumed file system kind for target reported file names.
19234
19235 Shared library file names as reported by the target system may not
19236 make sense as is on the system @value{GDBN} is running on.  For
19237 example, when remote debugging a target that has MS-DOS based file
19238 system semantics, from a Unix host, the target may be reporting to
19239 @value{GDBN} a list of loaded shared libraries with file names such as
19240 @file{c:\Windows\kernel32.dll}.  On Unix hosts, there's no concept of
19241 drive letters, so the @samp{c:\} prefix is not normally understood as
19242 indicating an absolute file name, and neither is the backslash
19243 normally considered a directory separator character.  In that case,
19244 the native file system would interpret this whole absolute file name
19245 as a relative file name with no directory components.  This would make
19246 it impossible to point @value{GDBN} at a copy of the remote target's
19247 shared libraries on the host using @code{set sysroot}, and impractical
19248 with @code{set solib-search-path}.  Setting
19249 @code{target-file-system-kind} to @code{dos-based} tells @value{GDBN}
19250 to interpret such file names similarly to how the target would, and to
19251 map them to file names valid on @value{GDBN}'s native file system
19252 semantics.  The value of @var{kind} can be @code{"auto"}, in addition
19253 to one of the supported file system kinds.  In that case, @value{GDBN}
19254 tries to determine the appropriate file system variant based on the
19255 current target's operating system (@pxref{ABI, ,Configuring the
19256 Current ABI}).  The supported file system settings are:
19257
19258 @table @code
19259 @item unix
19260 Instruct @value{GDBN} to assume the target file system is of Unix
19261 kind.  Only file names starting the forward slash (@samp{/}) character
19262 are considered absolute, and the directory separator character is also
19263 the forward slash.
19264
19265 @item dos-based
19266 Instruct @value{GDBN} to assume the target file system is DOS based.
19267 File names starting with either a forward slash, or a drive letter
19268 followed by a colon (e.g., @samp{c:}), are considered absolute, and
19269 both the slash (@samp{/}) and the backslash (@samp{\\}) characters are
19270 considered directory separators.
19271
19272 @item auto
19273 Instruct @value{GDBN} to use the file system kind associated with the
19274 target operating system (@pxref{ABI, ,Configuring the Current ABI}).
19275 This is the default.
19276 @end table
19277 @end table
19278
19279 @cindex file name canonicalization
19280 @cindex base name differences
19281 When processing file names provided by the user, @value{GDBN}
19282 frequently needs to compare them to the file names recorded in the
19283 program's debug info.  Normally, @value{GDBN} compares just the
19284 @dfn{base names} of the files as strings, which is reasonably fast
19285 even for very large programs.  (The base name of a file is the last
19286 portion of its name, after stripping all the leading directories.)
19287 This shortcut in comparison is based upon the assumption that files
19288 cannot have more than one base name.  This is usually true, but
19289 references to files that use symlinks or similar filesystem
19290 facilities violate that assumption.  If your program records files
19291 using such facilities, or if you provide file names to @value{GDBN}
19292 using symlinks etc., you can set @code{basenames-may-differ} to
19293 @code{true} to instruct @value{GDBN} to completely canonicalize each
19294 pair of file names it needs to compare.  This will make file-name
19295 comparisons accurate, but at a price of a significant slowdown.
19296
19297 @table @code
19298 @item set basenames-may-differ
19299 @kindex set basenames-may-differ
19300 Set whether a source file may have multiple base names.
19301
19302 @item show basenames-may-differ
19303 @kindex show basenames-may-differ
19304 Show whether a source file may have multiple base names.
19305 @end table
19306
19307 @node File Caching
19308 @section File Caching
19309 @cindex caching of opened files
19310 @cindex caching of bfd objects
19311
19312 To speed up file loading, and reduce memory usage, @value{GDBN} will
19313 reuse the @code{bfd} objects used to track open files.  @xref{Top, ,
19314 BFD, bfd, The Binary File Descriptor Library}.  The following commands
19315 allow visibility and control of the caching behavior.
19316
19317 @table @code
19318 @kindex maint info bfds
19319 @item maint info bfds
19320 This prints information about each @code{bfd} object that is known to
19321 @value{GDBN}.
19322
19323 @kindex maint set bfd-sharing
19324 @kindex maint show bfd-sharing
19325 @kindex bfd caching
19326 @item maint set bfd-sharing
19327 @item maint show bfd-sharing
19328 Control whether @code{bfd} objects can be shared.  When sharing is
19329 enabled @value{GDBN} reuses already open @code{bfd} objects rather
19330 than reopening the same file.  Turning sharing off does not cause
19331 already shared @code{bfd} objects to be unshared, but all future files
19332 that are opened will create a new @code{bfd} object.  Similarly,
19333 re-enabling sharing does not cause multiple existing @code{bfd}
19334 objects to be collapsed into a single shared @code{bfd} object.
19335
19336 @kindex set debug bfd-cache @var{level}
19337 @kindex bfd caching
19338 @item set debug bfd-cache @var{level}
19339 Turns on debugging of the bfd cache, setting the level to @var{level}.
19340
19341 @kindex show debug bfd-cache
19342 @kindex bfd caching
19343 @item show debug bfd-cache
19344 Show the current debugging level of the bfd cache.
19345 @end table
19346
19347 @node Separate Debug Files
19348 @section Debugging Information in Separate Files
19349 @cindex separate debugging information files
19350 @cindex debugging information in separate files
19351 @cindex @file{.debug} subdirectories
19352 @cindex debugging information directory, global
19353 @cindex global debugging information directories
19354 @cindex build ID, and separate debugging files
19355 @cindex @file{.build-id} directory
19356
19357 @value{GDBN} allows you to put a program's debugging information in a
19358 file separate from the executable itself, in a way that allows
19359 @value{GDBN} to find and load the debugging information automatically.
19360 Since debugging information can be very large---sometimes larger
19361 than the executable code itself---some systems distribute debugging
19362 information for their executables in separate files, which users can
19363 install only when they need to debug a problem.
19364
19365 @value{GDBN} supports two ways of specifying the separate debug info
19366 file:
19367
19368 @itemize @bullet
19369 @item
19370 The executable contains a @dfn{debug link} that specifies the name of
19371 the separate debug info file.  The separate debug file's name is
19372 usually @file{@var{executable}.debug}, where @var{executable} is the
19373 name of the corresponding executable file without leading directories
19374 (e.g., @file{ls.debug} for @file{/usr/bin/ls}).  In addition, the
19375 debug link specifies a 32-bit @dfn{Cyclic Redundancy Check} (CRC)
19376 checksum for the debug file, which @value{GDBN} uses to validate that
19377 the executable and the debug file came from the same build.
19378
19379 @item
19380 The executable contains a @dfn{build ID}, a unique bit string that is
19381 also present in the corresponding debug info file.  (This is supported
19382 only on some operating systems, when using the ELF or PE file formats
19383 for binary files and the @sc{gnu} Binutils.)  For more details about
19384 this feature, see the description of the @option{--build-id}
19385 command-line option in @ref{Options, , Command Line Options, ld.info,
19386 The GNU Linker}.  The debug info file's name is not specified
19387 explicitly by the build ID, but can be computed from the build ID, see
19388 below.
19389 @end itemize
19390
19391 Depending on the way the debug info file is specified, @value{GDBN}
19392 uses two different methods of looking for the debug file:
19393
19394 @itemize @bullet
19395 @item
19396 For the ``debug link'' method, @value{GDBN} looks up the named file in
19397 the directory of the executable file, then in a subdirectory of that
19398 directory named @file{.debug}, and finally under each one of the global debug
19399 directories, in a subdirectory whose name is identical to the leading
19400 directories of the executable's absolute file name.
19401
19402 @item
19403 For the ``build ID'' method, @value{GDBN} looks in the
19404 @file{.build-id} subdirectory of each one of the global debug directories for
19405 a file named @file{@var{nn}/@var{nnnnnnnn}.debug}, where @var{nn} are the
19406 first 2 hex characters of the build ID bit string, and @var{nnnnnnnn}
19407 are the rest of the bit string.  (Real build ID strings are 32 or more
19408 hex characters, not 10.)
19409 @end itemize
19410
19411 So, for example, suppose you ask @value{GDBN} to debug
19412 @file{/usr/bin/ls}, which has a debug link that specifies the
19413 file @file{ls.debug}, and a build ID whose value in hex is
19414 @code{abcdef1234}.  If the list of the global debug directories includes
19415 @file{/usr/lib/debug}, then @value{GDBN} will look for the following
19416 debug information files, in the indicated order:
19417
19418 @itemize @minus
19419 @item
19420 @file{/usr/lib/debug/.build-id/ab/cdef1234.debug}
19421 @item
19422 @file{/usr/bin/ls.debug}
19423 @item
19424 @file{/usr/bin/.debug/ls.debug}
19425 @item
19426 @file{/usr/lib/debug/usr/bin/ls.debug}.
19427 @end itemize
19428
19429 @anchor{debug-file-directory}
19430 Global debugging info directories default to what is set by @value{GDBN}
19431 configure option @option{--with-separate-debug-dir}.  During @value{GDBN} run
19432 you can also set the global debugging info directories, and view the list
19433 @value{GDBN} is currently using.
19434
19435 @table @code
19436
19437 @kindex set debug-file-directory
19438 @item set debug-file-directory @var{directories}
19439 Set the directories which @value{GDBN} searches for separate debugging
19440 information files to @var{directory}.  Multiple path components can be set
19441 concatenating them by a path separator.
19442
19443 @kindex show debug-file-directory
19444 @item show debug-file-directory
19445 Show the directories @value{GDBN} searches for separate debugging
19446 information files.
19447
19448 @end table
19449
19450 @cindex @code{.gnu_debuglink} sections
19451 @cindex debug link sections
19452 A debug link is a special section of the executable file named
19453 @code{.gnu_debuglink}.  The section must contain:
19454
19455 @itemize
19456 @item
19457 A filename, with any leading directory components removed, followed by
19458 a zero byte,
19459 @item
19460 zero to three bytes of padding, as needed to reach the next four-byte
19461 boundary within the section, and
19462 @item
19463 a four-byte CRC checksum, stored in the same endianness used for the
19464 executable file itself.  The checksum is computed on the debugging
19465 information file's full contents by the function given below, passing
19466 zero as the @var{crc} argument.
19467 @end itemize
19468
19469 Any executable file format can carry a debug link, as long as it can
19470 contain a section named @code{.gnu_debuglink} with the contents
19471 described above.
19472
19473 @cindex @code{.note.gnu.build-id} sections
19474 @cindex build ID sections
19475 The build ID is a special section in the executable file (and in other
19476 ELF binary files that @value{GDBN} may consider).  This section is
19477 often named @code{.note.gnu.build-id}, but that name is not mandatory.
19478 It contains unique identification for the built files---the ID remains
19479 the same across multiple builds of the same build tree.  The default
19480 algorithm SHA1 produces 160 bits (40 hexadecimal characters) of the
19481 content for the build ID string.  The same section with an identical
19482 value is present in the original built binary with symbols, in its
19483 stripped variant, and in the separate debugging information file.
19484
19485 The debugging information file itself should be an ordinary
19486 executable, containing a full set of linker symbols, sections, and
19487 debugging information.  The sections of the debugging information file
19488 should have the same names, addresses, and sizes as the original file,
19489 but they need not contain any data---much like a @code{.bss} section
19490 in an ordinary executable.
19491
19492 The @sc{gnu} binary utilities (Binutils) package includes the
19493 @samp{objcopy} utility that can produce
19494 the separated executable / debugging information file pairs using the
19495 following commands:
19496
19497 @smallexample
19498 @kbd{objcopy --only-keep-debug foo foo.debug}
19499 @kbd{strip -g foo}
19500 @end smallexample
19501
19502 @noindent
19503 These commands remove the debugging
19504 information from the executable file @file{foo} and place it in the file
19505 @file{foo.debug}.  You can use the first, second or both methods to link the
19506 two files:
19507
19508 @itemize @bullet
19509 @item
19510 The debug link method needs the following additional command to also leave
19511 behind a debug link in @file{foo}:
19512
19513 @smallexample
19514 @kbd{objcopy --add-gnu-debuglink=foo.debug foo}
19515 @end smallexample
19516
19517 Ulrich Drepper's @file{elfutils} package, starting with version 0.53, contains
19518 a version of the @code{strip} command such that the command @kbd{strip foo -f
19519 foo.debug} has the same functionality as the two @code{objcopy} commands and
19520 the @code{ln -s} command above, together.
19521
19522 @item
19523 Build ID gets embedded into the main executable using @code{ld --build-id} or
19524 the @value{NGCC} counterpart @code{gcc -Wl,--build-id}.  Build ID support plus
19525 compatibility fixes for debug files separation are present in @sc{gnu} binary
19526 utilities (Binutils) package since version 2.18.
19527 @end itemize
19528
19529 @noindent
19530
19531 @cindex CRC algorithm definition
19532 The CRC used in @code{.gnu_debuglink} is the CRC-32 defined in
19533 IEEE 802.3 using the polynomial:
19534
19535 @c TexInfo requires naked braces for multi-digit exponents for Tex
19536 @c output, but this causes HTML output to barf. HTML has to be set using
19537 @c raw commands. So we end up having to specify this equation in 2
19538 @c different ways!
19539 @ifhtml
19540 @display
19541 @html
19542  <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>
19543  + <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
19544 @end html
19545 @end display
19546 @end ifhtml
19547 @ifnothtml
19548 @display
19549  @math{x^{32} + x^{26} + x^{23} + x^{22} + x^{16} + x^{12} + x^{11}}
19550  @math{+ x^{10} + x^8 + x^7 + x^5 + x^4 + x^2 + x + 1}
19551 @end display
19552 @end ifnothtml
19553
19554 The function is computed byte at a time, taking the least
19555 significant bit of each byte first.  The initial pattern
19556 @code{0xffffffff} is used, to ensure leading zeros affect the CRC and
19557 the final result is inverted to ensure trailing zeros also affect the
19558 CRC.
19559
19560 @emph{Note:} This is the same CRC polynomial as used in handling the
19561 @dfn{Remote Serial Protocol} @code{qCRC} packet (@pxref{qCRC packet}).
19562 However in the case of the Remote Serial Protocol, the CRC is computed
19563 @emph{most} significant bit first, and the result is not inverted, so
19564 trailing zeros have no effect on the CRC value.
19565
19566 To complete the description, we show below the code of the function
19567 which produces the CRC used in @code{.gnu_debuglink}.  Inverting the
19568 initially supplied @code{crc} argument means that an initial call to
19569 this function passing in zero will start computing the CRC using
19570 @code{0xffffffff}.
19571
19572 @kindex gnu_debuglink_crc32
19573 @smallexample
19574 unsigned long
19575 gnu_debuglink_crc32 (unsigned long crc,
19576                      unsigned char *buf, size_t len)
19577 @{
19578   static const unsigned long crc32_table[256] =
19579     @{
19580       0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419,
19581       0x706af48f, 0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4,
19582       0xe0d5e91e, 0x97d2d988, 0x09b64c2b, 0x7eb17cbd, 0xe7b82d07,
19583       0x90bf1d91, 0x1db71064, 0x6ab020f2, 0xf3b97148, 0x84be41de,
19584       0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7, 0x136c9856,
19585       0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9,
19586       0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4,
19587       0xa2677172, 0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b,
19588       0x35b5a8fa, 0x42b2986c, 0xdbbbc9d6, 0xacbcf940, 0x32d86ce3,
19589       0x45df5c75, 0xdcd60dcf, 0xabd13d59, 0x26d930ac, 0x51de003a,
19590       0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423, 0xcfba9599,
19591       0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
19592       0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190,
19593       0x01db7106, 0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f,
19594       0x9fbfe4a5, 0xe8b8d433, 0x7807c9a2, 0x0f00f934, 0x9609a88e,
19595       0xe10e9818, 0x7f6a0dbb, 0x086d3d2d, 0x91646c97, 0xe6635c01,
19596       0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e, 0x6c0695ed,
19597       0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950,
19598       0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3,
19599       0xfbd44c65, 0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2,
19600       0x4adfa541, 0x3dd895d7, 0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a,
19601       0x346ed9fc, 0xad678846, 0xda60b8d0, 0x44042d73, 0x33031de5,
19602       0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa, 0xbe0b1010,
19603       0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
19604       0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17,
19605       0x2eb40d81, 0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6,
19606       0x03b6e20c, 0x74b1d29a, 0xead54739, 0x9dd277af, 0x04db2615,
19607       0x73dc1683, 0xe3630b12, 0x94643b84, 0x0d6d6a3e, 0x7a6a5aa8,
19608       0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1, 0xf00f9344,
19609       0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb,
19610       0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a,
19611       0x67dd4acc, 0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5,
19612       0xd6d6a3e8, 0xa1d1937e, 0x38d8c2c4, 0x4fdff252, 0xd1bb67f1,
19613       0xa6bc5767, 0x3fb506dd, 0x48b2364b, 0xd80d2bda, 0xaf0a1b4c,
19614       0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55, 0x316e8eef,
19615       0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236,
19616       0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe,
19617       0xb2bd0b28, 0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31,
19618       0x2cd99e8b, 0x5bdeae1d, 0x9b64c2b0, 0xec63f226, 0x756aa39c,
19619       0x026d930a, 0x9c0906a9, 0xeb0e363f, 0x72076785, 0x05005713,
19620       0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38, 0x92d28e9b,
19621       0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242,
19622       0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1,
19623       0x18b74777, 0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c,
19624       0x8f659eff, 0xf862ae69, 0x616bffd3, 0x166ccf45, 0xa00ae278,
19625       0xd70dd2ee, 0x4e048354, 0x3903b3c2, 0xa7672661, 0xd06016f7,
19626       0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc, 0x40df0b66,
19627       0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
19628       0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605,
19629       0xcdd70693, 0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8,
19630       0x5d681b02, 0x2a6f2b94, 0xb40bbe37, 0xc30c8ea1, 0x5a05df1b,
19631       0x2d02ef8d
19632     @};
19633   unsigned char *end;
19634
19635   crc = ~crc & 0xffffffff;
19636   for (end = buf + len; buf < end; ++buf)
19637     crc = crc32_table[(crc ^ *buf) & 0xff] ^ (crc >> 8);
19638   return ~crc & 0xffffffff;
19639 @}
19640 @end smallexample
19641
19642 @noindent
19643 This computation does not apply to the ``build ID'' method.
19644
19645 @node MiniDebugInfo
19646 @section Debugging information in a special section
19647 @cindex separate debug sections
19648 @cindex @samp{.gnu_debugdata} section
19649
19650 Some systems ship pre-built executables and libraries that have a
19651 special @samp{.gnu_debugdata} section.  This feature is called
19652 @dfn{MiniDebugInfo}.  This section holds an LZMA-compressed object and
19653 is used to supply extra symbols for backtraces.
19654
19655 The intent of this section is to provide extra minimal debugging
19656 information for use in simple backtraces.  It is not intended to be a
19657 replacement for full separate debugging information (@pxref{Separate
19658 Debug Files}).  The example below shows the intended use; however,
19659 @value{GDBN} does not currently put restrictions on what sort of
19660 debugging information might be included in the section.
19661
19662 @value{GDBN} has support for this extension.  If the section exists,
19663 then it is used provided that no other source of debugging information
19664 can be found, and that @value{GDBN} was configured with LZMA support.
19665
19666 This section can be easily created using @command{objcopy} and other
19667 standard utilities:
19668
19669 @smallexample
19670 # Extract the dynamic symbols from the main binary, there is no need
19671 # to also have these in the normal symbol table.
19672 nm -D @var{binary} --format=posix --defined-only \
19673   | awk '@{ print $1 @}' | sort > dynsyms
19674
19675 # Extract all the text (i.e. function) symbols from the debuginfo.
19676 # (Note that we actually also accept "D" symbols, for the benefit
19677 # of platforms like PowerPC64 that use function descriptors.)
19678 nm @var{binary} --format=posix --defined-only \
19679   | awk '@{ if ($2 == "T" || $2 == "t" || $2 == "D") print $1 @}' \
19680   | sort > funcsyms
19681
19682 # Keep all the function symbols not already in the dynamic symbol
19683 # table.
19684 comm -13 dynsyms funcsyms > keep_symbols
19685
19686 # Separate full debug info into debug binary.
19687 objcopy --only-keep-debug @var{binary} debug
19688
19689 # Copy the full debuginfo, keeping only a minimal set of symbols and
19690 # removing some unnecessary sections.
19691 objcopy -S --remove-section .gdb_index --remove-section .comment \
19692   --keep-symbols=keep_symbols debug mini_debuginfo
19693
19694 # Drop the full debug info from the original binary.
19695 strip --strip-all -R .comment @var{binary}
19696
19697 # Inject the compressed data into the .gnu_debugdata section of the
19698 # original binary.
19699 xz mini_debuginfo
19700 objcopy --add-section .gnu_debugdata=mini_debuginfo.xz @var{binary}
19701 @end smallexample
19702
19703 @node Index Files
19704 @section Index Files Speed Up @value{GDBN}
19705 @cindex index files
19706 @cindex @samp{.gdb_index} section
19707
19708 When @value{GDBN} finds a symbol file, it scans the symbols in the
19709 file in order to construct an internal symbol table.  This lets most
19710 @value{GDBN} operations work quickly---at the cost of a delay early
19711 on.  For large programs, this delay can be quite lengthy, so
19712 @value{GDBN} provides a way to build an index, which speeds up
19713 startup.
19714
19715 For convenience, @value{GDBN} comes with a program,
19716 @command{gdb-add-index}, which can be used to add the index to a
19717 symbol file.  It takes the symbol file as its only argument:
19718
19719 @smallexample
19720 $ gdb-add-index symfile
19721 @end smallexample
19722
19723 @xref{gdb-add-index}.
19724
19725 It is also possible to do the work manually.  Here is what
19726 @command{gdb-add-index} does behind the curtains.
19727
19728 The index is stored as a section in the symbol file.  @value{GDBN} can
19729 write the index to a file, then you can put it into the symbol file
19730 using @command{objcopy}.
19731
19732 To create an index file, use the @code{save gdb-index} command:
19733
19734 @table @code
19735 @item save gdb-index [-dwarf-5] @var{directory}
19736 @kindex save gdb-index
19737 Create index files for all symbol files currently known by
19738 @value{GDBN}.  For each known @var{symbol-file}, this command by
19739 default creates it produces a single file
19740 @file{@var{symbol-file}.gdb-index}.  If you invoke this command with
19741 the @option{-dwarf-5} option, it produces 2 files:
19742 @file{@var{symbol-file}.debug_names} and
19743 @file{@var{symbol-file}.debug_str}.  The files are created in the
19744 given @var{directory}.
19745 @end table
19746
19747 Once you have created an index file you can merge it into your symbol
19748 file, here named @file{symfile}, using @command{objcopy}:
19749
19750 @smallexample
19751 $ objcopy --add-section .gdb_index=symfile.gdb-index \
19752     --set-section-flags .gdb_index=readonly symfile symfile
19753 @end smallexample
19754
19755 Or for @code{-dwarf-5}:
19756
19757 @smallexample
19758 $ objcopy --dump-section .debug_str=symfile.debug_str.new symfile
19759 $ cat symfile.debug_str >>symfile.debug_str.new
19760 $ objcopy --add-section .debug_names=symfile.gdb-index \
19761     --set-section-flags .debug_names=readonly \
19762     --update-section .debug_str=symfile.debug_str.new symfile symfile
19763 @end smallexample
19764
19765 @value{GDBN} will normally ignore older versions of @file{.gdb_index}
19766 sections that have been deprecated.  Usually they are deprecated because
19767 they are missing a new feature or have performance issues.
19768 To tell @value{GDBN} to use a deprecated index section anyway
19769 specify @code{set use-deprecated-index-sections on}.
19770 The default is @code{off}.
19771 This can speed up startup, but may result in some functionality being lost.
19772 @xref{Index Section Format}.
19773
19774 @emph{Warning:} Setting @code{use-deprecated-index-sections} to @code{on}
19775 must be done before gdb reads the file.  The following will not work:
19776
19777 @smallexample
19778 $ gdb -ex "set use-deprecated-index-sections on" <program>
19779 @end smallexample
19780
19781 Instead you must do, for example,
19782
19783 @smallexample
19784 $ gdb -iex "set use-deprecated-index-sections on" <program>
19785 @end smallexample
19786
19787 There are currently some limitation on indices.  They only work when
19788 for DWARF debugging information, not stabs.  And, they do not
19789 currently work for programs using Ada.
19790
19791 @node Symbol Errors
19792 @section Errors Reading Symbol Files
19793
19794 While reading a symbol file, @value{GDBN} occasionally encounters problems,
19795 such as symbol types it does not recognize, or known bugs in compiler
19796 output.  By default, @value{GDBN} does not notify you of such problems, since
19797 they are relatively common and primarily of interest to people
19798 debugging compilers.  If you are interested in seeing information
19799 about ill-constructed symbol tables, you can either ask @value{GDBN} to print
19800 only one message about each such type of problem, no matter how many
19801 times the problem occurs; or you can ask @value{GDBN} to print more messages,
19802 to see how many times the problems occur, with the @code{set
19803 complaints} command (@pxref{Messages/Warnings, ,Optional Warnings and
19804 Messages}).
19805
19806 The messages currently printed, and their meanings, include:
19807
19808 @table @code
19809 @item inner block not inside outer block in @var{symbol}
19810
19811 The symbol information shows where symbol scopes begin and end
19812 (such as at the start of a function or a block of statements).  This
19813 error indicates that an inner scope block is not fully contained
19814 in its outer scope blocks.
19815
19816 @value{GDBN} circumvents the problem by treating the inner block as if it had
19817 the same scope as the outer block.  In the error message, @var{symbol}
19818 may be shown as ``@code{(don't know)}'' if the outer block is not a
19819 function.
19820
19821 @item block at @var{address} out of order
19822
19823 The symbol information for symbol scope blocks should occur in
19824 order of increasing addresses.  This error indicates that it does not
19825 do so.
19826
19827 @value{GDBN} does not circumvent this problem, and has trouble
19828 locating symbols in the source file whose symbols it is reading.  (You
19829 can often determine what source file is affected by specifying
19830 @code{set verbose on}.  @xref{Messages/Warnings, ,Optional Warnings and
19831 Messages}.)
19832
19833 @item bad block start address patched
19834
19835 The symbol information for a symbol scope block has a start address
19836 smaller than the address of the preceding source line.  This is known
19837 to occur in the SunOS 4.1.1 (and earlier) C compiler.
19838
19839 @value{GDBN} circumvents the problem by treating the symbol scope block as
19840 starting on the previous source line.
19841
19842 @item bad string table offset in symbol @var{n}
19843
19844 @cindex foo
19845 Symbol number @var{n} contains a pointer into the string table which is
19846 larger than the size of the string table.
19847
19848 @value{GDBN} circumvents the problem by considering the symbol to have the
19849 name @code{foo}, which may cause other problems if many symbols end up
19850 with this name.
19851
19852 @item unknown symbol type @code{0x@var{nn}}
19853
19854 The symbol information contains new data types that @value{GDBN} does
19855 not yet know how to read.  @code{0x@var{nn}} is the symbol type of the
19856 uncomprehended information, in hexadecimal.
19857
19858 @value{GDBN} circumvents the error by ignoring this symbol information.
19859 This usually allows you to debug your program, though certain symbols
19860 are not accessible.  If you encounter such a problem and feel like
19861 debugging it, you can debug @code{@value{GDBP}} with itself, breakpoint
19862 on @code{complain}, then go up to the function @code{read_dbx_symtab}
19863 and examine @code{*bufp} to see the symbol.
19864
19865 @item stub type has NULL name
19866
19867 @value{GDBN} could not find the full definition for a struct or class.
19868
19869 @item const/volatile indicator missing (ok if using g++ v1.x), got@dots{}
19870 The symbol information for a C@t{++} member function is missing some
19871 information that recent versions of the compiler should have output for
19872 it.
19873
19874 @item info mismatch between compiler and debugger
19875
19876 @value{GDBN} could not parse a type specification output by the compiler.
19877
19878 @end table
19879
19880 @node Data Files
19881 @section GDB Data Files
19882
19883 @cindex prefix for data files
19884 @value{GDBN} will sometimes read an auxiliary data file.  These files
19885 are kept in a directory known as the @dfn{data directory}.
19886
19887 You can set the data directory's name, and view the name @value{GDBN}
19888 is currently using.
19889
19890 @table @code
19891 @kindex set data-directory
19892 @item set data-directory @var{directory}
19893 Set the directory which @value{GDBN} searches for auxiliary data files
19894 to @var{directory}.
19895
19896 @kindex show data-directory
19897 @item show data-directory
19898 Show the directory @value{GDBN} searches for auxiliary data files.
19899 @end table
19900
19901 @cindex default data directory
19902 @cindex @samp{--with-gdb-datadir}
19903 You can set the default data directory by using the configure-time
19904 @samp{--with-gdb-datadir} option.  If the data directory is inside
19905 @value{GDBN}'s configured binary prefix (set with @samp{--prefix} or
19906 @samp{--exec-prefix}), then the default data directory will be updated
19907 automatically if the installed @value{GDBN} is moved to a new
19908 location.
19909
19910 The data directory may also be specified with the
19911 @code{--data-directory} command line option.
19912 @xref{Mode Options}.
19913
19914 @node Targets
19915 @chapter Specifying a Debugging Target
19916
19917 @cindex debugging target
19918 A @dfn{target} is the execution environment occupied by your program.
19919
19920 Often, @value{GDBN} runs in the same host environment as your program;
19921 in that case, the debugging target is specified as a side effect when
19922 you use the @code{file} or @code{core} commands.  When you need more
19923 flexibility---for example, running @value{GDBN} on a physically separate
19924 host, or controlling a standalone system over a serial port or a
19925 realtime system over a TCP/IP connection---you can use the @code{target}
19926 command to specify one of the target types configured for @value{GDBN}
19927 (@pxref{Target Commands, ,Commands for Managing Targets}).
19928
19929 @cindex target architecture
19930 It is possible to build @value{GDBN} for several different @dfn{target
19931 architectures}.  When @value{GDBN} is built like that, you can choose
19932 one of the available architectures with the @kbd{set architecture}
19933 command.
19934
19935 @table @code
19936 @kindex set architecture
19937 @kindex show architecture
19938 @item set architecture @var{arch}
19939 This command sets the current target architecture to @var{arch}.  The
19940 value of @var{arch} can be @code{"auto"}, in addition to one of the
19941 supported architectures.
19942
19943 @item show architecture
19944 Show the current target architecture.
19945
19946 @item set processor
19947 @itemx processor
19948 @kindex set processor
19949 @kindex show processor
19950 These are alias commands for, respectively, @code{set architecture}
19951 and @code{show architecture}.
19952 @end table
19953
19954 @menu
19955 * Active Targets::              Active targets
19956 * Target Commands::             Commands for managing targets
19957 * Byte Order::                  Choosing target byte order
19958 @end menu
19959
19960 @node Active Targets
19961 @section Active Targets
19962
19963 @cindex stacking targets
19964 @cindex active targets
19965 @cindex multiple targets
19966
19967 There are multiple classes of targets such as: processes, executable files or
19968 recording sessions.  Core files belong to the process class, making core file
19969 and process mutually exclusive.  Otherwise, @value{GDBN} can work concurrently
19970 on multiple active targets, one in each class.  This allows you to (for
19971 example) start a process and inspect its activity, while still having access to
19972 the executable file after the process finishes.  Or if you start process
19973 recording (@pxref{Reverse Execution}) and @code{reverse-step} there, you are
19974 presented a virtual layer of the recording target, while the process target
19975 remains stopped at the chronologically last point of the process execution.
19976
19977 Use the @code{core-file} and @code{exec-file} commands to select a new core
19978 file or executable target (@pxref{Files, ,Commands to Specify Files}).  To
19979 specify as a target a process that is already running, use the @code{attach}
19980 command (@pxref{Attach, ,Debugging an Already-running Process}).
19981
19982 @node Target Commands
19983 @section Commands for Managing Targets
19984
19985 @table @code
19986 @item target @var{type} @var{parameters}
19987 Connects the @value{GDBN} host environment to a target machine or
19988 process.  A target is typically a protocol for talking to debugging
19989 facilities.  You use the argument @var{type} to specify the type or
19990 protocol of the target machine.
19991
19992 Further @var{parameters} are interpreted by the target protocol, but
19993 typically include things like device names or host names to connect
19994 with, process numbers, and baud rates.
19995
19996 The @code{target} command does not repeat if you press @key{RET} again
19997 after executing the command.
19998
19999 @kindex help target
20000 @item help target
20001 Displays the names of all targets available.  To display targets
20002 currently selected, use either @code{info target} or @code{info files}
20003 (@pxref{Files, ,Commands to Specify Files}).
20004
20005 @item help target @var{name}
20006 Describe a particular target, including any parameters necessary to
20007 select it.
20008
20009 @kindex set gnutarget
20010 @item set gnutarget @var{args}
20011 @value{GDBN} uses its own library BFD to read your files.  @value{GDBN}
20012 knows whether it is reading an @dfn{executable},
20013 a @dfn{core}, or a @dfn{.o} file; however, you can specify the file format
20014 with the @code{set gnutarget} command.  Unlike most @code{target} commands,
20015 with @code{gnutarget} the @code{target} refers to a program, not a machine.
20016
20017 @quotation
20018 @emph{Warning:} To specify a file format with @code{set gnutarget},
20019 you must know the actual BFD name.
20020 @end quotation
20021
20022 @noindent
20023 @xref{Files, , Commands to Specify Files}.
20024
20025 @kindex show gnutarget
20026 @item show gnutarget
20027 Use the @code{show gnutarget} command to display what file format
20028 @code{gnutarget} is set to read.  If you have not set @code{gnutarget},
20029 @value{GDBN} will determine the file format for each file automatically,
20030 and @code{show gnutarget} displays @samp{The current BFD target is "auto"}.
20031 @end table
20032
20033 @cindex common targets
20034 Here are some common targets (available, or not, depending on the GDB
20035 configuration):
20036
20037 @table @code
20038 @kindex target
20039 @item target exec @var{program}
20040 @cindex executable file target
20041 An executable file.  @samp{target exec @var{program}} is the same as
20042 @samp{exec-file @var{program}}.
20043
20044 @item target core @var{filename}
20045 @cindex core dump file target
20046 A core dump file.  @samp{target core @var{filename}} is the same as
20047 @samp{core-file @var{filename}}.
20048
20049 @item target remote @var{medium}
20050 @cindex remote target
20051 A remote system connected to @value{GDBN} via a serial line or network
20052 connection.  This command tells @value{GDBN} to use its own remote
20053 protocol over @var{medium} for debugging.  @xref{Remote Debugging}.
20054
20055 For example, if you have a board connected to @file{/dev/ttya} on the
20056 machine running @value{GDBN}, you could say:
20057
20058 @smallexample
20059 target remote /dev/ttya
20060 @end smallexample
20061
20062 @code{target remote} supports the @code{load} command.  This is only
20063 useful if you have some other way of getting the stub to the target
20064 system, and you can put it somewhere in memory where it won't get
20065 clobbered by the download.
20066
20067 @item target sim @r{[}@var{simargs}@r{]} @dots{}
20068 @cindex built-in simulator target
20069 Builtin CPU simulator.  @value{GDBN} includes simulators for most architectures.
20070 In general,
20071 @smallexample
20072         target sim
20073         load
20074         run
20075 @end smallexample
20076 @noindent
20077 works; however, you cannot assume that a specific memory map, device
20078 drivers, or even basic I/O is available, although some simulators do
20079 provide these.  For info about any processor-specific simulator details,
20080 see the appropriate section in @ref{Embedded Processors, ,Embedded
20081 Processors}.
20082
20083 @item target native
20084 @cindex native target
20085 Setup for local/native process debugging.  Useful to make the
20086 @code{run} command spawn native processes (likewise @code{attach},
20087 etc.@:) even when @code{set auto-connect-native-target} is @code{off}
20088 (@pxref{set auto-connect-native-target}).
20089
20090 @end table
20091
20092 Different targets are available on different configurations of @value{GDBN};
20093 your configuration may have more or fewer targets.
20094
20095 Many remote targets require you to download the executable's code once
20096 you've successfully established a connection.  You may wish to control
20097 various aspects of this process.
20098
20099 @table @code
20100
20101 @item set hash
20102 @kindex set hash@r{, for remote monitors}
20103 @cindex hash mark while downloading
20104 This command controls whether a hash mark @samp{#} is displayed while
20105 downloading a file to the remote monitor.  If on, a hash mark is
20106 displayed after each S-record is successfully downloaded to the
20107 monitor.
20108
20109 @item show hash
20110 @kindex show hash@r{, for remote monitors}
20111 Show the current status of displaying the hash mark.
20112
20113 @item set debug monitor
20114 @kindex set debug monitor
20115 @cindex display remote monitor communications
20116 Enable or disable display of communications messages between
20117 @value{GDBN} and the remote monitor.
20118
20119 @item show debug monitor
20120 @kindex show debug monitor
20121 Show the current status of displaying communications between
20122 @value{GDBN} and the remote monitor.
20123 @end table
20124
20125 @table @code
20126
20127 @kindex load @var{filename} @var{offset}
20128 @item load @var{filename} @var{offset}
20129 @anchor{load}
20130 Depending on what remote debugging facilities are configured into
20131 @value{GDBN}, the @code{load} command may be available.  Where it exists, it
20132 is meant to make @var{filename} (an executable) available for debugging
20133 on the remote system---by downloading, or dynamic linking, for example.
20134 @code{load} also records the @var{filename} symbol table in @value{GDBN}, like
20135 the @code{add-symbol-file} command.
20136
20137 If your @value{GDBN} does not have a @code{load} command, attempting to
20138 execute it gets the error message ``@code{You can't do that when your
20139 target is @dots{}}''
20140
20141 The file is loaded at whatever address is specified in the executable.
20142 For some object file formats, you can specify the load address when you
20143 link the program; for other formats, like a.out, the object file format
20144 specifies a fixed address.
20145 @c FIXME! This would be a good place for an xref to the GNU linker doc.
20146
20147 It is also possible to tell @value{GDBN} to load the executable file at a
20148 specific offset described by the optional argument @var{offset}.  When
20149 @var{offset} is provided, @var{filename} must also be provided.
20150
20151 Depending on the remote side capabilities, @value{GDBN} may be able to
20152 load programs into flash memory.
20153
20154 @code{load} does not repeat if you press @key{RET} again after using it.
20155 @end table
20156
20157 @table @code
20158
20159 @kindex flash-erase
20160 @item flash-erase
20161 @anchor{flash-erase}
20162
20163 Erases all known flash memory regions on the target.
20164
20165 @end table
20166
20167 @node Byte Order
20168 @section Choosing Target Byte Order
20169
20170 @cindex choosing target byte order
20171 @cindex target byte order
20172
20173 Some types of processors, such as the @acronym{MIPS}, PowerPC, and Renesas SH,
20174 offer the ability to run either big-endian or little-endian byte
20175 orders.  Usually the executable or symbol will include a bit to
20176 designate the endian-ness, and you will not need to worry about
20177 which to use.  However, you may still find it useful to adjust
20178 @value{GDBN}'s idea of processor endian-ness manually.
20179
20180 @table @code
20181 @kindex set endian
20182 @item set endian big
20183 Instruct @value{GDBN} to assume the target is big-endian.
20184
20185 @item set endian little
20186 Instruct @value{GDBN} to assume the target is little-endian.
20187
20188 @item set endian auto
20189 Instruct @value{GDBN} to use the byte order associated with the
20190 executable.
20191
20192 @item show endian
20193 Display @value{GDBN}'s current idea of the target byte order.
20194
20195 @end table
20196
20197 Note that these commands merely adjust interpretation of symbolic
20198 data on the host, and that they have absolutely no effect on the
20199 target system.
20200
20201
20202 @node Remote Debugging
20203 @chapter Debugging Remote Programs
20204 @cindex remote debugging
20205
20206 If you are trying to debug a program running on a machine that cannot run
20207 @value{GDBN} in the usual way, it is often useful to use remote debugging.
20208 For example, you might use remote debugging on an operating system kernel,
20209 or on a small system which does not have a general purpose operating system
20210 powerful enough to run a full-featured debugger.
20211
20212 Some configurations of @value{GDBN} have special serial or TCP/IP interfaces
20213 to make this work with particular debugging targets.  In addition,
20214 @value{GDBN} comes with a generic serial protocol (specific to @value{GDBN},
20215 but not specific to any particular target system) which you can use if you
20216 write the remote stubs---the code that runs on the remote system to
20217 communicate with @value{GDBN}.
20218
20219 Other remote targets may be available in your
20220 configuration of @value{GDBN}; use @code{help target} to list them.
20221
20222 @menu
20223 * Connecting::                  Connecting to a remote target
20224 * File Transfer::               Sending files to a remote system
20225 * Server::                      Using the gdbserver program
20226 * Remote Configuration::        Remote configuration
20227 * Remote Stub::                 Implementing a remote stub
20228 @end menu
20229
20230 @node Connecting
20231 @section Connecting to a Remote Target
20232 @cindex remote debugging, connecting
20233 @cindex @code{gdbserver}, connecting
20234 @cindex remote debugging, types of connections
20235 @cindex @code{gdbserver}, types of connections
20236 @cindex @code{gdbserver}, @code{target remote} mode
20237 @cindex @code{gdbserver}, @code{target extended-remote} mode
20238
20239 This section describes how to connect to a remote target, including the
20240 types of connections and their differences, how to set up executable and
20241 symbol files on the host and target, and the commands used for
20242 connecting to and disconnecting from the remote target.
20243
20244 @subsection Types of Remote Connections
20245
20246 @value{GDBN} supports two types of remote connections, @code{target remote}
20247 mode and @code{target extended-remote} mode.  Note that many remote targets
20248 support only @code{target remote} mode.  There are several major
20249 differences between the two types of connections, enumerated here:
20250
20251 @table @asis
20252
20253 @cindex remote debugging, detach and program exit
20254 @item Result of detach or program exit
20255 @strong{With target remote mode:} When the debugged program exits or you
20256 detach from it, @value{GDBN} disconnects from the target.  When using
20257 @code{gdbserver}, @code{gdbserver} will exit.
20258
20259 @strong{With target extended-remote mode:} When the debugged program exits or
20260 you detach from it, @value{GDBN} remains connected to the target, even
20261 though no program is running.  You can rerun the program, attach to a
20262 running program, or use @code{monitor} commands specific to the target.
20263
20264 When using @code{gdbserver} in this case, it does not exit unless it was
20265 invoked using the @option{--once} option.  If the @option{--once} option
20266 was not used, you can ask @code{gdbserver} to exit using the
20267 @code{monitor exit} command (@pxref{Monitor Commands for gdbserver}).
20268
20269 @item Specifying the program to debug
20270 For both connection types you use the @code{file} command to specify the
20271 program on the host system.  If you are using @code{gdbserver} there are
20272 some differences in how to specify the location of the program on the
20273 target.
20274
20275 @strong{With target remote mode:} You must either specify the program to debug
20276 on the @code{gdbserver} command line or use the @option{--attach} option
20277 (@pxref{Attaching to a program,,Attaching to a Running Program}).
20278
20279 @cindex @option{--multi}, @code{gdbserver} option
20280 @strong{With target extended-remote mode:} You may specify the program to debug
20281 on the @code{gdbserver} command line, or you can load the program or attach
20282 to it using @value{GDBN} commands after connecting to @code{gdbserver}.
20283
20284 @anchor{--multi Option in Types of Remote Connnections}
20285 You can start @code{gdbserver} without supplying an initial command to run
20286 or process ID to attach.  To do this, use the @option{--multi} command line
20287 option.  Then you can connect using @code{target extended-remote} and start
20288 the program you want to debug (see below for details on using the
20289 @code{run} command in this scenario).  Note that the conditions under which
20290 @code{gdbserver} terminates depend on how @value{GDBN} connects to it
20291 (@code{target remote} or @code{target extended-remote}).  The
20292 @option{--multi} option to @code{gdbserver} has no influence on that.
20293
20294 @item The @code{run} command
20295 @strong{With target remote mode:} The @code{run} command is not
20296 supported.  Once a connection has been established, you can use all
20297 the usual @value{GDBN} commands to examine and change data.  The
20298 remote program is already running, so you can use commands like
20299 @kbd{step} and @kbd{continue}.
20300
20301 @strong{With target extended-remote mode:} The @code{run} command is
20302 supported.  The @code{run} command uses the value set by
20303 @code{set remote exec-file} (@pxref{set remote exec-file}) to select
20304 the program to run.  Command line arguments are supported, except for
20305 wildcard expansion and I/O redirection (@pxref{Arguments}).
20306
20307 If you specify the program to debug on the command line, then the
20308 @code{run} command is not required to start execution, and you can
20309 resume using commands like @kbd{step} and @kbd{continue} as with
20310 @code{target remote} mode.
20311
20312 @anchor{Attaching in Types of Remote Connections}
20313 @item Attaching
20314 @strong{With target remote mode:} The @value{GDBN} command @code{attach} is
20315 not supported.  To attach to a running program using @code{gdbserver}, you
20316 must use the @option{--attach} option (@pxref{Running gdbserver}).
20317
20318 @strong{With target extended-remote mode:} To attach to a running program,
20319 you may use the @code{attach} command after the connection has been
20320 established.  If you are using @code{gdbserver}, you may also invoke
20321 @code{gdbserver} using the @option{--attach} option
20322 (@pxref{Running gdbserver}).
20323
20324 @end table
20325
20326 @anchor{Host and target files}
20327 @subsection Host and Target Files
20328 @cindex remote debugging, symbol files
20329 @cindex symbol files, remote debugging
20330
20331 @value{GDBN}, running on the host, needs access to symbol and debugging
20332 information for your program running on the target.  This requires 
20333 access to an unstripped copy of your program, and possibly any associated
20334 symbol files.  Note that this section applies equally to both @code{target
20335 remote} mode and @code{target extended-remote} mode.
20336
20337 Some remote targets (@pxref{qXfer executable filename read}, and
20338 @pxref{Host I/O Packets}) allow @value{GDBN} to access program files over
20339 the same connection used to communicate with @value{GDBN}.  With such a
20340 target, if the remote program is unstripped, the only command you need is
20341 @code{target remote} (or @code{target extended-remote}).
20342
20343 If the remote program is stripped, or the target does not support remote
20344 program file access, start up @value{GDBN} using the name of the local
20345 unstripped copy of your program as the first argument, or use the
20346 @code{file} command.  Use @code{set sysroot} to specify the location (on
20347 the host) of target libraries (unless your @value{GDBN} was compiled with
20348 the correct sysroot using @code{--with-sysroot}).  Alternatively, you
20349 may use @code{set solib-search-path} to specify how @value{GDBN} locates
20350 target libraries.
20351
20352 The symbol file and target libraries must exactly match the executable
20353 and libraries on the target, with one exception: the files on the host
20354 system should not be stripped, even if the files on the target system
20355 are.  Mismatched or missing files will lead to confusing results
20356 during debugging.  On @sc{gnu}/Linux targets, mismatched or missing
20357 files may also prevent @code{gdbserver} from debugging multi-threaded
20358 programs.
20359
20360 @subsection Remote Connection Commands
20361 @cindex remote connection commands
20362 @value{GDBN} can communicate with the target over a serial line, or
20363 over an @acronym{IP} network using @acronym{TCP} or @acronym{UDP}.  In
20364 each case, @value{GDBN} uses the same protocol for debugging your
20365 program; only the medium carrying the debugging packets varies.  The
20366 @code{target remote} and @code{target extended-remote} commands
20367 establish a connection to the target.  Both commands accept the same
20368 arguments, which indicate the medium to use:
20369
20370 @table @code
20371
20372 @item target remote @var{serial-device}
20373 @itemx target extended-remote @var{serial-device}
20374 @cindex serial line, @code{target remote}
20375 Use @var{serial-device} to communicate with the target.  For example,
20376 to use a serial line connected to the device named @file{/dev/ttyb}:
20377
20378 @smallexample
20379 target remote /dev/ttyb
20380 @end smallexample
20381
20382 If you're using a serial line, you may want to give @value{GDBN} the
20383 @samp{--baud} option, or use the @code{set serial baud} command
20384 (@pxref{Remote Configuration, set serial baud}) before the
20385 @code{target} command.
20386
20387 @item target remote @code{@var{host}:@var{port}}
20388 @itemx target remote @code{tcp:@var{host}:@var{port}}
20389 @itemx target extended-remote @code{@var{host}:@var{port}}
20390 @itemx target extended-remote @code{tcp:@var{host}:@var{port}}
20391 @cindex @acronym{TCP} port, @code{target remote}
20392 Debug using a @acronym{TCP} connection to @var{port} on @var{host}.
20393 The @var{host} may be either a host name or a numeric @acronym{IP}
20394 address; @var{port} must be a decimal number.  The @var{host} could be
20395 the target machine itself, if it is directly connected to the net, or
20396 it might be a terminal server which in turn has a serial line to the
20397 target.
20398
20399 For example, to connect to port 2828 on a terminal server named
20400 @code{manyfarms}:
20401
20402 @smallexample
20403 target remote manyfarms:2828
20404 @end smallexample
20405
20406 If your remote target is actually running on the same machine as your
20407 debugger session (e.g.@: a simulator for your target running on the
20408 same host), you can omit the hostname.  For example, to connect to
20409 port 1234 on your local machine:
20410
20411 @smallexample
20412 target remote :1234
20413 @end smallexample
20414 @noindent
20415
20416 Note that the colon is still required here.
20417
20418 @item target remote @code{udp:@var{host}:@var{port}}
20419 @itemx target extended-remote @code{udp:@var{host}:@var{port}}
20420 @cindex @acronym{UDP} port, @code{target remote}
20421 Debug using @acronym{UDP} packets to @var{port} on @var{host}.  For example, to
20422 connect to @acronym{UDP} port 2828 on a terminal server named @code{manyfarms}:
20423
20424 @smallexample
20425 target remote udp:manyfarms:2828
20426 @end smallexample
20427
20428 When using a @acronym{UDP} connection for remote debugging, you should
20429 keep in mind that the `U' stands for ``Unreliable''.  @acronym{UDP}
20430 can silently drop packets on busy or unreliable networks, which will
20431 cause havoc with your debugging session.
20432
20433 @item target remote | @var{command}
20434 @itemx target extended-remote | @var{command}
20435 @cindex pipe, @code{target remote} to
20436 Run @var{command} in the background and communicate with it using a
20437 pipe.  The @var{command} is a shell command, to be parsed and expanded
20438 by the system's command shell, @code{/bin/sh}; it should expect remote
20439 protocol packets on its standard input, and send replies on its
20440 standard output.  You could use this to run a stand-alone simulator
20441 that speaks the remote debugging protocol, to make net connections
20442 using programs like @code{ssh}, or for other similar tricks.
20443
20444 If @var{command} closes its standard output (perhaps by exiting),
20445 @value{GDBN} will try to send it a @code{SIGTERM} signal.  (If the
20446 program has already exited, this will have no effect.)
20447
20448 @end table
20449
20450 @cindex interrupting remote programs
20451 @cindex remote programs, interrupting
20452 Whenever @value{GDBN} is waiting for the remote program, if you type the
20453 interrupt character (often @kbd{Ctrl-c}), @value{GDBN} attempts to stop the
20454 program.  This may or may not succeed, depending in part on the hardware
20455 and the serial drivers the remote system uses.  If you type the
20456 interrupt character once again, @value{GDBN} displays this prompt:
20457
20458 @smallexample
20459 Interrupted while waiting for the program.
20460 Give up (and stop debugging it)?  (y or n)
20461 @end smallexample
20462
20463 In @code{target remote} mode, if you type @kbd{y}, @value{GDBN} abandons
20464 the remote debugging session.  (If you decide you want to try again later,
20465 you can use @kbd{target remote} again to connect once more.)  If you type
20466 @kbd{n}, @value{GDBN} goes back to waiting.
20467
20468 In @code{target extended-remote} mode, typing @kbd{n} will leave
20469 @value{GDBN} connected to the target.
20470
20471 @table @code
20472 @kindex detach (remote)
20473 @item detach
20474 When you have finished debugging the remote program, you can use the
20475 @code{detach} command to release it from @value{GDBN} control.
20476 Detaching from the target normally resumes its execution, but the results
20477 will depend on your particular remote stub.  After the @code{detach}
20478 command in @code{target remote} mode, @value{GDBN} is free to connect to
20479 another target.  In @code{target extended-remote} mode, @value{GDBN} is
20480 still connected to the target.
20481
20482 @kindex disconnect
20483 @item disconnect
20484 The @code{disconnect} command closes the connection to the target, and
20485 the target is generally not resumed.  It will wait for @value{GDBN}
20486 (this instance or another one) to connect and continue debugging.  After
20487 the @code{disconnect} command, @value{GDBN} is again free to connect to
20488 another target.
20489
20490 @cindex send command to remote monitor
20491 @cindex extend @value{GDBN} for remote targets
20492 @cindex add new commands for external monitor
20493 @kindex monitor
20494 @item monitor @var{cmd}
20495 This command allows you to send arbitrary commands directly to the
20496 remote monitor.  Since @value{GDBN} doesn't care about the commands it
20497 sends like this, this command is the way to extend @value{GDBN}---you
20498 can add new commands that only the external monitor will understand
20499 and implement.
20500 @end table
20501
20502 @node File Transfer
20503 @section Sending files to a remote system
20504 @cindex remote target, file transfer
20505 @cindex file transfer
20506 @cindex sending files to remote systems
20507
20508 Some remote targets offer the ability to transfer files over the same
20509 connection used to communicate with @value{GDBN}.  This is convenient
20510 for targets accessible through other means, e.g.@: @sc{gnu}/Linux systems
20511 running @code{gdbserver} over a network interface.  For other targets,
20512 e.g.@: embedded devices with only a single serial port, this may be
20513 the only way to upload or download files.
20514
20515 Not all remote targets support these commands.
20516
20517 @table @code
20518 @kindex remote put
20519 @item remote put @var{hostfile} @var{targetfile}
20520 Copy file @var{hostfile} from the host system (the machine running
20521 @value{GDBN}) to @var{targetfile} on the target system.
20522
20523 @kindex remote get
20524 @item remote get @var{targetfile} @var{hostfile}
20525 Copy file @var{targetfile} from the target system to @var{hostfile}
20526 on the host system.
20527
20528 @kindex remote delete
20529 @item remote delete @var{targetfile}
20530 Delete @var{targetfile} from the target system.
20531
20532 @end table
20533
20534 @node Server
20535 @section Using the @code{gdbserver} Program
20536
20537 @kindex gdbserver
20538 @cindex remote connection without stubs
20539 @code{gdbserver} is a control program for Unix-like systems, which
20540 allows you to connect your program with a remote @value{GDBN} via
20541 @code{target remote} or @code{target extended-remote}---but without
20542 linking in the usual debugging stub.
20543
20544 @code{gdbserver} is not a complete replacement for the debugging stubs,
20545 because it requires essentially the same operating-system facilities
20546 that @value{GDBN} itself does.  In fact, a system that can run
20547 @code{gdbserver} to connect to a remote @value{GDBN} could also run
20548 @value{GDBN} locally!  @code{gdbserver} is sometimes useful nevertheless,
20549 because it is a much smaller program than @value{GDBN} itself.  It is
20550 also easier to port than all of @value{GDBN}, so you may be able to get
20551 started more quickly on a new system by using @code{gdbserver}.
20552 Finally, if you develop code for real-time systems, you may find that
20553 the tradeoffs involved in real-time operation make it more convenient to
20554 do as much development work as possible on another system, for example
20555 by cross-compiling.  You can use @code{gdbserver} to make a similar
20556 choice for debugging.
20557
20558 @value{GDBN} and @code{gdbserver} communicate via either a serial line
20559 or a TCP connection, using the standard @value{GDBN} remote serial
20560 protocol.
20561
20562 @quotation
20563 @emph{Warning:} @code{gdbserver} does not have any built-in security.
20564 Do not run @code{gdbserver} connected to any public network; a
20565 @value{GDBN} connection to @code{gdbserver} provides access to the
20566 target system with the same privileges as the user running
20567 @code{gdbserver}.
20568 @end quotation
20569
20570 @anchor{Running gdbserver}
20571 @subsection Running @code{gdbserver}
20572 @cindex arguments, to @code{gdbserver}
20573 @cindex @code{gdbserver}, command-line arguments
20574
20575 Run @code{gdbserver} on the target system.  You need a copy of the
20576 program you want to debug, including any libraries it requires.
20577 @code{gdbserver} does not need your program's symbol table, so you can
20578 strip the program if necessary to save space.  @value{GDBN} on the host
20579 system does all the symbol handling.
20580
20581 To use the server, you must tell it how to communicate with @value{GDBN};
20582 the name of your program; and the arguments for your program.  The usual
20583 syntax is:
20584
20585 @smallexample
20586 target> gdbserver @var{comm} @var{program} [ @var{args} @dots{} ]
20587 @end smallexample
20588
20589 @var{comm} is either a device name (to use a serial line), or a TCP
20590 hostname and portnumber, or @code{-} or @code{stdio} to use
20591 stdin/stdout of @code{gdbserver}.
20592 For example, to debug Emacs with the argument
20593 @samp{foo.txt} and communicate with @value{GDBN} over the serial port
20594 @file{/dev/com1}:
20595
20596 @smallexample
20597 target> gdbserver /dev/com1 emacs foo.txt
20598 @end smallexample
20599
20600 @code{gdbserver} waits passively for the host @value{GDBN} to communicate
20601 with it.
20602
20603 To use a TCP connection instead of a serial line:
20604
20605 @smallexample
20606 target> gdbserver host:2345 emacs foo.txt
20607 @end smallexample
20608
20609 The only difference from the previous example is the first argument,
20610 specifying that you are communicating with the host @value{GDBN} via
20611 TCP.  The @samp{host:2345} argument means that @code{gdbserver} is to
20612 expect a TCP connection from machine @samp{host} to local TCP port 2345.
20613 (Currently, the @samp{host} part is ignored.)  You can choose any number
20614 you want for the port number as long as it does not conflict with any
20615 TCP ports already in use on the target system (for example, @code{23} is
20616 reserved for @code{telnet}).@footnote{If you choose a port number that
20617 conflicts with another service, @code{gdbserver} prints an error message
20618 and exits.}  You must use the same port number with the host @value{GDBN}
20619 @code{target remote} command.
20620
20621 The @code{stdio} connection is useful when starting @code{gdbserver}
20622 with ssh:
20623
20624 @smallexample
20625 (gdb) target remote | ssh -T hostname gdbserver - hello
20626 @end smallexample
20627
20628 The @samp{-T} option to ssh is provided because we don't need a remote pty,
20629 and we don't want escape-character handling.  Ssh does this by default when
20630 a command is provided, the flag is provided to make it explicit.
20631 You could elide it if you want to.
20632
20633 Programs started with stdio-connected gdbserver have @file{/dev/null} for
20634 @code{stdin}, and @code{stdout},@code{stderr} are sent back to gdb for
20635 display through a pipe connected to gdbserver.
20636 Both @code{stdout} and @code{stderr} use the same pipe.
20637
20638 @anchor{Attaching to a program}
20639 @subsubsection Attaching to a Running Program
20640 @cindex attach to a program, @code{gdbserver}
20641 @cindex @option{--attach}, @code{gdbserver} option
20642
20643 On some targets, @code{gdbserver} can also attach to running programs.
20644 This is accomplished via the @code{--attach} argument.  The syntax is:
20645
20646 @smallexample
20647 target> gdbserver --attach @var{comm} @var{pid}
20648 @end smallexample
20649
20650 @var{pid} is the process ID of a currently running process.  It isn't
20651 necessary to point @code{gdbserver} at a binary for the running process.
20652
20653 In @code{target extended-remote} mode, you can also attach using the
20654 @value{GDBN} attach command
20655 (@pxref{Attaching in Types of Remote Connections}).
20656
20657 @pindex pidof
20658 You can debug processes by name instead of process ID if your target has the
20659 @code{pidof} utility:
20660
20661 @smallexample
20662 target> gdbserver --attach @var{comm} `pidof @var{program}`
20663 @end smallexample
20664
20665 In case more than one copy of @var{program} is running, or @var{program}
20666 has multiple threads, most versions of @code{pidof} support the
20667 @code{-s} option to only return the first process ID.
20668
20669 @subsubsection TCP port allocation lifecycle of @code{gdbserver}
20670
20671 This section applies only when @code{gdbserver} is run to listen on a TCP
20672 port.
20673
20674 @code{gdbserver} normally terminates after all of its debugged processes have
20675 terminated in @kbd{target remote} mode.  On the other hand, for @kbd{target
20676 extended-remote}, @code{gdbserver} stays running even with no processes left.
20677 @value{GDBN} normally terminates the spawned debugged process on its exit,
20678 which normally also terminates @code{gdbserver} in the @kbd{target remote}
20679 mode.  Therefore, when the connection drops unexpectedly, and @value{GDBN}
20680 cannot ask @code{gdbserver} to kill its debugged processes, @code{gdbserver}
20681 stays running even in the @kbd{target remote} mode.
20682
20683 When @code{gdbserver} stays running, @value{GDBN} can connect to it again later.
20684 Such reconnecting is useful for features like @ref{disconnected tracing}.  For
20685 completeness, at most one @value{GDBN} can be connected at a time.
20686
20687 @cindex @option{--once}, @code{gdbserver} option
20688 By default, @code{gdbserver} keeps the listening TCP port open, so that
20689 subsequent connections are possible.  However, if you start @code{gdbserver}
20690 with the @option{--once} option, it will stop listening for any further
20691 connection attempts after connecting to the first @value{GDBN} session.  This
20692 means no further connections to @code{gdbserver} will be possible after the
20693 first one.  It also means @code{gdbserver} will terminate after the first
20694 connection with remote @value{GDBN} has closed, even for unexpectedly closed
20695 connections and even in the @kbd{target extended-remote} mode.  The
20696 @option{--once} option allows reusing the same port number for connecting to
20697 multiple instances of @code{gdbserver} running on the same host, since each
20698 instance closes its port after the first connection.
20699
20700 @anchor{Other Command-Line Arguments for gdbserver}
20701 @subsubsection Other Command-Line Arguments for @code{gdbserver}
20702
20703 You can use the @option{--multi} option to start @code{gdbserver} without
20704 specifying a program to debug or a process to attach to.  Then you can
20705 attach in @code{target extended-remote} mode and run or attach to a
20706 program.  For more information,
20707 @pxref{--multi Option in Types of Remote Connnections}.
20708
20709 @cindex @option{--debug}, @code{gdbserver} option
20710 The @option{--debug} option tells @code{gdbserver} to display extra
20711 status information about the debugging process.
20712 @cindex @option{--remote-debug}, @code{gdbserver} option
20713 The @option{--remote-debug} option tells @code{gdbserver} to display
20714 remote protocol debug output.  These options are intended for
20715 @code{gdbserver} development and for bug reports to the developers.
20716
20717 @cindex @option{--debug-format}, @code{gdbserver} option
20718 The @option{--debug-format=option1[,option2,...]} option tells
20719 @code{gdbserver} to include additional information in each output.
20720 Possible options are:
20721
20722 @table @code
20723 @item none
20724 Turn off all extra information in debugging output.
20725 @item all
20726 Turn on all extra information in debugging output.
20727 @item timestamps
20728 Include a timestamp in each line of debugging output.
20729 @end table
20730
20731 Options are processed in order.  Thus, for example, if @option{none}
20732 appears last then no additional information is added to debugging output.
20733
20734 @cindex @option{--wrapper}, @code{gdbserver} option
20735 The @option{--wrapper} option specifies a wrapper to launch programs
20736 for debugging.  The option should be followed by the name of the
20737 wrapper, then any command-line arguments to pass to the wrapper, then
20738 @kbd{--} indicating the end of the wrapper arguments.
20739
20740 @code{gdbserver} runs the specified wrapper program with a combined
20741 command line including the wrapper arguments, then the name of the
20742 program to debug, then any arguments to the program.  The wrapper
20743 runs until it executes your program, and then @value{GDBN} gains control.
20744
20745 You can use any program that eventually calls @code{execve} with
20746 its arguments as a wrapper.  Several standard Unix utilities do
20747 this, e.g.@: @code{env} and @code{nohup}.  Any Unix shell script ending
20748 with @code{exec "$@@"} will also work.
20749
20750 For example, you can use @code{env} to pass an environment variable to
20751 the debugged program, without setting the variable in @code{gdbserver}'s
20752 environment:
20753
20754 @smallexample
20755 $ gdbserver --wrapper env LD_PRELOAD=libtest.so -- :2222 ./testprog
20756 @end smallexample
20757
20758 @cindex @option{--selftest}
20759 The @option{--selftest} option runs the self tests in @code{gdbserver}:
20760
20761 @smallexample
20762 $ gdbserver --selftest
20763 Ran 2 unit tests, 0 failed
20764 @end smallexample
20765
20766 These tests are disabled in release.
20767 @subsection Connecting to @code{gdbserver}
20768
20769 The basic procedure for connecting to the remote target is:
20770 @itemize
20771
20772 @item
20773 Run @value{GDBN} on the host system.
20774
20775 @item
20776 Make sure you have the necessary symbol files
20777 (@pxref{Host and target files}).
20778 Load symbols for your application using the @code{file} command before you
20779 connect.  Use @code{set sysroot} to locate target libraries (unless your
20780 @value{GDBN} was compiled with the correct sysroot using
20781 @code{--with-sysroot}).
20782
20783 @item
20784 Connect to your target (@pxref{Connecting,,Connecting to a Remote Target}).
20785 For TCP connections, you must start up @code{gdbserver} prior to using
20786 the @code{target} command.  Otherwise you may get an error whose
20787 text depends on the host system, but which usually looks something like
20788 @samp{Connection refused}.  Don't use the @code{load}
20789 command in @value{GDBN} when using @code{target remote} mode, since the
20790 program is already on the target.
20791
20792 @end itemize
20793
20794 @anchor{Monitor Commands for gdbserver}
20795 @subsection Monitor Commands for @code{gdbserver}
20796 @cindex monitor commands, for @code{gdbserver}
20797
20798 During a @value{GDBN} session using @code{gdbserver}, you can use the
20799 @code{monitor} command to send special requests to @code{gdbserver}.
20800 Here are the available commands.
20801
20802 @table @code
20803 @item monitor help
20804 List the available monitor commands.
20805
20806 @item monitor set debug 0
20807 @itemx monitor set debug 1
20808 Disable or enable general debugging messages.
20809
20810 @item monitor set remote-debug 0
20811 @itemx monitor set remote-debug 1
20812 Disable or enable specific debugging messages associated with the remote
20813 protocol (@pxref{Remote Protocol}).
20814
20815 @item monitor set debug-format option1@r{[},option2,...@r{]}
20816 Specify additional text to add to debugging messages.
20817 Possible options are:
20818
20819 @table @code
20820 @item none
20821 Turn off all extra information in debugging output.
20822 @item all
20823 Turn on all extra information in debugging output.
20824 @item timestamps
20825 Include a timestamp in each line of debugging output.
20826 @end table
20827
20828 Options are processed in order.  Thus, for example, if @option{none}
20829 appears last then no additional information is added to debugging output.
20830
20831 @item monitor set libthread-db-search-path [PATH]
20832 @cindex gdbserver, search path for @code{libthread_db}
20833 When this command is issued, @var{path} is a colon-separated list of
20834 directories to search for @code{libthread_db} (@pxref{Threads,,set
20835 libthread-db-search-path}).  If you omit @var{path},
20836 @samp{libthread-db-search-path} will be reset to its default value.
20837
20838 The special entry @samp{$pdir} for @samp{libthread-db-search-path} is
20839 not supported in @code{gdbserver}.
20840
20841 @item monitor exit
20842 Tell gdbserver to exit immediately.  This command should be followed by
20843 @code{disconnect} to close the debugging session.  @code{gdbserver} will
20844 detach from any attached processes and kill any processes it created.
20845 Use @code{monitor exit} to terminate @code{gdbserver} at the end
20846 of a multi-process mode debug session.
20847
20848 @end table
20849
20850 @subsection Tracepoints support in @code{gdbserver}
20851 @cindex tracepoints support in @code{gdbserver}
20852
20853 On some targets, @code{gdbserver} supports tracepoints, fast
20854 tracepoints and static tracepoints.
20855
20856 For fast or static tracepoints to work, a special library called the
20857 @dfn{in-process agent} (IPA), must be loaded in the inferior process.
20858 This library is built and distributed as an integral part of
20859 @code{gdbserver}.  In addition, support for static tracepoints
20860 requires building the in-process agent library with static tracepoints
20861 support.  At present, the UST (LTTng Userspace Tracer,
20862 @url{http://lttng.org/ust}) tracing engine is supported.  This support
20863 is automatically available if UST development headers are found in the
20864 standard include path when @code{gdbserver} is built, or if
20865 @code{gdbserver} was explicitly configured using @option{--with-ust}
20866 to point at such headers.  You can explicitly disable the support
20867 using @option{--with-ust=no}.
20868
20869 There are several ways to load the in-process agent in your program:
20870
20871 @table @code
20872 @item Specifying it as dependency at link time
20873
20874 You can link your program dynamically with the in-process agent
20875 library.  On most systems, this is accomplished by adding
20876 @code{-linproctrace} to the link command.
20877
20878 @item Using the system's preloading mechanisms
20879
20880 You can force loading the in-process agent at startup time by using
20881 your system's support for preloading shared libraries.  Many Unixes
20882 support the concept of preloading user defined libraries.  In most
20883 cases, you do that by specifying @code{LD_PRELOAD=libinproctrace.so}
20884 in the environment.  See also the description of @code{gdbserver}'s
20885 @option{--wrapper} command line option.
20886
20887 @item Using @value{GDBN} to force loading the agent at run time
20888
20889 On some systems, you can force the inferior to load a shared library,
20890 by calling a dynamic loader function in the inferior that takes care
20891 of dynamically looking up and loading a shared library.  On most Unix
20892 systems, the function is @code{dlopen}.  You'll use the @code{call}
20893 command for that.  For example:
20894
20895 @smallexample
20896 (@value{GDBP}) call dlopen ("libinproctrace.so", ...)
20897 @end smallexample
20898
20899 Note that on most Unix systems, for the @code{dlopen} function to be
20900 available, the program needs to be linked with @code{-ldl}.
20901 @end table
20902
20903 On systems that have a userspace dynamic loader, like most Unix
20904 systems, when you connect to @code{gdbserver} using @code{target
20905 remote}, you'll find that the program is stopped at the dynamic
20906 loader's entry point, and no shared library has been loaded in the
20907 program's address space yet, including the in-process agent.  In that
20908 case, before being able to use any of the fast or static tracepoints
20909 features, you need to let the loader run and load the shared
20910 libraries.  The simplest way to do that is to run the program to the
20911 main procedure.  E.g., if debugging a C or C@t{++} program, start
20912 @code{gdbserver} like so:
20913
20914 @smallexample
20915 $ gdbserver :9999 myprogram
20916 @end smallexample
20917
20918 Start GDB and connect to @code{gdbserver} like so, and run to main:
20919
20920 @smallexample
20921 $ gdb myprogram
20922 (@value{GDBP}) target remote myhost:9999
20923 0x00007f215893ba60 in ?? () from /lib64/ld-linux-x86-64.so.2
20924 (@value{GDBP}) b main
20925 (@value{GDBP}) continue
20926 @end smallexample
20927
20928 The in-process tracing agent library should now be loaded into the
20929 process; you can confirm it with the @code{info sharedlibrary}
20930 command, which will list @file{libinproctrace.so} as loaded in the
20931 process.  You are now ready to install fast tracepoints, list static
20932 tracepoint markers, probe static tracepoints markers, and start
20933 tracing.
20934
20935 @node Remote Configuration
20936 @section Remote Configuration
20937
20938 @kindex set remote
20939 @kindex show remote
20940 This section documents the configuration options available when
20941 debugging remote programs.  For the options related to the File I/O
20942 extensions of the remote protocol, see @ref{system,
20943 system-call-allowed}.
20944
20945 @table @code
20946 @item set remoteaddresssize @var{bits}
20947 @cindex address size for remote targets
20948 @cindex bits in remote address
20949 Set the maximum size of address in a memory packet to the specified
20950 number of bits.  @value{GDBN} will mask off the address bits above
20951 that number, when it passes addresses to the remote target.  The
20952 default value is the number of bits in the target's address.
20953
20954 @item show remoteaddresssize
20955 Show the current value of remote address size in bits.
20956
20957 @item set serial baud @var{n}
20958 @cindex baud rate for remote targets
20959 Set the baud rate for the remote serial I/O to @var{n} baud.  The
20960 value is used to set the speed of the serial port used for debugging
20961 remote targets.
20962
20963 @item show serial baud
20964 Show the current speed of the remote connection.
20965
20966 @item set serial parity @var{parity}
20967 Set the parity for the remote serial I/O.  Supported values of @var{parity} are:
20968 @code{even}, @code{none}, and @code{odd}.  The default is @code{none}.
20969
20970 @item show serial parity
20971 Show the current parity of the serial port.
20972
20973 @item set remotebreak
20974 @cindex interrupt remote programs
20975 @cindex BREAK signal instead of Ctrl-C
20976 @anchor{set remotebreak}
20977 If set to on, @value{GDBN} sends a @code{BREAK} signal to the remote
20978 when you type @kbd{Ctrl-c} to interrupt the program running
20979 on the remote.  If set to off, @value{GDBN} sends the @samp{Ctrl-C}
20980 character instead.  The default is off, since most remote systems
20981 expect to see @samp{Ctrl-C} as the interrupt signal.
20982
20983 @item show remotebreak
20984 Show whether @value{GDBN} sends @code{BREAK} or @samp{Ctrl-C} to
20985 interrupt the remote program.
20986
20987 @item set remoteflow on
20988 @itemx set remoteflow off
20989 @kindex set remoteflow
20990 Enable or disable hardware flow control (@code{RTS}/@code{CTS})
20991 on the serial port used to communicate to the remote target.
20992
20993 @item show remoteflow
20994 @kindex show remoteflow
20995 Show the current setting of hardware flow control.
20996
20997 @item set remotelogbase @var{base}
20998 Set the base (a.k.a.@: radix) of logging serial protocol
20999 communications to @var{base}.  Supported values of @var{base} are:
21000 @code{ascii}, @code{octal}, and @code{hex}.  The default is
21001 @code{ascii}.
21002
21003 @item show remotelogbase
21004 Show the current setting of the radix for logging remote serial
21005 protocol.
21006
21007 @item set remotelogfile @var{file}
21008 @cindex record serial communications on file
21009 Record remote serial communications on the named @var{file}.  The
21010 default is not to record at all.
21011
21012 @item show remotelogfile.
21013 Show the current setting  of the file name on which to record the
21014 serial communications.
21015
21016 @item set remotetimeout @var{num}
21017 @cindex timeout for serial communications
21018 @cindex remote timeout
21019 Set the timeout limit to wait for the remote target to respond to
21020 @var{num} seconds.  The default is 2 seconds.
21021
21022 @item show remotetimeout
21023 Show the current number of seconds to wait for the remote target
21024 responses.
21025
21026 @cindex limit hardware breakpoints and watchpoints
21027 @cindex remote target, limit break- and watchpoints
21028 @anchor{set remote hardware-watchpoint-limit}
21029 @anchor{set remote hardware-breakpoint-limit}
21030 @item set remote hardware-watchpoint-limit @var{limit}
21031 @itemx set remote hardware-breakpoint-limit @var{limit}
21032 Restrict @value{GDBN} to using @var{limit} remote hardware breakpoint or
21033 watchpoints.  A limit of -1, the default, is treated as unlimited.
21034
21035 @cindex limit hardware watchpoints length
21036 @cindex remote target, limit watchpoints length
21037 @anchor{set remote hardware-watchpoint-length-limit}
21038 @item set remote hardware-watchpoint-length-limit @var{limit}
21039 Restrict @value{GDBN} to using @var{limit} bytes for the maximum length of
21040 a remote hardware watchpoint.  A limit of -1, the default, is treated
21041 as unlimited.
21042
21043 @item show remote hardware-watchpoint-length-limit
21044 Show the current limit (in bytes) of the maximum length of
21045 a remote hardware watchpoint.
21046
21047 @item set remote exec-file @var{filename}
21048 @itemx show remote exec-file
21049 @anchor{set remote exec-file}
21050 @cindex executable file, for remote target
21051 Select the file used for @code{run} with @code{target
21052 extended-remote}.  This should be set to a filename valid on the
21053 target system.  If it is not set, the target will use a default
21054 filename (e.g.@: the last program run).
21055
21056 @item set remote interrupt-sequence
21057 @cindex interrupt remote programs
21058 @cindex select Ctrl-C, BREAK or BREAK-g
21059 Allow the user to select one of @samp{Ctrl-C}, a @code{BREAK} or
21060 @samp{BREAK-g} as the
21061 sequence to the remote target in order to interrupt the execution.
21062 @samp{Ctrl-C} is a default.  Some system prefers @code{BREAK} which
21063 is high level of serial line for some certain time.
21064 Linux kernel prefers @samp{BREAK-g}, a.k.a Magic SysRq g.
21065 It is @code{BREAK} signal followed by character @code{g}.
21066
21067 @item show interrupt-sequence
21068 Show which of @samp{Ctrl-C}, @code{BREAK} or @code{BREAK-g}
21069 is sent by @value{GDBN} to interrupt the remote program.
21070 @code{BREAK-g} is BREAK signal followed by @code{g} and
21071 also known as Magic SysRq g.
21072
21073 @item set remote interrupt-on-connect
21074 @cindex send interrupt-sequence on start
21075 Specify whether interrupt-sequence is sent to remote target when
21076 @value{GDBN} connects to it.  This is mostly needed when you debug
21077 Linux kernel.  Linux kernel expects @code{BREAK} followed by @code{g}
21078 which is known as Magic SysRq g in order to connect @value{GDBN}.
21079
21080 @item show interrupt-on-connect
21081 Show whether interrupt-sequence is sent
21082 to remote target when @value{GDBN} connects to it.
21083
21084 @kindex set tcp
21085 @kindex show tcp
21086 @item set tcp auto-retry on
21087 @cindex auto-retry, for remote TCP target
21088 Enable auto-retry for remote TCP connections.  This is useful if the remote
21089 debugging agent is launched in parallel with @value{GDBN}; there is a race
21090 condition because the agent may not become ready to accept the connection
21091 before @value{GDBN} attempts to connect.  When auto-retry is
21092 enabled, if the initial attempt to connect fails, @value{GDBN} reattempts
21093 to establish the connection using the timeout specified by 
21094 @code{set tcp connect-timeout}.
21095
21096 @item set tcp auto-retry off
21097 Do not auto-retry failed TCP connections.
21098
21099 @item show tcp auto-retry
21100 Show the current auto-retry setting.
21101
21102 @item set tcp connect-timeout @var{seconds}
21103 @itemx set tcp connect-timeout unlimited
21104 @cindex connection timeout, for remote TCP target
21105 @cindex timeout, for remote target connection
21106 Set the timeout for establishing a TCP connection to the remote target to
21107 @var{seconds}.  The timeout affects both polling to retry failed connections 
21108 (enabled by @code{set tcp auto-retry on}) and waiting for connections
21109 that are merely slow to complete, and represents an approximate cumulative
21110 value.  If @var{seconds} is @code{unlimited}, there is no timeout and
21111 @value{GDBN} will keep attempting to establish a connection forever,
21112 unless interrupted with @kbd{Ctrl-c}.  The default is 15 seconds.
21113
21114 @item show tcp connect-timeout
21115 Show the current connection timeout setting.
21116 @end table
21117
21118 @cindex remote packets, enabling and disabling
21119 The @value{GDBN} remote protocol autodetects the packets supported by
21120 your debugging stub.  If you need to override the autodetection, you
21121 can use these commands to enable or disable individual packets.  Each
21122 packet can be set to @samp{on} (the remote target supports this
21123 packet), @samp{off} (the remote target does not support this packet),
21124 or @samp{auto} (detect remote target support for this packet).  They
21125 all default to @samp{auto}.  For more information about each packet,
21126 see @ref{Remote Protocol}.
21127
21128 During normal use, you should not have to use any of these commands.
21129 If you do, that may be a bug in your remote debugging stub, or a bug
21130 in @value{GDBN}.  You may want to report the problem to the
21131 @value{GDBN} developers.
21132
21133 For each packet @var{name}, the command to enable or disable the
21134 packet is @code{set remote @var{name}-packet}.  The available settings
21135 are:
21136
21137 @multitable @columnfractions 0.28 0.32 0.25
21138 @item Command Name
21139 @tab Remote Packet
21140 @tab Related Features
21141
21142 @item @code{fetch-register}
21143 @tab @code{p}
21144 @tab @code{info registers}
21145
21146 @item @code{set-register}
21147 @tab @code{P}
21148 @tab @code{set}
21149
21150 @item @code{binary-download}
21151 @tab @code{X}
21152 @tab @code{load}, @code{set}
21153
21154 @item @code{read-aux-vector}
21155 @tab @code{qXfer:auxv:read}
21156 @tab @code{info auxv}
21157
21158 @item @code{symbol-lookup}
21159 @tab @code{qSymbol}
21160 @tab Detecting multiple threads
21161
21162 @item @code{attach}
21163 @tab @code{vAttach}
21164 @tab @code{attach}
21165
21166 @item @code{verbose-resume}
21167 @tab @code{vCont}
21168 @tab Stepping or resuming multiple threads
21169
21170 @item @code{run}
21171 @tab @code{vRun}
21172 @tab @code{run}
21173
21174 @item @code{software-breakpoint}
21175 @tab @code{Z0}
21176 @tab @code{break}
21177
21178 @item @code{hardware-breakpoint}
21179 @tab @code{Z1}
21180 @tab @code{hbreak}
21181
21182 @item @code{write-watchpoint}
21183 @tab @code{Z2}
21184 @tab @code{watch}
21185
21186 @item @code{read-watchpoint}
21187 @tab @code{Z3}
21188 @tab @code{rwatch}
21189
21190 @item @code{access-watchpoint}
21191 @tab @code{Z4}
21192 @tab @code{awatch}
21193
21194 @item @code{pid-to-exec-file}
21195 @tab @code{qXfer:exec-file:read}
21196 @tab @code{attach}, @code{run}
21197
21198 @item @code{target-features}
21199 @tab @code{qXfer:features:read}
21200 @tab @code{set architecture}
21201
21202 @item @code{library-info}
21203 @tab @code{qXfer:libraries:read}
21204 @tab @code{info sharedlibrary}
21205
21206 @item @code{memory-map}
21207 @tab @code{qXfer:memory-map:read}
21208 @tab @code{info mem}
21209
21210 @item @code{read-sdata-object}
21211 @tab @code{qXfer:sdata:read}
21212 @tab @code{print $_sdata}
21213
21214 @item @code{read-spu-object}
21215 @tab @code{qXfer:spu:read}
21216 @tab @code{info spu}
21217
21218 @item @code{write-spu-object}
21219 @tab @code{qXfer:spu:write}
21220 @tab @code{info spu}
21221
21222 @item @code{read-siginfo-object}
21223 @tab @code{qXfer:siginfo:read}
21224 @tab @code{print $_siginfo}
21225
21226 @item @code{write-siginfo-object}
21227 @tab @code{qXfer:siginfo:write}
21228 @tab @code{set $_siginfo}
21229
21230 @item @code{threads}
21231 @tab @code{qXfer:threads:read}
21232 @tab @code{info threads}
21233
21234 @item @code{get-thread-local-@*storage-address}
21235 @tab @code{qGetTLSAddr}
21236 @tab Displaying @code{__thread} variables
21237
21238 @item @code{get-thread-information-block-address}
21239 @tab @code{qGetTIBAddr}
21240 @tab Display MS-Windows Thread Information Block.
21241
21242 @item @code{search-memory}
21243 @tab @code{qSearch:memory}
21244 @tab @code{find}
21245
21246 @item @code{supported-packets}
21247 @tab @code{qSupported}
21248 @tab Remote communications parameters
21249
21250 @item @code{catch-syscalls}
21251 @tab @code{QCatchSyscalls}
21252 @tab @code{catch syscall}
21253
21254 @item @code{pass-signals}
21255 @tab @code{QPassSignals}
21256 @tab @code{handle @var{signal}}
21257
21258 @item @code{program-signals}
21259 @tab @code{QProgramSignals}
21260 @tab @code{handle @var{signal}}
21261
21262 @item @code{hostio-close-packet}
21263 @tab @code{vFile:close}
21264 @tab @code{remote get}, @code{remote put}
21265
21266 @item @code{hostio-open-packet}
21267 @tab @code{vFile:open}
21268 @tab @code{remote get}, @code{remote put}
21269
21270 @item @code{hostio-pread-packet}
21271 @tab @code{vFile:pread}
21272 @tab @code{remote get}, @code{remote put}
21273
21274 @item @code{hostio-pwrite-packet}
21275 @tab @code{vFile:pwrite}
21276 @tab @code{remote get}, @code{remote put}
21277
21278 @item @code{hostio-unlink-packet}
21279 @tab @code{vFile:unlink}
21280 @tab @code{remote delete}
21281
21282 @item @code{hostio-readlink-packet}
21283 @tab @code{vFile:readlink}
21284 @tab Host I/O
21285
21286 @item @code{hostio-fstat-packet}
21287 @tab @code{vFile:fstat}
21288 @tab Host I/O
21289
21290 @item @code{hostio-setfs-packet}
21291 @tab @code{vFile:setfs}
21292 @tab Host I/O
21293
21294 @item @code{noack-packet}
21295 @tab @code{QStartNoAckMode}
21296 @tab Packet acknowledgment
21297
21298 @item @code{osdata}
21299 @tab @code{qXfer:osdata:read}
21300 @tab @code{info os}
21301
21302 @item @code{query-attached}
21303 @tab @code{qAttached}
21304 @tab Querying remote process attach state.
21305
21306 @item @code{trace-buffer-size}
21307 @tab @code{QTBuffer:size}
21308 @tab @code{set trace-buffer-size}
21309
21310 @item @code{trace-status}
21311 @tab @code{qTStatus}
21312 @tab @code{tstatus}
21313
21314 @item @code{traceframe-info}
21315 @tab @code{qXfer:traceframe-info:read}
21316 @tab Traceframe info
21317
21318 @item @code{install-in-trace}
21319 @tab @code{InstallInTrace}
21320 @tab Install tracepoint in tracing
21321
21322 @item @code{disable-randomization}
21323 @tab @code{QDisableRandomization}
21324 @tab @code{set disable-randomization}
21325
21326 @item @code{startup-with-shell}
21327 @tab @code{QStartupWithShell}
21328 @tab @code{set startup-with-shell}
21329
21330 @item @code{environment-hex-encoded}
21331 @tab @code{QEnvironmentHexEncoded}
21332 @tab @code{set environment}
21333
21334 @item @code{environment-unset}
21335 @tab @code{QEnvironmentUnset}
21336 @tab @code{unset environment}
21337
21338 @item @code{environment-reset}
21339 @tab @code{QEnvironmentReset}
21340 @tab @code{Reset the inferior environment (i.e., unset user-set variables)}
21341
21342 @item @code{set-working-dir}
21343 @tab @code{QSetWorkingDir}
21344 @tab @code{set cwd}
21345
21346 @item @code{conditional-breakpoints-packet}
21347 @tab @code{Z0 and Z1}
21348 @tab @code{Support for target-side breakpoint condition evaluation}
21349
21350 @item @code{multiprocess-extensions}
21351 @tab @code{multiprocess extensions}
21352 @tab Debug multiple processes and remote process PID awareness
21353
21354 @item @code{swbreak-feature}
21355 @tab @code{swbreak stop reason}
21356 @tab @code{break}
21357
21358 @item @code{hwbreak-feature}
21359 @tab @code{hwbreak stop reason}
21360 @tab @code{hbreak}
21361
21362 @item @code{fork-event-feature}
21363 @tab @code{fork stop reason}
21364 @tab @code{fork}
21365
21366 @item @code{vfork-event-feature}
21367 @tab @code{vfork stop reason}
21368 @tab @code{vfork}
21369
21370 @item @code{exec-event-feature}
21371 @tab @code{exec stop reason}
21372 @tab @code{exec}
21373
21374 @item @code{thread-events}
21375 @tab @code{QThreadEvents}
21376 @tab Tracking thread lifetime.
21377
21378 @item @code{no-resumed-stop-reply}
21379 @tab @code{no resumed thread left stop reply}
21380 @tab Tracking thread lifetime.
21381
21382 @end multitable
21383
21384 @node Remote Stub
21385 @section Implementing a Remote Stub
21386
21387 @cindex debugging stub, example
21388 @cindex remote stub, example
21389 @cindex stub example, remote debugging
21390 The stub files provided with @value{GDBN} implement the target side of the
21391 communication protocol, and the @value{GDBN} side is implemented in the
21392 @value{GDBN} source file @file{remote.c}.  Normally, you can simply allow
21393 these subroutines to communicate, and ignore the details.  (If you're
21394 implementing your own stub file, you can still ignore the details: start
21395 with one of the existing stub files.  @file{sparc-stub.c} is the best
21396 organized, and therefore the easiest to read.)
21397
21398 @cindex remote serial debugging, overview
21399 To debug a program running on another machine (the debugging
21400 @dfn{target} machine), you must first arrange for all the usual
21401 prerequisites for the program to run by itself.  For example, for a C
21402 program, you need:
21403
21404 @enumerate
21405 @item
21406 A startup routine to set up the C runtime environment; these usually
21407 have a name like @file{crt0}.  The startup routine may be supplied by
21408 your hardware supplier, or you may have to write your own.
21409
21410 @item
21411 A C subroutine library to support your program's
21412 subroutine calls, notably managing input and output.
21413
21414 @item
21415 A way of getting your program to the other machine---for example, a
21416 download program.  These are often supplied by the hardware
21417 manufacturer, but you may have to write your own from hardware
21418 documentation.
21419 @end enumerate
21420
21421 The next step is to arrange for your program to use a serial port to
21422 communicate with the machine where @value{GDBN} is running (the @dfn{host}
21423 machine).  In general terms, the scheme looks like this:
21424
21425 @table @emph
21426 @item On the host,
21427 @value{GDBN} already understands how to use this protocol; when everything
21428 else is set up, you can simply use the @samp{target remote} command
21429 (@pxref{Targets,,Specifying a Debugging Target}).
21430
21431 @item On the target,
21432 you must link with your program a few special-purpose subroutines that
21433 implement the @value{GDBN} remote serial protocol.  The file containing these
21434 subroutines is called  a @dfn{debugging stub}.
21435
21436 On certain remote targets, you can use an auxiliary program
21437 @code{gdbserver} instead of linking a stub into your program.
21438 @xref{Server,,Using the @code{gdbserver} Program}, for details.
21439 @end table
21440
21441 The debugging stub is specific to the architecture of the remote
21442 machine; for example, use @file{sparc-stub.c} to debug programs on
21443 @sc{sparc} boards.
21444
21445 @cindex remote serial stub list
21446 These working remote stubs are distributed with @value{GDBN}:
21447
21448 @table @code
21449
21450 @item i386-stub.c
21451 @cindex @file{i386-stub.c}
21452 @cindex Intel
21453 @cindex i386
21454 For Intel 386 and compatible architectures.
21455
21456 @item m68k-stub.c
21457 @cindex @file{m68k-stub.c}
21458 @cindex Motorola 680x0
21459 @cindex m680x0
21460 For Motorola 680x0 architectures.
21461
21462 @item sh-stub.c
21463 @cindex @file{sh-stub.c}
21464 @cindex Renesas
21465 @cindex SH
21466 For Renesas SH architectures.
21467
21468 @item sparc-stub.c
21469 @cindex @file{sparc-stub.c}
21470 @cindex Sparc
21471 For @sc{sparc} architectures.
21472
21473 @item sparcl-stub.c
21474 @cindex @file{sparcl-stub.c}
21475 @cindex Fujitsu
21476 @cindex SparcLite
21477 For Fujitsu @sc{sparclite} architectures.
21478
21479 @end table
21480
21481 The @file{README} file in the @value{GDBN} distribution may list other
21482 recently added stubs.
21483
21484 @menu
21485 * Stub Contents::       What the stub can do for you
21486 * Bootstrapping::       What you must do for the stub
21487 * Debug Session::       Putting it all together
21488 @end menu
21489
21490 @node Stub Contents
21491 @subsection What the Stub Can Do for You
21492
21493 @cindex remote serial stub
21494 The debugging stub for your architecture supplies these three
21495 subroutines:
21496
21497 @table @code
21498 @item set_debug_traps
21499 @findex set_debug_traps
21500 @cindex remote serial stub, initialization
21501 This routine arranges for @code{handle_exception} to run when your
21502 program stops.  You must call this subroutine explicitly in your
21503 program's startup code.
21504
21505 @item handle_exception
21506 @findex handle_exception
21507 @cindex remote serial stub, main routine
21508 This is the central workhorse, but your program never calls it
21509 explicitly---the setup code arranges for @code{handle_exception} to
21510 run when a trap is triggered.
21511
21512 @code{handle_exception} takes control when your program stops during
21513 execution (for example, on a breakpoint), and mediates communications
21514 with @value{GDBN} on the host machine.  This is where the communications
21515 protocol is implemented; @code{handle_exception} acts as the @value{GDBN}
21516 representative on the target machine.  It begins by sending summary
21517 information on the state of your program, then continues to execute,
21518 retrieving and transmitting any information @value{GDBN} needs, until you
21519 execute a @value{GDBN} command that makes your program resume; at that point,
21520 @code{handle_exception} returns control to your own code on the target
21521 machine.
21522
21523 @item breakpoint
21524 @cindex @code{breakpoint} subroutine, remote
21525 Use this auxiliary subroutine to make your program contain a
21526 breakpoint.  Depending on the particular situation, this may be the only
21527 way for @value{GDBN} to get control.  For instance, if your target
21528 machine has some sort of interrupt button, you won't need to call this;
21529 pressing the interrupt button transfers control to
21530 @code{handle_exception}---in effect, to @value{GDBN}.  On some machines,
21531 simply receiving characters on the serial port may also trigger a trap;
21532 again, in that situation, you don't need to call @code{breakpoint} from
21533 your own program---simply running @samp{target remote} from the host
21534 @value{GDBN} session gets control.
21535
21536 Call @code{breakpoint} if none of these is true, or if you simply want
21537 to make certain your program stops at a predetermined point for the
21538 start of your debugging session.
21539 @end table
21540
21541 @node Bootstrapping
21542 @subsection What You Must Do for the Stub
21543
21544 @cindex remote stub, support routines
21545 The debugging stubs that come with @value{GDBN} are set up for a particular
21546 chip architecture, but they have no information about the rest of your
21547 debugging target machine.
21548
21549 First of all you need to tell the stub how to communicate with the
21550 serial port.
21551
21552 @table @code
21553 @item int getDebugChar()
21554 @findex getDebugChar
21555 Write this subroutine to read a single character from the serial port.
21556 It may be identical to @code{getchar} for your target system; a
21557 different name is used to allow you to distinguish the two if you wish.
21558
21559 @item void putDebugChar(int)
21560 @findex putDebugChar
21561 Write this subroutine to write a single character to the serial port.
21562 It may be identical to @code{putchar} for your target system; a
21563 different name is used to allow you to distinguish the two if you wish.
21564 @end table
21565
21566 @cindex control C, and remote debugging
21567 @cindex interrupting remote targets
21568 If you want @value{GDBN} to be able to stop your program while it is
21569 running, you need to use an interrupt-driven serial driver, and arrange
21570 for it to stop when it receives a @code{^C} (@samp{\003}, the control-C
21571 character).  That is the character which @value{GDBN} uses to tell the
21572 remote system to stop.
21573
21574 Getting the debugging target to return the proper status to @value{GDBN}
21575 probably requires changes to the standard stub; one quick and dirty way
21576 is to just execute a breakpoint instruction (the ``dirty'' part is that
21577 @value{GDBN} reports a @code{SIGTRAP} instead of a @code{SIGINT}).
21578
21579 Other routines you need to supply are:
21580
21581 @table @code
21582 @item void exceptionHandler (int @var{exception_number}, void *@var{exception_address})
21583 @findex exceptionHandler
21584 Write this function to install @var{exception_address} in the exception
21585 handling tables.  You need to do this because the stub does not have any
21586 way of knowing what the exception handling tables on your target system
21587 are like (for example, the processor's table might be in @sc{rom},
21588 containing entries which point to a table in @sc{ram}).
21589 The @var{exception_number} specifies the exception which should be changed;
21590 its meaning is architecture-dependent (for example, different numbers
21591 might represent divide by zero, misaligned access, etc).  When this
21592 exception occurs, control should be transferred directly to
21593 @var{exception_address}, and the processor state (stack, registers,
21594 and so on) should be just as it is when a processor exception occurs.  So if
21595 you want to use a jump instruction to reach @var{exception_address}, it
21596 should be a simple jump, not a jump to subroutine.
21597
21598 For the 386, @var{exception_address} should be installed as an interrupt
21599 gate so that interrupts are masked while the handler runs.  The gate
21600 should be at privilege level 0 (the most privileged level).  The
21601 @sc{sparc} and 68k stubs are able to mask interrupts themselves without
21602 help from @code{exceptionHandler}.
21603
21604 @item void flush_i_cache()
21605 @findex flush_i_cache
21606 On @sc{sparc} and @sc{sparclite} only, write this subroutine to flush the
21607 instruction cache, if any, on your target machine.  If there is no
21608 instruction cache, this subroutine may be a no-op.
21609
21610 On target machines that have instruction caches, @value{GDBN} requires this
21611 function to make certain that the state of your program is stable.
21612 @end table
21613
21614 @noindent
21615 You must also make sure this library routine is available:
21616
21617 @table @code
21618 @item void *memset(void *, int, int)
21619 @findex memset
21620 This is the standard library function @code{memset} that sets an area of
21621 memory to a known value.  If you have one of the free versions of
21622 @code{libc.a}, @code{memset} can be found there; otherwise, you must
21623 either obtain it from your hardware manufacturer, or write your own.
21624 @end table
21625
21626 If you do not use the GNU C compiler, you may need other standard
21627 library subroutines as well; this varies from one stub to another,
21628 but in general the stubs are likely to use any of the common library
21629 subroutines which @code{@value{NGCC}} generates as inline code.
21630
21631
21632 @node Debug Session
21633 @subsection Putting it All Together
21634
21635 @cindex remote serial debugging summary
21636 In summary, when your program is ready to debug, you must follow these
21637 steps.
21638
21639 @enumerate
21640 @item
21641 Make sure you have defined the supporting low-level routines
21642 (@pxref{Bootstrapping,,What You Must Do for the Stub}):
21643 @display
21644 @code{getDebugChar}, @code{putDebugChar},
21645 @code{flush_i_cache}, @code{memset}, @code{exceptionHandler}.
21646 @end display
21647
21648 @item
21649 Insert these lines in your program's startup code, before the main
21650 procedure is called:
21651
21652 @smallexample
21653 set_debug_traps();
21654 breakpoint();
21655 @end smallexample
21656
21657 On some machines, when a breakpoint trap is raised, the hardware
21658 automatically makes the PC point to the instruction after the
21659 breakpoint.  If your machine doesn't do that, you may need to adjust
21660 @code{handle_exception} to arrange for it to return to the instruction
21661 after the breakpoint on this first invocation, so that your program
21662 doesn't keep hitting the initial breakpoint instead of making
21663 progress.
21664
21665 @item
21666 For the 680x0 stub only, you need to provide a variable called
21667 @code{exceptionHook}.  Normally you just use:
21668
21669 @smallexample
21670 void (*exceptionHook)() = 0;
21671 @end smallexample
21672
21673 @noindent
21674 but if before calling @code{set_debug_traps}, you set it to point to a
21675 function in your program, that function is called when
21676 @code{@value{GDBN}} continues after stopping on a trap (for example, bus
21677 error).  The function indicated by @code{exceptionHook} is called with
21678 one parameter: an @code{int} which is the exception number.
21679
21680 @item
21681 Compile and link together: your program, the @value{GDBN} debugging stub for
21682 your target architecture, and the supporting subroutines.
21683
21684 @item
21685 Make sure you have a serial connection between your target machine and
21686 the @value{GDBN} host, and identify the serial port on the host.
21687
21688 @item
21689 @c The "remote" target now provides a `load' command, so we should
21690 @c document that.  FIXME.
21691 Download your program to your target machine (or get it there by
21692 whatever means the manufacturer provides), and start it.
21693
21694 @item
21695 Start @value{GDBN} on the host, and connect to the target
21696 (@pxref{Connecting,,Connecting to a Remote Target}).
21697
21698 @end enumerate
21699
21700 @node Configurations
21701 @chapter Configuration-Specific Information
21702
21703 While nearly all @value{GDBN} commands are available for all native and
21704 cross versions of the debugger, there are some exceptions.  This chapter
21705 describes things that are only available in certain configurations.
21706
21707 There are three major categories of configurations: native
21708 configurations, where the host and target are the same, embedded
21709 operating system configurations, which are usually the same for several
21710 different processor architectures, and bare embedded processors, which
21711 are quite different from each other.
21712
21713 @menu
21714 * Native::
21715 * Embedded OS::
21716 * Embedded Processors::
21717 * Architectures::
21718 @end menu
21719
21720 @node Native
21721 @section Native
21722
21723 This section describes details specific to particular native
21724 configurations.
21725
21726 @menu
21727 * BSD libkvm Interface::        Debugging BSD kernel memory images
21728 * Process Information::         Process information
21729 * DJGPP Native::                Features specific to the DJGPP port
21730 * Cygwin Native::               Features specific to the Cygwin port
21731 * Hurd Native::                 Features specific to @sc{gnu} Hurd
21732 * Darwin::                      Features specific to Darwin
21733 @end menu
21734
21735 @node BSD libkvm Interface
21736 @subsection BSD libkvm Interface
21737
21738 @cindex libkvm
21739 @cindex kernel memory image
21740 @cindex kernel crash dump
21741
21742 BSD-derived systems (FreeBSD/NetBSD/OpenBSD) have a kernel memory
21743 interface that provides a uniform interface for accessing kernel virtual
21744 memory images, including live systems and crash dumps.  @value{GDBN}
21745 uses this interface to allow you to debug live kernels and kernel crash
21746 dumps on many native BSD configurations.  This is implemented as a
21747 special @code{kvm} debugging target.  For debugging a live system, load
21748 the currently running kernel into @value{GDBN} and connect to the
21749 @code{kvm} target:
21750
21751 @smallexample
21752 (@value{GDBP}) @b{target kvm}
21753 @end smallexample
21754
21755 For debugging crash dumps, provide the file name of the crash dump as an
21756 argument:
21757
21758 @smallexample
21759 (@value{GDBP}) @b{target kvm /var/crash/bsd.0}
21760 @end smallexample
21761
21762 Once connected to the @code{kvm} target, the following commands are
21763 available:
21764
21765 @table @code
21766 @kindex kvm
21767 @item kvm pcb
21768 Set current context from the @dfn{Process Control Block} (PCB) address.
21769
21770 @item kvm proc
21771 Set current context from proc address.  This command isn't available on
21772 modern FreeBSD systems.
21773 @end table
21774
21775 @node Process Information
21776 @subsection Process Information
21777 @cindex /proc
21778 @cindex examine process image
21779 @cindex process info via @file{/proc}
21780
21781 Some operating systems provide interfaces to fetch additional
21782 information about running processes beyond memory and per-thread
21783 register state.  If @value{GDBN} is configured for an operating system
21784 with a supported interface, the command @code{info proc} is available
21785 to report information about the process running your program, or about
21786 any process running on your system.
21787
21788 One supported interface is a facility called @samp{/proc} that can be
21789 used to examine the image of a running process using file-system
21790 subroutines.  This facility is supported on @sc{gnu}/Linux and Solaris
21791 systems.
21792
21793 On FreeBSD systems, system control nodes are used to query process
21794 information.
21795
21796 In addition, some systems may provide additional process information
21797 in core files.  Note that a core file may include a subset of the
21798 information available from a live process.  Process information is
21799 currently avaiable from cores created on @sc{gnu}/Linux and FreeBSD
21800 systems.
21801
21802 @table @code
21803 @kindex info proc
21804 @cindex process ID
21805 @item info proc
21806 @itemx info proc @var{process-id}
21807 Summarize available information about any running process.  If a
21808 process ID is specified by @var{process-id}, display information about
21809 that process; otherwise display information about the program being
21810 debugged.  The summary includes the debugged process ID, the command
21811 line used to invoke it, its current working directory, and its
21812 executable file's absolute file name.
21813
21814 On some systems, @var{process-id} can be of the form
21815 @samp{[@var{pid}]/@var{tid}} which specifies a certain thread ID
21816 within a process.  If the optional @var{pid} part is missing, it means
21817 a thread from the process being debugged (the leading @samp{/} still
21818 needs to be present, or else @value{GDBN} will interpret the number as
21819 a process ID rather than a thread ID).
21820
21821 @item info proc cmdline
21822 @cindex info proc cmdline
21823 Show the original command line of the process.  This command is
21824 supported on @sc{gnu}/Linux and FreeBSD.
21825
21826 @item info proc cwd
21827 @cindex info proc cwd
21828 Show the current working directory of the process.  This command is
21829 supported on @sc{gnu}/Linux and FreeBSD.
21830
21831 @item info proc exe
21832 @cindex info proc exe
21833 Show the name of executable of the process.  This command is supported
21834 on @sc{gnu}/Linux and FreeBSD.
21835
21836 @item info proc mappings
21837 @cindex memory address space mappings
21838 Report the memory address space ranges accessible in the program.  On
21839 Solaris and FreeBSD systems, each memory range includes information on
21840 whether the process has read, write, or execute access rights to each
21841 range.  On @sc{gnu}/Linux and FreeBSD systems, each memory range
21842 includes the object file which is mapped to that range.
21843
21844 @item info proc stat
21845 @itemx info proc status
21846 @cindex process detailed status information
21847 Show additional process-related information, including the user ID and
21848 group ID; virtual memory usage; the signals that are pending, blocked,
21849 and ignored; its TTY; its consumption of system and user time; its
21850 stack size; its @samp{nice} value; etc.  These commands are supported
21851 on @sc{gnu}/Linux and FreeBSD.
21852
21853 For @sc{gnu}/Linux systems, see the @samp{proc} man page for more
21854 information (type @kbd{man 5 proc} from your shell prompt).
21855
21856 For FreeBSD systems, @code{info proc stat} is an alias for @code{info
21857 proc status}.
21858
21859 @item info proc all
21860 Show all the information about the process described under all of the
21861 above @code{info proc} subcommands.
21862
21863 @ignore
21864 @comment These sub-options of 'info proc' were not included when
21865 @comment procfs.c was re-written.  Keep their descriptions around
21866 @comment against the day when someone finds the time to put them back in.
21867 @kindex info proc times
21868 @item info proc times
21869 Starting time, user CPU time, and system CPU time for your program and
21870 its children.
21871
21872 @kindex info proc id
21873 @item info proc id
21874 Report on the process IDs related to your program: its own process ID,
21875 the ID of its parent, the process group ID, and the session ID.
21876 @end ignore
21877
21878 @item set procfs-trace
21879 @kindex set procfs-trace
21880 @cindex @code{procfs} API calls
21881 This command enables and disables tracing of @code{procfs} API calls.
21882
21883 @item show procfs-trace
21884 @kindex show procfs-trace
21885 Show the current state of @code{procfs} API call tracing.
21886
21887 @item set procfs-file @var{file}
21888 @kindex set procfs-file
21889 Tell @value{GDBN} to write @code{procfs} API trace to the named
21890 @var{file}.  @value{GDBN} appends the trace info to the previous
21891 contents of the file.  The default is to display the trace on the
21892 standard output.
21893
21894 @item show procfs-file
21895 @kindex show procfs-file
21896 Show the file to which @code{procfs} API trace is written.
21897
21898 @item proc-trace-entry
21899 @itemx proc-trace-exit
21900 @itemx proc-untrace-entry
21901 @itemx proc-untrace-exit
21902 @kindex proc-trace-entry
21903 @kindex proc-trace-exit
21904 @kindex proc-untrace-entry
21905 @kindex proc-untrace-exit
21906 These commands enable and disable tracing of entries into and exits
21907 from the @code{syscall} interface.
21908
21909 @item info pidlist
21910 @kindex info pidlist
21911 @cindex process list, QNX Neutrino
21912 For QNX Neutrino only, this command displays the list of all the
21913 processes and all the threads within each process.
21914
21915 @item info meminfo
21916 @kindex info meminfo
21917 @cindex mapinfo list, QNX Neutrino
21918 For QNX Neutrino only, this command displays the list of all mapinfos.
21919 @end table
21920
21921 @node DJGPP Native
21922 @subsection Features for Debugging @sc{djgpp} Programs
21923 @cindex @sc{djgpp} debugging
21924 @cindex native @sc{djgpp} debugging
21925 @cindex MS-DOS-specific commands
21926
21927 @cindex DPMI
21928 @sc{djgpp} is a port of the @sc{gnu} development tools to MS-DOS and
21929 MS-Windows.  @sc{djgpp} programs are 32-bit protected-mode programs
21930 that use the @dfn{DPMI} (DOS Protected-Mode Interface) API to run on
21931 top of real-mode DOS systems and their emulations.
21932
21933 @value{GDBN} supports native debugging of @sc{djgpp} programs, and
21934 defines a few commands specific to the @sc{djgpp} port.  This
21935 subsection describes those commands.
21936
21937 @table @code
21938 @kindex info dos
21939 @item info dos
21940 This is a prefix of @sc{djgpp}-specific commands which print
21941 information about the target system and important OS structures.
21942
21943 @kindex sysinfo
21944 @cindex MS-DOS system info
21945 @cindex free memory information (MS-DOS)
21946 @item info dos sysinfo
21947 This command displays assorted information about the underlying
21948 platform: the CPU type and features, the OS version and flavor, the
21949 DPMI version, and the available conventional and DPMI memory.
21950
21951 @cindex GDT
21952 @cindex LDT
21953 @cindex IDT
21954 @cindex segment descriptor tables
21955 @cindex descriptor tables display
21956 @item info dos gdt
21957 @itemx info dos ldt
21958 @itemx info dos idt
21959 These 3 commands display entries from, respectively, Global, Local,
21960 and Interrupt Descriptor Tables (GDT, LDT, and IDT).  The descriptor
21961 tables are data structures which store a descriptor for each segment
21962 that is currently in use.  The segment's selector is an index into a
21963 descriptor table; the table entry for that index holds the
21964 descriptor's base address and limit, and its attributes and access
21965 rights.
21966
21967 A typical @sc{djgpp} program uses 3 segments: a code segment, a data
21968 segment (used for both data and the stack), and a DOS segment (which
21969 allows access to DOS/BIOS data structures and absolute addresses in
21970 conventional memory).  However, the DPMI host will usually define
21971 additional segments in order to support the DPMI environment.
21972
21973 @cindex garbled pointers
21974 These commands allow to display entries from the descriptor tables.
21975 Without an argument, all entries from the specified table are
21976 displayed.  An argument, which should be an integer expression, means
21977 display a single entry whose index is given by the argument.  For
21978 example, here's a convenient way to display information about the
21979 debugged program's data segment:
21980
21981 @smallexample
21982 @exdent @code{(@value{GDBP}) info dos ldt $ds}
21983 @exdent @code{0x13f: base=0x11970000 limit=0x0009ffff 32-Bit Data (Read/Write, Exp-up)}
21984 @end smallexample
21985
21986 @noindent
21987 This comes in handy when you want to see whether a pointer is outside
21988 the data segment's limit (i.e.@: @dfn{garbled}).
21989
21990 @cindex page tables display (MS-DOS)
21991 @item info dos pde
21992 @itemx info dos pte
21993 These two commands display entries from, respectively, the Page
21994 Directory and the Page Tables.  Page Directories and Page Tables are
21995 data structures which control how virtual memory addresses are mapped
21996 into physical addresses.  A Page Table includes an entry for every
21997 page of memory that is mapped into the program's address space; there
21998 may be several Page Tables, each one holding up to 4096 entries.  A
21999 Page Directory has up to 4096 entries, one each for every Page Table
22000 that is currently in use.
22001
22002 Without an argument, @kbd{info dos pde} displays the entire Page
22003 Directory, and @kbd{info dos pte} displays all the entries in all of
22004 the Page Tables.  An argument, an integer expression, given to the
22005 @kbd{info dos pde} command means display only that entry from the Page
22006 Directory table.  An argument given to the @kbd{info dos pte} command
22007 means display entries from a single Page Table, the one pointed to by
22008 the specified entry in the Page Directory.
22009
22010 @cindex direct memory access (DMA) on MS-DOS
22011 These commands are useful when your program uses @dfn{DMA} (Direct
22012 Memory Access), which needs physical addresses to program the DMA
22013 controller.
22014
22015 These commands are supported only with some DPMI servers.
22016
22017 @cindex physical address from linear address
22018 @item info dos address-pte @var{addr}
22019 This command displays the Page Table entry for a specified linear
22020 address.  The argument @var{addr} is a linear address which should
22021 already have the appropriate segment's base address added to it,
22022 because this command accepts addresses which may belong to @emph{any}
22023 segment.  For example, here's how to display the Page Table entry for
22024 the page where a variable @code{i} is stored:
22025
22026 @smallexample
22027 @exdent @code{(@value{GDBP}) info dos address-pte __djgpp_base_address + (char *)&i}
22028 @exdent @code{Page Table entry for address 0x11a00d30:}
22029 @exdent @code{Base=0x02698000 Dirty Acc. Not-Cached Write-Back Usr Read-Write +0xd30}
22030 @end smallexample
22031
22032 @noindent
22033 This says that @code{i} is stored at offset @code{0xd30} from the page
22034 whose physical base address is @code{0x02698000}, and shows all the
22035 attributes of that page.
22036
22037 Note that you must cast the addresses of variables to a @code{char *},
22038 since otherwise the value of @code{__djgpp_base_address}, the base
22039 address of all variables and functions in a @sc{djgpp} program, will
22040 be added using the rules of C pointer arithmetics: if @code{i} is
22041 declared an @code{int}, @value{GDBN} will add 4 times the value of
22042 @code{__djgpp_base_address} to the address of @code{i}.
22043
22044 Here's another example, it displays the Page Table entry for the
22045 transfer buffer:
22046
22047 @smallexample
22048 @exdent @code{(@value{GDBP}) info dos address-pte *((unsigned *)&_go32_info_block + 3)}
22049 @exdent @code{Page Table entry for address 0x29110:}
22050 @exdent @code{Base=0x00029000 Dirty Acc. Not-Cached Write-Back Usr Read-Write +0x110}
22051 @end smallexample
22052
22053 @noindent
22054 (The @code{+ 3} offset is because the transfer buffer's address is the
22055 3rd member of the @code{_go32_info_block} structure.)  The output
22056 clearly shows that this DPMI server maps the addresses in conventional
22057 memory 1:1, i.e.@: the physical (@code{0x00029000} + @code{0x110}) and
22058 linear (@code{0x29110}) addresses are identical.
22059
22060 This command is supported only with some DPMI servers.
22061 @end table
22062
22063 @cindex DOS serial data link, remote debugging
22064 In addition to native debugging, the DJGPP port supports remote
22065 debugging via a serial data link.  The following commands are specific
22066 to remote serial debugging in the DJGPP port of @value{GDBN}.
22067
22068 @table @code
22069 @kindex set com1base
22070 @kindex set com1irq
22071 @kindex set com2base
22072 @kindex set com2irq
22073 @kindex set com3base
22074 @kindex set com3irq
22075 @kindex set com4base
22076 @kindex set com4irq
22077 @item set com1base @var{addr}
22078 This command sets the base I/O port address of the @file{COM1} serial
22079 port.
22080
22081 @item set com1irq @var{irq}
22082 This command sets the @dfn{Interrupt Request} (@code{IRQ}) line to use
22083 for the @file{COM1} serial port.
22084
22085 There are similar commands @samp{set com2base}, @samp{set com3irq},
22086 etc.@: for setting the port address and the @code{IRQ} lines for the
22087 other 3 COM ports.
22088
22089 @kindex show com1base
22090 @kindex show com1irq
22091 @kindex show com2base
22092 @kindex show com2irq
22093 @kindex show com3base
22094 @kindex show com3irq
22095 @kindex show com4base
22096 @kindex show com4irq
22097 The related commands @samp{show com1base}, @samp{show com1irq} etc.@:
22098 display the current settings of the base address and the @code{IRQ}
22099 lines used by the COM ports.
22100
22101 @item info serial
22102 @kindex info serial
22103 @cindex DOS serial port status
22104 This command prints the status of the 4 DOS serial ports.  For each
22105 port, it prints whether it's active or not, its I/O base address and
22106 IRQ number, whether it uses a 16550-style FIFO, its baudrate, and the
22107 counts of various errors encountered so far.
22108 @end table
22109
22110
22111 @node Cygwin Native
22112 @subsection Features for Debugging MS Windows PE Executables
22113 @cindex MS Windows debugging
22114 @cindex native Cygwin debugging
22115 @cindex Cygwin-specific commands
22116
22117 @value{GDBN} supports native debugging of MS Windows programs, including
22118 DLLs with and without symbolic debugging information.
22119
22120 @cindex Ctrl-BREAK, MS-Windows
22121 @cindex interrupt debuggee on MS-Windows
22122 MS-Windows programs that call @code{SetConsoleMode} to switch off the
22123 special meaning of the @samp{Ctrl-C} keystroke cannot be interrupted
22124 by typing @kbd{C-c}.  For this reason, @value{GDBN} on MS-Windows
22125 supports @kbd{C-@key{BREAK}} as an alternative interrupt key
22126 sequence, which can be used to interrupt the debuggee even if it
22127 ignores @kbd{C-c}.
22128
22129 There are various additional Cygwin-specific commands, described in
22130 this section.  Working with DLLs that have no debugging symbols is
22131 described in @ref{Non-debug DLL Symbols}.
22132
22133 @table @code
22134 @kindex info w32
22135 @item info w32
22136 This is a prefix of MS Windows-specific commands which print
22137 information about the target system and important OS structures.
22138
22139 @item info w32 selector
22140 This command displays information returned by
22141 the Win32 API @code{GetThreadSelectorEntry} function.
22142 It takes an optional argument that is evaluated to
22143 a long value to give the information about this given selector.
22144 Without argument, this command displays information
22145 about the six segment registers.
22146
22147 @item info w32 thread-information-block
22148 This command displays thread specific information stored in the
22149 Thread Information Block (readable on the X86 CPU family using @code{$fs}
22150 selector for 32-bit programs and @code{$gs} for 64-bit programs).
22151
22152 @kindex signal-event
22153 @item signal-event @var{id}
22154 This command signals an event with user-provided @var{id}.  Used to resume
22155 crashing process when attached to it using MS-Windows JIT debugging (AeDebug).
22156
22157 To use it, create or edit the following keys in
22158 @code{HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\AeDebug} and/or
22159 @code{HKLM\SOFTWARE\Wow6432Node\Microsoft\Windows NT\CurrentVersion\AeDebug}
22160 (for x86_64 versions):
22161
22162 @itemize @minus
22163 @item
22164 @code{Debugger} (REG_SZ) --- a command to launch the debugger.
22165 Suggested command is: @code{@var{fully-qualified-path-to-gdb.exe} -ex
22166 "attach %ld" -ex "signal-event %ld" -ex "continue"}.
22167
22168 The first @code{%ld} will be replaced by the process ID of the
22169 crashing process, the second @code{%ld} will be replaced by the ID of
22170 the event that blocks the crashing process, waiting for @value{GDBN}
22171 to attach.
22172
22173 @item
22174 @code{Auto} (REG_SZ) --- either @code{1} or @code{0}.  @code{1} will
22175 make the system run debugger specified by the Debugger key
22176 automatically, @code{0} will cause a dialog box with ``OK'' and
22177 ``Cancel'' buttons to appear, which allows the user to either
22178 terminate the crashing process (OK) or debug it (Cancel).
22179 @end itemize
22180
22181 @kindex set cygwin-exceptions
22182 @cindex debugging the Cygwin DLL
22183 @cindex Cygwin DLL, debugging
22184 @item set cygwin-exceptions @var{mode}
22185 If @var{mode} is @code{on}, @value{GDBN} will break on exceptions that
22186 happen inside the Cygwin DLL.  If @var{mode} is @code{off},
22187 @value{GDBN} will delay recognition of exceptions, and may ignore some
22188 exceptions which seem to be caused by internal Cygwin DLL
22189 ``bookkeeping''.  This option is meant primarily for debugging the
22190 Cygwin DLL itself; the default value is @code{off} to avoid annoying
22191 @value{GDBN} users with false @code{SIGSEGV} signals.
22192
22193 @kindex show cygwin-exceptions
22194 @item show cygwin-exceptions
22195 Displays whether @value{GDBN} will break on exceptions that happen
22196 inside the Cygwin DLL itself.
22197
22198 @kindex set new-console
22199 @item set new-console @var{mode}
22200 If @var{mode} is @code{on} the debuggee will
22201 be started in a new console on next start.
22202 If @var{mode} is @code{off}, the debuggee will
22203 be started in the same console as the debugger.
22204
22205 @kindex show new-console
22206 @item show new-console
22207 Displays whether a new console is used
22208 when the debuggee is started.
22209
22210 @kindex set new-group
22211 @item set new-group @var{mode}
22212 This boolean value controls whether the debuggee should
22213 start a new group or stay in the same group as the debugger.
22214 This affects the way the Windows OS handles
22215 @samp{Ctrl-C}.
22216
22217 @kindex show new-group
22218 @item show new-group
22219 Displays current value of new-group boolean.
22220
22221 @kindex set debugevents
22222 @item set debugevents
22223 This boolean value adds debug output concerning kernel events related
22224 to the debuggee seen by the debugger.  This includes events that
22225 signal thread and process creation and exit, DLL loading and
22226 unloading, console interrupts, and debugging messages produced by the
22227 Windows @code{OutputDebugString} API call.
22228
22229 @kindex set debugexec
22230 @item set debugexec
22231 This boolean value adds debug output concerning execute events
22232 (such as resume thread) seen by the debugger.
22233
22234 @kindex set debugexceptions
22235 @item set debugexceptions
22236 This boolean value adds debug output concerning exceptions in the
22237 debuggee seen by the debugger.
22238
22239 @kindex set debugmemory
22240 @item set debugmemory
22241 This boolean value adds debug output concerning debuggee memory reads
22242 and writes by the debugger.
22243
22244 @kindex set shell
22245 @item set shell
22246 This boolean values specifies whether the debuggee is called
22247 via a shell or directly (default value is on).
22248
22249 @kindex show shell
22250 @item show shell
22251 Displays if the debuggee will be started with a shell.
22252
22253 @end table
22254
22255 @menu
22256 * Non-debug DLL Symbols::  Support for DLLs without debugging symbols
22257 @end menu
22258
22259 @node Non-debug DLL Symbols
22260 @subsubsection Support for DLLs without Debugging Symbols
22261 @cindex DLLs with no debugging symbols
22262 @cindex Minimal symbols and DLLs
22263
22264 Very often on windows, some of the DLLs that your program relies on do
22265 not include symbolic debugging information (for example,
22266 @file{kernel32.dll}).  When @value{GDBN} doesn't recognize any debugging
22267 symbols in a DLL, it relies on the minimal amount of symbolic
22268 information contained in the DLL's export table.  This section
22269 describes working with such symbols, known internally to @value{GDBN} as
22270 ``minimal symbols''.
22271
22272 Note that before the debugged program has started execution, no DLLs
22273 will have been loaded.  The easiest way around this problem is simply to
22274 start the program --- either by setting a breakpoint or letting the
22275 program run once to completion.
22276
22277 @subsubsection DLL Name Prefixes
22278
22279 In keeping with the naming conventions used by the Microsoft debugging
22280 tools, DLL export symbols are made available with a prefix based on the
22281 DLL name, for instance @code{KERNEL32!CreateFileA}.  The plain name is
22282 also entered into the symbol table, so @code{CreateFileA} is often
22283 sufficient.  In some cases there will be name clashes within a program
22284 (particularly if the executable itself includes full debugging symbols)
22285 necessitating the use of the fully qualified name when referring to the
22286 contents of the DLL.  Use single-quotes around the name to avoid the
22287 exclamation mark (``!'')  being interpreted as a language operator.
22288
22289 Note that the internal name of the DLL may be all upper-case, even
22290 though the file name of the DLL is lower-case, or vice-versa.  Since
22291 symbols within @value{GDBN} are @emph{case-sensitive} this may cause
22292 some confusion. If in doubt, try the @code{info functions} and
22293 @code{info variables} commands or even @code{maint print msymbols}
22294 (@pxref{Symbols}). Here's an example:
22295
22296 @smallexample
22297 (@value{GDBP}) info function CreateFileA
22298 All functions matching regular expression "CreateFileA":
22299
22300 Non-debugging symbols:
22301 0x77e885f4  CreateFileA
22302 0x77e885f4  KERNEL32!CreateFileA
22303 @end smallexample
22304
22305 @smallexample
22306 (@value{GDBP}) info function !
22307 All functions matching regular expression "!":
22308
22309 Non-debugging symbols:
22310 0x6100114c  cygwin1!__assert
22311 0x61004034  cygwin1!_dll_crt0@@0
22312 0x61004240  cygwin1!dll_crt0(per_process *)
22313 [etc...]
22314 @end smallexample
22315
22316 @subsubsection Working with Minimal Symbols
22317
22318 Symbols extracted from a DLL's export table do not contain very much
22319 type information. All that @value{GDBN} can do is guess whether a symbol
22320 refers to a function or variable depending on the linker section that
22321 contains the symbol. Also note that the actual contents of the memory
22322 contained in a DLL are not available unless the program is running. This
22323 means that you cannot examine the contents of a variable or disassemble
22324 a function within a DLL without a running program.
22325
22326 Variables are generally treated as pointers and dereferenced
22327 automatically. For this reason, it is often necessary to prefix a
22328 variable name with the address-of operator (``&'') and provide explicit
22329 type information in the command. Here's an example of the type of
22330 problem:
22331
22332 @smallexample
22333 (@value{GDBP}) print 'cygwin1!__argv'
22334 'cygwin1!__argv' has unknown type; cast it to its declared type
22335 @end smallexample
22336
22337 @smallexample
22338 (@value{GDBP}) x 'cygwin1!__argv'
22339 'cygwin1!__argv' has unknown type; cast it to its declared type
22340 @end smallexample
22341
22342 And two possible solutions:
22343
22344 @smallexample
22345 (@value{GDBP}) print ((char **)'cygwin1!__argv')[0]
22346 $2 = 0x22fd98 "/cygdrive/c/mydirectory/myprogram"
22347 @end smallexample
22348
22349 @smallexample
22350 (@value{GDBP}) x/2x &'cygwin1!__argv'
22351 0x610c0aa8 <cygwin1!__argv>:    0x10021608      0x00000000
22352 (@value{GDBP}) x/x 0x10021608
22353 0x10021608:     0x0022fd98
22354 (@value{GDBP}) x/s 0x0022fd98
22355 0x22fd98:        "/cygdrive/c/mydirectory/myprogram"
22356 @end smallexample
22357
22358 Setting a break point within a DLL is possible even before the program
22359 starts execution. However, under these circumstances, @value{GDBN} can't
22360 examine the initial instructions of the function in order to skip the
22361 function's frame set-up code. You can work around this by using ``*&''
22362 to set the breakpoint at a raw memory address:
22363
22364 @smallexample
22365 (@value{GDBP}) break *&'python22!PyOS_Readline'
22366 Breakpoint 1 at 0x1e04eff0
22367 @end smallexample
22368
22369 The author of these extensions is not entirely convinced that setting a
22370 break point within a shared DLL like @file{kernel32.dll} is completely
22371 safe.
22372
22373 @node Hurd Native
22374 @subsection Commands Specific to @sc{gnu} Hurd Systems
22375 @cindex @sc{gnu} Hurd debugging
22376
22377 This subsection describes @value{GDBN} commands specific to the
22378 @sc{gnu} Hurd native debugging.
22379
22380 @table @code
22381 @item set signals
22382 @itemx set sigs
22383 @kindex set signals@r{, Hurd command}
22384 @kindex set sigs@r{, Hurd command}
22385 This command toggles the state of inferior signal interception by
22386 @value{GDBN}.  Mach exceptions, such as breakpoint traps, are not
22387 affected by this command.  @code{sigs} is a shorthand alias for
22388 @code{signals}.
22389
22390 @item show signals
22391 @itemx show sigs
22392 @kindex show signals@r{, Hurd command}
22393 @kindex show sigs@r{, Hurd command}
22394 Show the current state of intercepting inferior's signals.
22395
22396 @item set signal-thread
22397 @itemx set sigthread
22398 @kindex set signal-thread
22399 @kindex set sigthread
22400 This command tells @value{GDBN} which thread is the @code{libc} signal
22401 thread.  That thread is run when a signal is delivered to a running
22402 process.  @code{set sigthread} is the shorthand alias of @code{set
22403 signal-thread}.
22404
22405 @item show signal-thread
22406 @itemx show sigthread
22407 @kindex show signal-thread
22408 @kindex show sigthread
22409 These two commands show which thread will run when the inferior is
22410 delivered a signal.
22411
22412 @item set stopped
22413 @kindex set stopped@r{, Hurd command}
22414 This commands tells @value{GDBN} that the inferior process is stopped,
22415 as with the @code{SIGSTOP} signal.  The stopped process can be
22416 continued by delivering a signal to it.
22417
22418 @item show stopped
22419 @kindex show stopped@r{, Hurd command}
22420 This command shows whether @value{GDBN} thinks the debuggee is
22421 stopped.
22422
22423 @item set exceptions
22424 @kindex set exceptions@r{, Hurd command}
22425 Use this command to turn off trapping of exceptions in the inferior.
22426 When exception trapping is off, neither breakpoints nor
22427 single-stepping will work.  To restore the default, set exception
22428 trapping on.
22429
22430 @item show exceptions
22431 @kindex show exceptions@r{, Hurd command}
22432 Show the current state of trapping exceptions in the inferior.
22433
22434 @item set task pause
22435 @kindex set task@r{, Hurd commands}
22436 @cindex task attributes (@sc{gnu} Hurd)
22437 @cindex pause current task (@sc{gnu} Hurd)
22438 This command toggles task suspension when @value{GDBN} has control.
22439 Setting it to on takes effect immediately, and the task is suspended
22440 whenever @value{GDBN} gets control.  Setting it to off will take
22441 effect the next time the inferior is continued.  If this option is set
22442 to off, you can use @code{set thread default pause on} or @code{set
22443 thread pause on} (see below) to pause individual threads.
22444
22445 @item show task pause
22446 @kindex show task@r{, Hurd commands}
22447 Show the current state of task suspension.
22448
22449 @item set task detach-suspend-count
22450 @cindex task suspend count
22451 @cindex detach from task, @sc{gnu} Hurd
22452 This command sets the suspend count the task will be left with when
22453 @value{GDBN} detaches from it.
22454
22455 @item show task detach-suspend-count
22456 Show the suspend count the task will be left with when detaching.
22457
22458 @item set task exception-port
22459 @itemx set task excp
22460 @cindex task exception port, @sc{gnu} Hurd
22461 This command sets the task exception port to which @value{GDBN} will
22462 forward exceptions.  The argument should be the value of the @dfn{send
22463 rights} of the task.  @code{set task excp} is a shorthand alias.
22464
22465 @item set noninvasive
22466 @cindex noninvasive task options
22467 This command switches @value{GDBN} to a mode that is the least
22468 invasive as far as interfering with the inferior is concerned.  This
22469 is the same as using @code{set task pause}, @code{set exceptions}, and
22470 @code{set signals} to values opposite to the defaults.
22471
22472 @item info send-rights
22473 @itemx info receive-rights
22474 @itemx info port-rights
22475 @itemx info port-sets
22476 @itemx info dead-names
22477 @itemx info ports
22478 @itemx info psets
22479 @cindex send rights, @sc{gnu} Hurd
22480 @cindex receive rights, @sc{gnu} Hurd
22481 @cindex port rights, @sc{gnu} Hurd
22482 @cindex port sets, @sc{gnu} Hurd
22483 @cindex dead names, @sc{gnu} Hurd
22484 These commands display information about, respectively, send rights,
22485 receive rights, port rights, port sets, and dead names of a task.
22486 There are also shorthand aliases: @code{info ports} for @code{info
22487 port-rights} and @code{info psets} for @code{info port-sets}.
22488
22489 @item set thread pause
22490 @kindex set thread@r{, Hurd command}
22491 @cindex thread properties, @sc{gnu} Hurd
22492 @cindex pause current thread (@sc{gnu} Hurd)
22493 This command toggles current thread suspension when @value{GDBN} has
22494 control.  Setting it to on takes effect immediately, and the current
22495 thread is suspended whenever @value{GDBN} gets control.  Setting it to
22496 off will take effect the next time the inferior is continued.
22497 Normally, this command has no effect, since when @value{GDBN} has
22498 control, the whole task is suspended.  However, if you used @code{set
22499 task pause off} (see above), this command comes in handy to suspend
22500 only the current thread.
22501
22502 @item show thread pause
22503 @kindex show thread@r{, Hurd command}
22504 This command shows the state of current thread suspension.
22505
22506 @item set thread run
22507 This command sets whether the current thread is allowed to run.
22508
22509 @item show thread run
22510 Show whether the current thread is allowed to run.
22511
22512 @item set thread detach-suspend-count
22513 @cindex thread suspend count, @sc{gnu} Hurd
22514 @cindex detach from thread, @sc{gnu} Hurd
22515 This command sets the suspend count @value{GDBN} will leave on a
22516 thread when detaching.  This number is relative to the suspend count
22517 found by @value{GDBN} when it notices the thread; use @code{set thread
22518 takeover-suspend-count} to force it to an absolute value.
22519
22520 @item show thread detach-suspend-count
22521 Show the suspend count @value{GDBN} will leave on the thread when
22522 detaching.
22523
22524 @item set thread exception-port
22525 @itemx set thread excp
22526 Set the thread exception port to which to forward exceptions.  This
22527 overrides the port set by @code{set task exception-port} (see above).
22528 @code{set thread excp} is the shorthand alias.
22529
22530 @item set thread takeover-suspend-count
22531 Normally, @value{GDBN}'s thread suspend counts are relative to the
22532 value @value{GDBN} finds when it notices each thread.  This command
22533 changes the suspend counts to be absolute instead.
22534
22535 @item set thread default
22536 @itemx show thread default
22537 @cindex thread default settings, @sc{gnu} Hurd
22538 Each of the above @code{set thread} commands has a @code{set thread
22539 default} counterpart (e.g., @code{set thread default pause}, @code{set
22540 thread default exception-port}, etc.).  The @code{thread default}
22541 variety of commands sets the default thread properties for all
22542 threads; you can then change the properties of individual threads with
22543 the non-default commands.
22544 @end table
22545
22546 @node Darwin
22547 @subsection Darwin
22548 @cindex Darwin
22549
22550 @value{GDBN} provides the following commands specific to the Darwin target:
22551
22552 @table @code
22553 @item set debug darwin @var{num}
22554 @kindex set debug darwin
22555 When set to a non zero value, enables debugging messages specific to
22556 the Darwin support.  Higher values produce more verbose output.
22557
22558 @item show debug darwin
22559 @kindex show debug darwin
22560 Show the current state of Darwin messages.
22561
22562 @item set debug mach-o @var{num}
22563 @kindex set debug mach-o
22564 When set to a non zero value, enables debugging messages while
22565 @value{GDBN} is reading Darwin object files.  (@dfn{Mach-O} is the
22566 file format used on Darwin for object and executable files.)  Higher
22567 values produce more verbose output.  This is a command to diagnose
22568 problems internal to @value{GDBN} and should not be needed in normal
22569 usage.
22570
22571 @item show debug mach-o
22572 @kindex show debug mach-o
22573 Show the current state of Mach-O file messages.
22574
22575 @item set mach-exceptions on
22576 @itemx set mach-exceptions off
22577 @kindex set mach-exceptions
22578 On Darwin, faults are first reported as a Mach exception and are then
22579 mapped to a Posix signal.  Use this command to turn on trapping of
22580 Mach exceptions in the inferior.  This might be sometimes useful to
22581 better understand the cause of a fault.  The default is off.
22582
22583 @item show mach-exceptions
22584 @kindex show mach-exceptions
22585 Show the current state of exceptions trapping.
22586 @end table
22587
22588
22589 @node Embedded OS
22590 @section Embedded Operating Systems
22591
22592 This section describes configurations involving the debugging of
22593 embedded operating systems that are available for several different
22594 architectures.
22595
22596 @value{GDBN} includes the ability to debug programs running on
22597 various real-time operating systems.
22598
22599 @node Embedded Processors
22600 @section Embedded Processors
22601
22602 This section goes into details specific to particular embedded
22603 configurations.
22604
22605 @cindex send command to simulator
22606 Whenever a specific embedded processor has a simulator, @value{GDBN}
22607 allows to send an arbitrary command to the simulator.
22608
22609 @table @code
22610 @item sim @var{command}
22611 @kindex sim@r{, a command}
22612 Send an arbitrary @var{command} string to the simulator.  Consult the
22613 documentation for the specific simulator in use for information about
22614 acceptable commands.
22615 @end table
22616
22617
22618 @menu
22619 * ARC::                         Synopsys ARC
22620 * ARM::                         ARM
22621 * M68K::                        Motorola M68K
22622 * MicroBlaze::                  Xilinx MicroBlaze
22623 * MIPS Embedded::               MIPS Embedded
22624 * OpenRISC 1000::               OpenRISC 1000 (or1k)
22625 * PowerPC Embedded::            PowerPC Embedded
22626 * AVR::                         Atmel AVR
22627 * CRIS::                        CRIS
22628 * Super-H::                     Renesas Super-H
22629 @end menu
22630
22631 @node ARC
22632 @subsection Synopsys ARC
22633 @cindex Synopsys ARC
22634 @cindex ARC specific commands
22635 @cindex ARC600
22636 @cindex ARC700
22637 @cindex ARC EM
22638 @cindex ARC HS
22639
22640 @value{GDBN} provides the following ARC-specific commands:
22641
22642 @table @code
22643 @item set debug arc
22644 @kindex set debug arc
22645 Control the level of ARC specific debug messages.  Use 0 for no messages (the
22646 default), 1 for debug messages, and 2 for even more debug messages.
22647
22648 @item show debug arc
22649 @kindex show debug arc
22650 Show the level of ARC specific debugging in operation.
22651
22652 @item maint print arc arc-instruction @var{address}
22653 @kindex maint print arc arc-instruction
22654 Print internal disassembler information about instruction at a given address.
22655
22656 @end table
22657
22658 @node ARM
22659 @subsection ARM
22660
22661 @value{GDBN} provides the following ARM-specific commands:
22662
22663 @table @code
22664 @item set arm disassembler
22665 @kindex set arm
22666 This commands selects from a list of disassembly styles.  The
22667 @code{"std"} style is the standard style.
22668
22669 @item show arm disassembler
22670 @kindex show arm
22671 Show the current disassembly style.
22672
22673 @item set arm apcs32
22674 @cindex ARM 32-bit mode
22675 This command toggles ARM operation mode between 32-bit and 26-bit.
22676
22677 @item show arm apcs32
22678 Display the current usage of the ARM 32-bit mode.
22679
22680 @item set arm fpu @var{fputype}
22681 This command sets the ARM floating-point unit (FPU) type.  The
22682 argument @var{fputype} can be one of these:
22683
22684 @table @code
22685 @item auto
22686 Determine the FPU type by querying the OS ABI.
22687 @item softfpa
22688 Software FPU, with mixed-endian doubles on little-endian ARM
22689 processors.
22690 @item fpa
22691 GCC-compiled FPA co-processor.
22692 @item softvfp
22693 Software FPU with pure-endian doubles.
22694 @item vfp
22695 VFP co-processor.
22696 @end table
22697
22698 @item show arm fpu
22699 Show the current type of the FPU.
22700
22701 @item set arm abi
22702 This command forces @value{GDBN} to use the specified ABI.
22703
22704 @item show arm abi
22705 Show the currently used ABI.
22706
22707 @item set arm fallback-mode (arm|thumb|auto)
22708 @value{GDBN} uses the symbol table, when available, to determine
22709 whether instructions are ARM or Thumb.  This command controls
22710 @value{GDBN}'s default behavior when the symbol table is not
22711 available.  The default is @samp{auto}, which causes @value{GDBN} to
22712 use the current execution mode (from the @code{T} bit in the @code{CPSR}
22713 register).
22714
22715 @item show arm fallback-mode
22716 Show the current fallback instruction mode.
22717
22718 @item set arm force-mode (arm|thumb|auto)
22719 This command overrides use of the symbol table to determine whether
22720 instructions are ARM or Thumb.  The default is @samp{auto}, which
22721 causes @value{GDBN} to use the symbol table and then the setting
22722 of @samp{set arm fallback-mode}.
22723
22724 @item show arm force-mode
22725 Show the current forced instruction mode.
22726
22727 @item set debug arm
22728 Toggle whether to display ARM-specific debugging messages from the ARM
22729 target support subsystem.
22730
22731 @item show debug arm
22732 Show whether ARM-specific debugging messages are enabled.
22733 @end table
22734
22735 @table @code
22736 @item target sim @r{[}@var{simargs}@r{]} @dots{} 
22737 The @value{GDBN} ARM simulator accepts the following optional arguments.
22738
22739 @table @code
22740 @item --swi-support=@var{type}
22741 Tell the simulator which SWI interfaces to support.  The argument
22742 @var{type} may be a comma separated list of the following values.
22743 The default value is @code{all}.
22744
22745 @table @code
22746 @item none
22747 @item demon
22748 @item angel
22749 @item redboot
22750 @item all
22751 @end table
22752 @end table
22753 @end table
22754
22755 @node M68K
22756 @subsection M68k
22757
22758 The Motorola m68k configuration includes ColdFire support.
22759
22760 @node MicroBlaze
22761 @subsection MicroBlaze
22762 @cindex Xilinx MicroBlaze
22763 @cindex XMD, Xilinx Microprocessor Debugger
22764
22765 The MicroBlaze is a soft-core processor supported on various Xilinx
22766 FPGAs, such as Spartan or Virtex series.  Boards with these processors
22767 usually have JTAG ports which connect to a host system running the Xilinx
22768 Embedded Development Kit (EDK) or Software Development Kit (SDK).
22769 This host system is used to download the configuration bitstream to
22770 the target FPGA.  The Xilinx Microprocessor Debugger (XMD) program
22771 communicates with the target board using the JTAG interface and
22772 presents a @code{gdbserver} interface to the board.  By default
22773 @code{xmd} uses port @code{1234}.  (While it is possible to change 
22774 this default port, it requires the use of undocumented @code{xmd} 
22775 commands.  Contact Xilinx support if you need to do this.)
22776
22777 Use these GDB commands to connect to the MicroBlaze target processor.
22778
22779 @table @code
22780 @item target remote :1234
22781 Use this command to connect to the target if you are running @value{GDBN}
22782 on the same system as @code{xmd}.
22783
22784 @item target remote @var{xmd-host}:1234
22785 Use this command to connect to the target if it is connected to @code{xmd}
22786 running on a different system named @var{xmd-host}.
22787
22788 @item load
22789 Use this command to download a program to the MicroBlaze target.
22790
22791 @item set debug microblaze @var{n}
22792 Enable MicroBlaze-specific debugging messages if non-zero.
22793
22794 @item show debug microblaze @var{n}
22795 Show MicroBlaze-specific debugging level.
22796 @end table
22797
22798 @node MIPS Embedded
22799 @subsection @acronym{MIPS} Embedded
22800
22801 @noindent
22802 @value{GDBN} supports these special commands for @acronym{MIPS} targets:
22803
22804 @table @code
22805 @item set mipsfpu double
22806 @itemx set mipsfpu single
22807 @itemx set mipsfpu none
22808 @itemx set mipsfpu auto
22809 @itemx show mipsfpu
22810 @kindex set mipsfpu
22811 @kindex show mipsfpu
22812 @cindex @acronym{MIPS} remote floating point
22813 @cindex floating point, @acronym{MIPS} remote
22814 If your target board does not support the @acronym{MIPS} floating point
22815 coprocessor, you should use the command @samp{set mipsfpu none} (if you
22816 need this, you may wish to put the command in your @value{GDBN} init
22817 file).  This tells @value{GDBN} how to find the return value of
22818 functions which return floating point values.  It also allows
22819 @value{GDBN} to avoid saving the floating point registers when calling
22820 functions on the board.  If you are using a floating point coprocessor
22821 with only single precision floating point support, as on the @sc{r4650}
22822 processor, use the command @samp{set mipsfpu single}.  The default
22823 double precision floating point coprocessor may be selected using
22824 @samp{set mipsfpu double}.
22825
22826 In previous versions the only choices were double precision or no
22827 floating point, so @samp{set mipsfpu on} will select double precision
22828 and @samp{set mipsfpu off} will select no floating point.
22829
22830 As usual, you can inquire about the @code{mipsfpu} variable with
22831 @samp{show mipsfpu}.
22832 @end table
22833
22834 @node OpenRISC 1000
22835 @subsection OpenRISC 1000
22836 @cindex OpenRISC 1000
22837
22838 @noindent
22839 The OpenRISC 1000 provides a free RISC instruction set architecture.  It is
22840 mainly provided as a soft-core which can run on Xilinx, Altera and other
22841 FPGA's.
22842
22843 @value{GDBN} for OpenRISC supports the below commands when connecting to
22844 a target:
22845
22846 @table @code
22847
22848 @kindex target sim
22849 @item target sim
22850
22851 Runs the builtin CPU simulator which can run very basic
22852 programs but does not support most hardware functions like MMU.
22853 For more complex use cases the user is advised to run an external
22854 target, and connect using @samp{target remote}.
22855
22856 Example: @code{target sim}
22857
22858 @item set debug or1k
22859 Toggle whether to display OpenRISC-specific debugging messages from the
22860 OpenRISC target support subsystem.
22861
22862 @item show debug or1k
22863 Show whether OpenRISC-specific debugging messages are enabled.
22864 @end table
22865
22866 @node PowerPC Embedded
22867 @subsection PowerPC Embedded
22868
22869 @cindex DVC register
22870 @value{GDBN} supports using the DVC (Data Value Compare) register to
22871 implement in hardware simple hardware watchpoint conditions of the form:
22872
22873 @smallexample
22874 (@value{GDBP}) watch @var{ADDRESS|VARIABLE} \
22875   if  @var{ADDRESS|VARIABLE} == @var{CONSTANT EXPRESSION}
22876 @end smallexample
22877
22878 The DVC register will be automatically used when @value{GDBN} detects
22879 such pattern in a condition expression, and the created watchpoint uses one
22880 debug register (either the @code{exact-watchpoints} option is on and the
22881 variable is scalar, or the variable has a length of one byte).  This feature
22882 is available in native @value{GDBN} running on a Linux kernel version 2.6.34
22883 or newer.
22884
22885 When running on PowerPC embedded processors, @value{GDBN} automatically uses
22886 ranged hardware watchpoints, unless the @code{exact-watchpoints} option is on,
22887 in which case watchpoints using only one debug register are created when
22888 watching variables of scalar types.
22889
22890 You can create an artificial array to watch an arbitrary memory
22891 region using one of the following commands (@pxref{Expressions}):
22892
22893 @smallexample
22894 (@value{GDBP}) watch *((char *) @var{address})@@@var{length}
22895 (@value{GDBP}) watch @{char[@var{length}]@} @var{address}
22896 @end smallexample
22897
22898 PowerPC embedded processors support masked watchpoints.  See the discussion
22899 about the @code{mask} argument in @ref{Set Watchpoints}.
22900
22901 @cindex ranged breakpoint
22902 PowerPC embedded processors support hardware accelerated
22903 @dfn{ranged breakpoints}.  A ranged breakpoint stops execution of
22904 the inferior whenever it executes an instruction at any address within
22905 the range it specifies.  To set a ranged breakpoint in @value{GDBN},
22906 use the @code{break-range} command.
22907
22908 @value{GDBN} provides the following PowerPC-specific commands:
22909
22910 @table @code
22911 @kindex break-range
22912 @item break-range @var{start-location}, @var{end-location}
22913 Set a breakpoint for an address range given by
22914 @var{start-location} and @var{end-location}, which can specify a function name,
22915 a line number, an offset of lines from the current line or from the start
22916 location, or an address of an instruction (see @ref{Specify Location},
22917 for a list of all the possible ways to specify a @var{location}.)
22918 The breakpoint will stop execution of the inferior whenever it
22919 executes an instruction at any address within the specified range,
22920 (including @var{start-location} and @var{end-location}.)
22921
22922 @kindex set powerpc
22923 @item set powerpc soft-float
22924 @itemx show powerpc soft-float
22925 Force @value{GDBN} to use (or not use) a software floating point calling
22926 convention.  By default, @value{GDBN} selects the calling convention based
22927 on the selected architecture and the provided executable file.
22928
22929 @item set powerpc vector-abi
22930 @itemx show powerpc vector-abi
22931 Force @value{GDBN} to use the specified calling convention for vector
22932 arguments and return values.  The valid options are @samp{auto};
22933 @samp{generic}, to avoid vector registers even if they are present;
22934 @samp{altivec}, to use AltiVec registers; and @samp{spe} to use SPE
22935 registers.  By default, @value{GDBN} selects the calling convention
22936 based on the selected architecture and the provided executable file.
22937
22938 @item set powerpc exact-watchpoints
22939 @itemx show powerpc exact-watchpoints
22940 Allow @value{GDBN} to use only one debug register when watching a variable
22941 of scalar type, thus assuming that the variable is accessed through the
22942 address of its first byte.
22943
22944 @end table
22945
22946 @node AVR
22947 @subsection Atmel AVR
22948 @cindex AVR
22949
22950 When configured for debugging the Atmel AVR, @value{GDBN} supports the
22951 following AVR-specific commands:
22952
22953 @table @code
22954 @item info io_registers
22955 @kindex info io_registers@r{, AVR}
22956 @cindex I/O registers (Atmel AVR)
22957 This command displays information about the AVR I/O registers.  For
22958 each register, @value{GDBN} prints its number and value.
22959 @end table
22960
22961 @node CRIS
22962 @subsection CRIS
22963 @cindex CRIS
22964
22965 When configured for debugging CRIS, @value{GDBN} provides the
22966 following CRIS-specific commands:
22967
22968 @table @code
22969 @item set cris-version @var{ver}
22970 @cindex CRIS version
22971 Set the current CRIS version to @var{ver}, either @samp{10} or @samp{32}.
22972 The CRIS version affects register names and sizes.  This command is useful in
22973 case autodetection of the CRIS version fails.
22974
22975 @item show cris-version
22976 Show the current CRIS version.
22977
22978 @item set cris-dwarf2-cfi
22979 @cindex DWARF-2 CFI and CRIS
22980 Set the usage of DWARF-2 CFI for CRIS debugging.  The default is @samp{on}.
22981 Change to @samp{off} when using @code{gcc-cris} whose version is below 
22982 @code{R59}.
22983
22984 @item show cris-dwarf2-cfi
22985 Show the current state of using DWARF-2 CFI.
22986
22987 @item set cris-mode @var{mode}
22988 @cindex CRIS mode
22989 Set the current CRIS mode to @var{mode}.  It should only be changed when
22990 debugging in guru mode, in which case it should be set to 
22991 @samp{guru} (the default is @samp{normal}).
22992
22993 @item show cris-mode
22994 Show the current CRIS mode.
22995 @end table
22996
22997 @node Super-H
22998 @subsection Renesas Super-H
22999 @cindex Super-H
23000
23001 For the Renesas Super-H processor, @value{GDBN} provides these
23002 commands:
23003
23004 @table @code
23005 @item set sh calling-convention @var{convention}
23006 @kindex set sh calling-convention
23007 Set the calling-convention used when calling functions from @value{GDBN}.
23008 Allowed values are @samp{gcc}, which is the default setting, and @samp{renesas}.
23009 With the @samp{gcc} setting, functions are called using the @value{NGCC} calling
23010 convention.  If the DWARF-2 information of the called function specifies
23011 that the function follows the Renesas calling convention, the function
23012 is called using the Renesas calling convention.  If the calling convention
23013 is set to @samp{renesas}, the Renesas calling convention is always used,
23014 regardless of the DWARF-2 information.  This can be used to override the
23015 default of @samp{gcc} if debug information is missing, or the compiler
23016 does not emit the DWARF-2 calling convention entry for a function.
23017
23018 @item show sh calling-convention
23019 @kindex show sh calling-convention
23020 Show the current calling convention setting.
23021
23022 @end table
23023
23024
23025 @node Architectures
23026 @section Architectures
23027
23028 This section describes characteristics of architectures that affect
23029 all uses of @value{GDBN} with the architecture, both native and cross.
23030
23031 @menu
23032 * AArch64::
23033 * i386::
23034 * Alpha::
23035 * MIPS::
23036 * HPPA::               HP PA architecture
23037 * SPU::                Cell Broadband Engine SPU architecture
23038 * PowerPC::
23039 * Nios II::
23040 * Sparc64::
23041 @end menu
23042
23043 @node AArch64
23044 @subsection AArch64
23045 @cindex AArch64 support
23046
23047 When @value{GDBN} is debugging the AArch64 architecture, it provides the
23048 following special commands:
23049
23050 @table @code
23051 @item set debug aarch64
23052 @kindex set debug aarch64
23053 This command determines whether AArch64 architecture-specific debugging
23054 messages are to be displayed.
23055
23056 @item show debug aarch64
23057 Show whether AArch64 debugging messages are displayed.
23058
23059 @end table
23060
23061 @node i386
23062 @subsection x86 Architecture-specific Issues
23063
23064 @table @code
23065 @item set struct-convention @var{mode}
23066 @kindex set struct-convention
23067 @cindex struct return convention
23068 @cindex struct/union returned in registers
23069 Set the convention used by the inferior to return @code{struct}s and
23070 @code{union}s from functions to @var{mode}.  Possible values of
23071 @var{mode} are @code{"pcc"}, @code{"reg"}, and @code{"default"} (the
23072 default).  @code{"default"} or @code{"pcc"} means that @code{struct}s
23073 are returned on the stack, while @code{"reg"} means that a
23074 @code{struct} or a @code{union} whose size is 1, 2, 4, or 8 bytes will
23075 be returned in a register.
23076
23077 @item show struct-convention
23078 @kindex show struct-convention
23079 Show the current setting of the convention to return @code{struct}s
23080 from functions.
23081 @end table
23082
23083
23084 @subsubsection Intel @dfn{Memory Protection Extensions} (MPX).
23085 @cindex Intel Memory Protection Extensions (MPX).
23086
23087 Memory Protection Extension (MPX) adds the bound registers @samp{BND0}
23088 @footnote{The register named with capital letters represent the architecture
23089 registers.} through @samp{BND3}.  Bound registers store a pair of 64-bit values
23090 which are the lower bound and upper bound.  Bounds are effective addresses or
23091 memory locations.  The upper bounds are architecturally represented in 1's
23092 complement form.  A bound having lower bound = 0, and upper bound = 0
23093 (1's complement of all bits set) will allow access to the entire address space.
23094
23095 @samp{BND0} through @samp{BND3} are represented in @value{GDBN} as @samp{bnd0raw}
23096 through @samp{bnd3raw}.  Pseudo registers @samp{bnd0} through @samp{bnd3}
23097 display the upper bound performing the complement of one operation on the
23098 upper bound value, i.e.@ when upper bound in @samp{bnd0raw} is 0 in the
23099 @value{GDBN} @samp{bnd0} it will be @code{0xfff@dots{}}.  In this sense it
23100 can also be noted that the upper bounds are inclusive.
23101
23102 As an example, assume that the register BND0 holds bounds for a pointer having
23103 access allowed for the range between 0x32 and 0x71.  The values present on
23104 bnd0raw and bnd registers are presented as follows:
23105
23106 @smallexample
23107         bnd0raw = @{0x32, 0xffffffff8e@}
23108         bnd0 = @{lbound = 0x32, ubound = 0x71@} : size 64
23109 @end smallexample
23110
23111 This way the raw value can be accessed via bnd0raw@dots{}bnd3raw.  Any
23112 change on bnd0@dots{}bnd3 or bnd0raw@dots{}bnd3raw is reflect on its
23113 counterpart.  When the bnd0@dots{}bnd3 registers are displayed via
23114 Python, the display includes the memory size, in bits, accessible to
23115 the pointer.
23116
23117 Bounds can also be stored in bounds tables, which are stored in
23118 application memory.  These tables store bounds for pointers by specifying
23119 the bounds pointer's value along with its bounds.  Evaluating and changing
23120 bounds located in bound tables is therefore interesting while investigating
23121 bugs on MPX context.  @value{GDBN} provides commands for this purpose:
23122
23123 @table @code
23124 @item show mpx bound @var{pointer}
23125 @kindex show mpx bound
23126 Display bounds of the given @var{pointer}.
23127
23128 @item set mpx bound @var{pointer}, @var{lbound}, @var{ubound}
23129 @kindex  set mpx bound
23130 Set the bounds of a pointer in the bound table.
23131 This command takes three parameters: @var{pointer} is the pointers
23132 whose bounds are to be changed, @var{lbound} and @var{ubound} are new values
23133 for lower and upper bounds respectively.
23134 @end table
23135
23136 When you call an inferior function on an Intel MPX enabled program,
23137 GDB sets the inferior's bound registers to the init (disabled) state
23138 before calling the function.  As a consequence, bounds checks for the
23139 pointer arguments passed to the function will always pass.
23140
23141 This is necessary because when you call an inferior function, the
23142 program is usually in the middle of the execution of other function.
23143 Since at that point bound registers are in an arbitrary state, not
23144 clearing them would lead to random bound violations in the called
23145 function.
23146
23147 You can still examine the influence of the bound registers on the
23148 execution of the called function by stopping the execution of the
23149 called function at its prologue, setting bound registers, and
23150 continuing the execution.  For example:
23151
23152 @smallexample
23153         $ break *upper
23154         Breakpoint 2 at 0x4009de: file i386-mpx-call.c, line 47.
23155         $ print upper (a, b, c, d, 1)
23156         Breakpoint 2, upper (a=0x0, b=0x6e0000005b, c=0x0, d=0x0, len=48)....
23157         $ print $bnd0
23158         @{lbound = 0x0, ubound = ffffffff@} : size -1
23159 @end smallexample
23160
23161 At this last step the value of bnd0 can be changed for investigation of bound
23162 violations caused along the execution of the call.  In order to know how to
23163 set the bound registers or bound table for the call consult the ABI.
23164
23165 @node Alpha
23166 @subsection Alpha
23167
23168 See the following section.
23169
23170 @node MIPS
23171 @subsection @acronym{MIPS}
23172
23173 @cindex stack on Alpha
23174 @cindex stack on @acronym{MIPS}
23175 @cindex Alpha stack
23176 @cindex @acronym{MIPS} stack
23177 Alpha- and @acronym{MIPS}-based computers use an unusual stack frame, which
23178 sometimes requires @value{GDBN} to search backward in the object code to
23179 find the beginning of a function.
23180
23181 @cindex response time, @acronym{MIPS} debugging
23182 To improve response time (especially for embedded applications, where
23183 @value{GDBN} may be restricted to a slow serial line for this search)
23184 you may want to limit the size of this search, using one of these
23185 commands:
23186
23187 @table @code
23188 @cindex @code{heuristic-fence-post} (Alpha, @acronym{MIPS})
23189 @item set heuristic-fence-post @var{limit}
23190 Restrict @value{GDBN} to examining at most @var{limit} bytes in its
23191 search for the beginning of a function.  A value of @var{0} (the
23192 default) means there is no limit.  However, except for @var{0}, the
23193 larger the limit the more bytes @code{heuristic-fence-post} must search
23194 and therefore the longer it takes to run.  You should only need to use
23195 this command when debugging a stripped executable.
23196
23197 @item show heuristic-fence-post
23198 Display the current limit.
23199 @end table
23200
23201 @noindent
23202 These commands are available @emph{only} when @value{GDBN} is configured
23203 for debugging programs on Alpha or @acronym{MIPS} processors.
23204
23205 Several @acronym{MIPS}-specific commands are available when debugging @acronym{MIPS}
23206 programs:
23207
23208 @table @code
23209 @item set mips abi @var{arg}
23210 @kindex set mips abi
23211 @cindex set ABI for @acronym{MIPS}
23212 Tell @value{GDBN} which @acronym{MIPS} ABI is used by the inferior.  Possible
23213 values of @var{arg} are:
23214
23215 @table @samp
23216 @item auto
23217 The default ABI associated with the current binary (this is the
23218 default).
23219 @item o32
23220 @item o64
23221 @item n32
23222 @item n64
23223 @item eabi32
23224 @item eabi64
23225 @end table
23226
23227 @item show mips abi
23228 @kindex show mips abi
23229 Show the @acronym{MIPS} ABI used by @value{GDBN} to debug the inferior.
23230
23231 @item set mips compression @var{arg}
23232 @kindex set mips compression
23233 @cindex code compression, @acronym{MIPS}
23234 Tell @value{GDBN} which @acronym{MIPS} compressed
23235 @acronym{ISA, Instruction Set Architecture} encoding is used by the
23236 inferior.  @value{GDBN} uses this for code disassembly and other
23237 internal interpretation purposes.  This setting is only referred to
23238 when no executable has been associated with the debugging session or
23239 the executable does not provide information about the encoding it uses.
23240 Otherwise this setting is automatically updated from information
23241 provided by the executable.
23242
23243 Possible values of @var{arg} are @samp{mips16} and @samp{micromips}.
23244 The default compressed @acronym{ISA} encoding is @samp{mips16}, as
23245 executables containing @acronym{MIPS16} code frequently are not
23246 identified as such.
23247
23248 This setting is ``sticky''; that is, it retains its value across
23249 debugging sessions until reset either explicitly with this command or
23250 implicitly from an executable.
23251
23252 The compiler and/or assembler typically add symbol table annotations to
23253 identify functions compiled for the @acronym{MIPS16} or
23254 @acronym{microMIPS} @acronym{ISA}s.  If these function-scope annotations
23255 are present, @value{GDBN} uses them in preference to the global
23256 compressed @acronym{ISA} encoding setting.
23257
23258 @item show mips compression
23259 @kindex show mips compression
23260 Show the @acronym{MIPS} compressed @acronym{ISA} encoding used by
23261 @value{GDBN} to debug the inferior.
23262
23263 @item set mipsfpu
23264 @itemx show mipsfpu
23265 @xref{MIPS Embedded, set mipsfpu}.
23266
23267 @item set mips mask-address @var{arg}
23268 @kindex set mips mask-address
23269 @cindex @acronym{MIPS} addresses, masking
23270 This command determines whether the most-significant 32 bits of 64-bit
23271 @acronym{MIPS} addresses are masked off.  The argument @var{arg} can be
23272 @samp{on}, @samp{off}, or @samp{auto}.  The latter is the default
23273 setting, which lets @value{GDBN} determine the correct value.
23274
23275 @item show mips mask-address
23276 @kindex show mips mask-address
23277 Show whether the upper 32 bits of @acronym{MIPS} addresses are masked off or
23278 not.
23279
23280 @item set remote-mips64-transfers-32bit-regs
23281 @kindex set remote-mips64-transfers-32bit-regs
23282 This command controls compatibility with 64-bit @acronym{MIPS} targets that
23283 transfer data in 32-bit quantities.  If you have an old @acronym{MIPS} 64 target
23284 that transfers 32 bits for some registers, like @sc{sr} and @sc{fsr},
23285 and 64 bits for other registers, set this option to @samp{on}.
23286
23287 @item show remote-mips64-transfers-32bit-regs
23288 @kindex show remote-mips64-transfers-32bit-regs
23289 Show the current setting of compatibility with older @acronym{MIPS} 64 targets.
23290
23291 @item set debug mips
23292 @kindex set debug mips
23293 This command turns on and off debugging messages for the @acronym{MIPS}-specific
23294 target code in @value{GDBN}.
23295
23296 @item show debug mips
23297 @kindex show debug mips
23298 Show the current setting of @acronym{MIPS} debugging messages.
23299 @end table
23300
23301
23302 @node HPPA
23303 @subsection HPPA
23304 @cindex HPPA support
23305
23306 When @value{GDBN} is debugging the HP PA architecture, it provides the
23307 following special commands:
23308
23309 @table @code
23310 @item set debug hppa
23311 @kindex set debug hppa
23312 This command determines whether HPPA architecture-specific debugging
23313 messages are to be displayed.
23314
23315 @item show debug hppa
23316 Show whether HPPA debugging messages are displayed.
23317
23318 @item maint print unwind @var{address}
23319 @kindex maint print unwind@r{, HPPA}
23320 This command displays the contents of the unwind table entry at the
23321 given @var{address}.
23322
23323 @end table
23324
23325
23326 @node SPU
23327 @subsection Cell Broadband Engine SPU architecture
23328 @cindex Cell Broadband Engine
23329 @cindex SPU
23330
23331 When @value{GDBN} is debugging the Cell Broadband Engine SPU architecture,
23332 it provides the following special commands:
23333
23334 @table @code
23335 @item info spu event
23336 @kindex info spu
23337 Display SPU event facility status.  Shows current event mask
23338 and pending event status.
23339
23340 @item info spu signal
23341 Display SPU signal notification facility status.  Shows pending
23342 signal-control word and signal notification mode of both signal
23343 notification channels.
23344
23345 @item info spu mailbox
23346 Display SPU mailbox facility status.  Shows all pending entries,
23347 in order of processing, in each of the SPU Write Outbound,
23348 SPU Write Outbound Interrupt, and SPU Read Inbound mailboxes.
23349
23350 @item info spu dma
23351 Display MFC DMA status.  Shows all pending commands in the MFC
23352 DMA queue.  For each entry, opcode, tag, class IDs, effective
23353 and local store addresses and transfer size are shown.
23354
23355 @item info spu proxydma
23356 Display MFC Proxy-DMA status.  Shows all pending commands in the MFC
23357 Proxy-DMA queue.  For each entry, opcode, tag, class IDs, effective
23358 and local store addresses and transfer size are shown.
23359
23360 @end table
23361  
23362 When @value{GDBN} is debugging a combined PowerPC/SPU application
23363 on the Cell Broadband Engine, it provides in addition the following
23364 special commands:
23365
23366 @table @code
23367 @item set spu stop-on-load @var{arg}
23368 @kindex set spu
23369 Set whether to stop for new SPE threads.  When set to @code{on}, @value{GDBN}
23370 will give control to the user when a new SPE thread enters its @code{main}
23371 function.  The default is @code{off}.
23372
23373 @item show spu stop-on-load
23374 @kindex show spu
23375 Show whether to stop for new SPE threads.
23376
23377 @item set spu auto-flush-cache @var{arg}
23378 Set whether to automatically flush the software-managed cache.  When set to
23379 @code{on}, @value{GDBN} will automatically cause the SPE software-managed
23380 cache to be flushed whenever SPE execution stops.  This provides a consistent
23381 view of PowerPC memory that is accessed via the cache.  If an application
23382 does not use the software-managed cache, this option has no effect.
23383
23384 @item show spu auto-flush-cache
23385 Show whether to automatically flush the software-managed cache.
23386
23387 @end table
23388
23389 @node PowerPC
23390 @subsection PowerPC
23391 @cindex PowerPC architecture
23392
23393 When @value{GDBN} is debugging the PowerPC architecture, it provides a set of 
23394 pseudo-registers to enable inspection of 128-bit wide Decimal Floating Point
23395 numbers stored in the floating point registers. These values must be stored
23396 in two consecutive registers, always starting at an even register like
23397 @code{f0} or @code{f2}.
23398
23399 The pseudo-registers go from @code{$dl0} through @code{$dl15}, and are formed
23400 by joining the even/odd register pairs @code{f0} and @code{f1} for @code{$dl0},
23401 @code{f2} and @code{f3} for @code{$dl1} and so on.
23402
23403 For POWER7 processors, @value{GDBN} provides a set of pseudo-registers, the 64-bit
23404 wide Extended Floating Point Registers (@samp{f32} through @samp{f63}).
23405
23406 @node Nios II
23407 @subsection Nios II
23408 @cindex Nios II architecture
23409
23410 When @value{GDBN} is debugging the Nios II architecture,
23411 it provides the following special commands:
23412
23413 @table @code
23414
23415 @item set debug nios2
23416 @kindex set debug nios2
23417 This command turns on and off debugging messages for the Nios II
23418 target code in @value{GDBN}.
23419
23420 @item show debug nios2
23421 @kindex show debug nios2
23422 Show the current setting of Nios II debugging messages.
23423 @end table
23424
23425 @node Sparc64
23426 @subsection Sparc64
23427 @cindex Sparc64 support
23428 @cindex Application Data Integrity
23429 @subsubsection ADI Support
23430
23431 The M7 processor supports an Application Data Integrity (ADI) feature that 
23432 detects invalid data accesses.  When software allocates memory and enables 
23433 ADI on the allocated memory, it chooses a 4-bit version number, sets the 
23434 version in the upper 4 bits of the 64-bit pointer to that data, and stores 
23435 the 4-bit version in every cacheline of that data.  Hardware saves the latter 
23436 in spare bits in the cache and memory hierarchy.  On each load and store, 
23437 the processor compares the upper 4 VA (virtual address) bits to the 
23438 cacheline's version.  If there is a mismatch, the processor generates a 
23439 version mismatch trap which can be either precise or disrupting.  The trap 
23440 is an error condition which the kernel delivers to the process as a SIGSEGV 
23441 signal.
23442
23443 Note that only 64-bit applications can use ADI and need to be built with
23444 ADI-enabled.
23445
23446 Values of the ADI version tags, which are in granularity of a 
23447 cacheline (64 bytes), can be viewed or modified. 
23448
23449
23450 @table @code
23451 @kindex adi examine
23452 @item adi (examine | x) [ / @var{n} ] @var{addr}
23453
23454 The @code{adi examine} command displays the value of one ADI version tag per 
23455 cacheline. 
23456
23457 @var{n} is a decimal integer specifying the number in bytes; the default 
23458 is 1.  It specifies how much ADI version information, at the ratio of 1:ADI 
23459 block size, to display. 
23460
23461 @var{addr} is the address in user address space where you want @value{GDBN} 
23462 to begin displaying the ADI version tags. 
23463
23464 Below is an example of displaying ADI versions of variable "shmaddr".
23465
23466 @smallexample
23467 (@value{GDBP}) adi x/100 shmaddr
23468    0xfff800010002c000:     0 0
23469 @end smallexample
23470
23471 @kindex adi assign
23472 @item adi (assign | a) [ / @var{n} ] @var{addr} = @var{tag}
23473
23474 The @code{adi assign} command is used to assign new ADI version tag 
23475 to an address. 
23476
23477 @var{n} is a decimal integer specifying the number in bytes; 
23478 the default is 1.  It specifies how much ADI version information, at the 
23479 ratio of 1:ADI block size, to modify. 
23480
23481 @var{addr} is the address in user address space where you want @value{GDBN} 
23482 to begin modifying the ADI version tags. 
23483
23484 @var{tag} is the new ADI version tag.
23485
23486 For example, do the following to modify then verify ADI versions of 
23487 variable "shmaddr":
23488
23489 @smallexample
23490 (@value{GDBP}) adi a/100 shmaddr = 7
23491 (@value{GDBP}) adi x/100 shmaddr
23492    0xfff800010002c000:     7 7
23493 @end smallexample
23494
23495 @end table
23496
23497 @node Controlling GDB
23498 @chapter Controlling @value{GDBN}
23499
23500 You can alter the way @value{GDBN} interacts with you by using the
23501 @code{set} command.  For commands controlling how @value{GDBN} displays
23502 data, see @ref{Print Settings, ,Print Settings}.  Other settings are
23503 described here.
23504
23505 @menu
23506 * Prompt::                      Prompt
23507 * Editing::                     Command editing
23508 * Command History::             Command history
23509 * Screen Size::                 Screen size
23510 * Numbers::                     Numbers
23511 * ABI::                         Configuring the current ABI
23512 * Auto-loading::                Automatically loading associated files
23513 * Messages/Warnings::           Optional warnings and messages
23514 * Debugging Output::            Optional messages about internal happenings
23515 * Other Misc Settings::         Other Miscellaneous Settings
23516 @end menu
23517
23518 @node Prompt
23519 @section Prompt
23520
23521 @cindex prompt
23522
23523 @value{GDBN} indicates its readiness to read a command by printing a string
23524 called the @dfn{prompt}.  This string is normally @samp{(@value{GDBP})}.  You
23525 can change the prompt string with the @code{set prompt} command.  For
23526 instance, when debugging @value{GDBN} with @value{GDBN}, it is useful to change
23527 the prompt in one of the @value{GDBN} sessions so that you can always tell
23528 which one you are talking to.
23529
23530 @emph{Note:}  @code{set prompt} does not add a space for you after the
23531 prompt you set.  This allows you to set a prompt which ends in a space
23532 or a prompt that does not.
23533
23534 @table @code
23535 @kindex set prompt
23536 @item set prompt @var{newprompt}
23537 Directs @value{GDBN} to use @var{newprompt} as its prompt string henceforth.
23538
23539 @kindex show prompt
23540 @item show prompt
23541 Prints a line of the form: @samp{Gdb's prompt is: @var{your-prompt}}
23542 @end table
23543
23544 Versions of @value{GDBN} that ship with Python scripting enabled have
23545 prompt extensions.  The commands for interacting with these extensions
23546 are:
23547
23548 @table @code
23549 @kindex set extended-prompt
23550 @item set extended-prompt @var{prompt}
23551 Set an extended prompt that allows for substitutions.
23552 @xref{gdb.prompt}, for a list of escape sequences that can be used for
23553 substitution.  Any escape sequences specified as part of the prompt
23554 string are replaced with the corresponding strings each time the prompt
23555 is displayed.
23556
23557 For example:
23558
23559 @smallexample
23560 set extended-prompt Current working directory: \w (gdb)
23561 @end smallexample
23562
23563 Note that when an extended-prompt is set, it takes control of the
23564 @var{prompt_hook} hook.  @xref{prompt_hook}, for further information.
23565
23566 @kindex show extended-prompt
23567 @item show extended-prompt
23568 Prints the extended prompt.  Any escape sequences specified as part of
23569 the prompt string with @code{set extended-prompt}, are replaced with the
23570 corresponding strings each time the prompt is displayed.
23571 @end table
23572
23573 @node Editing
23574 @section Command Editing
23575 @cindex readline
23576 @cindex command line editing
23577
23578 @value{GDBN} reads its input commands via the @dfn{Readline} interface.  This
23579 @sc{gnu} library provides consistent behavior for programs which provide a
23580 command line interface to the user.  Advantages are @sc{gnu} Emacs-style
23581 or @dfn{vi}-style inline editing of commands, @code{csh}-like history
23582 substitution, and a storage and recall of command history across
23583 debugging sessions.
23584
23585 You may control the behavior of command line editing in @value{GDBN} with the
23586 command @code{set}.
23587
23588 @table @code
23589 @kindex set editing
23590 @cindex editing
23591 @item set editing
23592 @itemx set editing on
23593 Enable command line editing (enabled by default).
23594
23595 @item set editing off
23596 Disable command line editing.
23597
23598 @kindex show editing
23599 @item show editing
23600 Show whether command line editing is enabled.
23601 @end table
23602
23603 @ifset SYSTEM_READLINE
23604 @xref{Command Line Editing, , , rluserman, GNU Readline Library},
23605 @end ifset
23606 @ifclear SYSTEM_READLINE
23607 @xref{Command Line Editing},
23608 @end ifclear
23609 for more details about the Readline
23610 interface.  Users unfamiliar with @sc{gnu} Emacs or @code{vi} are
23611 encouraged to read that chapter.
23612
23613 @node Command History
23614 @section Command History
23615 @cindex command history
23616
23617 @value{GDBN} can keep track of the commands you type during your
23618 debugging sessions, so that you can be certain of precisely what
23619 happened.  Use these commands to manage the @value{GDBN} command
23620 history facility.
23621
23622 @value{GDBN} uses the @sc{gnu} History library, a part of the Readline
23623 package, to provide the history facility.
23624 @ifset SYSTEM_READLINE
23625 @xref{Using History Interactively, , , history, GNU History Library},
23626 @end ifset
23627 @ifclear SYSTEM_READLINE
23628 @xref{Using History Interactively},
23629 @end ifclear
23630 for the detailed description of the History library.
23631
23632 To issue a command to @value{GDBN} without affecting certain aspects of
23633 the state which is seen by users, prefix it with @samp{server }
23634 (@pxref{Server Prefix}).  This
23635 means that this command will not affect the command history, nor will it
23636 affect @value{GDBN}'s notion of which command to repeat if @key{RET} is
23637 pressed on a line by itself.
23638
23639 @cindex @code{server}, command prefix
23640 The server prefix does not affect the recording of values into the value
23641 history; to print a value without recording it into the value history,
23642 use the @code{output} command instead of the @code{print} command.
23643
23644 Here is the description of @value{GDBN} commands related to command
23645 history.
23646
23647 @table @code
23648 @cindex history substitution
23649 @cindex history file
23650 @kindex set history filename
23651 @cindex @env{GDBHISTFILE}, environment variable
23652 @item set history filename @var{fname}
23653 Set the name of the @value{GDBN} command history file to @var{fname}.
23654 This is the file where @value{GDBN} reads an initial command history
23655 list, and where it writes the command history from this session when it
23656 exits.  You can access this list through history expansion or through
23657 the history command editing characters listed below.  This file defaults
23658 to the value of the environment variable @code{GDBHISTFILE}, or to
23659 @file{./.gdb_history} (@file{./_gdb_history} on MS-DOS) if this variable
23660 is not set.
23661
23662 @cindex save command history
23663 @kindex set history save
23664 @item set history save
23665 @itemx set history save on
23666 Record command history in a file, whose name may be specified with the
23667 @code{set history filename} command.  By default, this option is disabled.
23668
23669 @item set history save off
23670 Stop recording command history in a file.
23671
23672 @cindex history size
23673 @kindex set history size
23674 @cindex @env{GDBHISTSIZE}, environment variable
23675 @item set history size @var{size}
23676 @itemx set history size unlimited
23677 Set the number of commands which @value{GDBN} keeps in its history list.
23678 This defaults to the value of the environment variable @env{GDBHISTSIZE}, or
23679 to 256 if this variable is not set.  Non-numeric values of @env{GDBHISTSIZE}
23680 are ignored.  If @var{size} is @code{unlimited} or if @env{GDBHISTSIZE} is
23681 either a negative number or the empty string, then the number of commands
23682 @value{GDBN} keeps in the history list is unlimited.
23683
23684 @cindex remove duplicate history
23685 @kindex set history remove-duplicates
23686 @item set history remove-duplicates @var{count}
23687 @itemx set history remove-duplicates unlimited
23688 Control the removal of duplicate history entries in the command history list.
23689 If @var{count} is non-zero, @value{GDBN} will look back at the last @var{count}
23690 history entries and remove the first entry that is a duplicate of the current
23691 entry being added to the command history list.  If @var{count} is
23692 @code{unlimited} then this lookbehind is unbounded.  If @var{count} is 0, then
23693 removal of duplicate history entries is disabled.
23694
23695 Only history entries added during the current session are considered for
23696 removal.  This option is set to 0 by default.
23697
23698 @end table
23699
23700 History expansion assigns special meaning to the character @kbd{!}.
23701 @ifset SYSTEM_READLINE
23702 @xref{Event Designators, , , history, GNU History Library},
23703 @end ifset
23704 @ifclear SYSTEM_READLINE
23705 @xref{Event Designators},
23706 @end ifclear
23707 for more details.
23708
23709 @cindex history expansion, turn on/off
23710 Since @kbd{!} is also the logical not operator in C, history expansion
23711 is off by default. If you decide to enable history expansion with the
23712 @code{set history expansion on} command, you may sometimes need to
23713 follow @kbd{!} (when it is used as logical not, in an expression) with
23714 a space or a tab to prevent it from being expanded.  The readline
23715 history facilities do not attempt substitution on the strings
23716 @kbd{!=} and @kbd{!(}, even when history expansion is enabled.
23717
23718 The commands to control history expansion are:
23719
23720 @table @code
23721 @item set history expansion on
23722 @itemx set history expansion
23723 @kindex set history expansion
23724 Enable history expansion.  History expansion is off by default.
23725
23726 @item set history expansion off
23727 Disable history expansion.
23728
23729 @c @group
23730 @kindex show history
23731 @item show history
23732 @itemx show history filename
23733 @itemx show history save
23734 @itemx show history size
23735 @itemx show history expansion
23736 These commands display the state of the @value{GDBN} history parameters.
23737 @code{show history} by itself displays all four states.
23738 @c @end group
23739 @end table
23740
23741 @table @code
23742 @kindex show commands
23743 @cindex show last commands
23744 @cindex display command history
23745 @item show commands
23746 Display the last ten commands in the command history.
23747
23748 @item show commands @var{n}
23749 Print ten commands centered on command number @var{n}.
23750
23751 @item show commands +
23752 Print ten commands just after the commands last printed.
23753 @end table
23754
23755 @node Screen Size
23756 @section Screen Size
23757 @cindex size of screen
23758 @cindex screen size
23759 @cindex pagination
23760 @cindex page size
23761 @cindex pauses in output
23762
23763 Certain commands to @value{GDBN} may produce large amounts of
23764 information output to the screen.  To help you read all of it,
23765 @value{GDBN} pauses and asks you for input at the end of each page of
23766 output.  Type @key{RET} when you want to continue the output, or @kbd{q}
23767 to discard the remaining output.  Also, the screen width setting
23768 determines when to wrap lines of output.  Depending on what is being
23769 printed, @value{GDBN} tries to break the line at a readable place,
23770 rather than simply letting it overflow onto the following line.
23771
23772 Normally @value{GDBN} knows the size of the screen from the terminal
23773 driver software.  For example, on Unix @value{GDBN} uses the termcap data base
23774 together with the value of the @code{TERM} environment variable and the
23775 @code{stty rows} and @code{stty cols} settings.  If this is not correct,
23776 you can override it with the @code{set height} and @code{set
23777 width} commands:
23778
23779 @table @code
23780 @kindex set height
23781 @kindex set width
23782 @kindex show width
23783 @kindex show height
23784 @item set height @var{lpp}
23785 @itemx set height unlimited
23786 @itemx show height
23787 @itemx set width @var{cpl}
23788 @itemx set width unlimited
23789 @itemx show width
23790 These @code{set} commands specify a screen height of @var{lpp} lines and
23791 a screen width of @var{cpl} characters.  The associated @code{show}
23792 commands display the current settings.
23793
23794 If you specify a height of either @code{unlimited} or zero lines,
23795 @value{GDBN} does not pause during output no matter how long the
23796 output is.  This is useful if output is to a file or to an editor
23797 buffer.
23798
23799 Likewise, you can specify @samp{set width unlimited} or @samp{set
23800 width 0} to prevent @value{GDBN} from wrapping its output.
23801
23802 @item set pagination on
23803 @itemx set pagination off
23804 @kindex set pagination
23805 Turn the output pagination on or off; the default is on.  Turning
23806 pagination off is the alternative to @code{set height unlimited}.  Note that
23807 running @value{GDBN} with the @option{--batch} option (@pxref{Mode
23808 Options, -batch}) also automatically disables pagination.
23809
23810 @item show pagination
23811 @kindex show pagination
23812 Show the current pagination mode.
23813 @end table
23814
23815 @node Numbers
23816 @section Numbers
23817 @cindex number representation
23818 @cindex entering numbers
23819
23820 You can always enter numbers in octal, decimal, or hexadecimal in
23821 @value{GDBN} by the usual conventions: octal numbers begin with
23822 @samp{0}, decimal numbers end with @samp{.}, and hexadecimal numbers
23823 begin with @samp{0x}.  Numbers that neither begin with @samp{0} or
23824 @samp{0x}, nor end with a @samp{.} are, by default, entered in base
23825 10; likewise, the default display for numbers---when no particular
23826 format is specified---is base 10.  You can change the default base for
23827 both input and output with the commands described below.
23828
23829 @table @code
23830 @kindex set input-radix
23831 @item set input-radix @var{base}
23832 Set the default base for numeric input.  Supported choices
23833 for @var{base} are decimal 8, 10, or 16.  The base must itself be
23834 specified either unambiguously or using the current input radix; for
23835 example, any of
23836
23837 @smallexample
23838 set input-radix 012
23839 set input-radix 10.
23840 set input-radix 0xa
23841 @end smallexample
23842
23843 @noindent
23844 sets the input base to decimal.  On the other hand, @samp{set input-radix 10}
23845 leaves the input radix unchanged, no matter what it was, since
23846 @samp{10}, being without any leading or trailing signs of its base, is
23847 interpreted in the current radix.  Thus, if the current radix is 16,
23848 @samp{10} is interpreted in hex, i.e.@: as 16 decimal, which doesn't
23849 change the radix.
23850
23851 @kindex set output-radix
23852 @item set output-radix @var{base}
23853 Set the default base for numeric display.  Supported choices
23854 for @var{base} are decimal 8, 10, or 16.  The base must itself be
23855 specified either unambiguously or using the current input radix.
23856
23857 @kindex show input-radix
23858 @item show input-radix
23859 Display the current default base for numeric input.
23860
23861 @kindex show output-radix
23862 @item show output-radix
23863 Display the current default base for numeric display.
23864
23865 @item set radix @r{[}@var{base}@r{]}
23866 @itemx show radix
23867 @kindex set radix
23868 @kindex show radix
23869 These commands set and show the default base for both input and output
23870 of numbers.  @code{set radix} sets the radix of input and output to
23871 the same base; without an argument, it resets the radix back to its
23872 default value of 10.
23873
23874 @end table
23875
23876 @node ABI
23877 @section Configuring the Current ABI
23878
23879 @value{GDBN} can determine the @dfn{ABI} (Application Binary Interface) of your
23880 application automatically.  However, sometimes you need to override its
23881 conclusions.  Use these commands to manage @value{GDBN}'s view of the
23882 current ABI.
23883
23884 @cindex OS ABI
23885 @kindex set osabi
23886 @kindex show osabi
23887 @cindex Newlib OS ABI and its influence on the longjmp handling
23888
23889 One @value{GDBN} configuration can debug binaries for multiple operating
23890 system targets, either via remote debugging or native emulation.
23891 @value{GDBN} will autodetect the @dfn{OS ABI} (Operating System ABI) in use,
23892 but you can override its conclusion using the @code{set osabi} command.
23893 One example where this is useful is in debugging of binaries which use
23894 an alternate C library (e.g.@: @sc{uClibc} for @sc{gnu}/Linux) which does
23895 not have the same identifying marks that the standard C library for your
23896 platform provides.
23897
23898 When @value{GDBN} is debugging the AArch64 architecture, it provides a
23899 ``Newlib'' OS ABI.  This is useful for handling @code{setjmp} and
23900 @code{longjmp} when debugging binaries that use the @sc{newlib} C library.
23901 The ``Newlib'' OS ABI can be selected by @code{set osabi Newlib}.
23902
23903 @table @code
23904 @item show osabi
23905 Show the OS ABI currently in use.
23906
23907 @item set osabi
23908 With no argument, show the list of registered available OS ABI's.
23909
23910 @item set osabi @var{abi}
23911 Set the current OS ABI to @var{abi}.
23912 @end table
23913
23914 @cindex float promotion
23915
23916 Generally, the way that an argument of type @code{float} is passed to a
23917 function depends on whether the function is prototyped.  For a prototyped
23918 (i.e.@: ANSI/ISO style) function, @code{float} arguments are passed unchanged,
23919 according to the architecture's convention for @code{float}.  For unprototyped
23920 (i.e.@: K&R style) functions, @code{float} arguments are first promoted to type
23921 @code{double} and then passed.
23922
23923 Unfortunately, some forms of debug information do not reliably indicate whether
23924 a function is prototyped.  If @value{GDBN} calls a function that is not marked
23925 as prototyped, it consults @kbd{set coerce-float-to-double}.
23926
23927 @table @code
23928 @kindex set coerce-float-to-double
23929 @item set coerce-float-to-double
23930 @itemx set coerce-float-to-double on
23931 Arguments of type @code{float} will be promoted to @code{double} when passed
23932 to an unprototyped function.  This is the default setting.
23933
23934 @item set coerce-float-to-double off
23935 Arguments of type @code{float} will be passed directly to unprototyped
23936 functions.
23937
23938 @kindex show coerce-float-to-double
23939 @item show coerce-float-to-double
23940 Show the current setting of promoting @code{float} to @code{double}.
23941 @end table
23942
23943 @kindex set cp-abi
23944 @kindex show cp-abi
23945 @value{GDBN} needs to know the ABI used for your program's C@t{++}
23946 objects.  The correct C@t{++} ABI depends on which C@t{++} compiler was
23947 used to build your application.  @value{GDBN} only fully supports
23948 programs with a single C@t{++} ABI; if your program contains code using
23949 multiple C@t{++} ABI's or if @value{GDBN} can not identify your
23950 program's ABI correctly, you can tell @value{GDBN} which ABI to use.
23951 Currently supported ABI's include ``gnu-v2'', for @code{g++} versions
23952 before 3.0, ``gnu-v3'', for @code{g++} versions 3.0 and later, and
23953 ``hpaCC'' for the HP ANSI C@t{++} compiler.  Other C@t{++} compilers may
23954 use the ``gnu-v2'' or ``gnu-v3'' ABI's as well.  The default setting is
23955 ``auto''.
23956
23957 @table @code
23958 @item show cp-abi
23959 Show the C@t{++} ABI currently in use.
23960
23961 @item set cp-abi
23962 With no argument, show the list of supported C@t{++} ABI's.
23963
23964 @item set cp-abi @var{abi}
23965 @itemx set cp-abi auto
23966 Set the current C@t{++} ABI to @var{abi}, or return to automatic detection.
23967 @end table
23968
23969 @node Auto-loading
23970 @section Automatically loading associated files
23971 @cindex auto-loading
23972
23973 @value{GDBN} sometimes reads files with commands and settings automatically,
23974 without being explicitly told so by the user.  We call this feature
23975 @dfn{auto-loading}.  While auto-loading is useful for automatically adapting
23976 @value{GDBN} to the needs of your project, it can sometimes produce unexpected
23977 results or introduce security risks (e.g., if the file comes from untrusted
23978 sources).
23979
23980 @menu
23981 * Init File in the Current Directory:: @samp{set/show/info auto-load local-gdbinit}
23982 * libthread_db.so.1 file::             @samp{set/show/info auto-load libthread-db}
23983
23984 * Auto-loading safe path::             @samp{set/show/info auto-load safe-path}
23985 * Auto-loading verbose mode::          @samp{set/show debug auto-load}
23986 @end menu
23987
23988 There are various kinds of files @value{GDBN} can automatically load.
23989 In addition to these files, @value{GDBN} supports auto-loading code written
23990 in various extension languages.  @xref{Auto-loading extensions}.
23991
23992 Note that loading of these associated files (including the local @file{.gdbinit}
23993 file) requires accordingly configured @code{auto-load safe-path}
23994 (@pxref{Auto-loading safe path}).
23995
23996 For these reasons, @value{GDBN} includes commands and options to let you
23997 control when to auto-load files and which files should be auto-loaded.
23998
23999 @table @code
24000 @anchor{set auto-load off}
24001 @kindex set auto-load off
24002 @item set auto-load off
24003 Globally disable loading of all auto-loaded files.
24004 You may want to use this command with the @samp{-iex} option
24005 (@pxref{Option -init-eval-command}) such as:
24006 @smallexample
24007 $ @kbd{gdb -iex "set auto-load off" untrusted-executable corefile}
24008 @end smallexample
24009
24010 Be aware that system init file (@pxref{System-wide configuration})
24011 and init files from your home directory (@pxref{Home Directory Init File})
24012 still get read (as they come from generally trusted directories).
24013 To prevent @value{GDBN} from auto-loading even those init files, use the
24014 @option{-nx} option (@pxref{Mode Options}), in addition to
24015 @code{set auto-load no}.
24016
24017 @anchor{show auto-load}
24018 @kindex show auto-load
24019 @item show auto-load
24020 Show whether auto-loading of each specific @samp{auto-load} file(s) is enabled
24021 or disabled.
24022
24023 @smallexample
24024 (gdb) show auto-load
24025 gdb-scripts:  Auto-loading of canned sequences of commands scripts is on.
24026 libthread-db:  Auto-loading of inferior specific libthread_db is on.
24027 local-gdbinit:  Auto-loading of .gdbinit script from current directory
24028                 is on.
24029 python-scripts:  Auto-loading of Python scripts is on.
24030 safe-path:  List of directories from which it is safe to auto-load files
24031             is $debugdir:$datadir/auto-load.
24032 scripts-directory:  List of directories from which to load auto-loaded scripts
24033                     is $debugdir:$datadir/auto-load.
24034 @end smallexample
24035
24036 @anchor{info auto-load}
24037 @kindex info auto-load
24038 @item info auto-load
24039 Print whether each specific @samp{auto-load} file(s) have been auto-loaded or
24040 not.
24041
24042 @smallexample
24043 (gdb) info auto-load
24044 gdb-scripts:
24045 Loaded  Script
24046 Yes     /home/user/gdb/gdb-gdb.gdb
24047 libthread-db:  No auto-loaded libthread-db.
24048 local-gdbinit:  Local .gdbinit file "/home/user/gdb/.gdbinit" has been
24049                 loaded.
24050 python-scripts:
24051 Loaded  Script
24052 Yes     /home/user/gdb/gdb-gdb.py
24053 @end smallexample
24054 @end table
24055
24056 These are @value{GDBN} control commands for the auto-loading:
24057
24058 @multitable @columnfractions .5 .5
24059 @item @xref{set auto-load off}.
24060 @tab Disable auto-loading globally.
24061 @item @xref{show auto-load}.
24062 @tab Show setting of all kinds of files.
24063 @item @xref{info auto-load}.
24064 @tab Show state of all kinds of files.
24065 @item @xref{set auto-load gdb-scripts}.
24066 @tab Control for @value{GDBN} command scripts.
24067 @item @xref{show auto-load gdb-scripts}.
24068 @tab Show setting of @value{GDBN} command scripts.
24069 @item @xref{info auto-load gdb-scripts}.
24070 @tab Show state of @value{GDBN} command scripts.
24071 @item @xref{set auto-load python-scripts}.
24072 @tab Control for @value{GDBN} Python scripts.
24073 @item @xref{show auto-load python-scripts}.
24074 @tab Show setting of @value{GDBN} Python scripts.
24075 @item @xref{info auto-load python-scripts}.
24076 @tab Show state of @value{GDBN} Python scripts.
24077 @item @xref{set auto-load guile-scripts}.
24078 @tab Control for @value{GDBN} Guile scripts.
24079 @item @xref{show auto-load guile-scripts}.
24080 @tab Show setting of @value{GDBN} Guile scripts.
24081 @item @xref{info auto-load guile-scripts}.
24082 @tab Show state of @value{GDBN} Guile scripts.
24083 @item @xref{set auto-load scripts-directory}.
24084 @tab Control for @value{GDBN} auto-loaded scripts location.
24085 @item @xref{show auto-load scripts-directory}.
24086 @tab Show @value{GDBN} auto-loaded scripts location.
24087 @item @xref{add-auto-load-scripts-directory}.
24088 @tab Add directory for auto-loaded scripts location list.
24089 @item @xref{set auto-load local-gdbinit}.
24090 @tab Control for init file in the current directory.
24091 @item @xref{show auto-load local-gdbinit}.
24092 @tab Show setting of init file in the current directory.
24093 @item @xref{info auto-load local-gdbinit}.
24094 @tab Show state of init file in the current directory.
24095 @item @xref{set auto-load libthread-db}.
24096 @tab Control for thread debugging library.
24097 @item @xref{show auto-load libthread-db}.
24098 @tab Show setting of thread debugging library.
24099 @item @xref{info auto-load libthread-db}.
24100 @tab Show state of thread debugging library.
24101 @item @xref{set auto-load safe-path}.
24102 @tab Control directories trusted for automatic loading.
24103 @item @xref{show auto-load safe-path}.
24104 @tab Show directories trusted for automatic loading.
24105 @item @xref{add-auto-load-safe-path}.
24106 @tab Add directory trusted for automatic loading.
24107 @end multitable
24108
24109 @node Init File in the Current Directory
24110 @subsection Automatically loading init file in the current directory
24111 @cindex auto-loading init file in the current directory
24112
24113 By default, @value{GDBN} reads and executes the canned sequences of commands
24114 from init file (if any) in the current working directory,
24115 see @ref{Init File in the Current Directory during Startup}.
24116
24117 Note that loading of this local @file{.gdbinit} file also requires accordingly
24118 configured @code{auto-load safe-path} (@pxref{Auto-loading safe path}).
24119
24120 @table @code
24121 @anchor{set auto-load local-gdbinit}
24122 @kindex set auto-load local-gdbinit
24123 @item set auto-load local-gdbinit [on|off]
24124 Enable or disable the auto-loading of canned sequences of commands
24125 (@pxref{Sequences}) found in init file in the current directory.
24126
24127 @anchor{show auto-load local-gdbinit}
24128 @kindex show auto-load local-gdbinit
24129 @item show auto-load local-gdbinit
24130 Show whether auto-loading of canned sequences of commands from init file in the
24131 current directory is enabled or disabled.
24132
24133 @anchor{info auto-load local-gdbinit}
24134 @kindex info auto-load local-gdbinit
24135 @item info auto-load local-gdbinit
24136 Print whether canned sequences of commands from init file in the
24137 current directory have been auto-loaded.
24138 @end table
24139
24140 @node libthread_db.so.1 file
24141 @subsection Automatically loading thread debugging library
24142 @cindex auto-loading libthread_db.so.1
24143
24144 This feature is currently present only on @sc{gnu}/Linux native hosts.
24145
24146 @value{GDBN} reads in some cases thread debugging library from places specific
24147 to the inferior (@pxref{set libthread-db-search-path}).
24148
24149 The special @samp{libthread-db-search-path} entry @samp{$sdir} is processed
24150 without checking this @samp{set auto-load libthread-db} switch as system
24151 libraries have to be trusted in general.  In all other cases of
24152 @samp{libthread-db-search-path} entries @value{GDBN} checks first if @samp{set
24153 auto-load libthread-db} is enabled before trying to open such thread debugging
24154 library.
24155
24156 Note that loading of this debugging library also requires accordingly configured
24157 @code{auto-load safe-path} (@pxref{Auto-loading safe path}).
24158
24159 @table @code
24160 @anchor{set auto-load libthread-db}
24161 @kindex set auto-load libthread-db
24162 @item set auto-load libthread-db [on|off]
24163 Enable or disable the auto-loading of inferior specific thread debugging library.
24164
24165 @anchor{show auto-load libthread-db}
24166 @kindex show auto-load libthread-db
24167 @item show auto-load libthread-db
24168 Show whether auto-loading of inferior specific thread debugging library is
24169 enabled or disabled.
24170
24171 @anchor{info auto-load libthread-db}
24172 @kindex info auto-load libthread-db
24173 @item info auto-load libthread-db
24174 Print the list of all loaded inferior specific thread debugging libraries and
24175 for each such library print list of inferior @var{pid}s using it.
24176 @end table
24177
24178 @node Auto-loading safe path
24179 @subsection Security restriction for auto-loading
24180 @cindex auto-loading safe-path
24181
24182 As the files of inferior can come from untrusted source (such as submitted by
24183 an application user) @value{GDBN} does not always load any files automatically.
24184 @value{GDBN} provides the @samp{set auto-load safe-path} setting to list
24185 directories trusted for loading files not explicitly requested by user.
24186 Each directory can also be a shell wildcard pattern.
24187
24188 If the path is not set properly you will see a warning and the file will not
24189 get loaded:
24190
24191 @smallexample
24192 $ ./gdb -q ./gdb
24193 Reading symbols from /home/user/gdb/gdb...done.
24194 warning: File "/home/user/gdb/gdb-gdb.gdb" auto-loading has been
24195          declined by your `auto-load safe-path' set
24196          to "$debugdir:$datadir/auto-load".
24197 warning: File "/home/user/gdb/gdb-gdb.py" auto-loading has been
24198          declined by your `auto-load safe-path' set
24199          to "$debugdir:$datadir/auto-load".
24200 @end smallexample
24201
24202 @noindent
24203 To instruct @value{GDBN} to go ahead and use the init files anyway,
24204 invoke @value{GDBN} like this:
24205
24206 @smallexample
24207 $ gdb -q -iex "set auto-load safe-path /home/user/gdb" ./gdb
24208 @end smallexample
24209
24210 The list of trusted directories is controlled by the following commands:
24211
24212 @table @code
24213 @anchor{set auto-load safe-path}
24214 @kindex set auto-load safe-path
24215 @item set auto-load safe-path @r{[}@var{directories}@r{]}
24216 Set the list of directories (and their subdirectories) trusted for automatic
24217 loading and execution of scripts.  You can also enter a specific trusted file.
24218 Each directory can also be a shell wildcard pattern; wildcards do not match
24219 directory separator - see @code{FNM_PATHNAME} for system function @code{fnmatch}
24220 (@pxref{Wildcard Matching, fnmatch, , libc, GNU C Library Reference Manual}).
24221 If you omit @var{directories}, @samp{auto-load safe-path} will be reset to
24222 its default value as specified during @value{GDBN} compilation.
24223
24224 The list of directories uses path separator (@samp{:} on GNU and Unix
24225 systems, @samp{;} on MS-Windows and MS-DOS) to separate directories, similarly
24226 to the @env{PATH} environment variable.
24227
24228 @anchor{show auto-load safe-path}
24229 @kindex show auto-load safe-path
24230 @item show auto-load safe-path
24231 Show the list of directories trusted for automatic loading and execution of
24232 scripts.
24233
24234 @anchor{add-auto-load-safe-path}
24235 @kindex add-auto-load-safe-path
24236 @item add-auto-load-safe-path
24237 Add an entry (or list of entries) to the list of directories trusted for
24238 automatic loading and execution of scripts.  Multiple entries may be delimited
24239 by the host platform path separator in use.
24240 @end table
24241
24242 This variable defaults to what @code{--with-auto-load-dir} has been configured
24243 to (@pxref{with-auto-load-dir}).  @file{$debugdir} and @file{$datadir}
24244 substitution applies the same as for @ref{set auto-load scripts-directory}.
24245 The default @code{set auto-load safe-path} value can be also overriden by
24246 @value{GDBN} configuration option @option{--with-auto-load-safe-path}.
24247
24248 Setting this variable to @file{/} disables this security protection,
24249 corresponding @value{GDBN} configuration option is
24250 @option{--without-auto-load-safe-path}.
24251 This variable is supposed to be set to the system directories writable by the
24252 system superuser only.  Users can add their source directories in init files in
24253 their home directories (@pxref{Home Directory Init File}).  See also deprecated
24254 init file in the current directory
24255 (@pxref{Init File in the Current Directory during Startup}).
24256
24257 To force @value{GDBN} to load the files it declined to load in the previous
24258 example, you could use one of the following ways:
24259
24260 @table @asis
24261 @item @file{~/.gdbinit}: @samp{add-auto-load-safe-path ~/src/gdb}
24262 Specify this trusted directory (or a file) as additional component of the list.
24263 You have to specify also any existing directories displayed by
24264 by @samp{show auto-load safe-path} (such as @samp{/usr:/bin} in this example).
24265
24266 @item @kbd{gdb -iex "set auto-load safe-path /usr:/bin:~/src/gdb" @dots{}}
24267 Specify this directory as in the previous case but just for a single
24268 @value{GDBN} session.
24269
24270 @item @kbd{gdb -iex "set auto-load safe-path /" @dots{}}
24271 Disable auto-loading safety for a single @value{GDBN} session.
24272 This assumes all the files you debug during this @value{GDBN} session will come
24273 from trusted sources.
24274
24275 @item @kbd{./configure --without-auto-load-safe-path}
24276 During compilation of @value{GDBN} you may disable any auto-loading safety.
24277 This assumes all the files you will ever debug with this @value{GDBN} come from
24278 trusted sources.
24279 @end table
24280
24281 On the other hand you can also explicitly forbid automatic files loading which
24282 also suppresses any such warning messages:
24283
24284 @table @asis
24285 @item @kbd{gdb -iex "set auto-load no" @dots{}}
24286 You can use @value{GDBN} command-line option for a single @value{GDBN} session.
24287
24288 @item @file{~/.gdbinit}: @samp{set auto-load no}
24289 Disable auto-loading globally for the user
24290 (@pxref{Home Directory Init File}).  While it is improbable, you could also
24291 use system init file instead (@pxref{System-wide configuration}).
24292 @end table
24293
24294 This setting applies to the file names as entered by user.  If no entry matches
24295 @value{GDBN} tries as a last resort to also resolve all the file names into
24296 their canonical form (typically resolving symbolic links) and compare the
24297 entries again.  @value{GDBN} already canonicalizes most of the filenames on its
24298 own before starting the comparison so a canonical form of directories is
24299 recommended to be entered.
24300
24301 @node Auto-loading verbose mode
24302 @subsection Displaying files tried for auto-load
24303 @cindex auto-loading verbose mode
24304
24305 For better visibility of all the file locations where you can place scripts to
24306 be auto-loaded with inferior --- or to protect yourself against accidental
24307 execution of untrusted scripts --- @value{GDBN} provides a feature for printing
24308 all the files attempted to be loaded.  Both existing and non-existing files may
24309 be printed.
24310
24311 For example the list of directories from which it is safe to auto-load files
24312 (@pxref{Auto-loading safe path}) applies also to canonicalized filenames which
24313 may not be too obvious while setting it up.
24314
24315 @smallexample
24316 (gdb) set debug auto-load on
24317 (gdb) file ~/src/t/true
24318 auto-load: Loading canned sequences of commands script "/tmp/true-gdb.gdb"
24319            for objfile "/tmp/true".
24320 auto-load: Updating directories of "/usr:/opt".
24321 auto-load: Using directory "/usr".
24322 auto-load: Using directory "/opt".
24323 warning: File "/tmp/true-gdb.gdb" auto-loading has been declined
24324          by your `auto-load safe-path' set to "/usr:/opt".
24325 @end smallexample
24326
24327 @table @code
24328 @anchor{set debug auto-load}
24329 @kindex set debug auto-load
24330 @item set debug auto-load [on|off]
24331 Set whether to print the filenames attempted to be auto-loaded.
24332
24333 @anchor{show debug auto-load}
24334 @kindex show debug auto-load
24335 @item show debug auto-load
24336 Show whether printing of the filenames attempted to be auto-loaded is turned
24337 on or off.
24338 @end table
24339
24340 @node Messages/Warnings
24341 @section Optional Warnings and Messages
24342
24343 @cindex verbose operation
24344 @cindex optional warnings
24345 By default, @value{GDBN} is silent about its inner workings.  If you are
24346 running on a slow machine, you may want to use the @code{set verbose}
24347 command.  This makes @value{GDBN} tell you when it does a lengthy
24348 internal operation, so you will not think it has crashed.
24349
24350 Currently, the messages controlled by @code{set verbose} are those
24351 which announce that the symbol table for a source file is being read;
24352 see @code{symbol-file} in @ref{Files, ,Commands to Specify Files}.
24353
24354 @table @code
24355 @kindex set verbose
24356 @item set verbose on
24357 Enables @value{GDBN} output of certain informational messages.
24358
24359 @item set verbose off
24360 Disables @value{GDBN} output of certain informational messages.
24361
24362 @kindex show verbose
24363 @item show verbose
24364 Displays whether @code{set verbose} is on or off.
24365 @end table
24366
24367 By default, if @value{GDBN} encounters bugs in the symbol table of an
24368 object file, it is silent; but if you are debugging a compiler, you may
24369 find this information useful (@pxref{Symbol Errors, ,Errors Reading
24370 Symbol Files}).
24371
24372 @table @code
24373
24374 @kindex set complaints
24375 @item set complaints @var{limit}
24376 Permits @value{GDBN} to output @var{limit} complaints about each type of
24377 unusual symbols before becoming silent about the problem.  Set
24378 @var{limit} to zero to suppress all complaints; set it to a large number
24379 to prevent complaints from being suppressed.
24380
24381 @kindex show complaints
24382 @item show complaints
24383 Displays how many symbol complaints @value{GDBN} is permitted to produce.
24384
24385 @end table
24386
24387 @anchor{confirmation requests}
24388 By default, @value{GDBN} is cautious, and asks what sometimes seems to be a
24389 lot of stupid questions to confirm certain commands.  For example, if
24390 you try to run a program which is already running:
24391
24392 @smallexample
24393 (@value{GDBP}) run
24394 The program being debugged has been started already.
24395 Start it from the beginning? (y or n)
24396 @end smallexample
24397
24398 If you are willing to unflinchingly face the consequences of your own
24399 commands, you can disable this ``feature'':
24400
24401 @table @code
24402
24403 @kindex set confirm
24404 @cindex flinching
24405 @cindex confirmation
24406 @cindex stupid questions
24407 @item set confirm off
24408 Disables confirmation requests.  Note that running @value{GDBN} with
24409 the @option{--batch} option (@pxref{Mode Options, -batch}) also
24410 automatically disables confirmation requests.
24411
24412 @item set confirm on
24413 Enables confirmation requests (the default).
24414
24415 @kindex show confirm
24416 @item show confirm
24417 Displays state of confirmation requests.
24418
24419 @end table
24420
24421 @cindex command tracing
24422 If you need to debug user-defined commands or sourced files you may find it
24423 useful to enable @dfn{command tracing}.  In this mode each command will be
24424 printed as it is executed, prefixed with one or more @samp{+} symbols, the
24425 quantity denoting the call depth of each command.
24426
24427 @table @code
24428 @kindex set trace-commands
24429 @cindex command scripts, debugging
24430 @item set trace-commands on
24431 Enable command tracing.
24432 @item set trace-commands off
24433 Disable command tracing.
24434 @item show trace-commands
24435 Display the current state of command tracing.
24436 @end table
24437
24438 @node Debugging Output
24439 @section Optional Messages about Internal Happenings
24440 @cindex optional debugging messages
24441
24442 @value{GDBN} has commands that enable optional debugging messages from
24443 various @value{GDBN} subsystems; normally these commands are of
24444 interest to @value{GDBN} maintainers, or when reporting a bug.  This
24445 section documents those commands.
24446
24447 @table @code
24448 @kindex set exec-done-display
24449 @item set exec-done-display
24450 Turns on or off the notification of asynchronous commands'
24451 completion.  When on, @value{GDBN} will print a message when an
24452 asynchronous command finishes its execution.  The default is off.
24453 @kindex show exec-done-display
24454 @item show exec-done-display
24455 Displays the current setting of asynchronous command completion
24456 notification.
24457 @kindex set debug
24458 @cindex ARM AArch64
24459 @item set debug aarch64
24460 Turns on or off display of debugging messages related to ARM AArch64.
24461 The default is off.
24462 @kindex show debug
24463 @item show debug aarch64
24464 Displays the current state of displaying debugging messages related to
24465 ARM AArch64.
24466 @cindex gdbarch debugging info
24467 @cindex architecture debugging info
24468 @item set debug arch
24469 Turns on or off display of gdbarch debugging info.  The default is off
24470 @item show debug arch
24471 Displays the current state of displaying gdbarch debugging info.
24472 @item set debug aix-solib
24473 @cindex AIX shared library debugging
24474 Control display of debugging messages from the AIX shared library
24475 support module.  The default is off.
24476 @item show debug aix-thread
24477 Show the current state of displaying AIX shared library debugging messages.
24478 @item set debug aix-thread
24479 @cindex AIX threads
24480 Display debugging messages about inner workings of the AIX thread
24481 module.
24482 @item show debug aix-thread
24483 Show the current state of AIX thread debugging info display.
24484 @item set debug check-physname
24485 @cindex physname
24486 Check the results of the ``physname'' computation.  When reading DWARF
24487 debugging information for C@t{++}, @value{GDBN} attempts to compute
24488 each entity's name.  @value{GDBN} can do this computation in two
24489 different ways, depending on exactly what information is present.
24490 When enabled, this setting causes @value{GDBN} to compute the names
24491 both ways and display any discrepancies.
24492 @item show debug check-physname
24493 Show the current state of ``physname'' checking.
24494 @item set debug coff-pe-read
24495 @cindex COFF/PE exported symbols
24496 Control display of debugging messages related to reading of COFF/PE
24497 exported symbols.  The default is off.
24498 @item show debug coff-pe-read
24499 Displays the current state of displaying debugging messages related to
24500 reading of COFF/PE exported symbols.
24501 @item set debug dwarf-die
24502 @cindex DWARF DIEs
24503 Dump DWARF DIEs after they are read in.
24504 The value is the number of nesting levels to print.
24505 A value of zero turns off the display.
24506 @item show debug dwarf-die
24507 Show the current state of DWARF DIE debugging.
24508 @item set debug dwarf-line
24509 @cindex DWARF Line Tables
24510 Turns on or off display of debugging messages related to reading
24511 DWARF line tables.  The default is 0 (off).
24512 A value of 1 provides basic information.
24513 A value greater than 1 provides more verbose information.
24514 @item show debug dwarf-line
24515 Show the current state of DWARF line table debugging.
24516 @item set debug dwarf-read
24517 @cindex DWARF Reading
24518 Turns on or off display of debugging messages related to reading
24519 DWARF debug info.  The default is 0 (off).
24520 A value of 1 provides basic information.
24521 A value greater than 1 provides more verbose information.
24522 @item show debug dwarf-read
24523 Show the current state of DWARF reader debugging.
24524 @item set debug displaced
24525 @cindex displaced stepping debugging info
24526 Turns on or off display of @value{GDBN} debugging info for the
24527 displaced stepping support.  The default is off.
24528 @item show debug displaced
24529 Displays the current state of displaying @value{GDBN} debugging info
24530 related to displaced stepping.
24531 @item set debug event
24532 @cindex event debugging info
24533 Turns on or off display of @value{GDBN} event debugging info.  The
24534 default is off.
24535 @item show debug event
24536 Displays the current state of displaying @value{GDBN} event debugging
24537 info.
24538 @item set debug expression
24539 @cindex expression debugging info
24540 Turns on or off display of debugging info about @value{GDBN}
24541 expression parsing.  The default is off.
24542 @item show debug expression
24543 Displays the current state of displaying debugging info about
24544 @value{GDBN} expression parsing.
24545 @item set debug fbsd-lwp
24546 @cindex FreeBSD LWP debug messages
24547 Turns on or off debugging messages from the FreeBSD LWP debug support.
24548 @item show debug fbsd-lwp
24549 Show the current state of FreeBSD LWP debugging messages.
24550 @item set debug frame
24551 @cindex frame debugging info
24552 Turns on or off display of @value{GDBN} frame debugging info.  The
24553 default is off.
24554 @item show debug frame
24555 Displays the current state of displaying @value{GDBN} frame debugging
24556 info.
24557 @item set debug gnu-nat
24558 @cindex @sc{gnu}/Hurd debug messages
24559 Turn on or off debugging messages from the @sc{gnu}/Hurd debug support.
24560 @item show debug gnu-nat
24561 Show the current state of @sc{gnu}/Hurd debugging messages.
24562 @item set debug infrun
24563 @cindex inferior debugging info
24564 Turns on or off display of @value{GDBN} debugging info for running the inferior.
24565 The default is off.  @file{infrun.c} contains GDB's runtime state machine used 
24566 for implementing operations such as single-stepping the inferior.
24567 @item show debug infrun
24568 Displays the current state of @value{GDBN} inferior debugging.
24569 @item set debug jit
24570 @cindex just-in-time compilation, debugging messages
24571 Turn on or off debugging messages from JIT debug support.
24572 @item show debug jit
24573 Displays the current state of @value{GDBN} JIT debugging.
24574 @item set debug lin-lwp
24575 @cindex @sc{gnu}/Linux LWP debug messages
24576 @cindex Linux lightweight processes
24577 Turn on or off debugging messages from the Linux LWP debug support.
24578 @item show debug lin-lwp
24579 Show the current state of Linux LWP debugging messages.
24580 @item set debug linux-namespaces
24581 @cindex @sc{gnu}/Linux namespaces debug messages
24582 Turn on or off debugging messages from the Linux namespaces debug support.
24583 @item show debug linux-namespaces
24584 Show the current state of Linux namespaces debugging messages.
24585 @item set debug mach-o
24586 @cindex Mach-O symbols processing
24587 Control display of debugging messages related to Mach-O symbols
24588 processing.  The default is off.
24589 @item show debug mach-o
24590 Displays the current state of displaying debugging messages related to
24591 reading of COFF/PE exported symbols.
24592 @item set debug notification
24593 @cindex remote async notification debugging info
24594 Turn on or off debugging messages about remote async notification.
24595 The default is off.
24596 @item show debug notification
24597 Displays the current state of remote async notification debugging messages.
24598 @item set debug observer
24599 @cindex observer debugging info
24600 Turns on or off display of @value{GDBN} observer debugging.  This
24601 includes info such as the notification of observable events.
24602 @item show debug observer
24603 Displays the current state of observer debugging.
24604 @item set debug overload
24605 @cindex C@t{++} overload debugging info
24606 Turns on or off display of @value{GDBN} C@t{++} overload debugging
24607 info. This includes info such as ranking of functions, etc.  The default
24608 is off.
24609 @item show debug overload
24610 Displays the current state of displaying @value{GDBN} C@t{++} overload
24611 debugging info.
24612 @cindex expression parser, debugging info
24613 @cindex debug expression parser
24614 @item set debug parser
24615 Turns on or off the display of expression parser debugging output.
24616 Internally, this sets the @code{yydebug} variable in the expression
24617 parser.  @xref{Tracing, , Tracing Your Parser, bison, Bison}, for
24618 details.  The default is off.
24619 @item show debug parser
24620 Show the current state of expression parser debugging.
24621 @cindex packets, reporting on stdout
24622 @cindex serial connections, debugging
24623 @cindex debug remote protocol
24624 @cindex remote protocol debugging
24625 @cindex display remote packets
24626 @item set debug remote
24627 Turns on or off display of reports on all packets sent back and forth across
24628 the serial line to the remote machine.  The info is printed on the
24629 @value{GDBN} standard output stream. The default is off.
24630 @item show debug remote
24631 Displays the state of display of remote packets.
24632
24633 @item set debug separate-debug-file
24634 Turns on or off display of debug output about separate debug file search.
24635 @item show debug separate-debug-file
24636 Displays the state of separate debug file search debug output.
24637
24638 @item set debug serial
24639 Turns on or off display of @value{GDBN} serial debugging info. The
24640 default is off.
24641 @item show debug serial
24642 Displays the current state of displaying @value{GDBN} serial debugging
24643 info.
24644 @item set debug solib-frv
24645 @cindex FR-V shared-library debugging
24646 Turn on or off debugging messages for FR-V shared-library code.
24647 @item show debug solib-frv
24648 Display the current state of FR-V shared-library code debugging
24649 messages.
24650 @item set debug symbol-lookup
24651 @cindex symbol lookup
24652 Turns on or off display of debugging messages related to symbol lookup.
24653 The default is 0 (off).
24654 A value of 1 provides basic information.
24655 A value greater than 1 provides more verbose information.
24656 @item show debug symbol-lookup
24657 Show the current state of symbol lookup debugging messages.
24658 @item set debug symfile
24659 @cindex symbol file functions
24660 Turns on or off display of debugging messages related to symbol file functions.
24661 The default is off.  @xref{Files}.
24662 @item show debug symfile
24663 Show the current state of symbol file debugging messages.
24664 @item set debug symtab-create
24665 @cindex symbol table creation
24666 Turns on or off display of debugging messages related to symbol table creation.
24667 The default is 0 (off).
24668 A value of 1 provides basic information.
24669 A value greater than 1 provides more verbose information.
24670 @item show debug symtab-create
24671 Show the current state of symbol table creation debugging.
24672 @item set debug target
24673 @cindex target debugging info
24674 Turns on or off display of @value{GDBN} target debugging info. This info
24675 includes what is going on at the target level of GDB, as it happens. The
24676 default is 0.  Set it to 1 to track events, and to 2 to also track the
24677 value of large memory transfers.
24678 @item show debug target
24679 Displays the current state of displaying @value{GDBN} target debugging
24680 info.
24681 @item set debug timestamp
24682 @cindex timestampping debugging info
24683 Turns on or off display of timestamps with @value{GDBN} debugging info.
24684 When enabled, seconds and microseconds are displayed before each debugging
24685 message.
24686 @item show debug timestamp
24687 Displays the current state of displaying timestamps with @value{GDBN}
24688 debugging info.
24689 @item set debug varobj
24690 @cindex variable object debugging info
24691 Turns on or off display of @value{GDBN} variable object debugging
24692 info. The default is off.
24693 @item show debug varobj
24694 Displays the current state of displaying @value{GDBN} variable object
24695 debugging info.
24696 @item set debug xml
24697 @cindex XML parser debugging
24698 Turn on or off debugging messages for built-in XML parsers.
24699 @item show debug xml
24700 Displays the current state of XML debugging messages.
24701 @end table
24702
24703 @node Other Misc Settings
24704 @section Other Miscellaneous Settings
24705 @cindex miscellaneous settings
24706
24707 @table @code
24708 @kindex set interactive-mode
24709 @item set interactive-mode
24710 If @code{on}, forces @value{GDBN} to assume that GDB was started
24711 in a terminal.  In practice, this means that @value{GDBN} should wait
24712 for the user to answer queries generated by commands entered at
24713 the command prompt.  If @code{off}, forces @value{GDBN} to operate
24714 in the opposite mode, and it uses the default answers to all queries.
24715 If @code{auto} (the default), @value{GDBN} tries to determine whether
24716 its standard input is a terminal, and works in interactive-mode if it
24717 is, non-interactively otherwise.
24718
24719 In the vast majority of cases, the debugger should be able to guess
24720 correctly which mode should be used.  But this setting can be useful
24721 in certain specific cases, such as running a MinGW @value{GDBN}
24722 inside a cygwin window.
24723
24724 @kindex show interactive-mode
24725 @item show interactive-mode
24726 Displays whether the debugger is operating in interactive mode or not.
24727 @end table
24728
24729 @node Extending GDB
24730 @chapter Extending @value{GDBN}
24731 @cindex extending GDB
24732
24733 @value{GDBN} provides several mechanisms for extension.
24734 @value{GDBN} also provides the ability to automatically load
24735 extensions when it reads a file for debugging.  This allows the
24736 user to automatically customize @value{GDBN} for the program
24737 being debugged.
24738
24739 @menu
24740 * Sequences::                Canned Sequences of @value{GDBN} Commands
24741 * Python::                   Extending @value{GDBN} using Python
24742 * Guile::                    Extending @value{GDBN} using Guile
24743 * Auto-loading extensions::  Automatically loading extensions
24744 * Multiple Extension Languages:: Working with multiple extension languages
24745 * Aliases::                  Creating new spellings of existing commands
24746 @end menu
24747
24748 To facilitate the use of extension languages, @value{GDBN} is capable
24749 of evaluating the contents of a file.  When doing so, @value{GDBN}
24750 can recognize which extension language is being used by looking at
24751 the filename extension.  Files with an unrecognized filename extension
24752 are always treated as a @value{GDBN} Command Files.
24753 @xref{Command Files,, Command files}.
24754
24755 You can control how @value{GDBN} evaluates these files with the following
24756 setting:
24757
24758 @table @code
24759 @kindex set script-extension
24760 @kindex show script-extension
24761 @item set script-extension off
24762 All scripts are always evaluated as @value{GDBN} Command Files.
24763
24764 @item set script-extension soft
24765 The debugger determines the scripting language based on filename
24766 extension.  If this scripting language is supported, @value{GDBN}
24767 evaluates the script using that language.  Otherwise, it evaluates
24768 the file as a @value{GDBN} Command File.
24769
24770 @item set script-extension strict
24771 The debugger determines the scripting language based on filename
24772 extension, and evaluates the script using that language.  If the
24773 language is not supported, then the evaluation fails.
24774
24775 @item show script-extension
24776 Display the current value of the @code{script-extension} option.
24777
24778 @end table
24779
24780 @node Sequences
24781 @section Canned Sequences of Commands
24782
24783 Aside from breakpoint commands (@pxref{Break Commands, ,Breakpoint
24784 Command Lists}), @value{GDBN} provides two ways to store sequences of
24785 commands for execution as a unit: user-defined commands and command
24786 files.
24787
24788 @menu
24789 * Define::             How to define your own commands
24790 * Hooks::              Hooks for user-defined commands
24791 * Command Files::      How to write scripts of commands to be stored in a file
24792 * Output::             Commands for controlled output
24793 * Auto-loading sequences::  Controlling auto-loaded command files
24794 @end menu
24795
24796 @node Define
24797 @subsection User-defined Commands
24798
24799 @cindex user-defined command
24800 @cindex arguments, to user-defined commands
24801 A @dfn{user-defined command} is a sequence of @value{GDBN} commands to
24802 which you assign a new name as a command.  This is done with the
24803 @code{define} command.  User commands may accept an unlimited number of arguments
24804 separated by whitespace.  Arguments are accessed within the user command
24805 via @code{$arg0@dots{}$argN}.  A trivial example:
24806
24807 @smallexample
24808 define adder
24809   print $arg0 + $arg1 + $arg2
24810 end
24811 @end smallexample
24812
24813 @noindent
24814 To execute the command use:
24815
24816 @smallexample
24817 adder 1 2 3
24818 @end smallexample
24819
24820 @noindent
24821 This defines the command @code{adder}, which prints the sum of
24822 its three arguments.  Note the arguments are text substitutions, so they may
24823 reference variables, use complex expressions, or even perform inferior
24824 functions calls.
24825
24826 @cindex argument count in user-defined commands
24827 @cindex how many arguments (user-defined commands)
24828 In addition, @code{$argc} may be used to find out how many arguments have
24829 been passed.
24830
24831 @smallexample
24832 define adder
24833   if $argc == 2
24834     print $arg0 + $arg1
24835   end
24836   if $argc == 3
24837     print $arg0 + $arg1 + $arg2
24838   end
24839 end
24840 @end smallexample
24841
24842 Combining with the @code{eval} command (@pxref{eval}) makes it easier
24843 to process a variable number of arguments:
24844
24845 @smallexample
24846 define adder
24847   set $i = 0
24848   set $sum = 0
24849   while $i < $argc
24850     eval "set $sum = $sum + $arg%d", $i
24851     set $i = $i + 1
24852   end
24853   print $sum
24854 end
24855 @end smallexample
24856
24857 @table @code
24858
24859 @kindex define
24860 @item define @var{commandname}
24861 Define a command named @var{commandname}.  If there is already a command
24862 by that name, you are asked to confirm that you want to redefine it.
24863 The argument @var{commandname} may be a bare command name consisting of letters,
24864 numbers, dashes, and underscores.  It may also start with any predefined
24865 prefix command.  For example, @samp{define target my-target} creates
24866 a user-defined @samp{target my-target} command.
24867
24868 The definition of the command is made up of other @value{GDBN} command lines,
24869 which are given following the @code{define} command.  The end of these
24870 commands is marked by a line containing @code{end}.
24871
24872 @kindex document
24873 @kindex end@r{ (user-defined commands)}
24874 @item document @var{commandname}
24875 Document the user-defined command @var{commandname}, so that it can be
24876 accessed by @code{help}.  The command @var{commandname} must already be
24877 defined.  This command reads lines of documentation just as @code{define}
24878 reads the lines of the command definition, ending with @code{end}.
24879 After the @code{document} command is finished, @code{help} on command
24880 @var{commandname} displays the documentation you have written.
24881
24882 You may use the @code{document} command again to change the
24883 documentation of a command.  Redefining the command with @code{define}
24884 does not change the documentation.
24885
24886 @kindex dont-repeat
24887 @cindex don't repeat command
24888 @item dont-repeat
24889 Used inside a user-defined command, this tells @value{GDBN} that this
24890 command should not be repeated when the user hits @key{RET}
24891 (@pxref{Command Syntax, repeat last command}).
24892
24893 @kindex help user-defined
24894 @item help user-defined
24895 List all user-defined commands and all python commands defined in class
24896 COMAND_USER.  The first line of the documentation or docstring is
24897 included (if any).
24898
24899 @kindex show user
24900 @item show user
24901 @itemx show user @var{commandname}
24902 Display the @value{GDBN} commands used to define @var{commandname} (but
24903 not its documentation).  If no @var{commandname} is given, display the
24904 definitions for all user-defined commands.
24905 This does not work for user-defined python commands.
24906
24907 @cindex infinite recursion in user-defined commands
24908 @kindex show max-user-call-depth
24909 @kindex set max-user-call-depth
24910 @item show max-user-call-depth
24911 @itemx set max-user-call-depth
24912 The value of @code{max-user-call-depth} controls how many recursion
24913 levels are allowed in user-defined commands before @value{GDBN} suspects an
24914 infinite recursion and aborts the command.
24915 This does not apply to user-defined python commands.
24916 @end table
24917
24918 In addition to the above commands, user-defined commands frequently
24919 use control flow commands, described in @ref{Command Files}.
24920
24921 When user-defined commands are executed, the
24922 commands of the definition are not printed.  An error in any command
24923 stops execution of the user-defined command.
24924
24925 If used interactively, commands that would ask for confirmation proceed
24926 without asking when used inside a user-defined command.  Many @value{GDBN}
24927 commands that normally print messages to say what they are doing omit the
24928 messages when used in a user-defined command.
24929
24930 @node Hooks
24931 @subsection User-defined Command Hooks
24932 @cindex command hooks
24933 @cindex hooks, for commands
24934 @cindex hooks, pre-command
24935
24936 @kindex hook
24937 You may define @dfn{hooks}, which are a special kind of user-defined
24938 command.  Whenever you run the command @samp{foo}, if the user-defined
24939 command @samp{hook-foo} exists, it is executed (with no arguments)
24940 before that command.
24941
24942 @cindex hooks, post-command
24943 @kindex hookpost
24944 A hook may also be defined which is run after the command you executed.
24945 Whenever you run the command @samp{foo}, if the user-defined command
24946 @samp{hookpost-foo} exists, it is executed (with no arguments) after
24947 that command.  Post-execution hooks may exist simultaneously with
24948 pre-execution hooks, for the same command.
24949
24950 It is valid for a hook to call the command which it hooks.  If this
24951 occurs, the hook is not re-executed, thereby avoiding infinite recursion.
24952
24953 @c It would be nice if hookpost could be passed a parameter indicating
24954 @c if the command it hooks executed properly or not.  FIXME!
24955
24956 @kindex stop@r{, a pseudo-command}
24957 In addition, a pseudo-command, @samp{stop} exists.  Defining
24958 (@samp{hook-stop}) makes the associated commands execute every time
24959 execution stops in your program: before breakpoint commands are run,
24960 displays are printed, or the stack frame is printed.
24961
24962 For example, to ignore @code{SIGALRM} signals while
24963 single-stepping, but treat them normally during normal execution,
24964 you could define:
24965
24966 @smallexample
24967 define hook-stop
24968 handle SIGALRM nopass
24969 end
24970
24971 define hook-run
24972 handle SIGALRM pass
24973 end
24974
24975 define hook-continue
24976 handle SIGALRM pass
24977 end
24978 @end smallexample
24979
24980 As a further example, to hook at the beginning and end of the @code{echo}
24981 command, and to add extra text to the beginning and end of the message,
24982 you could define:
24983
24984 @smallexample
24985 define hook-echo
24986 echo <<<---
24987 end
24988
24989 define hookpost-echo
24990 echo --->>>\n
24991 end
24992
24993 (@value{GDBP}) echo Hello World
24994 <<<---Hello World--->>>
24995 (@value{GDBP})
24996
24997 @end smallexample
24998
24999 You can define a hook for any single-word command in @value{GDBN}, but
25000 not for command aliases; you should define a hook for the basic command
25001 name, e.g.@:  @code{backtrace} rather than @code{bt}.
25002 @c FIXME!  So how does Joe User discover whether a command is an alias
25003 @c or not?
25004 You can hook a multi-word command by adding @code{hook-} or
25005 @code{hookpost-} to the last word of the command, e.g.@:
25006 @samp{define target hook-remote} to add a hook to @samp{target remote}.
25007
25008 If an error occurs during the execution of your hook, execution of
25009 @value{GDBN} commands stops and @value{GDBN} issues a prompt
25010 (before the command that you actually typed had a chance to run).
25011
25012 If you try to define a hook which does not match any known command, you
25013 get a warning from the @code{define} command.
25014
25015 @node Command Files
25016 @subsection Command Files
25017
25018 @cindex command files
25019 @cindex scripting commands
25020 A command file for @value{GDBN} is a text file made of lines that are
25021 @value{GDBN} commands.  Comments (lines starting with @kbd{#}) may
25022 also be included.  An empty line in a command file does nothing; it
25023 does not mean to repeat the last command, as it would from the
25024 terminal.
25025
25026 You can request the execution of a command file with the @code{source}
25027 command.  Note that the @code{source} command is also used to evaluate
25028 scripts that are not Command Files.  The exact behavior can be configured
25029 using the @code{script-extension} setting.
25030 @xref{Extending GDB,, Extending GDB}.
25031
25032 @table @code
25033 @kindex source
25034 @cindex execute commands from a file
25035 @item source [-s] [-v] @var{filename}
25036 Execute the command file @var{filename}.
25037 @end table
25038
25039 The lines in a command file are generally executed sequentially,
25040 unless the order of execution is changed by one of the
25041 @emph{flow-control commands} described below.  The commands are not
25042 printed as they are executed.  An error in any command terminates
25043 execution of the command file and control is returned to the console.
25044
25045 @value{GDBN} first searches for @var{filename} in the current directory.
25046 If the file is not found there, and @var{filename} does not specify a
25047 directory, then @value{GDBN} also looks for the file on the source search path
25048 (specified with the @samp{directory} command);
25049 except that @file{$cdir} is not searched because the compilation directory
25050 is not relevant to scripts.
25051
25052 If @code{-s} is specified, then @value{GDBN} searches for @var{filename}
25053 on the search path even if @var{filename} specifies a directory.
25054 The search is done by appending @var{filename} to each element of the
25055 search path.  So, for example, if @var{filename} is @file{mylib/myscript}
25056 and the search path contains @file{/home/user} then @value{GDBN} will
25057 look for the script @file{/home/user/mylib/myscript}.
25058 The search is also done if @var{filename} is an absolute path.
25059 For example, if @var{filename} is @file{/tmp/myscript} and
25060 the search path contains @file{/home/user} then @value{GDBN} will
25061 look for the script @file{/home/user/tmp/myscript}.
25062 For DOS-like systems, if @var{filename} contains a drive specification,
25063 it is stripped before concatenation.  For example, if @var{filename} is
25064 @file{d:myscript} and the search path contains @file{c:/tmp} then @value{GDBN}
25065 will look for the script @file{c:/tmp/myscript}.
25066
25067 If @code{-v}, for verbose mode, is given then @value{GDBN} displays
25068 each command as it is executed.  The option must be given before
25069 @var{filename}, and is interpreted as part of the filename anywhere else.
25070
25071 Commands that would ask for confirmation if used interactively proceed
25072 without asking when used in a command file.  Many @value{GDBN} commands that
25073 normally print messages to say what they are doing omit the messages
25074 when called from command files.
25075
25076 @value{GDBN} also accepts command input from standard input.  In this
25077 mode, normal output goes to standard output and error output goes to
25078 standard error.  Errors in a command file supplied on standard input do
25079 not terminate execution of the command file---execution continues with
25080 the next command.
25081
25082 @smallexample
25083 gdb < cmds > log 2>&1
25084 @end smallexample
25085
25086 (The syntax above will vary depending on the shell used.) This example
25087 will execute commands from the file @file{cmds}. All output and errors
25088 would be directed to @file{log}.
25089
25090 Since commands stored on command files tend to be more general than
25091 commands typed interactively, they frequently need to deal with
25092 complicated situations, such as different or unexpected values of
25093 variables and symbols, changes in how the program being debugged is
25094 built, etc.  @value{GDBN} provides a set of flow-control commands to
25095 deal with these complexities.  Using these commands, you can write
25096 complex scripts that loop over data structures, execute commands
25097 conditionally, etc.
25098
25099 @table @code
25100 @kindex if
25101 @kindex else
25102 @item if
25103 @itemx else
25104 This command allows to include in your script conditionally executed
25105 commands. The @code{if} command takes a single argument, which is an
25106 expression to evaluate.  It is followed by a series of commands that
25107 are executed only if the expression is true (its value is nonzero).
25108 There can then optionally be an @code{else} line, followed by a series
25109 of commands that are only executed if the expression was false.  The
25110 end of the list is marked by a line containing @code{end}.
25111
25112 @kindex while
25113 @item while
25114 This command allows to write loops.  Its syntax is similar to
25115 @code{if}: the command takes a single argument, which is an expression
25116 to evaluate, and must be followed by the commands to execute, one per
25117 line, terminated by an @code{end}.  These commands are called the
25118 @dfn{body} of the loop.  The commands in the body of @code{while} are
25119 executed repeatedly as long as the expression evaluates to true.
25120
25121 @kindex loop_break
25122 @item loop_break
25123 This command exits the @code{while} loop in whose body it is included.
25124 Execution of the script continues after that @code{while}s @code{end}
25125 line.
25126
25127 @kindex loop_continue
25128 @item loop_continue
25129 This command skips the execution of the rest of the body of commands
25130 in the @code{while} loop in whose body it is included.  Execution
25131 branches to the beginning of the @code{while} loop, where it evaluates
25132 the controlling expression.
25133
25134 @kindex end@r{ (if/else/while commands)}
25135 @item end
25136 Terminate the block of commands that are the body of @code{if},
25137 @code{else}, or @code{while} flow-control commands.
25138 @end table
25139
25140
25141 @node Output
25142 @subsection Commands for Controlled Output
25143
25144 During the execution of a command file or a user-defined command, normal
25145 @value{GDBN} output is suppressed; the only output that appears is what is
25146 explicitly printed by the commands in the definition.  This section
25147 describes three commands useful for generating exactly the output you
25148 want.
25149
25150 @table @code
25151 @kindex echo
25152 @item echo @var{text}
25153 @c I do not consider backslash-space a standard C escape sequence
25154 @c because it is not in ANSI.
25155 Print @var{text}.  Nonprinting characters can be included in
25156 @var{text} using C escape sequences, such as @samp{\n} to print a
25157 newline.  @strong{No newline is printed unless you specify one.}
25158 In addition to the standard C escape sequences, a backslash followed
25159 by a space stands for a space.  This is useful for displaying a
25160 string with spaces at the beginning or the end, since leading and
25161 trailing spaces are otherwise trimmed from all arguments.
25162 To print @samp{@w{ }and foo =@w{ }}, use the command
25163 @samp{echo \@w{ }and foo = \@w{ }}.
25164
25165 A backslash at the end of @var{text} can be used, as in C, to continue
25166 the command onto subsequent lines.  For example,
25167
25168 @smallexample
25169 echo This is some text\n\
25170 which is continued\n\
25171 onto several lines.\n
25172 @end smallexample
25173
25174 produces the same output as
25175
25176 @smallexample
25177 echo This is some text\n
25178 echo which is continued\n
25179 echo onto several lines.\n
25180 @end smallexample
25181
25182 @kindex output
25183 @item output @var{expression}
25184 Print the value of @var{expression} and nothing but that value: no
25185 newlines, no @samp{$@var{nn} = }.  The value is not entered in the
25186 value history either.  @xref{Expressions, ,Expressions}, for more information
25187 on expressions.
25188
25189 @item output/@var{fmt} @var{expression}
25190 Print the value of @var{expression} in format @var{fmt}.  You can use
25191 the same formats as for @code{print}.  @xref{Output Formats,,Output
25192 Formats}, for more information.
25193
25194 @kindex printf
25195 @item printf @var{template}, @var{expressions}@dots{}
25196 Print the values of one or more @var{expressions} under the control of
25197 the string @var{template}.  To print several values, make
25198 @var{expressions} be a comma-separated list of individual expressions,
25199 which may be either numbers or pointers.  Their values are printed as
25200 specified by @var{template}, exactly as a C program would do by
25201 executing the code below:
25202
25203 @smallexample
25204 printf (@var{template}, @var{expressions}@dots{});
25205 @end smallexample
25206
25207 As in @code{C} @code{printf}, ordinary characters in @var{template}
25208 are printed verbatim, while @dfn{conversion specification} introduced
25209 by the @samp{%} character cause subsequent @var{expressions} to be
25210 evaluated, their values converted and formatted according to type and
25211 style information encoded in the conversion specifications, and then
25212 printed.
25213
25214 For example, you can print two values in hex like this:
25215
25216 @smallexample
25217 printf "foo, bar-foo = 0x%x, 0x%x\n", foo, bar-foo
25218 @end smallexample
25219
25220 @code{printf} supports all the standard @code{C} conversion
25221 specifications, including the flags and modifiers between the @samp{%}
25222 character and the conversion letter, with the following exceptions:
25223
25224 @itemize @bullet
25225 @item
25226 The argument-ordering modifiers, such as @samp{2$}, are not supported.
25227
25228 @item
25229 The modifier @samp{*} is not supported for specifying precision or
25230 width.
25231
25232 @item
25233 The @samp{'} flag (for separation of digits into groups according to
25234 @code{LC_NUMERIC'}) is not supported.
25235
25236 @item
25237 The type modifiers @samp{hh}, @samp{j}, @samp{t}, and @samp{z} are not
25238 supported.
25239
25240 @item
25241 The conversion letter @samp{n} (as in @samp{%n}) is not supported.
25242
25243 @item
25244 The conversion letters @samp{a} and @samp{A} are not supported.
25245 @end itemize
25246
25247 @noindent
25248 Note that the @samp{ll} type modifier is supported only if the
25249 underlying @code{C} implementation used to build @value{GDBN} supports
25250 the @code{long long int} type, and the @samp{L} type modifier is
25251 supported only if @code{long double} type is available.
25252
25253 As in @code{C}, @code{printf} supports simple backslash-escape
25254 sequences, such as @code{\n}, @samp{\t}, @samp{\\}, @samp{\"},
25255 @samp{\a}, and @samp{\f}, that consist of backslash followed by a
25256 single character.  Octal and hexadecimal escape sequences are not
25257 supported.
25258
25259 Additionally, @code{printf} supports conversion specifications for DFP
25260 (@dfn{Decimal Floating Point}) types using the following length modifiers
25261 together with a floating point specifier.
25262 letters:
25263
25264 @itemize @bullet
25265 @item
25266 @samp{H} for printing @code{Decimal32} types.
25267
25268 @item
25269 @samp{D} for printing @code{Decimal64} types.
25270
25271 @item
25272 @samp{DD} for printing @code{Decimal128} types.
25273 @end itemize
25274
25275 If the underlying @code{C} implementation used to build @value{GDBN} has
25276 support for the three length modifiers for DFP types, other modifiers
25277 such as width and precision will also be available for @value{GDBN} to use.
25278
25279 In case there is no such @code{C} support, no additional modifiers will be
25280 available and the value will be printed in the standard way.
25281
25282 Here's an example of printing DFP types using the above conversion letters:
25283 @smallexample
25284 printf "D32: %Hf - D64: %Df - D128: %DDf\n",1.2345df,1.2E10dd,1.2E1dl
25285 @end smallexample
25286
25287 @anchor{eval}
25288 @kindex eval
25289 @item eval @var{template}, @var{expressions}@dots{}
25290 Convert the values of one or more @var{expressions} under the control of
25291 the string @var{template} to a command line, and call it.
25292
25293 @end table
25294
25295 @node Auto-loading sequences
25296 @subsection Controlling auto-loading native @value{GDBN} scripts
25297 @cindex native script auto-loading
25298
25299 When a new object file is read (for example, due to the @code{file}
25300 command, or because the inferior has loaded a shared library),
25301 @value{GDBN} will look for the command file @file{@var{objfile}-gdb.gdb}.
25302 @xref{Auto-loading extensions}.
25303
25304 Auto-loading can be enabled or disabled,
25305 and the list of auto-loaded scripts can be printed.
25306
25307 @table @code
25308 @anchor{set auto-load gdb-scripts}
25309 @kindex set auto-load gdb-scripts
25310 @item set auto-load gdb-scripts [on|off]
25311 Enable or disable the auto-loading of canned sequences of commands scripts.
25312
25313 @anchor{show auto-load gdb-scripts}
25314 @kindex show auto-load gdb-scripts
25315 @item show auto-load gdb-scripts
25316 Show whether auto-loading of canned sequences of commands scripts is enabled or
25317 disabled.
25318
25319 @anchor{info auto-load gdb-scripts}
25320 @kindex info auto-load gdb-scripts
25321 @cindex print list of auto-loaded canned sequences of commands scripts
25322 @item info auto-load gdb-scripts [@var{regexp}]
25323 Print the list of all canned sequences of commands scripts that @value{GDBN}
25324 auto-loaded.
25325 @end table
25326
25327 If @var{regexp} is supplied only canned sequences of commands scripts with
25328 matching names are printed.
25329
25330 @c Python docs live in a separate file.
25331 @include python.texi
25332
25333 @c Guile docs live in a separate file.
25334 @include guile.texi
25335
25336 @node Auto-loading extensions
25337 @section Auto-loading extensions
25338 @cindex auto-loading extensions
25339
25340 @value{GDBN} provides two mechanisms for automatically loading extensions
25341 when a new object file is read (for example, due to the @code{file}
25342 command, or because the inferior has loaded a shared library):
25343 @file{@var{objfile}-gdb.@var{ext}} and the @code{.debug_gdb_scripts}
25344 section of modern file formats like ELF.
25345
25346 @menu
25347 * objfile-gdb.ext file: objfile-gdbdotext file.  The @file{@var{objfile}-gdb.@var{ext}} file
25348 * .debug_gdb_scripts section: dotdebug_gdb_scripts section.  The @code{.debug_gdb_scripts} section
25349 * Which flavor to choose?::
25350 @end menu
25351
25352 The auto-loading feature is useful for supplying application-specific
25353 debugging commands and features.
25354
25355 Auto-loading can be enabled or disabled,
25356 and the list of auto-loaded scripts can be printed.
25357 See the @samp{auto-loading} section of each extension language
25358 for more information.
25359 For @value{GDBN} command files see @ref{Auto-loading sequences}.
25360 For Python files see @ref{Python Auto-loading}.
25361
25362 Note that loading of this script file also requires accordingly configured
25363 @code{auto-load safe-path} (@pxref{Auto-loading safe path}).
25364
25365 @node objfile-gdbdotext file
25366 @subsection The @file{@var{objfile}-gdb.@var{ext}} file
25367 @cindex @file{@var{objfile}-gdb.gdb}
25368 @cindex @file{@var{objfile}-gdb.py}
25369 @cindex @file{@var{objfile}-gdb.scm}
25370
25371 When a new object file is read, @value{GDBN} looks for a file named
25372 @file{@var{objfile}-gdb.@var{ext}} (we call it @var{script-name} below),
25373 where @var{objfile} is the object file's name and
25374 where @var{ext} is the file extension for the extension language:
25375
25376 @table @code
25377 @item @file{@var{objfile}-gdb.gdb}
25378 GDB's own command language
25379 @item @file{@var{objfile}-gdb.py}
25380 Python
25381 @item @file{@var{objfile}-gdb.scm}
25382 Guile
25383 @end table
25384
25385 @var{script-name} is formed by ensuring that the file name of @var{objfile}
25386 is absolute, following all symlinks, and resolving @code{.} and @code{..}
25387 components, and appending the @file{-gdb.@var{ext}} suffix.
25388 If this file exists and is readable, @value{GDBN} will evaluate it as a
25389 script in the specified extension language.
25390
25391 If this file does not exist, then @value{GDBN} will look for
25392 @var{script-name} file in all of the directories as specified below.
25393
25394 Note that loading of these files requires an accordingly configured
25395 @code{auto-load safe-path} (@pxref{Auto-loading safe path}).
25396
25397 For object files using @file{.exe} suffix @value{GDBN} tries to load first the
25398 scripts normally according to its @file{.exe} filename.  But if no scripts are
25399 found @value{GDBN} also tries script filenames matching the object file without
25400 its @file{.exe} suffix.  This @file{.exe} stripping is case insensitive and it
25401 is attempted on any platform.  This makes the script filenames compatible
25402 between Unix and MS-Windows hosts.
25403
25404 @table @code
25405 @anchor{set auto-load scripts-directory}
25406 @kindex set auto-load scripts-directory
25407 @item set auto-load scripts-directory @r{[}@var{directories}@r{]}
25408 Control @value{GDBN} auto-loaded scripts location.  Multiple directory entries
25409 may be delimited by the host platform path separator in use
25410 (@samp{:} on Unix, @samp{;} on MS-Windows and MS-DOS).
25411
25412 Each entry here needs to be covered also by the security setting
25413 @code{set auto-load safe-path} (@pxref{set auto-load safe-path}).
25414
25415 @anchor{with-auto-load-dir}
25416 This variable defaults to @file{$debugdir:$datadir/auto-load}.  The default
25417 @code{set auto-load safe-path} value can be also overriden by @value{GDBN}
25418 configuration option @option{--with-auto-load-dir}.
25419
25420 Any reference to @file{$debugdir} will get replaced by
25421 @var{debug-file-directory} value (@pxref{Separate Debug Files}) and any
25422 reference to @file{$datadir} will get replaced by @var{data-directory} which is
25423 determined at @value{GDBN} startup (@pxref{Data Files}).  @file{$debugdir} and
25424 @file{$datadir} must be placed as a directory component --- either alone or
25425 delimited by @file{/} or @file{\} directory separators, depending on the host
25426 platform.
25427
25428 The list of directories uses path separator (@samp{:} on GNU and Unix
25429 systems, @samp{;} on MS-Windows and MS-DOS) to separate directories, similarly
25430 to the @env{PATH} environment variable.
25431
25432 @anchor{show auto-load scripts-directory}
25433 @kindex show auto-load scripts-directory
25434 @item show auto-load scripts-directory
25435 Show @value{GDBN} auto-loaded scripts location.
25436
25437 @anchor{add-auto-load-scripts-directory}
25438 @kindex add-auto-load-scripts-directory
25439 @item add-auto-load-scripts-directory @r{[}@var{directories}@dots{}@r{]}
25440 Add an entry (or list of entries) to the list of auto-loaded scripts locations.
25441 Multiple entries may be delimited by the host platform path separator in use.
25442 @end table
25443
25444 @value{GDBN} does not track which files it has already auto-loaded this way.
25445 @value{GDBN} will load the associated script every time the corresponding
25446 @var{objfile} is opened.
25447 So your @file{-gdb.@var{ext}} file should be careful to avoid errors if it
25448 is evaluated more than once.
25449
25450 @node dotdebug_gdb_scripts section
25451 @subsection The @code{.debug_gdb_scripts} section
25452 @cindex @code{.debug_gdb_scripts} section
25453
25454 For systems using file formats like ELF and COFF,
25455 when @value{GDBN} loads a new object file
25456 it will look for a special section named @code{.debug_gdb_scripts}.
25457 If this section exists, its contents is a list of null-terminated entries
25458 specifying scripts to load.  Each entry begins with a non-null prefix byte that
25459 specifies the kind of entry, typically the extension language and whether the
25460 script is in a file or inlined in @code{.debug_gdb_scripts}.
25461
25462 The following entries are supported:
25463
25464 @table @code
25465 @item SECTION_SCRIPT_ID_PYTHON_FILE = 1
25466 @item SECTION_SCRIPT_ID_SCHEME_FILE = 3
25467 @item SECTION_SCRIPT_ID_PYTHON_TEXT = 4
25468 @item SECTION_SCRIPT_ID_SCHEME_TEXT = 6
25469 @end table
25470
25471 @subsubsection Script File Entries
25472
25473 If the entry specifies a file, @value{GDBN} will look for the file first
25474 in the current directory and then along the source search path
25475 (@pxref{Source Path, ,Specifying Source Directories}),
25476 except that @file{$cdir} is not searched, since the compilation
25477 directory is not relevant to scripts.
25478
25479 File entries can be placed in section @code{.debug_gdb_scripts} with,
25480 for example, this GCC macro for Python scripts.
25481
25482 @example
25483 /* Note: The "MS" section flags are to remove duplicates.  */
25484 #define DEFINE_GDB_PY_SCRIPT(script_name) \
25485   asm("\
25486 .pushsection \".debug_gdb_scripts\", \"MS\",@@progbits,1\n\
25487 .byte 1 /* Python */\n\
25488 .asciz \"" script_name "\"\n\
25489 .popsection \n\
25490 ");
25491 @end example
25492
25493 @noindent
25494 For Guile scripts, replace @code{.byte 1} with @code{.byte 3}.
25495 Then one can reference the macro in a header or source file like this:
25496
25497 @example
25498 DEFINE_GDB_PY_SCRIPT ("my-app-scripts.py")
25499 @end example
25500
25501 The script name may include directories if desired.
25502
25503 Note that loading of this script file also requires accordingly configured
25504 @code{auto-load safe-path} (@pxref{Auto-loading safe path}).
25505
25506 If the macro invocation is put in a header, any application or library
25507 using this header will get a reference to the specified script,
25508 and with the use of @code{"MS"} attributes on the section, the linker
25509 will remove duplicates.
25510
25511 @subsubsection Script Text Entries
25512
25513 Script text entries allow to put the executable script in the entry
25514 itself instead of loading it from a file.
25515 The first line of the entry, everything after the prefix byte and up to
25516 the first newline (@code{0xa}) character, is the script name, and must not
25517 contain any kind of space character, e.g., spaces or tabs.
25518 The rest of the entry, up to the trailing null byte, is the script to
25519 execute in the specified language.  The name needs to be unique among
25520 all script names, as @value{GDBN} executes each script only once based
25521 on its name.
25522
25523 Here is an example from file @file{py-section-script.c} in the @value{GDBN}
25524 testsuite.
25525
25526 @example
25527 #include "symcat.h"
25528 #include "gdb/section-scripts.h"
25529 asm(
25530 ".pushsection \".debug_gdb_scripts\", \"MS\",@@progbits,1\n"
25531 ".byte " XSTRING (SECTION_SCRIPT_ID_PYTHON_TEXT) "\n"
25532 ".ascii \"gdb.inlined-script\\n\"\n"
25533 ".ascii \"class test_cmd (gdb.Command):\\n\"\n"
25534 ".ascii \"  def __init__ (self):\\n\"\n"
25535 ".ascii \"    super (test_cmd, self).__init__ ("
25536     "\\\"test-cmd\\\", gdb.COMMAND_OBSCURE)\\n\"\n"
25537 ".ascii \"  def invoke (self, arg, from_tty):\\n\"\n"
25538 ".ascii \"    print (\\\"test-cmd output, arg = %s\\\" % arg)\\n\"\n"
25539 ".ascii \"test_cmd ()\\n\"\n"
25540 ".byte 0\n"
25541 ".popsection\n"
25542 );
25543 @end example
25544
25545 Loading of inlined scripts requires a properly configured
25546 @code{auto-load safe-path} (@pxref{Auto-loading safe path}).
25547 The path to specify in @code{auto-load safe-path} is the path of the file
25548 containing the @code{.debug_gdb_scripts} section.
25549
25550 @node Which flavor to choose?
25551 @subsection Which flavor to choose?
25552
25553 Given the multiple ways of auto-loading extensions, it might not always
25554 be clear which one to choose.  This section provides some guidance.
25555
25556 @noindent
25557 Benefits of the @file{-gdb.@var{ext}} way:
25558
25559 @itemize @bullet
25560 @item
25561 Can be used with file formats that don't support multiple sections.
25562
25563 @item
25564 Ease of finding scripts for public libraries.
25565
25566 Scripts specified in the @code{.debug_gdb_scripts} section are searched for
25567 in the source search path.
25568 For publicly installed libraries, e.g., @file{libstdc++}, there typically
25569 isn't a source directory in which to find the script.
25570
25571 @item
25572 Doesn't require source code additions.
25573 @end itemize
25574
25575 @noindent
25576 Benefits of the @code{.debug_gdb_scripts} way:
25577
25578 @itemize @bullet
25579 @item
25580 Works with static linking.
25581
25582 Scripts for libraries done the @file{-gdb.@var{ext}} way require an objfile to
25583 trigger their loading.  When an application is statically linked the only
25584 objfile available is the executable, and it is cumbersome to attach all the
25585 scripts from all the input libraries to the executable's
25586 @file{-gdb.@var{ext}} script.
25587
25588 @item
25589 Works with classes that are entirely inlined.
25590
25591 Some classes can be entirely inlined, and thus there may not be an associated
25592 shared library to attach a @file{-gdb.@var{ext}} script to.
25593
25594 @item
25595 Scripts needn't be copied out of the source tree.
25596
25597 In some circumstances, apps can be built out of large collections of internal
25598 libraries, and the build infrastructure necessary to install the
25599 @file{-gdb.@var{ext}} scripts in a place where @value{GDBN} can find them is
25600 cumbersome.  It may be easier to specify the scripts in the
25601 @code{.debug_gdb_scripts} section as relative paths, and add a path to the
25602 top of the source tree to the source search path.
25603 @end itemize
25604
25605 @node Multiple Extension Languages
25606 @section Multiple Extension Languages
25607
25608 The Guile and Python extension languages do not share any state,
25609 and generally do not interfere with each other.
25610 There are some things to be aware of, however.
25611
25612 @subsection Python comes first
25613
25614 Python was @value{GDBN}'s first extension language, and to avoid breaking
25615 existing behaviour Python comes first.  This is generally solved by the
25616 ``first one wins'' principle.  @value{GDBN} maintains a list of enabled
25617 extension languages, and when it makes a call to an extension language,
25618 (say to pretty-print a value), it tries each in turn until an extension
25619 language indicates it has performed the request (e.g., has returned the
25620 pretty-printed form of a value).
25621 This extends to errors while performing such requests: If an error happens
25622 while, for example, trying to pretty-print an object then the error is
25623 reported and any following extension languages are not tried.
25624
25625 @node Aliases
25626 @section Creating new spellings of existing commands
25627 @cindex aliases for commands
25628
25629 It is often useful to define alternate spellings of existing commands.
25630 For example, if a new @value{GDBN} command defined in Python has
25631 a long name to type, it is handy to have an abbreviated version of it
25632 that involves less typing.
25633
25634 @value{GDBN} itself uses aliases.  For example @samp{s} is an alias
25635 of the @samp{step} command even though it is otherwise an ambiguous
25636 abbreviation of other commands like @samp{set} and @samp{show}.
25637
25638 Aliases are also used to provide shortened or more common versions
25639 of multi-word commands.  For example, @value{GDBN} provides the
25640 @samp{tty} alias of the @samp{set inferior-tty} command.
25641
25642 You can define a new alias with the @samp{alias} command.
25643
25644 @table @code
25645
25646 @kindex alias
25647 @item alias [-a] [--] @var{ALIAS} = @var{COMMAND}
25648
25649 @end table
25650
25651 @var{ALIAS} specifies the name of the new alias.
25652 Each word of @var{ALIAS} must consist of letters, numbers, dashes and
25653 underscores.
25654
25655 @var{COMMAND} specifies the name of an existing command
25656 that is being aliased.
25657
25658 The @samp{-a} option specifies that the new alias is an abbreviation
25659 of the command.  Abbreviations are not shown in command
25660 lists displayed by the @samp{help} command.
25661
25662 The @samp{--} option specifies the end of options,
25663 and is useful when @var{ALIAS} begins with a dash.
25664
25665 Here is a simple example showing how to make an abbreviation
25666 of a command so that there is less to type.
25667 Suppose you were tired of typing @samp{disas}, the current
25668 shortest unambiguous abbreviation of the @samp{disassemble} command
25669 and you wanted an even shorter version named @samp{di}.
25670 The following will accomplish this.
25671
25672 @smallexample
25673 (gdb) alias -a di = disas
25674 @end smallexample
25675
25676 Note that aliases are different from user-defined commands.
25677 With a user-defined command, you also need to write documentation
25678 for it with the @samp{document} command.
25679 An alias automatically picks up the documentation of the existing command.
25680
25681 Here is an example where we make @samp{elms} an abbreviation of
25682 @samp{elements} in the @samp{set print elements} command.
25683 This is to show that you can make an abbreviation of any part
25684 of a command.
25685
25686 @smallexample
25687 (gdb) alias -a set print elms = set print elements
25688 (gdb) alias -a show print elms = show print elements
25689 (gdb) set p elms 20
25690 (gdb) show p elms
25691 Limit on string chars or array elements to print is 200.
25692 @end smallexample
25693
25694 Note that if you are defining an alias of a @samp{set} command,
25695 and you want to have an alias for the corresponding @samp{show}
25696 command, then you need to define the latter separately.
25697
25698 Unambiguously abbreviated commands are allowed in @var{COMMAND} and
25699 @var{ALIAS}, just as they are normally.
25700
25701 @smallexample
25702 (gdb) alias -a set pr elms = set p ele
25703 @end smallexample
25704
25705 Finally, here is an example showing the creation of a one word
25706 alias for a more complex command.
25707 This creates alias @samp{spe} of the command @samp{set print elements}.
25708
25709 @smallexample
25710 (gdb) alias spe = set print elements
25711 (gdb) spe 20
25712 @end smallexample
25713
25714 @node Interpreters
25715 @chapter Command Interpreters
25716 @cindex command interpreters
25717
25718 @value{GDBN} supports multiple command interpreters, and some command
25719 infrastructure to allow users or user interface writers to switch
25720 between interpreters or run commands in other interpreters.
25721
25722 @value{GDBN} currently supports two command interpreters, the console
25723 interpreter (sometimes called the command-line interpreter or @sc{cli})
25724 and the machine interface interpreter (or @sc{gdb/mi}).  This manual
25725 describes both of these interfaces in great detail.
25726
25727 By default, @value{GDBN} will start with the console interpreter.
25728 However, the user may choose to start @value{GDBN} with another
25729 interpreter by specifying the @option{-i} or @option{--interpreter}
25730 startup options.  Defined interpreters include:
25731
25732 @table @code
25733 @item console
25734 @cindex console interpreter
25735 The traditional console or command-line interpreter.  This is the most often
25736 used interpreter with @value{GDBN}. With no interpreter specified at runtime,
25737 @value{GDBN} will use this interpreter.
25738
25739 @item mi
25740 @cindex mi interpreter
25741 The newest @sc{gdb/mi} interface (currently @code{mi2}).  Used primarily
25742 by programs wishing to use @value{GDBN} as a backend for a debugger GUI
25743 or an IDE.  For more information, see @ref{GDB/MI, ,The @sc{gdb/mi}
25744 Interface}.
25745
25746 @item mi2
25747 @cindex mi2 interpreter
25748 The current @sc{gdb/mi} interface.
25749
25750 @item mi1
25751 @cindex mi1 interpreter
25752 The @sc{gdb/mi} interface included in @value{GDBN} 5.1, 5.2, and 5.3.
25753
25754 @end table
25755
25756 @cindex invoke another interpreter
25757
25758 @kindex interpreter-exec
25759 You may execute commands in any interpreter from the current
25760 interpreter using the appropriate command.  If you are running the
25761 console interpreter, simply use the @code{interpreter-exec} command:
25762
25763 @smallexample
25764 interpreter-exec mi "-data-list-register-names"
25765 @end smallexample
25766
25767 @sc{gdb/mi} has a similar command, although it is only available in versions of
25768 @value{GDBN} which support @sc{gdb/mi} version 2 (or greater).
25769
25770 Note that @code{interpreter-exec} only changes the interpreter for the
25771 duration of the specified command.  It does not change the interpreter
25772 permanently.
25773
25774 @cindex start a new independent interpreter
25775
25776 Although you may only choose a single interpreter at startup, it is
25777 possible to run an independent interpreter on a specified input/output
25778 device (usually a tty).
25779
25780 For example, consider a debugger GUI or IDE that wants to provide a
25781 @value{GDBN} console view.  It may do so by embedding a terminal
25782 emulator widget in its GUI, starting @value{GDBN} in the traditional
25783 command-line mode with stdin/stdout/stderr redirected to that
25784 terminal, and then creating an MI interpreter running on a specified
25785 input/output device.  The console interpreter created by @value{GDBN}
25786 at startup handles commands the user types in the terminal widget,
25787 while the GUI controls and synchronizes state with @value{GDBN} using
25788 the separate MI interpreter.
25789
25790 To start a new secondary @dfn{user interface} running MI, use the
25791 @code{new-ui} command:
25792
25793 @kindex new-ui
25794 @cindex new user interface
25795 @smallexample
25796 new-ui @var{interpreter} @var{tty}
25797 @end smallexample
25798
25799 The @var{interpreter} parameter specifies the interpreter to run.
25800 This accepts the same values as the @code{interpreter-exec} command.
25801 For example, @samp{console}, @samp{mi}, @samp{mi2}, etc.  The
25802 @var{tty} parameter specifies the name of the bidirectional file the
25803 interpreter uses for input/output, usually the name of a
25804 pseudoterminal slave on Unix systems.  For example:
25805
25806 @smallexample
25807 (@value{GDBP}) new-ui mi /dev/pts/9
25808 @end smallexample
25809
25810 @noindent
25811 runs an MI interpreter on @file{/dev/pts/9}.
25812
25813 @node TUI
25814 @chapter @value{GDBN} Text User Interface
25815 @cindex TUI
25816 @cindex Text User Interface
25817
25818 @menu
25819 * TUI Overview::                TUI overview
25820 * TUI Keys::                    TUI key bindings
25821 * TUI Single Key Mode::         TUI single key mode
25822 * TUI Commands::                TUI-specific commands
25823 * TUI Configuration::           TUI configuration variables
25824 @end menu
25825
25826 The @value{GDBN} Text User Interface (TUI) is a terminal
25827 interface which uses the @code{curses} library to show the source
25828 file, the assembly output, the program registers and @value{GDBN}
25829 commands in separate text windows.  The TUI mode is supported only
25830 on platforms where a suitable version of the @code{curses} library
25831 is available.
25832
25833 The TUI mode is enabled by default when you invoke @value{GDBN} as
25834 @samp{@value{GDBP} -tui}.
25835 You can also switch in and out of TUI mode while @value{GDBN} runs by
25836 using various TUI commands and key bindings, such as @command{tui
25837 enable} or @kbd{C-x C-a}.  @xref{TUI Commands, ,TUI Commands}, and
25838 @ref{TUI Keys, ,TUI Key Bindings}.
25839
25840 @node TUI Overview
25841 @section TUI Overview
25842
25843 In TUI mode, @value{GDBN} can display several text windows:
25844
25845 @table @emph
25846 @item command
25847 This window is the @value{GDBN} command window with the @value{GDBN}
25848 prompt and the @value{GDBN} output.  The @value{GDBN} input is still
25849 managed using readline.
25850
25851 @item source
25852 The source window shows the source file of the program.  The current
25853 line and active breakpoints are displayed in this window.
25854
25855 @item assembly
25856 The assembly window shows the disassembly output of the program.
25857
25858 @item register
25859 This window shows the processor registers.  Registers are highlighted
25860 when their values change.
25861 @end table
25862
25863 The source and assembly windows show the current program position
25864 by highlighting the current line and marking it with a @samp{>} marker.
25865 Breakpoints are indicated with two markers.  The first marker
25866 indicates the breakpoint type:
25867
25868 @table @code
25869 @item B
25870 Breakpoint which was hit at least once.
25871
25872 @item b
25873 Breakpoint which was never hit.
25874
25875 @item H
25876 Hardware breakpoint which was hit at least once.
25877
25878 @item h
25879 Hardware breakpoint which was never hit.
25880 @end table
25881
25882 The second marker indicates whether the breakpoint is enabled or not:
25883
25884 @table @code
25885 @item +
25886 Breakpoint is enabled.
25887
25888 @item -
25889 Breakpoint is disabled.
25890 @end table
25891
25892 The source, assembly and register windows are updated when the current
25893 thread changes, when the frame changes, or when the program counter
25894 changes.
25895
25896 These windows are not all visible at the same time.  The command
25897 window is always visible.  The others can be arranged in several
25898 layouts:
25899
25900 @itemize @bullet
25901 @item
25902 source only,
25903
25904 @item
25905 assembly only,
25906
25907 @item
25908 source and assembly,
25909
25910 @item
25911 source and registers, or
25912
25913 @item
25914 assembly and registers.
25915 @end itemize
25916
25917 A status line above the command window shows the following information:
25918
25919 @table @emph
25920 @item target
25921 Indicates the current @value{GDBN} target.
25922 (@pxref{Targets, ,Specifying a Debugging Target}).
25923
25924 @item process
25925 Gives the current process or thread number.
25926 When no process is being debugged, this field is set to @code{No process}.
25927
25928 @item function
25929 Gives the current function name for the selected frame.
25930 The name is demangled if demangling is turned on (@pxref{Print Settings}).
25931 When there is no symbol corresponding to the current program counter,
25932 the string @code{??} is displayed.
25933
25934 @item line
25935 Indicates the current line number for the selected frame.
25936 When the current line number is not known, the string @code{??} is displayed.
25937
25938 @item pc
25939 Indicates the current program counter address.
25940 @end table
25941
25942 @node TUI Keys
25943 @section TUI Key Bindings
25944 @cindex TUI key bindings
25945
25946 The TUI installs several key bindings in the readline keymaps
25947 @ifset SYSTEM_READLINE
25948 (@pxref{Command Line Editing, , , rluserman, GNU Readline Library}).
25949 @end ifset
25950 @ifclear SYSTEM_READLINE
25951 (@pxref{Command Line Editing}).
25952 @end ifclear
25953 The following key bindings are installed for both TUI mode and the
25954 @value{GDBN} standard mode.
25955
25956 @table @kbd
25957 @kindex C-x C-a
25958 @item C-x C-a
25959 @kindex C-x a
25960 @itemx C-x a
25961 @kindex C-x A
25962 @itemx C-x A
25963 Enter or leave the TUI mode.  When leaving the TUI mode,
25964 the curses window management stops and @value{GDBN} operates using
25965 its standard mode, writing on the terminal directly.  When reentering
25966 the TUI mode, control is given back to the curses windows.
25967 The screen is then refreshed.
25968
25969 @kindex C-x 1
25970 @item C-x 1
25971 Use a TUI layout with only one window.  The layout will
25972 either be @samp{source} or @samp{assembly}.  When the TUI mode
25973 is not active, it will switch to the TUI mode.
25974
25975 Think of this key binding as the Emacs @kbd{C-x 1} binding.
25976
25977 @kindex C-x 2
25978 @item C-x 2
25979 Use a TUI layout with at least two windows.  When the current
25980 layout already has two windows, the next layout with two windows is used.
25981 When a new layout is chosen, one window will always be common to the
25982 previous layout and the new one.
25983
25984 Think of it as the Emacs @kbd{C-x 2} binding.
25985
25986 @kindex C-x o
25987 @item C-x o
25988 Change the active window.  The TUI associates several key bindings
25989 (like scrolling and arrow keys) with the active window.  This command
25990 gives the focus to the next TUI window.
25991
25992 Think of it as the Emacs @kbd{C-x o} binding.
25993
25994 @kindex C-x s
25995 @item C-x s
25996 Switch in and out of the TUI SingleKey mode that binds single
25997 keys to @value{GDBN} commands (@pxref{TUI Single Key Mode}).
25998 @end table
25999
26000 The following key bindings only work in the TUI mode:
26001
26002 @table @asis
26003 @kindex PgUp
26004 @item @key{PgUp}
26005 Scroll the active window one page up.
26006
26007 @kindex PgDn
26008 @item @key{PgDn}
26009 Scroll the active window one page down.
26010
26011 @kindex Up
26012 @item @key{Up}
26013 Scroll the active window one line up.
26014
26015 @kindex Down
26016 @item @key{Down}
26017 Scroll the active window one line down.
26018
26019 @kindex Left
26020 @item @key{Left}
26021 Scroll the active window one column left.
26022
26023 @kindex Right
26024 @item @key{Right}
26025 Scroll the active window one column right.
26026
26027 @kindex C-L
26028 @item @kbd{C-L}
26029 Refresh the screen.
26030 @end table
26031
26032 Because the arrow keys scroll the active window in the TUI mode, they
26033 are not available for their normal use by readline unless the command
26034 window has the focus.  When another window is active, you must use
26035 other readline key bindings such as @kbd{C-p}, @kbd{C-n}, @kbd{C-b}
26036 and @kbd{C-f} to control the command window.
26037
26038 @node TUI Single Key Mode
26039 @section TUI Single Key Mode
26040 @cindex TUI single key mode
26041
26042 The TUI also provides a @dfn{SingleKey} mode, which binds several
26043 frequently used @value{GDBN} commands to single keys.  Type @kbd{C-x s} to
26044 switch into this mode, where the following key bindings are used:
26045
26046 @table @kbd
26047 @kindex c @r{(SingleKey TUI key)}
26048 @item c
26049 continue
26050
26051 @kindex d @r{(SingleKey TUI key)}
26052 @item d
26053 down
26054
26055 @kindex f @r{(SingleKey TUI key)}
26056 @item f
26057 finish
26058
26059 @kindex n @r{(SingleKey TUI key)}
26060 @item n
26061 next
26062
26063 @kindex o @r{(SingleKey TUI key)}
26064 @item o
26065 nexti.  The shortcut letter @samp{o} stands for ``step Over''.
26066
26067 @kindex q @r{(SingleKey TUI key)}
26068 @item q
26069 exit the SingleKey mode.
26070
26071 @kindex r @r{(SingleKey TUI key)}
26072 @item r
26073 run
26074
26075 @kindex s @r{(SingleKey TUI key)}
26076 @item s
26077 step
26078
26079 @kindex i @r{(SingleKey TUI key)}
26080 @item i
26081 stepi.  The shortcut letter @samp{i} stands for ``step Into''.
26082
26083 @kindex u @r{(SingleKey TUI key)}
26084 @item u
26085 up
26086
26087 @kindex v @r{(SingleKey TUI key)}
26088 @item v
26089 info locals
26090
26091 @kindex w @r{(SingleKey TUI key)}
26092 @item w
26093 where
26094 @end table
26095
26096 Other keys temporarily switch to the @value{GDBN} command prompt.
26097 The key that was pressed is inserted in the editing buffer so that
26098 it is possible to type most @value{GDBN} commands without interaction
26099 with the TUI SingleKey mode.  Once the command is entered the TUI
26100 SingleKey mode is restored.  The only way to permanently leave
26101 this mode is by typing @kbd{q} or @kbd{C-x s}.
26102
26103
26104 @node TUI Commands
26105 @section TUI-specific Commands
26106 @cindex TUI commands
26107
26108 The TUI has specific commands to control the text windows.
26109 These commands are always available, even when @value{GDBN} is not in
26110 the TUI mode.  When @value{GDBN} is in the standard mode, most
26111 of these commands will automatically switch to the TUI mode.
26112
26113 Note that if @value{GDBN}'s @code{stdout} is not connected to a
26114 terminal, or @value{GDBN} has been started with the machine interface
26115 interpreter (@pxref{GDB/MI, ,The @sc{gdb/mi} Interface}), most of
26116 these commands will fail with an error, because it would not be
26117 possible or desirable to enable curses window management.
26118
26119 @table @code
26120 @item tui enable
26121 @kindex tui enable
26122 Activate TUI mode.  The last active TUI window layout will be used if
26123 TUI mode has prevsiouly been used in the current debugging session,
26124 otherwise a default layout is used.
26125
26126 @item tui disable
26127 @kindex tui disable
26128 Disable TUI mode, returning to the console interpreter.
26129
26130 @item info win
26131 @kindex info win
26132 List and give the size of all displayed windows.
26133
26134 @item layout @var{name}
26135 @kindex layout
26136 Changes which TUI windows are displayed.  In each layout the command
26137 window is always displayed, the @var{name} parameter controls which
26138 additional windows are displayed, and can be any of the following:
26139
26140 @table @code
26141 @item next
26142 Display the next layout.
26143
26144 @item prev
26145 Display the previous layout.
26146
26147 @item src
26148 Display the source and command windows.
26149
26150 @item asm
26151 Display the assembly and command windows.
26152
26153 @item split
26154 Display the source, assembly, and command windows.
26155
26156 @item regs
26157 When in @code{src} layout display the register, source, and command
26158 windows.  When in @code{asm} or @code{split} layout display the
26159 register, assembler, and command windows.
26160 @end table
26161
26162 @item focus @var{name}
26163 @kindex focus
26164 Changes which TUI window is currently active for scrolling.  The
26165 @var{name} parameter can be any of the following:
26166
26167 @table @code
26168 @item next
26169 Make the next window active for scrolling.
26170
26171 @item prev
26172 Make the previous window active for scrolling.
26173
26174 @item src
26175 Make the source window active for scrolling.
26176
26177 @item asm
26178 Make the assembly window active for scrolling.
26179
26180 @item regs
26181 Make the register window active for scrolling.
26182
26183 @item cmd
26184 Make the command window active for scrolling.
26185 @end table
26186
26187 @item refresh
26188 @kindex refresh
26189 Refresh the screen.  This is similar to typing @kbd{C-L}.
26190
26191 @item tui reg @var{group}
26192 @kindex tui reg
26193 Changes the register group displayed in the tui register window to
26194 @var{group}.  If the register window is not currently displayed this
26195 command will cause the register window to be displayed.  The list of
26196 register groups, as well as their order is target specific. The
26197 following groups are available on most targets:
26198 @table @code
26199 @item next
26200 Repeatedly selecting this group will cause the display to cycle
26201 through all of the available register groups.
26202
26203 @item prev
26204 Repeatedly selecting this group will cause the display to cycle
26205 through all of the available register groups in the reverse order to
26206 @var{next}.
26207
26208 @item general
26209 Display the general registers.
26210 @item float
26211 Display the floating point registers.
26212 @item system
26213 Display the system registers.
26214 @item vector
26215 Display the vector registers.
26216 @item all
26217 Display all registers.
26218 @end table
26219
26220 @item update
26221 @kindex update
26222 Update the source window and the current execution point.
26223
26224 @item winheight @var{name} +@var{count}
26225 @itemx winheight @var{name} -@var{count}
26226 @kindex winheight
26227 Change the height of the window @var{name} by @var{count}
26228 lines.  Positive counts increase the height, while negative counts
26229 decrease it.  The @var{name} parameter can be one of @code{src} (the
26230 source window), @code{cmd} (the command window), @code{asm} (the
26231 disassembly window), or @code{regs} (the register display window).
26232
26233 @item tabset @var{nchars}
26234 @kindex tabset
26235 Set the width of tab stops to be @var{nchars} characters.  This
26236 setting affects the display of TAB characters in the source and
26237 assembly windows.
26238 @end table
26239
26240 @node TUI Configuration
26241 @section TUI Configuration Variables
26242 @cindex TUI configuration variables
26243
26244 Several configuration variables control the appearance of TUI windows.
26245
26246 @table @code
26247 @item set tui border-kind @var{kind}
26248 @kindex set tui border-kind
26249 Select the border appearance for the source, assembly and register windows.
26250 The possible values are the following:
26251 @table @code
26252 @item space
26253 Use a space character to draw the border.
26254
26255 @item ascii
26256 Use @sc{ascii} characters @samp{+}, @samp{-} and @samp{|} to draw the border.
26257
26258 @item acs
26259 Use the Alternate Character Set to draw the border.  The border is
26260 drawn using character line graphics if the terminal supports them.
26261 @end table
26262
26263 @item set tui border-mode @var{mode}
26264 @kindex set tui border-mode
26265 @itemx set tui active-border-mode @var{mode}
26266 @kindex set tui active-border-mode
26267 Select the display attributes for the borders of the inactive windows
26268 or the active window.  The @var{mode} can be one of the following:
26269 @table @code
26270 @item normal
26271 Use normal attributes to display the border.
26272
26273 @item standout
26274 Use standout mode.
26275
26276 @item reverse
26277 Use reverse video mode.
26278
26279 @item half
26280 Use half bright mode.
26281
26282 @item half-standout
26283 Use half bright and standout mode.
26284
26285 @item bold
26286 Use extra bright or bold mode.
26287
26288 @item bold-standout
26289 Use extra bright or bold and standout mode.
26290 @end table
26291 @end table
26292
26293 @node Emacs
26294 @chapter Using @value{GDBN} under @sc{gnu} Emacs
26295
26296 @cindex Emacs
26297 @cindex @sc{gnu} Emacs
26298 A special interface allows you to use @sc{gnu} Emacs to view (and
26299 edit) the source files for the program you are debugging with
26300 @value{GDBN}.
26301
26302 To use this interface, use the command @kbd{M-x gdb} in Emacs.  Give the
26303 executable file you want to debug as an argument.  This command starts
26304 @value{GDBN} as a subprocess of Emacs, with input and output through a newly
26305 created Emacs buffer.
26306 @c (Do not use the @code{-tui} option to run @value{GDBN} from Emacs.)
26307
26308 Running @value{GDBN} under Emacs can be just like running @value{GDBN} normally except for two
26309 things:
26310
26311 @itemize @bullet
26312 @item
26313 All ``terminal'' input and output goes through an Emacs buffer, called
26314 the GUD buffer.
26315
26316 This applies both to @value{GDBN} commands and their output, and to the input
26317 and output done by the program you are debugging.
26318
26319 This is useful because it means that you can copy the text of previous
26320 commands and input them again; you can even use parts of the output
26321 in this way.
26322
26323 All the facilities of Emacs' Shell mode are available for interacting
26324 with your program.  In particular, you can send signals the usual
26325 way---for example, @kbd{C-c C-c} for an interrupt, @kbd{C-c C-z} for a
26326 stop.
26327
26328 @item
26329 @value{GDBN} displays source code through Emacs.
26330
26331 Each time @value{GDBN} displays a stack frame, Emacs automatically finds the
26332 source file for that frame and puts an arrow (@samp{=>}) at the
26333 left margin of the current line.  Emacs uses a separate buffer for
26334 source display, and splits the screen to show both your @value{GDBN} session
26335 and the source.
26336
26337 Explicit @value{GDBN} @code{list} or search commands still produce output as
26338 usual, but you probably have no reason to use them from Emacs.
26339 @end itemize
26340
26341 We call this @dfn{text command mode}.  Emacs 22.1, and later, also uses
26342 a graphical mode, enabled by default, which provides further buffers
26343 that can control the execution and describe the state of your program.
26344 @xref{GDB Graphical Interface,,, Emacs, The @sc{gnu} Emacs Manual}.
26345
26346 If you specify an absolute file name when prompted for the @kbd{M-x
26347 gdb} argument, then Emacs sets your current working directory to where
26348 your program resides.  If you only specify the file name, then Emacs
26349 sets your current working directory to the directory associated
26350 with the previous buffer.  In this case, @value{GDBN} may find your
26351 program by searching your environment's @code{PATH} variable, but on
26352 some operating systems it might not find the source.  So, although the
26353 @value{GDBN} input and output session proceeds normally, the auxiliary
26354 buffer does not display the current source and line of execution.
26355
26356 The initial working directory of @value{GDBN} is printed on the top
26357 line of the GUD buffer and this serves as a default for the commands
26358 that specify files for @value{GDBN} to operate on.  @xref{Files,
26359 ,Commands to Specify Files}.
26360
26361 By default, @kbd{M-x gdb} calls the program called @file{gdb}.  If you
26362 need to call @value{GDBN} by a different name (for example, if you
26363 keep several configurations around, with different names) you can
26364 customize the Emacs variable @code{gud-gdb-command-name} to run the
26365 one you want.
26366
26367 In the GUD buffer, you can use these special Emacs commands in
26368 addition to the standard Shell mode commands:
26369
26370 @table @kbd
26371 @item C-h m
26372 Describe the features of Emacs' GUD Mode.
26373
26374 @item C-c C-s
26375 Execute to another source line, like the @value{GDBN} @code{step} command; also
26376 update the display window to show the current file and location.
26377
26378 @item C-c C-n
26379 Execute to next source line in this function, skipping all function
26380 calls, like the @value{GDBN} @code{next} command.  Then update the display window
26381 to show the current file and location.
26382
26383 @item C-c C-i
26384 Execute one instruction, like the @value{GDBN} @code{stepi} command; update
26385 display window accordingly.
26386
26387 @item C-c C-f
26388 Execute until exit from the selected stack frame, like the @value{GDBN}
26389 @code{finish} command.
26390
26391 @item C-c C-r
26392 Continue execution of your program, like the @value{GDBN} @code{continue}
26393 command.
26394
26395 @item C-c <
26396 Go up the number of frames indicated by the numeric argument
26397 (@pxref{Arguments, , Numeric Arguments, Emacs, The @sc{gnu} Emacs Manual}),
26398 like the @value{GDBN} @code{up} command.
26399
26400 @item C-c >
26401 Go down the number of frames indicated by the numeric argument, like the
26402 @value{GDBN} @code{down} command.
26403 @end table
26404
26405 In any source file, the Emacs command @kbd{C-x @key{SPC}} (@code{gud-break})
26406 tells @value{GDBN} to set a breakpoint on the source line point is on.
26407
26408 In text command mode, if you type @kbd{M-x speedbar}, Emacs displays a
26409 separate frame which shows a backtrace when the GUD buffer is current.
26410 Move point to any frame in the stack and type @key{RET} to make it
26411 become the current frame and display the associated source in the
26412 source buffer.  Alternatively, click @kbd{Mouse-2} to make the
26413 selected frame become the current one.  In graphical mode, the
26414 speedbar displays watch expressions.
26415
26416 If you accidentally delete the source-display buffer, an easy way to get
26417 it back is to type the command @code{f} in the @value{GDBN} buffer, to
26418 request a frame display; when you run under Emacs, this recreates
26419 the source buffer if necessary to show you the context of the current
26420 frame.
26421
26422 The source files displayed in Emacs are in ordinary Emacs buffers
26423 which are visiting the source files in the usual way.  You can edit
26424 the files with these buffers if you wish; but keep in mind that @value{GDBN}
26425 communicates with Emacs in terms of line numbers.  If you add or
26426 delete lines from the text, the line numbers that @value{GDBN} knows cease
26427 to correspond properly with the code.
26428
26429 A more detailed description of Emacs' interaction with @value{GDBN} is
26430 given in the Emacs manual (@pxref{Debuggers,,, Emacs, The @sc{gnu}
26431 Emacs Manual}).
26432
26433 @node GDB/MI
26434 @chapter The @sc{gdb/mi} Interface
26435
26436 @unnumberedsec Function and Purpose
26437
26438 @cindex @sc{gdb/mi}, its purpose
26439 @sc{gdb/mi} is a line based machine oriented text interface to
26440 @value{GDBN} and is activated by specifying using the
26441 @option{--interpreter} command line option (@pxref{Mode Options}).  It
26442 is specifically intended to support the development of systems which
26443 use the debugger as just one small component of a larger system.
26444
26445 This chapter is a specification of the @sc{gdb/mi} interface.  It is written
26446 in the form of a reference manual.
26447
26448 Note that @sc{gdb/mi} is still under construction, so some of the
26449 features described below are incomplete and subject to change
26450 (@pxref{GDB/MI Development and Front Ends, , @sc{gdb/mi} Development and Front Ends}).  
26451
26452 @unnumberedsec Notation and Terminology
26453
26454 @cindex notational conventions, for @sc{gdb/mi}
26455 This chapter uses the following notation:
26456
26457 @itemize @bullet
26458 @item
26459 @code{|} separates two alternatives.
26460
26461 @item
26462 @code{[ @var{something} ]} indicates that @var{something} is optional:
26463 it may or may not be given.
26464
26465 @item
26466 @code{( @var{group} )*} means that @var{group} inside the parentheses
26467 may repeat zero or more times.
26468
26469 @item
26470 @code{( @var{group} )+} means that @var{group} inside the parentheses
26471 may repeat one or more times.
26472
26473 @item
26474 @code{"@var{string}"} means a literal @var{string}.
26475 @end itemize
26476
26477 @ignore
26478 @heading Dependencies
26479 @end ignore
26480
26481 @menu
26482 * GDB/MI General Design::
26483 * GDB/MI Command Syntax::
26484 * GDB/MI Compatibility with CLI::
26485 * GDB/MI Development and Front Ends::
26486 * GDB/MI Output Records::
26487 * GDB/MI Simple Examples::
26488 * GDB/MI Command Description Format::
26489 * GDB/MI Breakpoint Commands::
26490 * GDB/MI Catchpoint Commands::
26491 * GDB/MI Program Context::
26492 * GDB/MI Thread Commands::
26493 * GDB/MI Ada Tasking Commands::
26494 * GDB/MI Program Execution::
26495 * GDB/MI Stack Manipulation::
26496 * GDB/MI Variable Objects::
26497 * GDB/MI Data Manipulation::
26498 * GDB/MI Tracepoint Commands::
26499 * GDB/MI Symbol Query::
26500 * GDB/MI File Commands::
26501 @ignore
26502 * GDB/MI Kod Commands::
26503 * GDB/MI Memory Overlay Commands::
26504 * GDB/MI Signal Handling Commands::
26505 @end ignore
26506 * GDB/MI Target Manipulation::
26507 * GDB/MI File Transfer Commands::
26508 * GDB/MI Ada Exceptions Commands::
26509 * GDB/MI Support Commands::
26510 * GDB/MI Miscellaneous Commands::
26511 @end menu
26512
26513 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
26514 @node GDB/MI General Design
26515 @section @sc{gdb/mi} General Design
26516 @cindex GDB/MI General Design
26517
26518 Interaction of a @sc{GDB/MI} frontend with @value{GDBN} involves three
26519 parts---commands sent to @value{GDBN}, responses to those commands
26520 and notifications.  Each command results in exactly one response,
26521 indicating either successful completion of the command, or an error.
26522 For the commands that do not resume the target, the response contains the
26523 requested information.  For the commands that resume the target, the
26524 response only indicates whether the target was successfully resumed.
26525 Notifications is the mechanism for reporting changes in the state of the
26526 target, or in @value{GDBN} state, that cannot conveniently be associated with
26527 a command and reported as part of that command response.
26528
26529 The important examples of notifications are:
26530 @itemize @bullet
26531
26532 @item 
26533 Exec notifications.  These are used to report changes in
26534 target state---when a target is resumed, or stopped.  It would not
26535 be feasible to include this information in response of resuming
26536 commands, because one resume commands can result in multiple events in
26537 different threads.  Also, quite some time may pass before any event
26538 happens in the target, while a frontend needs to know whether the resuming
26539 command itself was successfully executed.
26540
26541 @item 
26542 Console output, and status notifications.  Console output
26543 notifications are used to report output of CLI commands, as well as
26544 diagnostics for other commands.  Status notifications are used to
26545 report the progress of a long-running operation.  Naturally, including
26546 this information in command response would mean no output is produced
26547 until the command is finished, which is undesirable.
26548
26549 @item
26550 General notifications.  Commands may have various side effects on
26551 the @value{GDBN} or target state beyond their official purpose.  For example,
26552 a command may change the selected thread.  Although such changes can
26553 be included in command response, using notification allows for more
26554 orthogonal frontend design.
26555
26556 @end itemize
26557
26558 There's no guarantee that whenever an MI command reports an error,
26559 @value{GDBN} or the target are in any specific state, and especially,
26560 the state is not reverted to the state before the MI command was
26561 processed.  Therefore, whenever an MI command results in an error, 
26562 we recommend that the frontend refreshes all the information shown in 
26563 the user interface.
26564
26565
26566 @menu
26567 * Context management::
26568 * Asynchronous and non-stop modes::
26569 * Thread groups::
26570 @end menu
26571
26572 @node Context management
26573 @subsection Context management
26574
26575 @subsubsection Threads and Frames
26576
26577 In most cases when @value{GDBN} accesses the target, this access is
26578 done in context of a specific thread and frame (@pxref{Frames}).
26579 Often, even when accessing global data, the target requires that a thread
26580 be specified.  The CLI interface maintains the selected thread and frame,
26581 and supplies them to target on each command.  This is convenient,
26582 because a command line user would not want to specify that information
26583 explicitly on each command, and because user interacts with
26584 @value{GDBN} via a single terminal, so no confusion is possible as 
26585 to what thread and frame are the current ones.
26586
26587 In the case of MI, the concept of selected thread and frame is less
26588 useful.  First, a frontend can easily remember this information
26589 itself.  Second, a graphical frontend can have more than one window,
26590 each one used for debugging a different thread, and the frontend might
26591 want to access additional threads for internal purposes.  This
26592 increases the risk that by relying on implicitly selected thread, the
26593 frontend may be operating on a wrong one.  Therefore, each MI command
26594 should explicitly specify which thread and frame to operate on.  To
26595 make it possible, each MI command accepts the @samp{--thread} and
26596 @samp{--frame} options, the value to each is @value{GDBN} global
26597 identifier for thread and frame to operate on.
26598
26599 Usually, each top-level window in a frontend allows the user to select
26600 a thread and a frame, and remembers the user selection for further
26601 operations.  However, in some cases @value{GDBN} may suggest that the
26602 current thread or frame be changed.  For example, when stopping on a
26603 breakpoint it is reasonable to switch to the thread where breakpoint is
26604 hit.  For another example, if the user issues the CLI @samp{thread} or
26605 @samp{frame} commands via the frontend, it is desirable to change the
26606 frontend's selection to the one specified by user.  @value{GDBN}
26607 communicates the suggestion to change current thread and frame using the
26608 @samp{=thread-selected} notification.
26609
26610 Note that historically, MI shares the selected thread with CLI, so 
26611 frontends used the @code{-thread-select} to execute commands in the
26612 right context.  However, getting this to work right is cumbersome.  The
26613 simplest way is for frontend to emit @code{-thread-select} command
26614 before every command.  This doubles the number of commands that need
26615 to be sent.  The alternative approach is to suppress @code{-thread-select}
26616 if the selected thread in @value{GDBN} is supposed to be identical to the
26617 thread the frontend wants to operate on.  However, getting this
26618 optimization right can be tricky.  In particular, if the frontend
26619 sends several commands to @value{GDBN}, and one of the commands changes the
26620 selected thread, then the behaviour of subsequent commands will
26621 change.  So, a frontend should either wait for response from such
26622 problematic commands, or explicitly add @code{-thread-select} for
26623 all subsequent commands.  No frontend is known to do this exactly
26624 right, so it is suggested to just always pass the @samp{--thread} and
26625 @samp{--frame} options.
26626
26627 @subsubsection Language
26628
26629 The execution of several commands depends on which language is selected.
26630 By default, the current language (@pxref{show language}) is used.
26631 But for commands known to be language-sensitive, it is recommended
26632 to use the @samp{--language} option.  This option takes one argument,
26633 which is the name of the language to use while executing the command.
26634 For instance:
26635
26636 @smallexample
26637 -data-evaluate-expression --language c "sizeof (void*)"
26638 ^done,value="4"
26639 (gdb) 
26640 @end smallexample
26641
26642 The valid language names are the same names accepted by the
26643 @samp{set language} command (@pxref{Manually}), excluding @samp{auto},
26644 @samp{local} or @samp{unknown}.
26645
26646 @node Asynchronous and non-stop modes
26647 @subsection Asynchronous command execution and non-stop mode
26648
26649 On some targets, @value{GDBN} is capable of processing MI commands
26650 even while the target is running.  This is called @dfn{asynchronous
26651 command execution} (@pxref{Background Execution}).  The frontend may
26652 specify a preferrence for asynchronous execution using the
26653 @code{-gdb-set mi-async 1} command, which should be emitted before
26654 either running the executable or attaching to the target.  After the
26655 frontend has started the executable or attached to the target, it can
26656 find if asynchronous execution is enabled using the
26657 @code{-list-target-features} command.
26658
26659 @table @code
26660 @item -gdb-set mi-async on
26661 @item -gdb-set mi-async off
26662 Set whether MI is in asynchronous mode.
26663
26664 When @code{off}, which is the default, MI execution commands (e.g.,
26665 @code{-exec-continue}) are foreground commands, and @value{GDBN} waits
26666 for the program to stop before processing further commands.
26667
26668 When @code{on}, MI execution commands are background execution
26669 commands (e.g., @code{-exec-continue} becomes the equivalent of the
26670 @code{c&} CLI command), and so @value{GDBN} is capable of processing
26671 MI commands even while the target is running.
26672
26673 @item -gdb-show mi-async
26674 Show whether MI asynchronous mode is enabled.
26675 @end table
26676
26677 Note: In @value{GDBN} version 7.7 and earlier, this option was called
26678 @code{target-async} instead of @code{mi-async}, and it had the effect
26679 of both putting MI in asynchronous mode and making CLI background
26680 commands possible.  CLI background commands are now always possible
26681 ``out of the box'' if the target supports them.  The old spelling is
26682 kept as a deprecated alias for backwards compatibility.
26683
26684 Even if @value{GDBN} can accept a command while target is running,
26685 many commands that access the target do not work when the target is
26686 running.  Therefore, asynchronous command execution is most useful
26687 when combined with non-stop mode (@pxref{Non-Stop Mode}).  Then,
26688 it is possible to examine the state of one thread, while other threads
26689 are running.
26690
26691 When a given thread is running, MI commands that try to access the
26692 target in the context of that thread may not work, or may work only on
26693 some targets.  In particular, commands that try to operate on thread's
26694 stack will not work, on any target.  Commands that read memory, or
26695 modify breakpoints, may work or not work, depending on the target.  Note
26696 that even commands that operate on global state, such as @code{print},
26697 @code{set}, and breakpoint commands, still access the target in the
26698 context of a specific thread,  so frontend should try to find a
26699 stopped thread and perform the operation on that thread (using the
26700 @samp{--thread} option).
26701
26702 Which commands will work in the context of a running thread is
26703 highly target dependent.  However, the two commands
26704 @code{-exec-interrupt}, to stop a thread, and @code{-thread-info},
26705 to find the state of a thread, will always work.
26706
26707 @node Thread groups
26708 @subsection Thread groups
26709 @value{GDBN} may be used to debug several processes at the same time.
26710 On some platfroms, @value{GDBN} may support debugging of several
26711 hardware systems, each one having several cores with several different
26712 processes running on each core.  This section describes the MI
26713 mechanism to support such debugging scenarios.
26714
26715 The key observation is that regardless of the structure of the 
26716 target, MI can have a global list of threads, because most commands that 
26717 accept the @samp{--thread} option do not need to know what process that
26718 thread belongs to.  Therefore, it is not necessary to introduce
26719 neither additional @samp{--process} option, nor an notion of the
26720 current process in the MI interface.  The only strictly new feature
26721 that is required is the ability to find how the threads are grouped
26722 into processes.
26723
26724 To allow the user to discover such grouping, and to support arbitrary
26725 hierarchy of machines/cores/processes, MI introduces the concept of a
26726 @dfn{thread group}.  Thread group is a collection of threads and other
26727 thread groups.  A thread group always has a string identifier, a type,
26728 and may have additional attributes specific to the type.  A new
26729 command, @code{-list-thread-groups}, returns the list of top-level
26730 thread groups, which correspond to processes that @value{GDBN} is
26731 debugging at the moment.  By passing an identifier of a thread group
26732 to the @code{-list-thread-groups} command, it is possible to obtain
26733 the members of specific thread group.
26734
26735 To allow the user to easily discover processes, and other objects, he
26736 wishes to debug, a concept of @dfn{available thread group} is
26737 introduced.  Available thread group is an thread group that
26738 @value{GDBN} is not debugging, but that can be attached to, using the
26739 @code{-target-attach} command.  The list of available top-level thread
26740 groups can be obtained using @samp{-list-thread-groups --available}.
26741 In general, the content of a thread group may be only retrieved only
26742 after attaching to that thread group.
26743
26744 Thread groups are related to inferiors (@pxref{Inferiors and
26745 Programs}).  Each inferior corresponds to a thread group of a special
26746 type @samp{process}, and some additional operations are permitted on
26747 such thread groups.
26748
26749 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
26750 @node GDB/MI Command Syntax
26751 @section @sc{gdb/mi} Command Syntax
26752
26753 @menu
26754 * GDB/MI Input Syntax::
26755 * GDB/MI Output Syntax::
26756 @end menu
26757
26758 @node GDB/MI Input Syntax
26759 @subsection @sc{gdb/mi} Input Syntax
26760
26761 @cindex input syntax for @sc{gdb/mi}
26762 @cindex @sc{gdb/mi}, input syntax
26763 @table @code
26764 @item @var{command} @expansion{}
26765 @code{@var{cli-command} | @var{mi-command}}
26766
26767 @item @var{cli-command} @expansion{}
26768 @code{[ @var{token} ] @var{cli-command} @var{nl}}, where
26769 @var{cli-command} is any existing @value{GDBN} CLI command.
26770
26771 @item @var{mi-command} @expansion{}
26772 @code{[ @var{token} ] "-" @var{operation} ( " " @var{option} )*
26773 @code{[} " --" @code{]} ( " " @var{parameter} )* @var{nl}}
26774
26775 @item @var{token} @expansion{}
26776 "any sequence of digits"
26777
26778 @item @var{option} @expansion{}
26779 @code{"-" @var{parameter} [ " " @var{parameter} ]}
26780
26781 @item @var{parameter} @expansion{}
26782 @code{@var{non-blank-sequence} | @var{c-string}}
26783
26784 @item @var{operation} @expansion{}
26785 @emph{any of the operations described in this chapter}
26786
26787 @item @var{non-blank-sequence} @expansion{}
26788 @emph{anything, provided it doesn't contain special characters such as
26789 "-", @var{nl}, """ and of course " "}
26790
26791 @item @var{c-string} @expansion{}
26792 @code{""" @var{seven-bit-iso-c-string-content} """}
26793
26794 @item @var{nl} @expansion{}
26795 @code{CR | CR-LF}
26796 @end table
26797
26798 @noindent
26799 Notes:
26800
26801 @itemize @bullet
26802 @item
26803 The CLI commands are still handled by the @sc{mi} interpreter; their
26804 output is described below.
26805
26806 @item
26807 The @code{@var{token}}, when present, is passed back when the command
26808 finishes.
26809
26810 @item
26811 Some @sc{mi} commands accept optional arguments as part of the parameter
26812 list.  Each option is identified by a leading @samp{-} (dash) and may be
26813 followed by an optional argument parameter.  Options occur first in the
26814 parameter list and can be delimited from normal parameters using
26815 @samp{--} (this is useful when some parameters begin with a dash).
26816 @end itemize
26817
26818 Pragmatics:
26819
26820 @itemize @bullet
26821 @item
26822 We want easy access to the existing CLI syntax (for debugging).
26823
26824 @item
26825 We want it to be easy to spot a @sc{mi} operation.
26826 @end itemize
26827
26828 @node GDB/MI Output Syntax
26829 @subsection @sc{gdb/mi} Output Syntax
26830
26831 @cindex output syntax of @sc{gdb/mi}
26832 @cindex @sc{gdb/mi}, output syntax
26833 The output from @sc{gdb/mi} consists of zero or more out-of-band records
26834 followed, optionally, by a single result record.  This result record
26835 is for the most recent command.  The sequence of output records is
26836 terminated by @samp{(gdb)}.
26837
26838 If an input command was prefixed with a @code{@var{token}} then the
26839 corresponding output for that command will also be prefixed by that same
26840 @var{token}.
26841
26842 @table @code
26843 @item @var{output} @expansion{}
26844 @code{( @var{out-of-band-record} )* [ @var{result-record} ] "(gdb)" @var{nl}}
26845
26846 @item @var{result-record} @expansion{}
26847 @code{ [ @var{token} ] "^" @var{result-class} ( "," @var{result} )* @var{nl}}
26848
26849 @item @var{out-of-band-record} @expansion{}
26850 @code{@var{async-record} | @var{stream-record}}
26851
26852 @item @var{async-record} @expansion{}
26853 @code{@var{exec-async-output} | @var{status-async-output} | @var{notify-async-output}}
26854
26855 @item @var{exec-async-output} @expansion{}
26856 @code{[ @var{token} ] "*" @var{async-output nl}}
26857
26858 @item @var{status-async-output} @expansion{}
26859 @code{[ @var{token} ] "+" @var{async-output nl}}
26860
26861 @item @var{notify-async-output} @expansion{}
26862 @code{[ @var{token} ] "=" @var{async-output nl}}
26863
26864 @item @var{async-output} @expansion{}
26865 @code{@var{async-class} ( "," @var{result} )*}
26866
26867 @item @var{result-class} @expansion{}
26868 @code{"done" | "running" | "connected" | "error" | "exit"}
26869
26870 @item @var{async-class} @expansion{}
26871 @code{"stopped" | @var{others}} (where @var{others} will be added
26872 depending on the needs---this is still in development).
26873
26874 @item @var{result} @expansion{}
26875 @code{ @var{variable} "=" @var{value}}
26876
26877 @item @var{variable} @expansion{}
26878 @code{ @var{string} }
26879
26880 @item @var{value} @expansion{}
26881 @code{ @var{const} | @var{tuple} | @var{list} }
26882
26883 @item @var{const} @expansion{}
26884 @code{@var{c-string}}
26885
26886 @item @var{tuple} @expansion{}
26887 @code{ "@{@}" | "@{" @var{result} ( "," @var{result} )* "@}" }
26888
26889 @item @var{list} @expansion{}
26890 @code{ "[]" | "[" @var{value} ( "," @var{value} )* "]" | "["
26891 @var{result} ( "," @var{result} )* "]" }
26892
26893 @item @var{stream-record} @expansion{}
26894 @code{@var{console-stream-output} | @var{target-stream-output} | @var{log-stream-output}}
26895
26896 @item @var{console-stream-output} @expansion{}
26897 @code{"~" @var{c-string nl}}
26898
26899 @item @var{target-stream-output} @expansion{}
26900 @code{"@@" @var{c-string nl}}
26901
26902 @item @var{log-stream-output} @expansion{}
26903 @code{"&" @var{c-string nl}}
26904
26905 @item @var{nl} @expansion{}
26906 @code{CR | CR-LF}
26907
26908 @item @var{token} @expansion{}
26909 @emph{any sequence of digits}.
26910 @end table
26911
26912 @noindent
26913 Notes:
26914
26915 @itemize @bullet
26916 @item
26917 All output sequences end in a single line containing a period.
26918
26919 @item
26920 The @code{@var{token}} is from the corresponding request.  Note that
26921 for all async output, while the token is allowed by the grammar and
26922 may be output by future versions of @value{GDBN} for select async
26923 output messages, it is generally omitted.  Frontends should treat
26924 all async output as reporting general changes in the state of the
26925 target and there should be no need to associate async output to any
26926 prior command.
26927
26928 @item
26929 @cindex status output in @sc{gdb/mi}
26930 @var{status-async-output} contains on-going status information about the
26931 progress of a slow operation.  It can be discarded.  All status output is
26932 prefixed by @samp{+}.
26933
26934 @item
26935 @cindex async output in @sc{gdb/mi}
26936 @var{exec-async-output} contains asynchronous state change on the target
26937 (stopped, started, disappeared).  All async output is prefixed by
26938 @samp{*}.
26939
26940 @item
26941 @cindex notify output in @sc{gdb/mi}
26942 @var{notify-async-output} contains supplementary information that the
26943 client should handle (e.g., a new breakpoint information).  All notify
26944 output is prefixed by @samp{=}.
26945
26946 @item
26947 @cindex console output in @sc{gdb/mi}
26948 @var{console-stream-output} is output that should be displayed as is in the
26949 console.  It is the textual response to a CLI command.  All the console
26950 output is prefixed by @samp{~}.
26951
26952 @item
26953 @cindex target output in @sc{gdb/mi}
26954 @var{target-stream-output} is the output produced by the target program.
26955 All the target output is prefixed by @samp{@@}.
26956
26957 @item
26958 @cindex log output in @sc{gdb/mi}
26959 @var{log-stream-output} is output text coming from @value{GDBN}'s internals, for
26960 instance messages that should be displayed as part of an error log.  All
26961 the log output is prefixed by @samp{&}.
26962
26963 @item
26964 @cindex list output in @sc{gdb/mi}
26965 New @sc{gdb/mi} commands should only output @var{lists} containing
26966 @var{values}.
26967
26968
26969 @end itemize
26970
26971 @xref{GDB/MI Stream Records, , @sc{gdb/mi} Stream Records}, for more
26972 details about the various output records.
26973
26974 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
26975 @node GDB/MI Compatibility with CLI
26976 @section @sc{gdb/mi} Compatibility with CLI
26977
26978 @cindex compatibility, @sc{gdb/mi} and CLI
26979 @cindex @sc{gdb/mi}, compatibility with CLI
26980
26981 For the developers convenience CLI commands can be entered directly,
26982 but there may be some unexpected behaviour.  For example, commands
26983 that query the user will behave as if the user replied yes, breakpoint
26984 command lists are not executed and some CLI commands, such as
26985 @code{if}, @code{when} and @code{define}, prompt for further input with
26986 @samp{>}, which is not valid MI output.
26987
26988 This feature may be removed at some stage in the future and it is
26989 recommended that front ends use the @code{-interpreter-exec} command
26990 (@pxref{-interpreter-exec}).
26991
26992 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
26993 @node GDB/MI Development and Front Ends
26994 @section @sc{gdb/mi} Development and Front Ends
26995 @cindex @sc{gdb/mi} development
26996
26997 The application which takes the MI output and presents the state of the
26998 program being debugged to the user is called a @dfn{front end}.
26999
27000 Although @sc{gdb/mi} is still incomplete, it is currently being used
27001 by a variety of front ends to @value{GDBN}.  This makes it difficult
27002 to introduce new functionality without breaking existing usage.  This
27003 section tries to minimize the problems by describing how the protocol
27004 might change.
27005
27006 Some changes in MI need not break a carefully designed front end, and
27007 for these the MI version will remain unchanged.  The following is a
27008 list of changes that may occur within one level, so front ends should
27009 parse MI output in a way that can handle them:
27010
27011 @itemize @bullet
27012 @item
27013 New MI commands may be added.
27014
27015 @item
27016 New fields may be added to the output of any MI command.
27017
27018 @item
27019 The range of values for fields with specified values, e.g.,
27020 @code{in_scope} (@pxref{-var-update}) may be extended.
27021
27022 @c The format of field's content e.g type prefix, may change so parse it
27023 @c   at your own risk.  Yes, in general?
27024
27025 @c The order of fields may change?  Shouldn't really matter but it might
27026 @c resolve inconsistencies.
27027 @end itemize
27028
27029 If the changes are likely to break front ends, the MI version level
27030 will be increased by one.  This will allow the front end to parse the
27031 output according to the MI version.  Apart from mi0, new versions of
27032 @value{GDBN} will not support old versions of MI and it will be the
27033 responsibility of the front end to work with the new one.
27034
27035 @c Starting with mi3, add a new command -mi-version that prints the MI
27036 @c version?
27037
27038 The best way to avoid unexpected changes in MI that might break your front
27039 end is to make your project known to @value{GDBN} developers and
27040 follow development on @email{gdb@@sourceware.org} and
27041 @email{gdb-patches@@sourceware.org}.
27042 @cindex mailing lists
27043
27044 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
27045 @node GDB/MI Output Records
27046 @section @sc{gdb/mi} Output Records
27047
27048 @menu
27049 * GDB/MI Result Records::
27050 * GDB/MI Stream Records::
27051 * GDB/MI Async Records::
27052 * GDB/MI Breakpoint Information::
27053 * GDB/MI Frame Information::
27054 * GDB/MI Thread Information::
27055 * GDB/MI Ada Exception Information::
27056 @end menu
27057
27058 @node GDB/MI Result Records
27059 @subsection @sc{gdb/mi} Result Records
27060
27061 @cindex result records in @sc{gdb/mi}
27062 @cindex @sc{gdb/mi}, result records
27063 In addition to a number of out-of-band notifications, the response to a
27064 @sc{gdb/mi} command includes one of the following result indications:
27065
27066 @table @code
27067 @findex ^done
27068 @item "^done" [ "," @var{results} ]
27069 The synchronous operation was successful, @code{@var{results}} are the return
27070 values.
27071
27072 @item "^running"
27073 @findex ^running
27074 This result record is equivalent to @samp{^done}.  Historically, it
27075 was output instead of @samp{^done} if the command has resumed the
27076 target.  This behaviour is maintained for backward compatibility, but
27077 all frontends should treat @samp{^done} and @samp{^running}
27078 identically and rely on the @samp{*running} output record to determine
27079 which threads are resumed.
27080
27081 @item "^connected"
27082 @findex ^connected
27083 @value{GDBN} has connected to a remote target.
27084
27085 @item "^error" "," "msg=" @var{c-string} [ "," "code=" @var{c-string} ]
27086 @findex ^error
27087 The operation failed.  The @code{msg=@var{c-string}} variable contains
27088 the corresponding error message.
27089
27090 If present, the @code{code=@var{c-string}} variable provides an error
27091 code on which consumers can rely on to detect the corresponding
27092 error condition.  At present, only one error code is defined:
27093
27094 @table @samp
27095 @item "undefined-command"
27096 Indicates that the command causing the error does not exist.
27097 @end table
27098
27099 @item "^exit"
27100 @findex ^exit
27101 @value{GDBN} has terminated.
27102
27103 @end table
27104
27105 @node GDB/MI Stream Records
27106 @subsection @sc{gdb/mi} Stream Records
27107
27108 @cindex @sc{gdb/mi}, stream records
27109 @cindex stream records in @sc{gdb/mi}
27110 @value{GDBN} internally maintains a number of output streams: the console, the
27111 target, and the log.  The output intended for each of these streams is
27112 funneled through the @sc{gdb/mi} interface using @dfn{stream records}.
27113
27114 Each stream record begins with a unique @dfn{prefix character} which
27115 identifies its stream (@pxref{GDB/MI Output Syntax, , @sc{gdb/mi} Output
27116 Syntax}).  In addition to the prefix, each stream record contains a
27117 @code{@var{string-output}}.  This is either raw text (with an implicit new
27118 line) or a quoted C string (which does not contain an implicit newline).
27119
27120 @table @code
27121 @item "~" @var{string-output}
27122 The console output stream contains text that should be displayed in the
27123 CLI console window.  It contains the textual responses to CLI commands.
27124
27125 @item "@@" @var{string-output}
27126 The target output stream contains any textual output from the running
27127 target.  This is only present when GDB's event loop is truly
27128 asynchronous, which is currently only the case for remote targets.
27129
27130 @item "&" @var{string-output}
27131 The log stream contains debugging messages being produced by @value{GDBN}'s
27132 internals.
27133 @end table
27134
27135 @node GDB/MI Async Records
27136 @subsection @sc{gdb/mi} Async Records
27137
27138 @cindex async records in @sc{gdb/mi}
27139 @cindex @sc{gdb/mi}, async records
27140 @dfn{Async} records are used to notify the @sc{gdb/mi} client of
27141 additional changes that have occurred.  Those changes can either be a
27142 consequence of @sc{gdb/mi} commands (e.g., a breakpoint modified) or a result of
27143 target activity (e.g., target stopped).
27144
27145 The following is the list of possible async records:
27146
27147 @table @code
27148
27149 @item *running,thread-id="@var{thread}"
27150 The target is now running.  The @var{thread} field can be the global
27151 thread ID of the the thread that is now running, and it can be
27152 @samp{all} if all threads are running.  The frontend should assume
27153 that no interaction with a running thread is possible after this
27154 notification is produced.  The frontend should not assume that this
27155 notification is output only once for any command.  @value{GDBN} may
27156 emit this notification several times, either for different threads,
27157 because it cannot resume all threads together, or even for a single
27158 thread, if the thread must be stepped though some code before letting
27159 it run freely.
27160
27161 @item *stopped,reason="@var{reason}",thread-id="@var{id}",stopped-threads="@var{stopped}",core="@var{core}"
27162 The target has stopped.  The @var{reason} field can have one of the
27163 following values:
27164
27165 @table @code
27166 @item breakpoint-hit
27167 A breakpoint was reached.
27168 @item watchpoint-trigger
27169 A watchpoint was triggered.
27170 @item read-watchpoint-trigger
27171 A read watchpoint was triggered.
27172 @item access-watchpoint-trigger 
27173 An access watchpoint was triggered.
27174 @item function-finished
27175 An -exec-finish or similar CLI command was accomplished.
27176 @item location-reached
27177 An -exec-until or similar CLI command was accomplished.
27178 @item watchpoint-scope
27179 A watchpoint has gone out of scope.
27180 @item end-stepping-range
27181 An -exec-next, -exec-next-instruction, -exec-step, -exec-step-instruction or 
27182 similar CLI command was accomplished.
27183 @item exited-signalled 
27184 The inferior exited because of a signal.
27185 @item exited 
27186 The inferior exited.
27187 @item exited-normally 
27188 The inferior exited normally.
27189 @item signal-received 
27190 A signal was received by the inferior.
27191 @item solib-event
27192 The inferior has stopped due to a library being loaded or unloaded.
27193 This can happen when @code{stop-on-solib-events} (@pxref{Files}) is
27194 set or when a @code{catch load} or @code{catch unload} catchpoint is
27195 in use (@pxref{Set Catchpoints}).
27196 @item fork
27197 The inferior has forked.  This is reported when @code{catch fork}
27198 (@pxref{Set Catchpoints}) has been used.
27199 @item vfork
27200 The inferior has vforked.  This is reported in when @code{catch vfork}
27201 (@pxref{Set Catchpoints}) has been used.
27202 @item syscall-entry
27203 The inferior entered a system call.  This is reported when @code{catch
27204 syscall} (@pxref{Set Catchpoints}) has been used.
27205 @item syscall-return
27206 The inferior returned from a system call.  This is reported when
27207 @code{catch syscall} (@pxref{Set Catchpoints}) has been used.
27208 @item exec
27209 The inferior called @code{exec}.  This is reported when @code{catch exec}
27210 (@pxref{Set Catchpoints}) has been used.
27211 @end table
27212
27213 The @var{id} field identifies the global thread ID of the thread
27214 that directly caused the stop -- for example by hitting a breakpoint.
27215 Depending on whether all-stop
27216 mode is in effect (@pxref{All-Stop Mode}), @value{GDBN} may either
27217 stop all threads, or only the thread that directly triggered the stop.
27218 If all threads are stopped, the @var{stopped} field will have the
27219 value of @code{"all"}.  Otherwise, the value of the @var{stopped}
27220 field will be a list of thread identifiers.  Presently, this list will
27221 always include a single thread, but frontend should be prepared to see
27222 several threads in the list.  The @var{core} field reports the
27223 processor core on which the stop event has happened.  This field may be absent
27224 if such information is not available.
27225
27226 @item =thread-group-added,id="@var{id}"
27227 @itemx =thread-group-removed,id="@var{id}"
27228 A thread group was either added or removed.  The @var{id} field
27229 contains the @value{GDBN} identifier of the thread group.  When a thread
27230 group is added, it generally might not be associated with a running
27231 process.  When a thread group is removed, its id becomes invalid and
27232 cannot be used in any way.
27233
27234 @item =thread-group-started,id="@var{id}",pid="@var{pid}"
27235 A thread group became associated with a running program,
27236 either because the program was just started or the thread group
27237 was attached to a program.  The @var{id} field contains the
27238 @value{GDBN} identifier of the thread group.  The @var{pid} field
27239 contains process identifier, specific to the operating system.
27240
27241 @item =thread-group-exited,id="@var{id}"[,exit-code="@var{code}"]
27242 A thread group is no longer associated with a running program,
27243 either because the program has exited, or because it was detached
27244 from.  The @var{id} field contains the @value{GDBN} identifier of the
27245 thread group.  The @var{code} field is the exit code of the inferior; it exists
27246 only when the inferior exited with some code.
27247
27248 @item =thread-created,id="@var{id}",group-id="@var{gid}"
27249 @itemx =thread-exited,id="@var{id}",group-id="@var{gid}"
27250 A thread either was created, or has exited.  The @var{id} field
27251 contains the global @value{GDBN} identifier of the thread.  The @var{gid}
27252 field identifies the thread group this thread belongs to.
27253
27254 @item =thread-selected,id="@var{id}"[,frame="@var{frame}"]
27255 Informs that the selected thread or frame were changed.  This notification
27256 is not emitted as result of the @code{-thread-select} or
27257 @code{-stack-select-frame} commands, but is emitted whenever an MI command
27258 that is not documented to change the selected thread and frame actually
27259 changes them.  In particular, invoking, directly or indirectly
27260 (via user-defined command), the CLI @code{thread} or @code{frame} commands,
27261 will generate this notification.  Changing the thread or frame from another
27262 user interface (see @ref{Interpreters}) will also generate this notification.
27263
27264 The @var{frame} field is only present if the newly selected thread is
27265 stopped.  See @ref{GDB/MI Frame Information} for the format of its value.
27266
27267 We suggest that in response to this notification, front ends
27268 highlight the selected thread and cause subsequent commands to apply to
27269 that thread.
27270
27271 @item =library-loaded,...
27272 Reports that a new library file was loaded by the program.  This
27273 notification has 5 fields---@var{id}, @var{target-name},
27274 @var{host-name}, @var{symbols-loaded} and @var{ranges}.  The @var{id} field is an
27275 opaque identifier of the library.  For remote debugging case,
27276 @var{target-name} and @var{host-name} fields give the name of the
27277 library file on the target, and on the host respectively.  For native
27278 debugging, both those fields have the same value.  The
27279 @var{symbols-loaded} field is emitted only for backward compatibility
27280 and should not be relied on to convey any useful information.  The
27281 @var{thread-group} field, if present, specifies the id of the thread
27282 group in whose context the library was loaded.  If the field is
27283 absent, it means the library was loaded in the context of all present
27284 thread groups.  The @var{ranges} field specifies the ranges of addresses belonging
27285 to this library.
27286
27287 @item =library-unloaded,...
27288 Reports that a library was unloaded by the program.  This notification
27289 has 3 fields---@var{id}, @var{target-name} and @var{host-name} with
27290 the same meaning as for the @code{=library-loaded} notification.
27291 The @var{thread-group} field, if present, specifies the id of the
27292 thread group in whose context the library was unloaded.  If the field is
27293 absent, it means the library was unloaded in the context of all present
27294 thread groups.
27295
27296 @item =traceframe-changed,num=@var{tfnum},tracepoint=@var{tpnum}
27297 @itemx =traceframe-changed,end
27298 Reports that the trace frame was changed and its new number is
27299 @var{tfnum}.  The number of the tracepoint associated with this trace
27300 frame is @var{tpnum}.
27301
27302 @item =tsv-created,name=@var{name},initial=@var{initial}
27303 Reports that the new trace state variable @var{name} is created with
27304 initial value @var{initial}.
27305
27306 @item =tsv-deleted,name=@var{name}
27307 @itemx =tsv-deleted
27308 Reports that the trace state variable @var{name} is deleted or all
27309 trace state variables are deleted.
27310
27311 @item =tsv-modified,name=@var{name},initial=@var{initial}[,current=@var{current}]
27312 Reports that the trace state variable @var{name} is modified with
27313 the initial value @var{initial}. The current value @var{current} of
27314 trace state variable is optional and is reported if the current
27315 value of trace state variable is known.
27316
27317 @item =breakpoint-created,bkpt=@{...@}
27318 @itemx =breakpoint-modified,bkpt=@{...@}
27319 @itemx =breakpoint-deleted,id=@var{number}
27320 Reports that a breakpoint was created, modified, or deleted,
27321 respectively.  Only user-visible breakpoints are reported to the MI
27322 user.
27323
27324 The @var{bkpt} argument is of the same form as returned by the various
27325 breakpoint commands; @xref{GDB/MI Breakpoint Commands}.  The
27326 @var{number} is the ordinal number of the breakpoint.
27327
27328 Note that if a breakpoint is emitted in the result record of a
27329 command, then it will not also be emitted in an async record.
27330
27331 @item =record-started,thread-group="@var{id}",method="@var{method}"[,format="@var{format}"]
27332 @itemx =record-stopped,thread-group="@var{id}"
27333 Execution log recording was either started or stopped on an
27334 inferior.  The @var{id} is the @value{GDBN} identifier of the thread
27335 group corresponding to the affected inferior.
27336
27337 The @var{method} field indicates the method used to record execution.  If the
27338 method in use supports multiple recording formats, @var{format} will be present
27339 and contain the currently used format.  @xref{Process Record and Replay},
27340 for existing method and format values.
27341
27342 @item =cmd-param-changed,param=@var{param},value=@var{value}
27343 Reports that a parameter of the command @code{set @var{param}} is
27344 changed to @var{value}.  In the multi-word @code{set} command,
27345 the @var{param} is the whole parameter list to @code{set} command.
27346 For example, In command @code{set check type on}, @var{param}
27347 is @code{check type} and @var{value} is @code{on}.
27348
27349 @item =memory-changed,thread-group=@var{id},addr=@var{addr},len=@var{len}[,type="code"]
27350 Reports that bytes from @var{addr} to @var{data} + @var{len} were
27351 written in an inferior.  The @var{id} is the identifier of the
27352 thread group corresponding to the affected inferior.  The optional
27353 @code{type="code"} part is reported if the memory written to holds
27354 executable code.
27355 @end table
27356
27357 @node GDB/MI Breakpoint Information
27358 @subsection @sc{gdb/mi} Breakpoint Information
27359
27360 When @value{GDBN} reports information about a breakpoint, a
27361 tracepoint, a watchpoint, or a catchpoint, it uses a tuple with the
27362 following fields:
27363
27364 @table @code
27365 @item number
27366 The breakpoint number.  For a breakpoint that represents one location
27367 of a multi-location breakpoint, this will be a dotted pair, like
27368 @samp{1.2}.
27369
27370 @item type
27371 The type of the breakpoint.  For ordinary breakpoints this will be
27372 @samp{breakpoint}, but many values are possible.
27373
27374 @item catch-type
27375 If the type of the breakpoint is @samp{catchpoint}, then this
27376 indicates the exact type of catchpoint.
27377
27378 @item disp
27379 This is the breakpoint disposition---either @samp{del}, meaning that
27380 the breakpoint will be deleted at the next stop, or @samp{keep},
27381 meaning that the breakpoint will not be deleted.
27382
27383 @item enabled
27384 This indicates whether the breakpoint is enabled, in which case the
27385 value is @samp{y}, or disabled, in which case the value is @samp{n}.
27386 Note that this is not the same as the field @code{enable}.
27387
27388 @item addr
27389 The address of the breakpoint.  This may be a hexidecimal number,
27390 giving the address; or the string @samp{<PENDING>}, for a pending
27391 breakpoint; or the string @samp{<MULTIPLE>}, for a breakpoint with
27392 multiple locations.  This field will not be present if no address can
27393 be determined.  For example, a watchpoint does not have an address.
27394
27395 @item func
27396 If known, the function in which the breakpoint appears.
27397 If not known, this field is not present.
27398
27399 @item filename
27400 The name of the source file which contains this function, if known.
27401 If not known, this field is not present.
27402
27403 @item fullname
27404 The full file name of the source file which contains this function, if
27405 known.  If not known, this field is not present.
27406
27407 @item line
27408 The line number at which this breakpoint appears, if known.
27409 If not known, this field is not present.
27410
27411 @item at
27412 If the source file is not known, this field may be provided.  If
27413 provided, this holds the address of the breakpoint, possibly followed
27414 by a symbol name.
27415
27416 @item pending
27417 If this breakpoint is pending, this field is present and holds the
27418 text used to set the breakpoint, as entered by the user.
27419
27420 @item evaluated-by
27421 Where this breakpoint's condition is evaluated, either @samp{host} or
27422 @samp{target}.
27423
27424 @item thread
27425 If this is a thread-specific breakpoint, then this identifies the
27426 thread in which the breakpoint can trigger.
27427
27428 @item task
27429 If this breakpoint is restricted to a particular Ada task, then this
27430 field will hold the task identifier.
27431
27432 @item cond
27433 If the breakpoint is conditional, this is the condition expression.
27434
27435 @item ignore
27436 The ignore count of the breakpoint.
27437
27438 @item enable
27439 The enable count of the breakpoint.
27440
27441 @item traceframe-usage
27442 FIXME.
27443
27444 @item static-tracepoint-marker-string-id
27445 For a static tracepoint, the name of the static tracepoint marker.
27446
27447 @item mask
27448 For a masked watchpoint, this is the mask.
27449
27450 @item pass
27451 A tracepoint's pass count.
27452
27453 @item original-location
27454 The location of the breakpoint as originally specified by the user.
27455 This field is optional.
27456
27457 @item times
27458 The number of times the breakpoint has been hit.
27459
27460 @item installed
27461 This field is only given for tracepoints.  This is either @samp{y},
27462 meaning that the tracepoint is installed, or @samp{n}, meaning that it
27463 is not.
27464
27465 @item what
27466 Some extra data, the exact contents of which are type-dependent.
27467
27468 @end table
27469
27470 For example, here is what the output of @code{-break-insert}
27471 (@pxref{GDB/MI Breakpoint Commands}) might be:
27472
27473 @smallexample
27474 -> -break-insert main
27475 <- ^done,bkpt=@{number="1",type="breakpoint",disp="keep",
27476     enabled="y",addr="0x08048564",func="main",file="myprog.c",
27477     fullname="/home/nickrob/myprog.c",line="68",thread-groups=["i1"],
27478     times="0"@}
27479 <- (gdb)
27480 @end smallexample
27481
27482 @node GDB/MI Frame Information
27483 @subsection @sc{gdb/mi} Frame Information
27484
27485 Response from many MI commands includes an information about stack
27486 frame.  This information is a tuple that may have the following
27487 fields:
27488
27489 @table @code
27490 @item level
27491 The level of the stack frame.  The innermost frame has the level of
27492 zero.  This field is always present.
27493
27494 @item func
27495 The name of the function corresponding to the frame.  This field may
27496 be absent if @value{GDBN} is unable to determine the function name.
27497
27498 @item addr
27499 The code address for the frame.  This field is always present.
27500
27501 @item file
27502 The name of the source files that correspond to the frame's code
27503 address.  This field may be absent.
27504
27505 @item line
27506 The source line corresponding to the frames' code address.  This field
27507 may be absent.
27508
27509 @item from
27510 The name of the binary file (either executable or shared library) the
27511 corresponds to the frame's code address.  This field may be absent.
27512
27513 @end table
27514
27515 @node GDB/MI Thread Information
27516 @subsection @sc{gdb/mi} Thread Information
27517
27518 Whenever @value{GDBN} has to report an information about a thread, it
27519 uses a tuple with the following fields.  The fields are always present unless
27520 stated otherwise.
27521
27522 @table @code
27523 @item id
27524 The global numeric id assigned to the thread by @value{GDBN}.
27525
27526 @item target-id
27527 The target-specific string identifying the thread.
27528
27529 @item details
27530 Additional information about the thread provided by the target.
27531 It is supposed to be human-readable and not interpreted by the
27532 frontend.  This field is optional.
27533
27534 @item name
27535 The name of the thread.  If the user specified a name using the
27536 @code{thread name} command, then this name is given.  Otherwise, if
27537 @value{GDBN} can extract the thread name from the target, then that
27538 name is given.  If @value{GDBN} cannot find the thread name, then this
27539 field is omitted.
27540
27541 @item state
27542 The execution state of the thread, either @samp{stopped} or @samp{running},
27543 depending on whether the thread is presently running.
27544
27545 @item frame
27546 The stack frame currently executing in the thread.  This field is only present
27547 if the thread is stopped.  Its format is documented in
27548 @ref{GDB/MI Frame Information}.
27549
27550 @item core
27551 The value of this field is an integer number of the processor core the
27552 thread was last seen on.  This field is optional.
27553 @end table
27554
27555 @node GDB/MI Ada Exception Information
27556 @subsection @sc{gdb/mi} Ada Exception Information
27557
27558 Whenever a @code{*stopped} record is emitted because the program
27559 stopped after hitting an exception catchpoint (@pxref{Set Catchpoints}),
27560 @value{GDBN} provides the name of the exception that was raised via
27561 the @code{exception-name} field.  Also, for exceptions that were raised
27562 with an exception message, @value{GDBN} provides that message via
27563 the @code{exception-message} field.
27564
27565 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
27566 @node GDB/MI Simple Examples
27567 @section Simple Examples of @sc{gdb/mi} Interaction
27568 @cindex @sc{gdb/mi}, simple examples
27569
27570 This subsection presents several simple examples of interaction using
27571 the @sc{gdb/mi} interface.  In these examples, @samp{->} means that the
27572 following line is passed to @sc{gdb/mi} as input, while @samp{<-} means
27573 the output received from @sc{gdb/mi}.
27574
27575 Note the line breaks shown in the examples are here only for
27576 readability, they don't appear in the real output.
27577
27578 @subheading Setting a Breakpoint
27579
27580 Setting a breakpoint generates synchronous output which contains detailed
27581 information of the breakpoint.
27582
27583 @smallexample
27584 -> -break-insert main
27585 <- ^done,bkpt=@{number="1",type="breakpoint",disp="keep",
27586     enabled="y",addr="0x08048564",func="main",file="myprog.c",
27587     fullname="/home/nickrob/myprog.c",line="68",thread-groups=["i1"],
27588     times="0"@}
27589 <- (gdb)
27590 @end smallexample
27591
27592 @subheading Program Execution
27593
27594 Program execution generates asynchronous records and MI gives the
27595 reason that execution stopped.
27596
27597 @smallexample
27598 -> -exec-run
27599 <- ^running
27600 <- (gdb)
27601 <- *stopped,reason="breakpoint-hit",disp="keep",bkptno="1",thread-id="0",
27602    frame=@{addr="0x08048564",func="main",
27603    args=[@{name="argc",value="1"@},@{name="argv",value="0xbfc4d4d4"@}],
27604    file="myprog.c",fullname="/home/nickrob/myprog.c",line="68"@}
27605 <- (gdb)
27606 -> -exec-continue
27607 <- ^running
27608 <- (gdb)
27609 <- *stopped,reason="exited-normally"
27610 <- (gdb)
27611 @end smallexample
27612
27613 @subheading Quitting @value{GDBN}
27614
27615 Quitting @value{GDBN} just prints the result class @samp{^exit}.
27616
27617 @smallexample
27618 -> (gdb)
27619 <- -gdb-exit
27620 <- ^exit
27621 @end smallexample
27622
27623 Please note that @samp{^exit} is printed immediately, but it might
27624 take some time for @value{GDBN} to actually exit.  During that time, @value{GDBN}
27625 performs necessary cleanups, including killing programs being debugged
27626 or disconnecting from debug hardware, so the frontend should wait till
27627 @value{GDBN} exits and should only forcibly kill @value{GDBN} if it
27628 fails to exit in reasonable time.
27629
27630 @subheading A Bad Command
27631
27632 Here's what happens if you pass a non-existent command:
27633
27634 @smallexample
27635 -> -rubbish
27636 <- ^error,msg="Undefined MI command: rubbish"
27637 <- (gdb)
27638 @end smallexample
27639
27640
27641 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
27642 @node GDB/MI Command Description Format
27643 @section @sc{gdb/mi} Command Description Format
27644
27645 The remaining sections describe blocks of commands.  Each block of
27646 commands is laid out in a fashion similar to this section.
27647
27648 @subheading Motivation
27649
27650 The motivation for this collection of commands.
27651
27652 @subheading Introduction
27653
27654 A brief introduction to this collection of commands as a whole.
27655
27656 @subheading Commands
27657
27658 For each command in the block, the following is described:
27659
27660 @subsubheading Synopsis
27661
27662 @smallexample
27663  -command @var{args}@dots{}
27664 @end smallexample
27665
27666 @subsubheading Result
27667
27668 @subsubheading @value{GDBN} Command
27669
27670 The corresponding @value{GDBN} CLI command(s), if any.
27671
27672 @subsubheading Example
27673
27674 Example(s) formatted for readability.  Some of the described commands  have
27675 not been implemented yet and these are labeled N.A.@: (not available).
27676
27677
27678 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
27679 @node GDB/MI Breakpoint Commands
27680 @section @sc{gdb/mi} Breakpoint Commands
27681
27682 @cindex breakpoint commands for @sc{gdb/mi}
27683 @cindex @sc{gdb/mi}, breakpoint commands
27684 This section documents @sc{gdb/mi} commands for manipulating
27685 breakpoints.
27686
27687 @subheading The @code{-break-after} Command
27688 @findex -break-after
27689
27690 @subsubheading Synopsis
27691
27692 @smallexample
27693  -break-after @var{number} @var{count}
27694 @end smallexample
27695
27696 The breakpoint number @var{number} is not in effect until it has been
27697 hit @var{count} times.  To see how this is reflected in the output of
27698 the @samp{-break-list} command, see the description of the
27699 @samp{-break-list} command below.
27700
27701 @subsubheading @value{GDBN} Command
27702
27703 The corresponding @value{GDBN} command is @samp{ignore}.
27704
27705 @subsubheading Example
27706
27707 @smallexample
27708 (gdb)
27709 -break-insert main
27710 ^done,bkpt=@{number="1",type="breakpoint",disp="keep",
27711 enabled="y",addr="0x000100d0",func="main",file="hello.c",
27712 fullname="/home/foo/hello.c",line="5",thread-groups=["i1"],
27713 times="0"@}
27714 (gdb)
27715 -break-after 1 3
27716 ~
27717 ^done
27718 (gdb)
27719 -break-list
27720 ^done,BreakpointTable=@{nr_rows="1",nr_cols="6",
27721 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
27722 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
27723 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
27724 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
27725 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
27726 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
27727 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
27728 addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c",
27729 line="5",thread-groups=["i1"],times="0",ignore="3"@}]@}
27730 (gdb)
27731 @end smallexample
27732
27733 @ignore
27734 @subheading The @code{-break-catch} Command
27735 @findex -break-catch
27736 @end ignore
27737
27738 @subheading The @code{-break-commands} Command
27739 @findex -break-commands
27740
27741 @subsubheading Synopsis
27742
27743 @smallexample
27744  -break-commands @var{number} [ @var{command1} ... @var{commandN} ]
27745 @end smallexample
27746
27747 Specifies the CLI commands that should be executed when breakpoint
27748 @var{number} is hit.  The parameters @var{command1} to @var{commandN}
27749 are the commands.  If no command is specified, any previously-set
27750 commands are cleared.  @xref{Break Commands}.  Typical use of this
27751 functionality is tracing a program, that is, printing of values of
27752 some variables whenever breakpoint is hit and then continuing.
27753
27754 @subsubheading @value{GDBN} Command
27755
27756 The corresponding @value{GDBN} command is @samp{commands}.
27757
27758 @subsubheading Example
27759
27760 @smallexample
27761 (gdb)
27762 -break-insert main
27763 ^done,bkpt=@{number="1",type="breakpoint",disp="keep",
27764 enabled="y",addr="0x000100d0",func="main",file="hello.c",
27765 fullname="/home/foo/hello.c",line="5",thread-groups=["i1"],
27766 times="0"@}
27767 (gdb)
27768 -break-commands 1 "print v" "continue"
27769 ^done
27770 (gdb)
27771 @end smallexample
27772
27773 @subheading The @code{-break-condition} Command
27774 @findex -break-condition
27775
27776 @subsubheading Synopsis
27777
27778 @smallexample
27779  -break-condition @var{number} @var{expr}
27780 @end smallexample
27781
27782 Breakpoint @var{number} will stop the program only if the condition in
27783 @var{expr} is true.  The condition becomes part of the
27784 @samp{-break-list} output (see the description of the @samp{-break-list}
27785 command below).
27786
27787 @subsubheading @value{GDBN} Command
27788
27789 The corresponding @value{GDBN} command is @samp{condition}.
27790
27791 @subsubheading Example
27792
27793 @smallexample
27794 (gdb)
27795 -break-condition 1 1
27796 ^done
27797 (gdb)
27798 -break-list
27799 ^done,BreakpointTable=@{nr_rows="1",nr_cols="6",
27800 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
27801 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
27802 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
27803 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
27804 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
27805 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
27806 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
27807 addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c",
27808 line="5",cond="1",thread-groups=["i1"],times="0",ignore="3"@}]@}
27809 (gdb)
27810 @end smallexample
27811
27812 @subheading The @code{-break-delete} Command
27813 @findex -break-delete
27814
27815 @subsubheading Synopsis
27816
27817 @smallexample
27818  -break-delete ( @var{breakpoint} )+
27819 @end smallexample
27820
27821 Delete the breakpoint(s) whose number(s) are specified in the argument
27822 list.  This is obviously reflected in the breakpoint list.
27823
27824 @subsubheading @value{GDBN} Command
27825
27826 The corresponding @value{GDBN} command is @samp{delete}.
27827
27828 @subsubheading Example
27829
27830 @smallexample
27831 (gdb)
27832 -break-delete 1
27833 ^done
27834 (gdb)
27835 -break-list
27836 ^done,BreakpointTable=@{nr_rows="0",nr_cols="6",
27837 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
27838 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
27839 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
27840 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
27841 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
27842 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
27843 body=[]@}
27844 (gdb)
27845 @end smallexample
27846
27847 @subheading The @code{-break-disable} Command
27848 @findex -break-disable
27849
27850 @subsubheading Synopsis
27851
27852 @smallexample
27853  -break-disable ( @var{breakpoint} )+
27854 @end smallexample
27855
27856 Disable the named @var{breakpoint}(s).  The field @samp{enabled} in the
27857 break list is now set to @samp{n} for the named @var{breakpoint}(s).
27858
27859 @subsubheading @value{GDBN} Command
27860
27861 The corresponding @value{GDBN} command is @samp{disable}.
27862
27863 @subsubheading Example
27864
27865 @smallexample
27866 (gdb)
27867 -break-disable 2
27868 ^done
27869 (gdb)
27870 -break-list
27871 ^done,BreakpointTable=@{nr_rows="1",nr_cols="6",
27872 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
27873 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
27874 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
27875 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
27876 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
27877 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
27878 body=[bkpt=@{number="2",type="breakpoint",disp="keep",enabled="n",
27879 addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c",
27880 line="5",thread-groups=["i1"],times="0"@}]@}
27881 (gdb)
27882 @end smallexample
27883
27884 @subheading The @code{-break-enable} Command
27885 @findex -break-enable
27886
27887 @subsubheading Synopsis
27888
27889 @smallexample
27890  -break-enable ( @var{breakpoint} )+
27891 @end smallexample
27892
27893 Enable (previously disabled) @var{breakpoint}(s).
27894
27895 @subsubheading @value{GDBN} Command
27896
27897 The corresponding @value{GDBN} command is @samp{enable}.
27898
27899 @subsubheading Example
27900
27901 @smallexample
27902 (gdb)
27903 -break-enable 2
27904 ^done
27905 (gdb)
27906 -break-list
27907 ^done,BreakpointTable=@{nr_rows="1",nr_cols="6",
27908 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
27909 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
27910 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
27911 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
27912 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
27913 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
27914 body=[bkpt=@{number="2",type="breakpoint",disp="keep",enabled="y",
27915 addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c",
27916 line="5",thread-groups=["i1"],times="0"@}]@}
27917 (gdb)
27918 @end smallexample
27919
27920 @subheading The @code{-break-info} Command
27921 @findex -break-info
27922
27923 @subsubheading Synopsis
27924
27925 @smallexample
27926  -break-info @var{breakpoint}
27927 @end smallexample
27928
27929 @c REDUNDANT???
27930 Get information about a single breakpoint.
27931
27932 The result is a table of breakpoints.  @xref{GDB/MI Breakpoint
27933 Information}, for details on the format of each breakpoint in the
27934 table.
27935
27936 @subsubheading @value{GDBN} Command
27937
27938 The corresponding @value{GDBN} command is @samp{info break @var{breakpoint}}.
27939
27940 @subsubheading Example
27941 N.A.
27942
27943 @subheading The @code{-break-insert} Command
27944 @findex -break-insert
27945 @anchor{-break-insert}
27946
27947 @subsubheading Synopsis
27948
27949 @smallexample
27950  -break-insert [ -t ] [ -h ] [ -f ] [ -d ] [ -a ]
27951     [ -c @var{condition} ] [ -i @var{ignore-count} ]
27952     [ -p @var{thread-id} ] [ @var{location} ]
27953 @end smallexample
27954
27955 @noindent
27956 If specified, @var{location}, can be one of:
27957
27958 @table @var
27959 @item linespec location
27960 A linespec location.  @xref{Linespec Locations}.
27961
27962 @item explicit location
27963 An explicit location.  @sc{gdb/mi} explicit locations are
27964 analogous to the CLI's explicit locations using the option names
27965 listed below.  @xref{Explicit Locations}.
27966
27967 @table @samp
27968 @item --source @var{filename}
27969 The source file name of the location.  This option requires the use
27970 of either @samp{--function} or @samp{--line}.
27971
27972 @item --function @var{function}
27973 The name of a function or method.
27974
27975 @item --label @var{label}
27976 The name of a label.
27977
27978 @item --line @var{lineoffset}
27979 An absolute or relative line offset from the start of the location.
27980 @end table
27981
27982 @item address location
27983 An address location, *@var{address}.  @xref{Address Locations}.
27984 @end table
27985
27986 @noindent
27987 The possible optional parameters of this command are:
27988
27989 @table @samp
27990 @item -t
27991 Insert a temporary breakpoint.
27992 @item -h
27993 Insert a hardware breakpoint.
27994 @item -f
27995 If @var{location} cannot be parsed (for example if it
27996 refers to unknown files or functions), create a pending
27997 breakpoint. Without this flag, @value{GDBN} will report
27998 an error, and won't create a breakpoint, if @var{location}
27999 cannot be parsed.
28000 @item -d
28001 Create a disabled breakpoint.
28002 @item -a
28003 Create a tracepoint.  @xref{Tracepoints}.  When this parameter
28004 is used together with @samp{-h}, a fast tracepoint is created.
28005 @item -c @var{condition}
28006 Make the breakpoint conditional on @var{condition}.
28007 @item -i @var{ignore-count}
28008 Initialize the @var{ignore-count}.
28009 @item -p @var{thread-id}
28010 Restrict the breakpoint to the thread with the specified global
28011 @var{thread-id}.
28012 @end table
28013
28014 @subsubheading Result
28015
28016 @xref{GDB/MI Breakpoint Information}, for details on the format of the
28017 resulting breakpoint.
28018
28019 Note: this format is open to change.
28020 @c An out-of-band breakpoint instead of part of the result?
28021
28022 @subsubheading @value{GDBN} Command
28023
28024 The corresponding @value{GDBN} commands are @samp{break}, @samp{tbreak},
28025 @samp{hbreak}, and @samp{thbreak}. @c and @samp{rbreak}.
28026
28027 @subsubheading Example
28028
28029 @smallexample
28030 (gdb)
28031 -break-insert main
28032 ^done,bkpt=@{number="1",addr="0x0001072c",file="recursive2.c",
28033 fullname="/home/foo/recursive2.c,line="4",thread-groups=["i1"],
28034 times="0"@}
28035 (gdb)
28036 -break-insert -t foo
28037 ^done,bkpt=@{number="2",addr="0x00010774",file="recursive2.c",
28038 fullname="/home/foo/recursive2.c,line="11",thread-groups=["i1"],
28039 times="0"@}
28040 (gdb)
28041 -break-list
28042 ^done,BreakpointTable=@{nr_rows="2",nr_cols="6",
28043 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
28044 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
28045 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
28046 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
28047 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
28048 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
28049 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
28050 addr="0x0001072c", func="main",file="recursive2.c",
28051 fullname="/home/foo/recursive2.c,"line="4",thread-groups=["i1"],
28052 times="0"@},
28053 bkpt=@{number="2",type="breakpoint",disp="del",enabled="y",
28054 addr="0x00010774",func="foo",file="recursive2.c",
28055 fullname="/home/foo/recursive2.c",line="11",thread-groups=["i1"],
28056 times="0"@}]@}
28057 (gdb)
28058 @c -break-insert -r foo.*
28059 @c ~int foo(int, int);
28060 @c ^done,bkpt=@{number="3",addr="0x00010774",file="recursive2.c,
28061 @c "fullname="/home/foo/recursive2.c",line="11",thread-groups=["i1"],
28062 @c times="0"@}
28063 @c (gdb)
28064 @end smallexample
28065
28066 @subheading The @code{-dprintf-insert} Command
28067 @findex -dprintf-insert
28068
28069 @subsubheading Synopsis
28070
28071 @smallexample
28072  -dprintf-insert [ -t ] [ -f ] [ -d ]
28073     [ -c @var{condition} ] [ -i @var{ignore-count} ]
28074     [ -p @var{thread-id} ] [ @var{location} ] [ @var{format} ]
28075     [ @var{argument} ]
28076 @end smallexample
28077
28078 @noindent
28079 If supplied, @var{location} may be specified the same way as for
28080 the @code{-break-insert} command.  @xref{-break-insert}.
28081
28082 The possible optional parameters of this command are:
28083
28084 @table @samp
28085 @item -t
28086 Insert a temporary breakpoint.
28087 @item -f
28088 If @var{location} cannot be parsed (for example, if it
28089 refers to unknown files or functions), create a pending
28090 breakpoint.  Without this flag, @value{GDBN} will report
28091 an error, and won't create a breakpoint, if @var{location}
28092 cannot be parsed.
28093 @item -d
28094 Create a disabled breakpoint.
28095 @item -c @var{condition}
28096 Make the breakpoint conditional on @var{condition}.
28097 @item -i @var{ignore-count}
28098 Set the ignore count of the breakpoint (@pxref{Conditions, ignore count})
28099 to @var{ignore-count}.
28100 @item -p @var{thread-id}
28101 Restrict the breakpoint to the thread with the specified global
28102 @var{thread-id}.
28103 @end table
28104
28105 @subsubheading Result
28106
28107 @xref{GDB/MI Breakpoint Information}, for details on the format of the
28108 resulting breakpoint.
28109
28110 @c An out-of-band breakpoint instead of part of the result?
28111
28112 @subsubheading @value{GDBN} Command
28113
28114 The corresponding @value{GDBN} command is @samp{dprintf}.
28115
28116 @subsubheading Example
28117
28118 @smallexample
28119 (gdb)
28120 4-dprintf-insert foo "At foo entry\n"
28121 4^done,bkpt=@{number="1",type="dprintf",disp="keep",enabled="y",
28122 addr="0x000000000040061b",func="foo",file="mi-dprintf.c",
28123 fullname="mi-dprintf.c",line="25",thread-groups=["i1"],
28124 times="0",script=@{"printf \"At foo entry\\n\"","continue"@},
28125 original-location="foo"@}
28126 (gdb)
28127 5-dprintf-insert 26 "arg=%d, g=%d\n" arg g
28128 5^done,bkpt=@{number="2",type="dprintf",disp="keep",enabled="y",
28129 addr="0x000000000040062a",func="foo",file="mi-dprintf.c",
28130 fullname="mi-dprintf.c",line="26",thread-groups=["i1"],
28131 times="0",script=@{"printf \"arg=%d, g=%d\\n\", arg, g","continue"@},
28132 original-location="mi-dprintf.c:26"@}
28133 (gdb)
28134 @end smallexample
28135
28136 @subheading The @code{-break-list} Command
28137 @findex -break-list
28138
28139 @subsubheading Synopsis
28140
28141 @smallexample
28142  -break-list
28143 @end smallexample
28144
28145 Displays the list of inserted breakpoints, showing the following fields:
28146
28147 @table @samp
28148 @item Number
28149 number of the breakpoint
28150 @item Type
28151 type of the breakpoint: @samp{breakpoint} or @samp{watchpoint}
28152 @item Disposition
28153 should the breakpoint be deleted or disabled when it is hit: @samp{keep}
28154 or @samp{nokeep}
28155 @item Enabled
28156 is the breakpoint enabled or no: @samp{y} or @samp{n}
28157 @item Address
28158 memory location at which the breakpoint is set
28159 @item What
28160 logical location of the breakpoint, expressed by function name, file
28161 name, line number
28162 @item Thread-groups
28163 list of thread groups to which this breakpoint applies
28164 @item Times
28165 number of times the breakpoint has been hit
28166 @end table
28167
28168 If there are no breakpoints or watchpoints, the @code{BreakpointTable}
28169 @code{body} field is an empty list.
28170
28171 @subsubheading @value{GDBN} Command
28172
28173 The corresponding @value{GDBN} command is @samp{info break}.
28174
28175 @subsubheading Example
28176
28177 @smallexample
28178 (gdb)
28179 -break-list
28180 ^done,BreakpointTable=@{nr_rows="2",nr_cols="6",
28181 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
28182 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
28183 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
28184 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
28185 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
28186 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
28187 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
28188 addr="0x000100d0",func="main",file="hello.c",line="5",thread-groups=["i1"],
28189 times="0"@},
28190 bkpt=@{number="2",type="breakpoint",disp="keep",enabled="y",
28191 addr="0x00010114",func="foo",file="hello.c",fullname="/home/foo/hello.c",
28192 line="13",thread-groups=["i1"],times="0"@}]@}
28193 (gdb)
28194 @end smallexample
28195
28196 Here's an example of the result when there are no breakpoints:
28197
28198 @smallexample
28199 (gdb)
28200 -break-list
28201 ^done,BreakpointTable=@{nr_rows="0",nr_cols="6",
28202 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
28203 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
28204 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
28205 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
28206 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
28207 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
28208 body=[]@}
28209 (gdb)
28210 @end smallexample
28211
28212 @subheading The @code{-break-passcount} Command
28213 @findex -break-passcount
28214
28215 @subsubheading Synopsis
28216
28217 @smallexample
28218  -break-passcount @var{tracepoint-number} @var{passcount}
28219 @end smallexample
28220
28221 Set the passcount for tracepoint @var{tracepoint-number} to
28222 @var{passcount}.  If the breakpoint referred to by @var{tracepoint-number}
28223 is not a tracepoint, error is emitted.  This corresponds to CLI
28224 command @samp{passcount}.
28225
28226 @subheading The @code{-break-watch} Command
28227 @findex -break-watch
28228
28229 @subsubheading Synopsis
28230
28231 @smallexample
28232  -break-watch [ -a | -r ]
28233 @end smallexample
28234
28235 Create a watchpoint.  With the @samp{-a} option it will create an
28236 @dfn{access} watchpoint, i.e., a watchpoint that triggers either on a
28237 read from or on a write to the memory location.  With the @samp{-r}
28238 option, the watchpoint created is a @dfn{read} watchpoint, i.e., it will
28239 trigger only when the memory location is accessed for reading.  Without
28240 either of the options, the watchpoint created is a regular watchpoint,
28241 i.e., it will trigger when the memory location is accessed for writing.
28242 @xref{Set Watchpoints, , Setting Watchpoints}.
28243
28244 Note that @samp{-break-list} will report a single list of watchpoints and
28245 breakpoints inserted.
28246
28247 @subsubheading @value{GDBN} Command
28248
28249 The corresponding @value{GDBN} commands are @samp{watch}, @samp{awatch}, and
28250 @samp{rwatch}.
28251
28252 @subsubheading Example
28253
28254 Setting a watchpoint on a variable in the @code{main} function:
28255
28256 @smallexample
28257 (gdb)
28258 -break-watch x
28259 ^done,wpt=@{number="2",exp="x"@}
28260 (gdb)
28261 -exec-continue
28262 ^running
28263 (gdb)
28264 *stopped,reason="watchpoint-trigger",wpt=@{number="2",exp="x"@},
28265 value=@{old="-268439212",new="55"@},
28266 frame=@{func="main",args=[],file="recursive2.c",
28267 fullname="/home/foo/bar/recursive2.c",line="5"@}
28268 (gdb)
28269 @end smallexample
28270
28271 Setting a watchpoint on a variable local to a function.  @value{GDBN} will stop
28272 the program execution twice: first for the variable changing value, then
28273 for the watchpoint going out of scope.
28274
28275 @smallexample
28276 (gdb)
28277 -break-watch C
28278 ^done,wpt=@{number="5",exp="C"@}
28279 (gdb)
28280 -exec-continue
28281 ^running
28282 (gdb)
28283 *stopped,reason="watchpoint-trigger",
28284 wpt=@{number="5",exp="C"@},value=@{old="-276895068",new="3"@},
28285 frame=@{func="callee4",args=[],
28286 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
28287 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="13"@}
28288 (gdb)
28289 -exec-continue
28290 ^running
28291 (gdb)
28292 *stopped,reason="watchpoint-scope",wpnum="5",
28293 frame=@{func="callee3",args=[@{name="strarg",
28294 value="0x11940 \"A string argument.\""@}],
28295 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
28296 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="18"@}
28297 (gdb)
28298 @end smallexample
28299
28300 Listing breakpoints and watchpoints, at different points in the program
28301 execution.  Note that once the watchpoint goes out of scope, it is
28302 deleted.
28303
28304 @smallexample
28305 (gdb)
28306 -break-watch C
28307 ^done,wpt=@{number="2",exp="C"@}
28308 (gdb)
28309 -break-list
28310 ^done,BreakpointTable=@{nr_rows="2",nr_cols="6",
28311 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
28312 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
28313 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
28314 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
28315 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
28316 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
28317 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
28318 addr="0x00010734",func="callee4",
28319 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
28320 fullname="/home/foo/devo/gdb/testsuite/gdb.mi/basics.c"line="8",thread-groups=["i1"],
28321 times="1"@},
28322 bkpt=@{number="2",type="watchpoint",disp="keep",
28323 enabled="y",addr="",what="C",thread-groups=["i1"],times="0"@}]@}
28324 (gdb)
28325 -exec-continue
28326 ^running
28327 (gdb)
28328 *stopped,reason="watchpoint-trigger",wpt=@{number="2",exp="C"@},
28329 value=@{old="-276895068",new="3"@},
28330 frame=@{func="callee4",args=[],
28331 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
28332 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="13"@}
28333 (gdb)
28334 -break-list
28335 ^done,BreakpointTable=@{nr_rows="2",nr_cols="6",
28336 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
28337 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
28338 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
28339 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
28340 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
28341 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
28342 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
28343 addr="0x00010734",func="callee4",
28344 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
28345 fullname="/home/foo/devo/gdb/testsuite/gdb.mi/basics.c",line="8",thread-groups=["i1"],
28346 times="1"@},
28347 bkpt=@{number="2",type="watchpoint",disp="keep",
28348 enabled="y",addr="",what="C",thread-groups=["i1"],times="-5"@}]@}
28349 (gdb)
28350 -exec-continue
28351 ^running
28352 ^done,reason="watchpoint-scope",wpnum="2",
28353 frame=@{func="callee3",args=[@{name="strarg",
28354 value="0x11940 \"A string argument.\""@}],
28355 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
28356 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="18"@}
28357 (gdb)
28358 -break-list
28359 ^done,BreakpointTable=@{nr_rows="1",nr_cols="6",
28360 hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@},
28361 @{width="14",alignment="-1",col_name="type",colhdr="Type"@},
28362 @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@},
28363 @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@},
28364 @{width="10",alignment="-1",col_name="addr",colhdr="Address"@},
28365 @{width="40",alignment="2",col_name="what",colhdr="What"@}],
28366 body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
28367 addr="0x00010734",func="callee4",
28368 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
28369 fullname="/home/foo/devo/gdb/testsuite/gdb.mi/basics.c",line="8",
28370 thread-groups=["i1"],times="1"@}]@}
28371 (gdb)
28372 @end smallexample
28373
28374
28375 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
28376 @node GDB/MI Catchpoint Commands
28377 @section @sc{gdb/mi} Catchpoint Commands
28378
28379 This section documents @sc{gdb/mi} commands for manipulating
28380 catchpoints.
28381
28382 @menu
28383 * Shared Library GDB/MI Catchpoint Commands::
28384 * Ada Exception GDB/MI Catchpoint Commands::
28385 @end menu
28386
28387 @node Shared Library GDB/MI Catchpoint Commands
28388 @subsection Shared Library @sc{gdb/mi} Catchpoints
28389
28390 @subheading The @code{-catch-load} Command
28391 @findex -catch-load
28392
28393 @subsubheading Synopsis
28394
28395 @smallexample
28396  -catch-load [ -t ] [ -d ] @var{regexp}
28397 @end smallexample
28398
28399 Add a catchpoint for library load events.  If the @samp{-t} option is used,
28400 the catchpoint is a temporary one (@pxref{Set Breaks, ,Setting
28401 Breakpoints}).  If the @samp{-d} option is used, the catchpoint is created
28402 in a disabled state.  The @samp{regexp} argument is a regular
28403 expression used to match the name of the loaded library.
28404
28405
28406 @subsubheading @value{GDBN} Command
28407
28408 The corresponding @value{GDBN} command is @samp{catch load}.
28409
28410 @subsubheading Example
28411
28412 @smallexample
28413 -catch-load -t foo.so
28414 ^done,bkpt=@{number="1",type="catchpoint",disp="del",enabled="y",
28415 what="load of library matching foo.so",catch-type="load",times="0"@}
28416 (gdb)
28417 @end smallexample
28418
28419
28420 @subheading The @code{-catch-unload} Command
28421 @findex -catch-unload
28422
28423 @subsubheading Synopsis
28424
28425 @smallexample
28426  -catch-unload [ -t ] [ -d ] @var{regexp}
28427 @end smallexample
28428
28429 Add a catchpoint for library unload events.  If the @samp{-t} option is
28430 used, the catchpoint is a temporary one (@pxref{Set Breaks, ,Setting
28431 Breakpoints}).  If the @samp{-d} option is used, the catchpoint is
28432 created in a disabled state.  The @samp{regexp} argument is a regular
28433 expression used to match the name of the unloaded library.
28434
28435 @subsubheading @value{GDBN} Command
28436
28437 The corresponding @value{GDBN} command is @samp{catch unload}.
28438
28439 @subsubheading Example
28440
28441 @smallexample
28442 -catch-unload -d bar.so
28443 ^done,bkpt=@{number="2",type="catchpoint",disp="keep",enabled="n",
28444 what="load of library matching bar.so",catch-type="unload",times="0"@}
28445 (gdb)
28446 @end smallexample
28447
28448 @node Ada Exception GDB/MI Catchpoint Commands
28449 @subsection Ada Exception @sc{gdb/mi} Catchpoints
28450
28451 The following @sc{gdb/mi} commands can be used to create catchpoints
28452 that stop the execution when Ada exceptions are being raised.
28453
28454 @subheading The @code{-catch-assert} Command
28455 @findex -catch-assert
28456
28457 @subsubheading Synopsis
28458
28459 @smallexample
28460  -catch-assert [ -c @var{condition}] [ -d ] [ -t ]
28461 @end smallexample
28462
28463 Add a catchpoint for failed Ada assertions.
28464
28465 The possible optional parameters for this command are:
28466
28467 @table @samp
28468 @item -c @var{condition}
28469 Make the catchpoint conditional on @var{condition}.
28470 @item -d
28471 Create a disabled catchpoint.
28472 @item -t
28473 Create a temporary catchpoint.
28474 @end table
28475
28476 @subsubheading @value{GDBN} Command
28477
28478 The corresponding @value{GDBN} command is @samp{catch assert}.
28479
28480 @subsubheading Example
28481
28482 @smallexample
28483 -catch-assert
28484 ^done,bkptno="5",bkpt=@{number="5",type="breakpoint",disp="keep",
28485 enabled="y",addr="0x0000000000404888",what="failed Ada assertions",
28486 thread-groups=["i1"],times="0",
28487 original-location="__gnat_debug_raise_assert_failure"@}
28488 (gdb)
28489 @end smallexample
28490
28491 @subheading The @code{-catch-exception} Command
28492 @findex -catch-exception
28493
28494 @subsubheading Synopsis
28495
28496 @smallexample
28497  -catch-exception [ -c @var{condition}] [ -d ] [ -e @var{exception-name} ]
28498     [ -t ] [ -u ]
28499 @end smallexample
28500
28501 Add a catchpoint stopping when Ada exceptions are raised.
28502 By default, the command stops the program when any Ada exception
28503 gets raised.  But it is also possible, by using some of the
28504 optional parameters described below, to create more selective
28505 catchpoints.
28506
28507 The possible optional parameters for this command are:
28508
28509 @table @samp
28510 @item -c @var{condition}
28511 Make the catchpoint conditional on @var{condition}.
28512 @item -d
28513 Create a disabled catchpoint.
28514 @item -e @var{exception-name}
28515 Only stop when @var{exception-name} is raised.  This option cannot
28516 be used combined with @samp{-u}.
28517 @item -t
28518 Create a temporary catchpoint.
28519 @item -u
28520 Stop only when an unhandled exception gets raised.  This option
28521 cannot be used combined with @samp{-e}.
28522 @end table
28523
28524 @subsubheading @value{GDBN} Command
28525
28526 The corresponding @value{GDBN} commands are @samp{catch exception}
28527 and @samp{catch exception unhandled}.
28528
28529 @subsubheading Example
28530
28531 @smallexample
28532 -catch-exception -e Program_Error
28533 ^done,bkptno="4",bkpt=@{number="4",type="breakpoint",disp="keep",
28534 enabled="y",addr="0x0000000000404874",
28535 what="`Program_Error' Ada exception", thread-groups=["i1"],
28536 times="0",original-location="__gnat_debug_raise_exception"@}
28537 (gdb)
28538 @end smallexample
28539
28540 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
28541 @node GDB/MI Program Context
28542 @section @sc{gdb/mi}  Program Context
28543
28544 @subheading The @code{-exec-arguments} Command
28545 @findex -exec-arguments
28546
28547
28548 @subsubheading Synopsis
28549
28550 @smallexample
28551  -exec-arguments @var{args}
28552 @end smallexample
28553
28554 Set the inferior program arguments, to be used in the next
28555 @samp{-exec-run}.
28556
28557 @subsubheading @value{GDBN} Command
28558
28559 The corresponding @value{GDBN} command is @samp{set args}.
28560
28561 @subsubheading Example
28562
28563 @smallexample
28564 (gdb)
28565 -exec-arguments -v word
28566 ^done
28567 (gdb)
28568 @end smallexample
28569
28570
28571 @ignore
28572 @subheading The @code{-exec-show-arguments} Command
28573 @findex -exec-show-arguments
28574
28575 @subsubheading Synopsis
28576
28577 @smallexample
28578  -exec-show-arguments
28579 @end smallexample
28580
28581 Print the arguments of the program.
28582
28583 @subsubheading @value{GDBN} Command
28584
28585 The corresponding @value{GDBN} command is @samp{show args}.
28586
28587 @subsubheading Example
28588 N.A.
28589 @end ignore
28590
28591
28592 @subheading The @code{-environment-cd} Command
28593 @findex -environment-cd
28594
28595 @subsubheading Synopsis
28596
28597 @smallexample
28598  -environment-cd @var{pathdir}
28599 @end smallexample
28600
28601 Set @value{GDBN}'s working directory.
28602
28603 @subsubheading @value{GDBN} Command
28604
28605 The corresponding @value{GDBN} command is @samp{cd}.
28606
28607 @subsubheading Example
28608
28609 @smallexample
28610 (gdb)
28611 -environment-cd /kwikemart/marge/ezannoni/flathead-dev/devo/gdb
28612 ^done
28613 (gdb)
28614 @end smallexample
28615
28616
28617 @subheading The @code{-environment-directory} Command
28618 @findex -environment-directory
28619
28620 @subsubheading Synopsis
28621
28622 @smallexample
28623  -environment-directory [ -r ] [ @var{pathdir} ]+
28624 @end smallexample
28625
28626 Add directories @var{pathdir} to beginning of search path for source files.
28627 If the @samp{-r} option is used, the search path is reset to the default
28628 search path.  If directories @var{pathdir} are supplied in addition to the
28629 @samp{-r} option, the search path is first reset and then addition
28630 occurs as normal.
28631 Multiple directories may be specified, separated by blanks.  Specifying
28632 multiple directories in a single command
28633 results in the directories added to the beginning of the
28634 search path in the same order they were presented in the command.
28635 If blanks are needed as
28636 part of a directory name, double-quotes should be used around
28637 the name.  In the command output, the path will show up separated
28638 by the system directory-separator character.  The directory-separator
28639 character must not be used
28640 in any directory name.
28641 If no directories are specified, the current search path is displayed.
28642
28643 @subsubheading @value{GDBN} Command
28644
28645 The corresponding @value{GDBN} command is @samp{dir}.
28646
28647 @subsubheading Example
28648
28649 @smallexample
28650 (gdb)
28651 -environment-directory /kwikemart/marge/ezannoni/flathead-dev/devo/gdb
28652 ^done,source-path="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb:$cdir:$cwd"
28653 (gdb)
28654 -environment-directory ""
28655 ^done,source-path="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb:$cdir:$cwd"
28656 (gdb)
28657 -environment-directory -r /home/jjohnstn/src/gdb /usr/src
28658 ^done,source-path="/home/jjohnstn/src/gdb:/usr/src:$cdir:$cwd"
28659 (gdb)
28660 -environment-directory -r
28661 ^done,source-path="$cdir:$cwd"
28662 (gdb)
28663 @end smallexample
28664
28665
28666 @subheading The @code{-environment-path} Command
28667 @findex -environment-path
28668
28669 @subsubheading Synopsis
28670
28671 @smallexample
28672  -environment-path [ -r ] [ @var{pathdir} ]+
28673 @end smallexample
28674
28675 Add directories @var{pathdir} to beginning of search path for object files.
28676 If the @samp{-r} option is used, the search path is reset to the original
28677 search path that existed at gdb start-up.  If directories @var{pathdir} are
28678 supplied in addition to the
28679 @samp{-r} option, the search path is first reset and then addition
28680 occurs as normal.
28681 Multiple directories may be specified, separated by blanks.  Specifying
28682 multiple directories in a single command
28683 results in the directories added to the beginning of the
28684 search path in the same order they were presented in the command.
28685 If blanks are needed as
28686 part of a directory name, double-quotes should be used around
28687 the name.  In the command output, the path will show up separated
28688 by the system directory-separator character.  The directory-separator
28689 character must not be used
28690 in any directory name.
28691 If no directories are specified, the current path is displayed.
28692
28693
28694 @subsubheading @value{GDBN} Command
28695
28696 The corresponding @value{GDBN} command is @samp{path}.
28697
28698 @subsubheading Example
28699
28700 @smallexample
28701 (gdb)
28702 -environment-path
28703 ^done,path="/usr/bin"
28704 (gdb)
28705 -environment-path /kwikemart/marge/ezannoni/flathead-dev/ppc-eabi/gdb /bin
28706 ^done,path="/kwikemart/marge/ezannoni/flathead-dev/ppc-eabi/gdb:/bin:/usr/bin"
28707 (gdb)
28708 -environment-path -r /usr/local/bin
28709 ^done,path="/usr/local/bin:/usr/bin"
28710 (gdb)
28711 @end smallexample
28712
28713
28714 @subheading The @code{-environment-pwd} Command
28715 @findex -environment-pwd
28716
28717 @subsubheading Synopsis
28718
28719 @smallexample
28720  -environment-pwd
28721 @end smallexample
28722
28723 Show the current working directory.
28724
28725 @subsubheading @value{GDBN} Command
28726
28727 The corresponding @value{GDBN} command is @samp{pwd}.
28728
28729 @subsubheading Example
28730
28731 @smallexample
28732 (gdb)
28733 -environment-pwd
28734 ^done,cwd="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb"
28735 (gdb)
28736 @end smallexample
28737
28738 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
28739 @node GDB/MI Thread Commands
28740 @section @sc{gdb/mi} Thread Commands
28741
28742
28743 @subheading The @code{-thread-info} Command
28744 @findex -thread-info
28745
28746 @subsubheading Synopsis
28747
28748 @smallexample
28749  -thread-info [ @var{thread-id} ]
28750 @end smallexample
28751
28752 Reports information about either a specific thread, if the
28753 @var{thread-id} parameter is present, or about all threads.
28754 @var{thread-id} is the thread's global thread ID.  When printing
28755 information about all threads, also reports the global ID of the
28756 current thread.
28757
28758 @subsubheading @value{GDBN} Command
28759
28760 The @samp{info thread} command prints the same information
28761 about all threads.
28762
28763 @subsubheading Result
28764
28765 The result contains the following attributes:
28766
28767 @table @samp
28768 @item threads
28769 A list of threads.  The format of the elements of the list is described in
28770 @ref{GDB/MI Thread Information}.
28771
28772 @item current-thread-id
28773 The global id of the currently selected thread.  This field is omitted if there
28774 is no selected thread (for example, when the selected inferior is not running,
28775 and therefore has no threads) or if a @var{thread-id} argument was passed to
28776 the command.
28777
28778 @end table
28779
28780 @subsubheading Example
28781
28782 @smallexample
28783 -thread-info
28784 ^done,threads=[
28785 @{id="2",target-id="Thread 0xb7e14b90 (LWP 21257)",
28786    frame=@{level="0",addr="0xffffe410",func="__kernel_vsyscall",
28787            args=[]@},state="running"@},
28788 @{id="1",target-id="Thread 0xb7e156b0 (LWP 21254)",
28789    frame=@{level="0",addr="0x0804891f",func="foo",
28790            args=[@{name="i",value="10"@}],
28791            file="/tmp/a.c",fullname="/tmp/a.c",line="158"@},
28792            state="running"@}],
28793 current-thread-id="1"
28794 (gdb)
28795 @end smallexample
28796
28797 @subheading The @code{-thread-list-ids} Command
28798 @findex -thread-list-ids
28799
28800 @subsubheading Synopsis
28801
28802 @smallexample
28803  -thread-list-ids
28804 @end smallexample
28805
28806 Produces a list of the currently known global @value{GDBN} thread ids.
28807 At the end of the list it also prints the total number of such
28808 threads.
28809
28810 This command is retained for historical reasons, the
28811 @code{-thread-info} command should be used instead.
28812
28813 @subsubheading @value{GDBN} Command
28814
28815 Part of @samp{info threads} supplies the same information.
28816
28817 @subsubheading Example
28818
28819 @smallexample
28820 (gdb)
28821 -thread-list-ids
28822 ^done,thread-ids=@{thread-id="3",thread-id="2",thread-id="1"@},
28823 current-thread-id="1",number-of-threads="3"
28824 (gdb)
28825 @end smallexample
28826
28827
28828 @subheading The @code{-thread-select} Command
28829 @findex -thread-select
28830
28831 @subsubheading Synopsis
28832
28833 @smallexample
28834  -thread-select @var{thread-id}
28835 @end smallexample
28836
28837 Make thread with global thread number @var{thread-id} the current
28838 thread.  It prints the number of the new current thread, and the
28839 topmost frame for that thread.
28840
28841 This command is deprecated in favor of explicitly using the
28842 @samp{--thread} option to each command.
28843
28844 @subsubheading @value{GDBN} Command
28845
28846 The corresponding @value{GDBN} command is @samp{thread}.
28847
28848 @subsubheading Example
28849
28850 @smallexample
28851 (gdb)
28852 -exec-next
28853 ^running
28854 (gdb)
28855 *stopped,reason="end-stepping-range",thread-id="2",line="187",
28856 file="../../../devo/gdb/testsuite/gdb.threads/linux-dp.c"
28857 (gdb)
28858 -thread-list-ids
28859 ^done,
28860 thread-ids=@{thread-id="3",thread-id="2",thread-id="1"@},
28861 number-of-threads="3"
28862 (gdb)
28863 -thread-select 3
28864 ^done,new-thread-id="3",
28865 frame=@{level="0",func="vprintf",
28866 args=[@{name="format",value="0x8048e9c \"%*s%c %d %c\\n\""@},
28867 @{name="arg",value="0x2"@}],file="vprintf.c",line="31"@}
28868 (gdb)
28869 @end smallexample
28870
28871 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
28872 @node GDB/MI Ada Tasking Commands
28873 @section @sc{gdb/mi} Ada Tasking Commands
28874
28875 @subheading The @code{-ada-task-info} Command
28876 @findex -ada-task-info
28877
28878 @subsubheading Synopsis
28879
28880 @smallexample
28881  -ada-task-info [ @var{task-id} ]
28882 @end smallexample
28883
28884 Reports information about either a specific Ada task, if the
28885 @var{task-id} parameter is present, or about all Ada tasks.
28886
28887 @subsubheading @value{GDBN} Command
28888
28889 The @samp{info tasks} command prints the same information
28890 about all Ada tasks (@pxref{Ada Tasks}).
28891
28892 @subsubheading Result
28893
28894 The result is a table of Ada tasks.  The following columns are
28895 defined for each Ada task:
28896
28897 @table @samp
28898 @item current
28899 This field exists only for the current thread.  It has the value @samp{*}.
28900
28901 @item id
28902 The identifier that @value{GDBN} uses to refer to the Ada task.
28903
28904 @item task-id
28905 The identifier that the target uses to refer to the Ada task.
28906
28907 @item thread-id
28908 The global thread identifier of the thread corresponding to the Ada
28909 task.
28910
28911 This field should always exist, as Ada tasks are always implemented
28912 on top of a thread.  But if @value{GDBN} cannot find this corresponding
28913 thread for any reason, the field is omitted.
28914
28915 @item parent-id
28916 This field exists only when the task was created by another task.
28917 In this case, it provides the ID of the parent task.
28918
28919 @item priority
28920 The base priority of the task.
28921
28922 @item state
28923 The current state of the task.  For a detailed description of the
28924 possible states, see @ref{Ada Tasks}.
28925
28926 @item name
28927 The name of the task.
28928
28929 @end table
28930
28931 @subsubheading Example
28932
28933 @smallexample
28934 -ada-task-info
28935 ^done,tasks=@{nr_rows="3",nr_cols="8",
28936 hdr=[@{width="1",alignment="-1",col_name="current",colhdr=""@},
28937 @{width="3",alignment="1",col_name="id",colhdr="ID"@},
28938 @{width="9",alignment="1",col_name="task-id",colhdr="TID"@},
28939 @{width="4",alignment="1",col_name="thread-id",colhdr=""@},
28940 @{width="4",alignment="1",col_name="parent-id",colhdr="P-ID"@},
28941 @{width="3",alignment="1",col_name="priority",colhdr="Pri"@},
28942 @{width="22",alignment="-1",col_name="state",colhdr="State"@},
28943 @{width="1",alignment="2",col_name="name",colhdr="Name"@}],
28944 body=[@{current="*",id="1",task-id="   644010",thread-id="1",priority="48",
28945 state="Child Termination Wait",name="main_task"@}]@}
28946 (gdb)
28947 @end smallexample
28948
28949 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
28950 @node GDB/MI Program Execution
28951 @section @sc{gdb/mi} Program Execution
28952
28953 These are the asynchronous commands which generate the out-of-band
28954 record @samp{*stopped}.  Currently @value{GDBN} only really executes
28955 asynchronously with remote targets and this interaction is mimicked in
28956 other cases.
28957
28958 @subheading The @code{-exec-continue} Command
28959 @findex -exec-continue
28960
28961 @subsubheading Synopsis
28962
28963 @smallexample
28964  -exec-continue [--reverse] [--all|--thread-group N]
28965 @end smallexample
28966
28967 Resumes the execution of the inferior program, which will continue
28968 to execute until it reaches a debugger stop event.  If the 
28969 @samp{--reverse} option is specified, execution resumes in reverse until 
28970 it reaches a stop event.  Stop events may include
28971 @itemize @bullet
28972 @item
28973 breakpoints or watchpoints
28974 @item
28975 signals or exceptions
28976 @item
28977 the end of the process (or its beginning under @samp{--reverse})
28978 @item
28979 the end or beginning of a replay log if one is being used.
28980 @end itemize
28981 In all-stop mode (@pxref{All-Stop
28982 Mode}), may resume only one thread, or all threads, depending on the
28983 value of the @samp{scheduler-locking} variable.  If @samp{--all} is
28984 specified, all threads (in all inferiors) will be resumed.  The @samp{--all} option is
28985 ignored in all-stop mode.  If the @samp{--thread-group} options is
28986 specified, then all threads in that thread group are resumed.
28987
28988 @subsubheading @value{GDBN} Command
28989
28990 The corresponding @value{GDBN} corresponding is @samp{continue}.
28991
28992 @subsubheading Example
28993
28994 @smallexample
28995 -exec-continue
28996 ^running
28997 (gdb)
28998 @@Hello world
28999 *stopped,reason="breakpoint-hit",disp="keep",bkptno="2",frame=@{
29000 func="foo",args=[],file="hello.c",fullname="/home/foo/bar/hello.c",
29001 line="13"@}
29002 (gdb)
29003 @end smallexample
29004
29005
29006 @subheading The @code{-exec-finish} Command
29007 @findex -exec-finish
29008
29009 @subsubheading Synopsis
29010
29011 @smallexample
29012  -exec-finish [--reverse]
29013 @end smallexample
29014
29015 Resumes the execution of the inferior program until the current
29016 function is exited.  Displays the results returned by the function.
29017 If the @samp{--reverse} option is specified, resumes the reverse
29018 execution of the inferior program until the point where current
29019 function was called.
29020
29021 @subsubheading @value{GDBN} Command
29022
29023 The corresponding @value{GDBN} command is @samp{finish}.
29024
29025 @subsubheading Example
29026
29027 Function returning @code{void}.
29028
29029 @smallexample
29030 -exec-finish
29031 ^running
29032 (gdb)
29033 @@hello from foo
29034 *stopped,reason="function-finished",frame=@{func="main",args=[],
29035 file="hello.c",fullname="/home/foo/bar/hello.c",line="7"@}
29036 (gdb)
29037 @end smallexample
29038
29039 Function returning other than @code{void}.  The name of the internal
29040 @value{GDBN} variable storing the result is printed, together with the
29041 value itself.
29042
29043 @smallexample
29044 -exec-finish
29045 ^running
29046 (gdb)
29047 *stopped,reason="function-finished",frame=@{addr="0x000107b0",func="foo",
29048 args=[@{name="a",value="1"],@{name="b",value="9"@}@},
29049 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
29050 gdb-result-var="$1",return-value="0"
29051 (gdb)
29052 @end smallexample
29053
29054
29055 @subheading The @code{-exec-interrupt} Command
29056 @findex -exec-interrupt
29057
29058 @subsubheading Synopsis
29059
29060 @smallexample
29061  -exec-interrupt [--all|--thread-group N]
29062 @end smallexample
29063
29064 Interrupts the background execution of the target.  Note how the token
29065 associated with the stop message is the one for the execution command
29066 that has been interrupted.  The token for the interrupt itself only
29067 appears in the @samp{^done} output.  If the user is trying to
29068 interrupt a non-running program, an error message will be printed.
29069
29070 Note that when asynchronous execution is enabled, this command is
29071 asynchronous just like other execution commands.  That is, first the
29072 @samp{^done} response will be printed, and the target stop will be
29073 reported after that using the @samp{*stopped} notification.
29074
29075 In non-stop mode, only the context thread is interrupted by default.
29076 All threads (in all inferiors) will be interrupted if the
29077 @samp{--all}  option is specified.  If the @samp{--thread-group}
29078 option is specified, all threads in that group will be interrupted.
29079
29080 @subsubheading @value{GDBN} Command
29081
29082 The corresponding @value{GDBN} command is @samp{interrupt}.
29083
29084 @subsubheading Example
29085
29086 @smallexample
29087 (gdb)
29088 111-exec-continue
29089 111^running
29090
29091 (gdb)
29092 222-exec-interrupt
29093 222^done
29094 (gdb)
29095 111*stopped,signal-name="SIGINT",signal-meaning="Interrupt",
29096 frame=@{addr="0x00010140",func="foo",args=[],file="try.c",
29097 fullname="/home/foo/bar/try.c",line="13"@}
29098 (gdb)
29099
29100 (gdb)
29101 -exec-interrupt
29102 ^error,msg="mi_cmd_exec_interrupt: Inferior not executing."
29103 (gdb)
29104 @end smallexample
29105
29106 @subheading The @code{-exec-jump} Command
29107 @findex -exec-jump
29108
29109 @subsubheading Synopsis
29110
29111 @smallexample
29112  -exec-jump @var{location}
29113 @end smallexample
29114
29115 Resumes execution of the inferior program at the location specified by
29116 parameter.  @xref{Specify Location}, for a description of the
29117 different forms of @var{location}.
29118
29119 @subsubheading @value{GDBN} Command
29120
29121 The corresponding @value{GDBN} command is @samp{jump}.
29122
29123 @subsubheading Example
29124
29125 @smallexample
29126 -exec-jump foo.c:10
29127 *running,thread-id="all"
29128 ^running
29129 @end smallexample
29130
29131
29132 @subheading The @code{-exec-next} Command
29133 @findex -exec-next
29134
29135 @subsubheading Synopsis
29136
29137 @smallexample
29138  -exec-next [--reverse]
29139 @end smallexample
29140
29141 Resumes execution of the inferior program, stopping when the beginning
29142 of the next source line is reached.
29143
29144 If the @samp{--reverse} option is specified, resumes reverse execution
29145 of the inferior program, stopping at the beginning of the previous
29146 source line.  If you issue this command on the first line of a
29147 function, it will take you back to the caller of that function, to the
29148 source line where the function was called.
29149
29150
29151 @subsubheading @value{GDBN} Command
29152
29153 The corresponding @value{GDBN} command is @samp{next}.
29154
29155 @subsubheading Example
29156
29157 @smallexample
29158 -exec-next
29159 ^running
29160 (gdb)
29161 *stopped,reason="end-stepping-range",line="8",file="hello.c"
29162 (gdb)
29163 @end smallexample
29164
29165
29166 @subheading The @code{-exec-next-instruction} Command
29167 @findex -exec-next-instruction
29168
29169 @subsubheading Synopsis
29170
29171 @smallexample
29172  -exec-next-instruction [--reverse]
29173 @end smallexample
29174
29175 Executes one machine instruction.  If the instruction is a function
29176 call, continues until the function returns.  If the program stops at an
29177 instruction in the middle of a source line, the address will be
29178 printed as well.
29179
29180 If the @samp{--reverse} option is specified, resumes reverse execution
29181 of the inferior program, stopping at the previous instruction.  If the
29182 previously executed instruction was a return from another function,
29183 it will continue to execute in reverse until the call to that function
29184 (from the current stack frame) is reached.
29185
29186 @subsubheading @value{GDBN} Command
29187
29188 The corresponding @value{GDBN} command is @samp{nexti}.
29189
29190 @subsubheading Example
29191
29192 @smallexample
29193 (gdb)
29194 -exec-next-instruction
29195 ^running
29196
29197 (gdb)
29198 *stopped,reason="end-stepping-range",
29199 addr="0x000100d4",line="5",file="hello.c"
29200 (gdb)
29201 @end smallexample
29202
29203
29204 @subheading The @code{-exec-return} Command
29205 @findex -exec-return
29206
29207 @subsubheading Synopsis
29208
29209 @smallexample
29210  -exec-return
29211 @end smallexample
29212
29213 Makes current function return immediately.  Doesn't execute the inferior.
29214 Displays the new current frame.
29215
29216 @subsubheading @value{GDBN} Command
29217
29218 The corresponding @value{GDBN} command is @samp{return}.
29219
29220 @subsubheading Example
29221
29222 @smallexample
29223 (gdb)
29224 200-break-insert callee4
29225 200^done,bkpt=@{number="1",addr="0x00010734",
29226 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="8"@}
29227 (gdb)
29228 000-exec-run
29229 000^running
29230 (gdb)
29231 000*stopped,reason="breakpoint-hit",disp="keep",bkptno="1",
29232 frame=@{func="callee4",args=[],
29233 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
29234 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="8"@}
29235 (gdb)
29236 205-break-delete
29237 205^done
29238 (gdb)
29239 111-exec-return
29240 111^done,frame=@{level="0",func="callee3",
29241 args=[@{name="strarg",
29242 value="0x11940 \"A string argument.\""@}],
29243 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
29244 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="18"@}
29245 (gdb)
29246 @end smallexample
29247
29248
29249 @subheading The @code{-exec-run} Command
29250 @findex -exec-run
29251
29252 @subsubheading Synopsis
29253
29254 @smallexample
29255  -exec-run [ --all | --thread-group N ] [ --start ]
29256 @end smallexample
29257
29258 Starts execution of the inferior from the beginning.  The inferior
29259 executes until either a breakpoint is encountered or the program
29260 exits.  In the latter case the output will include an exit code, if
29261 the program has exited exceptionally.
29262
29263 When neither the @samp{--all} nor the @samp{--thread-group} option
29264 is specified, the current inferior is started.  If the
29265 @samp{--thread-group} option is specified, it should refer to a thread
29266 group of type @samp{process}, and that thread group will be started.
29267 If the @samp{--all} option is specified, then all inferiors will be started.
29268
29269 Using the @samp{--start} option instructs the debugger to stop
29270 the execution at the start of the inferior's main subprogram,
29271 following the same behavior as the @code{start} command
29272 (@pxref{Starting}).
29273
29274 @subsubheading @value{GDBN} Command
29275
29276 The corresponding @value{GDBN} command is @samp{run}.
29277
29278 @subsubheading Examples
29279
29280 @smallexample
29281 (gdb)
29282 -break-insert main
29283 ^done,bkpt=@{number="1",addr="0x0001072c",file="recursive2.c",line="4"@}
29284 (gdb)
29285 -exec-run
29286 ^running
29287 (gdb)
29288 *stopped,reason="breakpoint-hit",disp="keep",bkptno="1",
29289 frame=@{func="main",args=[],file="recursive2.c",
29290 fullname="/home/foo/bar/recursive2.c",line="4"@}
29291 (gdb)
29292 @end smallexample
29293
29294 @noindent
29295 Program exited normally:
29296
29297 @smallexample
29298 (gdb)
29299 -exec-run
29300 ^running
29301 (gdb)
29302 x = 55
29303 *stopped,reason="exited-normally"
29304 (gdb)
29305 @end smallexample
29306
29307 @noindent
29308 Program exited exceptionally:
29309
29310 @smallexample
29311 (gdb)
29312 -exec-run
29313 ^running
29314 (gdb)
29315 x = 55
29316 *stopped,reason="exited",exit-code="01"
29317 (gdb)
29318 @end smallexample
29319
29320 Another way the program can terminate is if it receives a signal such as
29321 @code{SIGINT}.  In this case, @sc{gdb/mi} displays this:
29322
29323 @smallexample
29324 (gdb)
29325 *stopped,reason="exited-signalled",signal-name="SIGINT",
29326 signal-meaning="Interrupt"
29327 @end smallexample
29328
29329
29330 @c @subheading -exec-signal
29331
29332
29333 @subheading The @code{-exec-step} Command
29334 @findex -exec-step
29335
29336 @subsubheading Synopsis
29337
29338 @smallexample
29339  -exec-step [--reverse]
29340 @end smallexample
29341
29342 Resumes execution of the inferior program, stopping when the beginning
29343 of the next source line is reached, if the next source line is not a
29344 function call.  If it is, stop at the first instruction of the called
29345 function.  If the @samp{--reverse} option is specified, resumes reverse
29346 execution of the inferior program, stopping at the beginning of the
29347 previously executed source line.
29348
29349 @subsubheading @value{GDBN} Command
29350
29351 The corresponding @value{GDBN} command is @samp{step}.
29352
29353 @subsubheading Example
29354
29355 Stepping into a function:
29356
29357 @smallexample
29358 -exec-step
29359 ^running
29360 (gdb)
29361 *stopped,reason="end-stepping-range",
29362 frame=@{func="foo",args=[@{name="a",value="10"@},
29363 @{name="b",value="0"@}],file="recursive2.c",
29364 fullname="/home/foo/bar/recursive2.c",line="11"@}
29365 (gdb)
29366 @end smallexample
29367
29368 Regular stepping:
29369
29370 @smallexample
29371 -exec-step
29372 ^running
29373 (gdb)
29374 *stopped,reason="end-stepping-range",line="14",file="recursive2.c"
29375 (gdb)
29376 @end smallexample
29377
29378
29379 @subheading The @code{-exec-step-instruction} Command
29380 @findex -exec-step-instruction
29381
29382 @subsubheading Synopsis
29383
29384 @smallexample
29385  -exec-step-instruction [--reverse]
29386 @end smallexample
29387
29388 Resumes the inferior which executes one machine instruction.  If the
29389 @samp{--reverse} option is specified, resumes reverse execution of the
29390 inferior program, stopping at the previously executed instruction.
29391 The output, once @value{GDBN} has stopped, will vary depending on
29392 whether we have stopped in the middle of a source line or not.  In the
29393 former case, the address at which the program stopped will be printed
29394 as well.
29395
29396 @subsubheading @value{GDBN} Command
29397
29398 The corresponding @value{GDBN} command is @samp{stepi}.
29399
29400 @subsubheading Example
29401
29402 @smallexample
29403 (gdb)
29404 -exec-step-instruction
29405 ^running
29406
29407 (gdb)
29408 *stopped,reason="end-stepping-range",
29409 frame=@{func="foo",args=[],file="try.c",
29410 fullname="/home/foo/bar/try.c",line="10"@}
29411 (gdb)
29412 -exec-step-instruction
29413 ^running
29414
29415 (gdb)
29416 *stopped,reason="end-stepping-range",
29417 frame=@{addr="0x000100f4",func="foo",args=[],file="try.c",
29418 fullname="/home/foo/bar/try.c",line="10"@}
29419 (gdb)
29420 @end smallexample
29421
29422
29423 @subheading The @code{-exec-until} Command
29424 @findex -exec-until
29425
29426 @subsubheading Synopsis
29427
29428 @smallexample
29429  -exec-until [ @var{location} ]
29430 @end smallexample
29431
29432 Executes the inferior until the @var{location} specified in the
29433 argument is reached.  If there is no argument, the inferior executes
29434 until a source line greater than the current one is reached.  The
29435 reason for stopping in this case will be @samp{location-reached}.
29436
29437 @subsubheading @value{GDBN} Command
29438
29439 The corresponding @value{GDBN} command is @samp{until}.
29440
29441 @subsubheading Example
29442
29443 @smallexample
29444 (gdb)
29445 -exec-until recursive2.c:6
29446 ^running
29447 (gdb)
29448 x = 55
29449 *stopped,reason="location-reached",frame=@{func="main",args=[],
29450 file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="6"@}
29451 (gdb)
29452 @end smallexample
29453
29454 @ignore
29455 @subheading -file-clear
29456 Is this going away????
29457 @end ignore
29458
29459 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
29460 @node GDB/MI Stack Manipulation
29461 @section @sc{gdb/mi} Stack Manipulation Commands
29462
29463 @subheading The @code{-enable-frame-filters} Command
29464 @findex -enable-frame-filters
29465
29466 @smallexample
29467 -enable-frame-filters
29468 @end smallexample
29469
29470 @value{GDBN} allows Python-based frame filters to affect the output of
29471 the MI commands relating to stack traces.  As there is no way to
29472 implement this in a fully backward-compatible way, a front end must
29473 request that this functionality be enabled.
29474
29475 Once enabled, this feature cannot be disabled.
29476
29477 Note that if Python support has not been compiled into @value{GDBN},
29478 this command will still succeed (and do nothing).
29479
29480 @subheading The @code{-stack-info-frame} Command
29481 @findex -stack-info-frame
29482
29483 @subsubheading Synopsis
29484
29485 @smallexample
29486  -stack-info-frame
29487 @end smallexample
29488
29489 Get info on the selected frame.
29490
29491 @subsubheading @value{GDBN} Command
29492
29493 The corresponding @value{GDBN} command is @samp{info frame} or @samp{frame}
29494 (without arguments).
29495
29496 @subsubheading Example
29497
29498 @smallexample
29499 (gdb)
29500 -stack-info-frame
29501 ^done,frame=@{level="1",addr="0x0001076c",func="callee3",
29502 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
29503 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="17"@}
29504 (gdb)
29505 @end smallexample
29506
29507 @subheading The @code{-stack-info-depth} Command
29508 @findex -stack-info-depth
29509
29510 @subsubheading Synopsis
29511
29512 @smallexample
29513  -stack-info-depth [ @var{max-depth} ]
29514 @end smallexample
29515
29516 Return the depth of the stack.  If the integer argument @var{max-depth}
29517 is specified, do not count beyond @var{max-depth} frames.
29518
29519 @subsubheading @value{GDBN} Command
29520
29521 There's no equivalent @value{GDBN} command.
29522
29523 @subsubheading Example
29524
29525 For a stack with frame levels 0 through 11:
29526
29527 @smallexample
29528 (gdb)
29529 -stack-info-depth
29530 ^done,depth="12"
29531 (gdb)
29532 -stack-info-depth 4
29533 ^done,depth="4"
29534 (gdb)
29535 -stack-info-depth 12
29536 ^done,depth="12"
29537 (gdb)
29538 -stack-info-depth 11
29539 ^done,depth="11"
29540 (gdb)
29541 -stack-info-depth 13
29542 ^done,depth="12"
29543 (gdb)
29544 @end smallexample
29545
29546 @anchor{-stack-list-arguments}
29547 @subheading The @code{-stack-list-arguments} Command
29548 @findex -stack-list-arguments
29549
29550 @subsubheading Synopsis
29551
29552 @smallexample
29553  -stack-list-arguments [ --no-frame-filters ] [ --skip-unavailable ] @var{print-values}
29554     [ @var{low-frame} @var{high-frame} ]
29555 @end smallexample
29556
29557 Display a list of the arguments for the frames between @var{low-frame}
29558 and @var{high-frame} (inclusive).  If @var{low-frame} and
29559 @var{high-frame} are not provided, list the arguments for the whole
29560 call stack.  If the two arguments are equal, show the single frame
29561 at the corresponding level.  It is an error if @var{low-frame} is
29562 larger than the actual number of frames.  On the other hand,
29563 @var{high-frame} may be larger than the actual number of frames, in
29564 which case only existing frames will be returned.
29565
29566 If @var{print-values} is 0 or @code{--no-values}, print only the names of
29567 the variables; if it is 1 or @code{--all-values}, print also their
29568 values; and if it is 2 or @code{--simple-values}, print the name,
29569 type and value for simple data types, and the name and type for arrays,
29570 structures and unions.  If the option @code{--no-frame-filters} is
29571 supplied, then Python frame filters will not be executed.
29572
29573 If the @code{--skip-unavailable} option is specified, arguments that
29574 are not available are not listed.  Partially available arguments
29575 are still displayed, however.
29576
29577 Use of this command to obtain arguments in a single frame is
29578 deprecated in favor of the @samp{-stack-list-variables} command.
29579
29580 @subsubheading @value{GDBN} Command
29581
29582 @value{GDBN} does not have an equivalent command.  @code{gdbtk} has a
29583 @samp{gdb_get_args} command which partially overlaps with the
29584 functionality of @samp{-stack-list-arguments}.
29585
29586 @subsubheading Example
29587
29588 @smallexample
29589 (gdb)
29590 -stack-list-frames
29591 ^done,
29592 stack=[
29593 frame=@{level="0",addr="0x00010734",func="callee4",
29594 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
29595 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="8"@},
29596 frame=@{level="1",addr="0x0001076c",func="callee3",
29597 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
29598 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="17"@},
29599 frame=@{level="2",addr="0x0001078c",func="callee2",
29600 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
29601 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="22"@},
29602 frame=@{level="3",addr="0x000107b4",func="callee1",
29603 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
29604 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="27"@},
29605 frame=@{level="4",addr="0x000107e0",func="main",
29606 file="../../../devo/gdb/testsuite/gdb.mi/basics.c",
29607 fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="32"@}]
29608 (gdb)
29609 -stack-list-arguments 0
29610 ^done,
29611 stack-args=[
29612 frame=@{level="0",args=[]@},
29613 frame=@{level="1",args=[name="strarg"]@},
29614 frame=@{level="2",args=[name="intarg",name="strarg"]@},
29615 frame=@{level="3",args=[name="intarg",name="strarg",name="fltarg"]@},
29616 frame=@{level="4",args=[]@}]
29617 (gdb)
29618 -stack-list-arguments 1
29619 ^done,
29620 stack-args=[
29621 frame=@{level="0",args=[]@},
29622 frame=@{level="1",
29623  args=[@{name="strarg",value="0x11940 \"A string argument.\""@}]@},
29624 frame=@{level="2",args=[
29625 @{name="intarg",value="2"@},
29626 @{name="strarg",value="0x11940 \"A string argument.\""@}]@},
29627 @{frame=@{level="3",args=[
29628 @{name="intarg",value="2"@},
29629 @{name="strarg",value="0x11940 \"A string argument.\""@},
29630 @{name="fltarg",value="3.5"@}]@},
29631 frame=@{level="4",args=[]@}]
29632 (gdb)
29633 -stack-list-arguments 0 2 2
29634 ^done,stack-args=[frame=@{level="2",args=[name="intarg",name="strarg"]@}]
29635 (gdb)
29636 -stack-list-arguments 1 2 2
29637 ^done,stack-args=[frame=@{level="2",
29638 args=[@{name="intarg",value="2"@},
29639 @{name="strarg",value="0x11940 \"A string argument.\""@}]@}]
29640 (gdb)
29641 @end smallexample
29642
29643 @c @subheading -stack-list-exception-handlers
29644
29645
29646 @anchor{-stack-list-frames}
29647 @subheading The @code{-stack-list-frames} Command
29648 @findex -stack-list-frames
29649
29650 @subsubheading Synopsis
29651
29652 @smallexample
29653  -stack-list-frames [ --no-frame-filters @var{low-frame} @var{high-frame} ]
29654 @end smallexample
29655
29656 List the frames currently on the stack.  For each frame it displays the
29657 following info:
29658
29659 @table @samp
29660 @item @var{level}
29661 The frame number, 0 being the topmost frame, i.e., the innermost function.
29662 @item @var{addr}
29663 The @code{$pc} value for that frame.
29664 @item @var{func}
29665 Function name.
29666 @item @var{file}
29667 File name of the source file where the function lives.
29668 @item @var{fullname}
29669 The full file name of the source file where the function lives.
29670 @item @var{line}
29671 Line number corresponding to the @code{$pc}.
29672 @item @var{from}
29673 The shared library where this function is defined.  This is only given
29674 if the frame's function is not known.
29675 @end table
29676
29677 If invoked without arguments, this command prints a backtrace for the
29678 whole stack.  If given two integer arguments, it shows the frames whose
29679 levels are between the two arguments (inclusive).  If the two arguments
29680 are equal, it shows the single frame at the corresponding level.  It is
29681 an error if @var{low-frame} is larger than the actual number of
29682 frames.  On the other hand, @var{high-frame} may be larger than the
29683 actual number of frames, in which case only existing frames will be
29684 returned.  If the option @code{--no-frame-filters} is supplied, then
29685 Python frame filters will not be executed.
29686
29687 @subsubheading @value{GDBN} Command
29688
29689 The corresponding @value{GDBN} commands are @samp{backtrace} and @samp{where}.
29690
29691 @subsubheading Example
29692
29693 Full stack backtrace:
29694
29695 @smallexample
29696 (gdb)
29697 -stack-list-frames
29698 ^done,stack=
29699 [frame=@{level="0",addr="0x0001076c",func="foo",
29700   file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="11"@},
29701 frame=@{level="1",addr="0x000107a4",func="foo",
29702   file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
29703 frame=@{level="2",addr="0x000107a4",func="foo",
29704   file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
29705 frame=@{level="3",addr="0x000107a4",func="foo",
29706   file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
29707 frame=@{level="4",addr="0x000107a4",func="foo",
29708   file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
29709 frame=@{level="5",addr="0x000107a4",func="foo",
29710   file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
29711 frame=@{level="6",addr="0x000107a4",func="foo",
29712   file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
29713 frame=@{level="7",addr="0x000107a4",func="foo",
29714   file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
29715 frame=@{level="8",addr="0x000107a4",func="foo",
29716   file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
29717 frame=@{level="9",addr="0x000107a4",func="foo",
29718   file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
29719 frame=@{level="10",addr="0x000107a4",func="foo",
29720   file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
29721 frame=@{level="11",addr="0x00010738",func="main",
29722   file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="4"@}]
29723 (gdb)
29724 @end smallexample
29725
29726 Show frames between @var{low_frame} and @var{high_frame}:
29727
29728 @smallexample
29729 (gdb)
29730 -stack-list-frames 3 5
29731 ^done,stack=
29732 [frame=@{level="3",addr="0x000107a4",func="foo",
29733   file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
29734 frame=@{level="4",addr="0x000107a4",func="foo",
29735   file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@},
29736 frame=@{level="5",addr="0x000107a4",func="foo",
29737   file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}]
29738 (gdb)
29739 @end smallexample
29740
29741 Show a single frame:
29742
29743 @smallexample
29744 (gdb)
29745 -stack-list-frames 3 3
29746 ^done,stack=
29747 [frame=@{level="3",addr="0x000107a4",func="foo",
29748   file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}]
29749 (gdb)
29750 @end smallexample
29751
29752
29753 @subheading The @code{-stack-list-locals} Command
29754 @findex -stack-list-locals
29755 @anchor{-stack-list-locals}
29756
29757 @subsubheading Synopsis
29758
29759 @smallexample
29760  -stack-list-locals [ --no-frame-filters ] [ --skip-unavailable ] @var{print-values}
29761 @end smallexample
29762
29763 Display the local variable names for the selected frame.  If
29764 @var{print-values} is 0 or @code{--no-values}, print only the names of
29765 the variables; if it is 1 or @code{--all-values}, print also their
29766 values; and if it is 2 or @code{--simple-values}, print the name,
29767 type and value for simple data types, and the name and type for arrays,
29768 structures and unions.  In this last case, a frontend can immediately
29769 display the value of simple data types and create variable objects for
29770 other data types when the user wishes to explore their values in
29771 more detail.  If the option @code{--no-frame-filters} is supplied, then
29772 Python frame filters will not be executed.
29773
29774 If the @code{--skip-unavailable} option is specified, local variables
29775 that are not available are not listed.  Partially available local
29776 variables are still displayed, however.
29777
29778 This command is deprecated in favor of the
29779 @samp{-stack-list-variables} command.
29780
29781 @subsubheading @value{GDBN} Command
29782
29783 @samp{info locals} in @value{GDBN}, @samp{gdb_get_locals} in @code{gdbtk}.
29784
29785 @subsubheading Example
29786
29787 @smallexample
29788 (gdb)
29789 -stack-list-locals 0
29790 ^done,locals=[name="A",name="B",name="C"]
29791 (gdb)
29792 -stack-list-locals --all-values
29793 ^done,locals=[@{name="A",value="1"@},@{name="B",value="2"@},
29794   @{name="C",value="@{1, 2, 3@}"@}]
29795 -stack-list-locals --simple-values
29796 ^done,locals=[@{name="A",type="int",value="1"@},
29797   @{name="B",type="int",value="2"@},@{name="C",type="int [3]"@}]
29798 (gdb)
29799 @end smallexample
29800
29801 @anchor{-stack-list-variables}
29802 @subheading The @code{-stack-list-variables} Command
29803 @findex -stack-list-variables
29804
29805 @subsubheading Synopsis
29806
29807 @smallexample
29808  -stack-list-variables [ --no-frame-filters ] [ --skip-unavailable ] @var{print-values}
29809 @end smallexample
29810
29811 Display the names of local variables and function arguments for the selected frame.  If
29812 @var{print-values} is 0 or @code{--no-values}, print only the names of
29813 the variables; if it is 1 or @code{--all-values}, print also their
29814 values; and if it is 2 or @code{--simple-values}, print the name,
29815 type and value for simple data types, and the name and type for arrays,
29816 structures and unions.  If the option @code{--no-frame-filters} is
29817 supplied, then Python frame filters will not be executed.
29818
29819 If the @code{--skip-unavailable} option is specified, local variables
29820 and arguments that are not available are not listed.  Partially
29821 available arguments and local variables are still displayed, however.
29822
29823 @subsubheading Example
29824
29825 @smallexample
29826 (gdb)
29827 -stack-list-variables --thread 1 --frame 0 --all-values
29828 ^done,variables=[@{name="x",value="11"@},@{name="s",value="@{a = 1, b = 2@}"@}]
29829 (gdb)
29830 @end smallexample
29831
29832
29833 @subheading The @code{-stack-select-frame} Command
29834 @findex -stack-select-frame
29835
29836 @subsubheading Synopsis
29837
29838 @smallexample
29839  -stack-select-frame @var{framenum}
29840 @end smallexample
29841
29842 Change the selected frame.  Select a different frame @var{framenum} on
29843 the stack.
29844
29845 This command in deprecated in favor of passing the @samp{--frame}
29846 option to every command.
29847
29848 @subsubheading @value{GDBN} Command
29849
29850 The corresponding @value{GDBN} commands are @samp{frame}, @samp{up},
29851 @samp{down}, @samp{select-frame}, @samp{up-silent}, and @samp{down-silent}.
29852
29853 @subsubheading Example
29854
29855 @smallexample
29856 (gdb)
29857 -stack-select-frame 2
29858 ^done
29859 (gdb)
29860 @end smallexample
29861
29862 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
29863 @node GDB/MI Variable Objects
29864 @section @sc{gdb/mi} Variable Objects
29865
29866 @ignore
29867
29868 @subheading Motivation for Variable Objects in @sc{gdb/mi}
29869
29870 For the implementation of a variable debugger window (locals, watched
29871 expressions, etc.), we are proposing the adaptation of the existing code
29872 used by @code{Insight}.
29873
29874 The two main reasons for that are:
29875
29876 @enumerate 1
29877 @item
29878 It has been proven in practice (it is already on its second generation).
29879
29880 @item
29881 It will shorten development time (needless to say how important it is
29882 now).
29883 @end enumerate
29884
29885 The original interface was designed to be used by Tcl code, so it was
29886 slightly changed so it could be used through @sc{gdb/mi}.  This section
29887 describes the @sc{gdb/mi} operations that will be available and gives some
29888 hints about their use.
29889
29890 @emph{Note}: In addition to the set of operations described here, we
29891 expect the @sc{gui} implementation of a variable window to require, at
29892 least, the following operations:
29893
29894 @itemize @bullet
29895 @item @code{-gdb-show} @code{output-radix}
29896 @item @code{-stack-list-arguments}
29897 @item @code{-stack-list-locals}
29898 @item @code{-stack-select-frame}
29899 @end itemize
29900
29901 @end ignore
29902
29903 @subheading Introduction to Variable Objects
29904
29905 @cindex variable objects in @sc{gdb/mi}
29906
29907 Variable objects are "object-oriented" MI interface for examining and
29908 changing values of expressions.  Unlike some other MI interfaces that
29909 work with expressions, variable objects are specifically designed for
29910 simple and efficient presentation in the frontend.  A variable object
29911 is identified by string name.  When a variable object is created, the
29912 frontend specifies the expression for that variable object.  The
29913 expression can be a simple variable, or it can be an arbitrary complex
29914 expression, and can even involve CPU registers.  After creating a
29915 variable object, the frontend can invoke other variable object
29916 operations---for example to obtain or change the value of a variable
29917 object, or to change display format.
29918
29919 Variable objects have hierarchical tree structure.  Any variable object
29920 that corresponds to a composite type, such as structure in C, has
29921 a number of child variable objects, for example corresponding to each
29922 element of a structure.  A child variable object can itself have 
29923 children, recursively.  Recursion ends when we reach 
29924 leaf variable objects, which always have built-in types.  Child variable
29925 objects are created only by explicit request, so if a frontend 
29926 is not interested in the children of a particular variable object, no
29927 child will be created.
29928
29929 For a leaf variable object it is possible to obtain its value as a
29930 string, or set the value from a string.  String value can be also
29931 obtained for a non-leaf variable object, but it's generally a string
29932 that only indicates the type of the object, and does not list its
29933 contents.  Assignment to a non-leaf variable object is not allowed.
29934  
29935 A frontend does not need to read the values of all variable objects each time
29936 the program stops.  Instead, MI provides an update command that lists all
29937 variable objects whose values has changed since the last update
29938 operation.  This considerably reduces the amount of data that must
29939 be transferred to the frontend.  As noted above, children variable
29940 objects are created on demand, and only leaf variable objects have a
29941 real value.  As result, gdb will read target memory only for leaf
29942 variables that frontend has created.
29943
29944 The automatic update is not always desirable.  For example, a frontend
29945 might want to keep a value of some expression for future reference,
29946 and never update it.  For another example,  fetching memory is
29947 relatively slow for embedded targets, so a frontend might want
29948 to disable automatic update for the variables that are either not
29949 visible on the screen, or ``closed''.  This is possible using so
29950 called ``frozen variable objects''.  Such variable objects are never
29951 implicitly updated.  
29952
29953 Variable objects can be either @dfn{fixed} or @dfn{floating}.  For the
29954 fixed variable object, the expression is parsed when the variable
29955 object is created, including associating identifiers to specific
29956 variables.  The meaning of expression never changes.  For a floating
29957 variable object the values of variables whose names appear in the
29958 expressions are re-evaluated every time in the context of the current
29959 frame.  Consider this example:
29960
29961 @smallexample
29962 void do_work(...)
29963 @{
29964         struct work_state state;
29965
29966         if (...)
29967            do_work(...);
29968 @}
29969 @end smallexample
29970
29971 If a fixed variable object for the @code{state} variable is created in
29972 this function, and we enter the recursive call, the variable
29973 object will report the value of @code{state} in the top-level
29974 @code{do_work} invocation.  On the other hand, a floating variable
29975 object will report the value of @code{state} in the current frame.
29976
29977 If an expression specified when creating a fixed variable object
29978 refers to a local variable, the variable object becomes bound to the
29979 thread and frame in which the variable object is created.  When such
29980 variable object is updated, @value{GDBN} makes sure that the
29981 thread/frame combination the variable object is bound to still exists,
29982 and re-evaluates the variable object in context of that thread/frame.
29983
29984 The following is the complete set of @sc{gdb/mi} operations defined to
29985 access this functionality:
29986
29987 @multitable @columnfractions .4 .6
29988 @item @strong{Operation}
29989 @tab @strong{Description}
29990
29991 @item @code{-enable-pretty-printing}
29992 @tab enable Python-based pretty-printing
29993 @item @code{-var-create}
29994 @tab create a variable object
29995 @item @code{-var-delete}
29996 @tab delete the variable object and/or its children
29997 @item @code{-var-set-format}
29998 @tab set the display format of this variable
29999 @item @code{-var-show-format}
30000 @tab show the display format of this variable
30001 @item @code{-var-info-num-children}
30002 @tab tells how many children this object has
30003 @item @code{-var-list-children}
30004 @tab return a list of the object's children
30005 @item @code{-var-info-type}
30006 @tab show the type of this variable object
30007 @item @code{-var-info-expression}
30008 @tab print parent-relative expression that this variable object represents
30009 @item @code{-var-info-path-expression}
30010 @tab print full expression that this variable object represents
30011 @item @code{-var-show-attributes}
30012 @tab is this variable editable? does it exist here?
30013 @item @code{-var-evaluate-expression}
30014 @tab get the value of this variable
30015 @item @code{-var-assign}
30016 @tab set the value of this variable
30017 @item @code{-var-update}
30018 @tab update the variable and its children
30019 @item @code{-var-set-frozen}
30020 @tab set frozeness attribute
30021 @item @code{-var-set-update-range}
30022 @tab set range of children to display on update
30023 @end multitable
30024
30025 In the next subsection we describe each operation in detail and suggest
30026 how it can be used.
30027
30028 @subheading Description And Use of Operations on Variable Objects
30029
30030 @subheading The @code{-enable-pretty-printing} Command
30031 @findex -enable-pretty-printing
30032
30033 @smallexample
30034 -enable-pretty-printing
30035 @end smallexample
30036
30037 @value{GDBN} allows Python-based visualizers to affect the output of the
30038 MI variable object commands.  However, because there was no way to
30039 implement this in a fully backward-compatible way, a front end must
30040 request that this functionality be enabled.
30041
30042 Once enabled, this feature cannot be disabled.
30043
30044 Note that if Python support has not been compiled into @value{GDBN},
30045 this command will still succeed (and do nothing).
30046
30047 This feature is currently (as of @value{GDBN} 7.0) experimental, and
30048 may work differently in future versions of @value{GDBN}.
30049
30050 @subheading The @code{-var-create} Command
30051 @findex -var-create
30052
30053 @subsubheading Synopsis
30054
30055 @smallexample
30056  -var-create @{@var{name} | "-"@}
30057     @{@var{frame-addr} | "*" | "@@"@} @var{expression}
30058 @end smallexample
30059
30060 This operation creates a variable object, which allows the monitoring of
30061 a variable, the result of an expression, a memory cell or a CPU
30062 register.
30063
30064 The @var{name} parameter is the string by which the object can be
30065 referenced.  It must be unique.  If @samp{-} is specified, the varobj
30066 system will generate a string ``varNNNNNN'' automatically.  It will be
30067 unique provided that one does not specify @var{name} of that format.
30068 The command fails if a duplicate name is found.
30069
30070 The frame under which the expression should be evaluated can be
30071 specified by @var{frame-addr}.  A @samp{*} indicates that the current
30072 frame should be used.  A @samp{@@} indicates that a floating variable
30073 object must be created.
30074
30075 @var{expression} is any expression valid on the current language set (must not
30076 begin with a @samp{*}), or one of the following:
30077
30078 @itemize @bullet
30079 @item
30080 @samp{*@var{addr}}, where @var{addr} is the address of a memory cell
30081
30082 @item
30083 @samp{*@var{addr}-@var{addr}} --- a memory address range (TBD)
30084
30085 @item
30086 @samp{$@var{regname}} --- a CPU register name
30087 @end itemize
30088
30089 @cindex dynamic varobj
30090 A varobj's contents may be provided by a Python-based pretty-printer.  In this
30091 case the varobj is known as a @dfn{dynamic varobj}.  Dynamic varobjs
30092 have slightly different semantics in some cases.  If the
30093 @code{-enable-pretty-printing} command is not sent, then @value{GDBN}
30094 will never create a dynamic varobj.  This ensures backward
30095 compatibility for existing clients.
30096
30097 @subsubheading Result
30098
30099 This operation returns attributes of the newly-created varobj.  These
30100 are:
30101
30102 @table @samp
30103 @item name
30104 The name of the varobj.
30105
30106 @item numchild
30107 The number of children of the varobj.  This number is not necessarily
30108 reliable for a dynamic varobj.  Instead, you must examine the
30109 @samp{has_more} attribute.
30110
30111 @item value
30112 The varobj's scalar value.  For a varobj whose type is some sort of
30113 aggregate (e.g., a @code{struct}), or for a dynamic varobj, this value
30114 will not be interesting.
30115
30116 @item type
30117 The varobj's type.  This is a string representation of the type, as
30118 would be printed by the @value{GDBN} CLI.  If @samp{print object}
30119 (@pxref{Print Settings, set print object}) is set to @code{on}, the
30120 @emph{actual} (derived) type of the object is shown rather than the
30121 @emph{declared} one.
30122
30123 @item thread-id
30124 If a variable object is bound to a specific thread, then this is the
30125 thread's global identifier.
30126
30127 @item has_more
30128 For a dynamic varobj, this indicates whether there appear to be any
30129 children available.  For a non-dynamic varobj, this will be 0.
30130
30131 @item dynamic
30132 This attribute will be present and have the value @samp{1} if the
30133 varobj is a dynamic varobj.  If the varobj is not a dynamic varobj,
30134 then this attribute will not be present.
30135
30136 @item displayhint
30137 A dynamic varobj can supply a display hint to the front end.  The
30138 value comes directly from the Python pretty-printer object's
30139 @code{display_hint} method.  @xref{Pretty Printing API}.
30140 @end table
30141
30142 Typical output will look like this:
30143
30144 @smallexample
30145  name="@var{name}",numchild="@var{N}",type="@var{type}",thread-id="@var{M}",
30146   has_more="@var{has_more}"
30147 @end smallexample
30148
30149
30150 @subheading The @code{-var-delete} Command
30151 @findex -var-delete
30152
30153 @subsubheading Synopsis
30154
30155 @smallexample
30156  -var-delete [ -c ] @var{name}
30157 @end smallexample
30158
30159 Deletes a previously created variable object and all of its children.
30160 With the @samp{-c} option, just deletes the children.
30161
30162 Returns an error if the object @var{name} is not found.
30163
30164
30165 @subheading The @code{-var-set-format} Command
30166 @findex -var-set-format
30167
30168 @subsubheading Synopsis
30169
30170 @smallexample
30171  -var-set-format @var{name} @var{format-spec}
30172 @end smallexample
30173
30174 Sets the output format for the value of the object @var{name} to be
30175 @var{format-spec}.
30176
30177 @anchor{-var-set-format}
30178 The syntax for the @var{format-spec} is as follows:
30179
30180 @smallexample
30181  @var{format-spec} @expansion{}
30182  @{binary | decimal | hexadecimal | octal | natural | zero-hexadecimal@}
30183 @end smallexample
30184
30185 The natural format is the default format choosen automatically
30186 based on the variable type (like decimal for an @code{int}, hex
30187 for pointers, etc.).
30188
30189 The zero-hexadecimal format has a representation similar to hexadecimal
30190 but with padding zeroes to the left of the value.  For example, a 32-bit
30191 hexadecimal value of 0x1234 would be represented as 0x00001234 in the
30192 zero-hexadecimal format.
30193
30194 For a variable with children, the format is set only on the 
30195 variable itself, and the children are not affected.  
30196
30197 @subheading The @code{-var-show-format} Command
30198 @findex -var-show-format
30199
30200 @subsubheading Synopsis
30201
30202 @smallexample
30203  -var-show-format @var{name}
30204 @end smallexample
30205
30206 Returns the format used to display the value of the object @var{name}.
30207
30208 @smallexample
30209  @var{format} @expansion{}
30210  @var{format-spec}
30211 @end smallexample
30212
30213
30214 @subheading The @code{-var-info-num-children} Command
30215 @findex -var-info-num-children
30216
30217 @subsubheading Synopsis
30218
30219 @smallexample
30220  -var-info-num-children @var{name}
30221 @end smallexample
30222
30223 Returns the number of children of a variable object @var{name}:
30224
30225 @smallexample
30226  numchild=@var{n}
30227 @end smallexample
30228
30229 Note that this number is not completely reliable for a dynamic varobj.
30230 It will return the current number of children, but more children may
30231 be available.
30232
30233
30234 @subheading The @code{-var-list-children} Command
30235 @findex -var-list-children
30236
30237 @subsubheading Synopsis
30238
30239 @smallexample
30240  -var-list-children [@var{print-values}] @var{name} [@var{from} @var{to}]
30241 @end smallexample
30242 @anchor{-var-list-children}
30243
30244 Return a list of the children of the specified variable object and
30245 create variable objects for them, if they do not already exist.  With
30246 a single argument or if @var{print-values} has a value of 0 or
30247 @code{--no-values}, print only the names of the variables; if
30248 @var{print-values} is 1 or @code{--all-values}, also print their
30249 values; and if it is 2 or @code{--simple-values} print the name and
30250 value for simple data types and just the name for arrays, structures
30251 and unions.
30252
30253 @var{from} and @var{to}, if specified, indicate the range of children
30254 to report.  If @var{from} or @var{to} is less than zero, the range is
30255 reset and all children will be reported.  Otherwise, children starting
30256 at @var{from} (zero-based) and up to and excluding @var{to} will be
30257 reported.
30258
30259 If a child range is requested, it will only affect the current call to
30260 @code{-var-list-children}, but not future calls to @code{-var-update}.
30261 For this, you must instead use @code{-var-set-update-range}.  The
30262 intent of this approach is to enable a front end to implement any
30263 update approach it likes; for example, scrolling a view may cause the
30264 front end to request more children with @code{-var-list-children}, and
30265 then the front end could call @code{-var-set-update-range} with a
30266 different range to ensure that future updates are restricted to just
30267 the visible items.
30268
30269 For each child the following results are returned:
30270
30271 @table @var
30272
30273 @item name
30274 Name of the variable object created for this child.
30275
30276 @item exp
30277 The expression to be shown to the user by the front end to designate this child.
30278 For example this may be the name of a structure member.
30279
30280 For a dynamic varobj, this value cannot be used to form an
30281 expression.  There is no way to do this at all with a dynamic varobj.
30282
30283 For C/C@t{++} structures there are several pseudo children returned to
30284 designate access qualifiers.  For these pseudo children @var{exp} is
30285 @samp{public}, @samp{private}, or @samp{protected}.  In this case the
30286 type and value are not present.
30287
30288 A dynamic varobj will not report the access qualifying
30289 pseudo-children, regardless of the language.  This information is not
30290 available at all with a dynamic varobj.
30291
30292 @item numchild
30293 Number of children this child has.  For a dynamic varobj, this will be
30294 0.
30295
30296 @item type
30297 The type of the child.  If @samp{print object}
30298 (@pxref{Print Settings, set print object}) is set to @code{on}, the
30299 @emph{actual} (derived) type of the object is shown rather than the
30300 @emph{declared} one.
30301
30302 @item value
30303 If values were requested, this is the value.
30304
30305 @item thread-id
30306 If this variable object is associated with a thread, this is the
30307 thread's global thread id.  Otherwise this result is not present.
30308
30309 @item frozen
30310 If the variable object is frozen, this variable will be present with a value of 1.
30311
30312 @item displayhint
30313 A dynamic varobj can supply a display hint to the front end.  The
30314 value comes directly from the Python pretty-printer object's
30315 @code{display_hint} method.  @xref{Pretty Printing API}.
30316
30317 @item dynamic
30318 This attribute will be present and have the value @samp{1} if the
30319 varobj is a dynamic varobj.  If the varobj is not a dynamic varobj,
30320 then this attribute will not be present.
30321
30322 @end table
30323
30324 The result may have its own attributes:
30325
30326 @table @samp
30327 @item displayhint
30328 A dynamic varobj can supply a display hint to the front end.  The
30329 value comes directly from the Python pretty-printer object's
30330 @code{display_hint} method.  @xref{Pretty Printing API}.
30331
30332 @item has_more
30333 This is an integer attribute which is nonzero if there are children
30334 remaining after the end of the selected range.
30335 @end table
30336
30337 @subsubheading Example
30338
30339 @smallexample
30340 (gdb)
30341  -var-list-children n
30342  ^done,numchild=@var{n},children=[child=@{name=@var{name},exp=@var{exp},
30343  numchild=@var{n},type=@var{type}@},@r{(repeats N times)}]
30344 (gdb)
30345  -var-list-children --all-values n
30346  ^done,numchild=@var{n},children=[child=@{name=@var{name},exp=@var{exp},
30347  numchild=@var{n},value=@var{value},type=@var{type}@},@r{(repeats N times)}]
30348 @end smallexample
30349
30350
30351 @subheading The @code{-var-info-type} Command
30352 @findex -var-info-type
30353
30354 @subsubheading Synopsis
30355
30356 @smallexample
30357  -var-info-type @var{name}
30358 @end smallexample
30359
30360 Returns the type of the specified variable @var{name}.  The type is
30361 returned as a string in the same format as it is output by the
30362 @value{GDBN} CLI:
30363
30364 @smallexample
30365  type=@var{typename}
30366 @end smallexample
30367
30368
30369 @subheading The @code{-var-info-expression} Command
30370 @findex -var-info-expression
30371
30372 @subsubheading Synopsis
30373
30374 @smallexample
30375  -var-info-expression @var{name}
30376 @end smallexample
30377
30378 Returns a string that is suitable for presenting this
30379 variable object in user interface.  The string is generally
30380 not valid expression in the current language, and cannot be evaluated.
30381
30382 For example, if @code{a} is an array, and variable object
30383 @code{A} was created for @code{a}, then we'll get this output:
30384
30385 @smallexample
30386 (gdb) -var-info-expression A.1
30387 ^done,lang="C",exp="1"
30388 @end smallexample
30389
30390 @noindent
30391 Here, the value of @code{lang} is the language name, which can be
30392 found in @ref{Supported Languages}.
30393
30394 Note that the output of the @code{-var-list-children} command also
30395 includes those expressions, so the @code{-var-info-expression} command
30396 is of limited use.
30397
30398 @subheading The @code{-var-info-path-expression} Command
30399 @findex -var-info-path-expression
30400
30401 @subsubheading Synopsis
30402
30403 @smallexample
30404  -var-info-path-expression @var{name}
30405 @end smallexample
30406
30407 Returns an expression that can be evaluated in the current
30408 context and will yield the same value that a variable object has.
30409 Compare this with the @code{-var-info-expression} command, which
30410 result can be used only for UI presentation.  Typical use of
30411 the @code{-var-info-path-expression} command is creating a 
30412 watchpoint from a variable object.
30413
30414 This command is currently not valid for children of a dynamic varobj,
30415 and will give an error when invoked on one.
30416
30417 For example, suppose @code{C} is a C@t{++} class, derived from class
30418 @code{Base}, and that the @code{Base} class has a member called
30419 @code{m_size}.  Assume a variable @code{c} is has the type of
30420 @code{C} and a variable object @code{C} was created for variable
30421 @code{c}.  Then, we'll get this output:
30422 @smallexample
30423 (gdb) -var-info-path-expression C.Base.public.m_size
30424 ^done,path_expr=((Base)c).m_size)
30425 @end smallexample
30426
30427 @subheading The @code{-var-show-attributes} Command
30428 @findex -var-show-attributes
30429
30430 @subsubheading Synopsis
30431
30432 @smallexample
30433  -var-show-attributes @var{name}
30434 @end smallexample
30435
30436 List attributes of the specified variable object @var{name}:
30437
30438 @smallexample
30439  status=@var{attr} [ ( ,@var{attr} )* ]
30440 @end smallexample
30441
30442 @noindent
30443 where @var{attr} is @code{@{ @{ editable | noneditable @} | TBD @}}.
30444
30445 @subheading The @code{-var-evaluate-expression} Command
30446 @findex -var-evaluate-expression
30447
30448 @subsubheading Synopsis
30449
30450 @smallexample
30451  -var-evaluate-expression [-f @var{format-spec}] @var{name}
30452 @end smallexample
30453
30454 Evaluates the expression that is represented by the specified variable
30455 object and returns its value as a string.  The format of the string
30456 can be specified with the @samp{-f} option.  The possible values of 
30457 this option are the same as for @code{-var-set-format} 
30458 (@pxref{-var-set-format}).  If the @samp{-f} option is not specified,
30459 the current display format will be used.  The current display format 
30460 can be changed using the @code{-var-set-format} command.
30461
30462 @smallexample
30463  value=@var{value}
30464 @end smallexample
30465
30466 Note that one must invoke @code{-var-list-children} for a variable
30467 before the value of a child variable can be evaluated.
30468
30469 @subheading The @code{-var-assign} Command
30470 @findex -var-assign
30471
30472 @subsubheading Synopsis
30473
30474 @smallexample
30475  -var-assign @var{name} @var{expression}
30476 @end smallexample
30477
30478 Assigns the value of @var{expression} to the variable object specified
30479 by @var{name}.  The object must be @samp{editable}.  If the variable's
30480 value is altered by the assign, the variable will show up in any
30481 subsequent @code{-var-update} list.
30482
30483 @subsubheading Example
30484
30485 @smallexample
30486 (gdb)
30487 -var-assign var1 3
30488 ^done,value="3"
30489 (gdb)
30490 -var-update *
30491 ^done,changelist=[@{name="var1",in_scope="true",type_changed="false"@}]
30492 (gdb)
30493 @end smallexample
30494
30495 @subheading The @code{-var-update} Command
30496 @findex -var-update
30497
30498 @subsubheading Synopsis
30499
30500 @smallexample
30501  -var-update [@var{print-values}] @{@var{name} | "*"@}
30502 @end smallexample
30503
30504 Reevaluate the expressions corresponding to the variable object
30505 @var{name} and all its direct and indirect children, and return the
30506 list of variable objects whose values have changed; @var{name} must
30507 be a root variable object.  Here, ``changed'' means that the result of
30508 @code{-var-evaluate-expression} before and after the
30509 @code{-var-update} is different.  If @samp{*} is used as the variable
30510 object names, all existing variable objects are updated, except
30511 for frozen ones (@pxref{-var-set-frozen}).  The option
30512 @var{print-values} determines whether both names and values, or just
30513 names are printed.  The possible values of this option are the same
30514 as for @code{-var-list-children} (@pxref{-var-list-children}).  It is
30515 recommended to use the @samp{--all-values} option, to reduce the
30516 number of MI commands needed on each program stop.
30517
30518 With the @samp{*} parameter, if a variable object is bound to a
30519 currently running thread, it will not be updated, without any
30520 diagnostic.
30521
30522 If @code{-var-set-update-range} was previously used on a varobj, then
30523 only the selected range of children will be reported.
30524
30525 @code{-var-update} reports all the changed varobjs in a tuple named
30526 @samp{changelist}.
30527
30528 Each item in the change list is itself a tuple holding:
30529
30530 @table @samp
30531 @item name
30532 The name of the varobj.
30533
30534 @item value
30535 If values were requested for this update, then this field will be
30536 present and will hold the value of the varobj.
30537
30538 @item in_scope
30539 @anchor{-var-update}
30540 This field is a string which may take one of three values:
30541
30542 @table @code
30543 @item "true"
30544 The variable object's current value is valid.
30545
30546 @item "false"
30547 The variable object does not currently hold a valid value but it may
30548 hold one in the future if its associated expression comes back into
30549 scope.
30550
30551 @item "invalid"
30552 The variable object no longer holds a valid value.
30553 This can occur when the executable file being debugged has changed,
30554 either through recompilation or by using the @value{GDBN} @code{file}
30555 command.  The front end should normally choose to delete these variable
30556 objects.
30557 @end table
30558
30559 In the future new values may be added to this list so the front should
30560 be prepared for this possibility.  @xref{GDB/MI Development and Front Ends, ,@sc{GDB/MI} Development and Front Ends}.
30561
30562 @item type_changed
30563 This is only present if the varobj is still valid.  If the type
30564 changed, then this will be the string @samp{true}; otherwise it will
30565 be @samp{false}.
30566
30567 When a varobj's type changes, its children are also likely to have
30568 become incorrect.  Therefore, the varobj's children are automatically
30569 deleted when this attribute is @samp{true}.  Also, the varobj's update
30570 range, when set using the @code{-var-set-update-range} command, is
30571 unset.
30572
30573 @item new_type
30574 If the varobj's type changed, then this field will be present and will
30575 hold the new type.
30576
30577 @item new_num_children
30578 For a dynamic varobj, if the number of children changed, or if the
30579 type changed, this will be the new number of children.
30580
30581 The @samp{numchild} field in other varobj responses is generally not
30582 valid for a dynamic varobj -- it will show the number of children that
30583 @value{GDBN} knows about, but because dynamic varobjs lazily
30584 instantiate their children, this will not reflect the number of
30585 children which may be available.
30586
30587 The @samp{new_num_children} attribute only reports changes to the
30588 number of children known by @value{GDBN}.  This is the only way to
30589 detect whether an update has removed children (which necessarily can
30590 only happen at the end of the update range).
30591
30592 @item displayhint
30593 The display hint, if any.
30594
30595 @item has_more
30596 This is an integer value, which will be 1 if there are more children
30597 available outside the varobj's update range.
30598
30599 @item dynamic
30600 This attribute will be present and have the value @samp{1} if the
30601 varobj is a dynamic varobj.  If the varobj is not a dynamic varobj,
30602 then this attribute will not be present.
30603
30604 @item new_children
30605 If new children were added to a dynamic varobj within the selected
30606 update range (as set by @code{-var-set-update-range}), then they will
30607 be listed in this attribute.
30608 @end table
30609
30610 @subsubheading Example
30611
30612 @smallexample
30613 (gdb)
30614 -var-assign var1 3
30615 ^done,value="3"
30616 (gdb)
30617 -var-update --all-values var1
30618 ^done,changelist=[@{name="var1",value="3",in_scope="true",
30619 type_changed="false"@}]
30620 (gdb)
30621 @end smallexample
30622
30623 @subheading The @code{-var-set-frozen} Command
30624 @findex -var-set-frozen
30625 @anchor{-var-set-frozen}
30626
30627 @subsubheading Synopsis
30628
30629 @smallexample
30630  -var-set-frozen @var{name} @var{flag}
30631 @end smallexample
30632
30633 Set the frozenness flag on the variable object @var{name}.  The
30634 @var{flag} parameter should be either @samp{1} to make the variable
30635 frozen or @samp{0} to make it unfrozen.  If a variable object is
30636 frozen, then neither itself, nor any of its children, are 
30637 implicitly updated by @code{-var-update} of 
30638 a parent variable or by @code{-var-update *}.  Only
30639 @code{-var-update} of the variable itself will update its value and
30640 values of its children.  After a variable object is unfrozen, it is
30641 implicitly updated by all subsequent @code{-var-update} operations.  
30642 Unfreezing a variable does not update it, only subsequent
30643 @code{-var-update} does.
30644
30645 @subsubheading Example
30646
30647 @smallexample
30648 (gdb)
30649 -var-set-frozen V 1
30650 ^done
30651 (gdb)
30652 @end smallexample
30653
30654 @subheading The @code{-var-set-update-range} command
30655 @findex -var-set-update-range
30656 @anchor{-var-set-update-range}
30657
30658 @subsubheading Synopsis
30659
30660 @smallexample
30661  -var-set-update-range @var{name} @var{from} @var{to}
30662 @end smallexample
30663
30664 Set the range of children to be returned by future invocations of
30665 @code{-var-update}.
30666
30667 @var{from} and @var{to} indicate the range of children to report.  If
30668 @var{from} or @var{to} is less than zero, the range is reset and all
30669 children will be reported.  Otherwise, children starting at @var{from}
30670 (zero-based) and up to and excluding @var{to} will be reported.
30671
30672 @subsubheading Example
30673
30674 @smallexample
30675 (gdb)
30676 -var-set-update-range V 1 2
30677 ^done
30678 @end smallexample
30679
30680 @subheading The @code{-var-set-visualizer} command
30681 @findex -var-set-visualizer
30682 @anchor{-var-set-visualizer}
30683
30684 @subsubheading Synopsis
30685
30686 @smallexample
30687  -var-set-visualizer @var{name} @var{visualizer}
30688 @end smallexample
30689
30690 Set a visualizer for the variable object @var{name}.
30691
30692 @var{visualizer} is the visualizer to use.  The special value
30693 @samp{None} means to disable any visualizer in use.
30694
30695 If not @samp{None}, @var{visualizer} must be a Python expression.
30696 This expression must evaluate to a callable object which accepts a
30697 single argument.  @value{GDBN} will call this object with the value of
30698 the varobj @var{name} as an argument (this is done so that the same
30699 Python pretty-printing code can be used for both the CLI and MI).
30700 When called, this object must return an object which conforms to the
30701 pretty-printing interface (@pxref{Pretty Printing API}).
30702
30703 The pre-defined function @code{gdb.default_visualizer} may be used to
30704 select a visualizer by following the built-in process
30705 (@pxref{Selecting Pretty-Printers}).  This is done automatically when
30706 a varobj is created, and so ordinarily is not needed.
30707
30708 This feature is only available if Python support is enabled.  The MI
30709 command @code{-list-features} (@pxref{GDB/MI Support Commands})
30710 can be used to check this.
30711
30712 @subsubheading Example
30713
30714 Resetting the visualizer:
30715
30716 @smallexample
30717 (gdb)
30718 -var-set-visualizer V None
30719 ^done
30720 @end smallexample
30721
30722 Reselecting the default (type-based) visualizer:
30723
30724 @smallexample
30725 (gdb)
30726 -var-set-visualizer V gdb.default_visualizer
30727 ^done
30728 @end smallexample
30729
30730 Suppose @code{SomeClass} is a visualizer class.  A lambda expression
30731 can be used to instantiate this class for a varobj:
30732
30733 @smallexample
30734 (gdb)
30735 -var-set-visualizer V "lambda val: SomeClass()"
30736 ^done
30737 @end smallexample
30738
30739 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
30740 @node GDB/MI Data Manipulation
30741 @section @sc{gdb/mi} Data Manipulation
30742
30743 @cindex data manipulation, in @sc{gdb/mi}
30744 @cindex @sc{gdb/mi}, data manipulation
30745 This section describes the @sc{gdb/mi} commands that manipulate data:
30746 examine memory and registers, evaluate expressions, etc.
30747
30748 For details about what an addressable memory unit is,
30749 @pxref{addressable memory unit}.
30750
30751 @c REMOVED FROM THE INTERFACE.
30752 @c @subheading -data-assign
30753 @c Change the value of a program variable. Plenty of side effects.
30754 @c @subsubheading GDB Command
30755 @c set variable
30756 @c @subsubheading Example
30757 @c N.A.
30758
30759 @subheading The @code{-data-disassemble} Command
30760 @findex -data-disassemble
30761
30762 @subsubheading Synopsis
30763
30764 @smallexample
30765  -data-disassemble
30766     [ -s @var{start-addr} -e @var{end-addr} ]
30767   | [ -f @var{filename} -l @var{linenum} [ -n @var{lines} ] ]
30768   -- @var{mode}
30769 @end smallexample
30770
30771 @noindent
30772 Where:
30773
30774 @table @samp
30775 @item @var{start-addr}
30776 is the beginning address (or @code{$pc})
30777 @item @var{end-addr}
30778 is the end address
30779 @item @var{filename}
30780 is the name of the file to disassemble
30781 @item @var{linenum}
30782 is the line number to disassemble around
30783 @item @var{lines}
30784 is the number of disassembly lines to be produced.  If it is -1,
30785 the whole function will be disassembled, in case no @var{end-addr} is
30786 specified.  If @var{end-addr} is specified as a non-zero value, and
30787 @var{lines} is lower than the number of disassembly lines between
30788 @var{start-addr} and @var{end-addr}, only @var{lines} lines are
30789 displayed; if @var{lines} is higher than the number of lines between
30790 @var{start-addr} and @var{end-addr}, only the lines up to @var{end-addr}
30791 are displayed.
30792 @item @var{mode}
30793 is one of:
30794 @itemize @bullet
30795 @item 0 disassembly only
30796 @item 1 mixed source and disassembly (deprecated)
30797 @item 2 disassembly with raw opcodes
30798 @item 3 mixed source and disassembly with raw opcodes (deprecated)
30799 @item 4 mixed source and disassembly
30800 @item 5 mixed source and disassembly with raw opcodes
30801 @end itemize
30802
30803 Modes 1 and 3 are deprecated.  The output is ``source centric''
30804 which hasn't proved useful in practice.
30805 @xref{Machine Code}, for a discussion of the difference between
30806 @code{/m} and @code{/s} output of the @code{disassemble} command.
30807 @end table
30808
30809 @subsubheading Result
30810
30811 The result of the @code{-data-disassemble} command will be a list named
30812 @samp{asm_insns}, the contents of this list depend on the @var{mode}
30813 used with the @code{-data-disassemble} command.
30814
30815 For modes 0 and 2 the @samp{asm_insns} list contains tuples with the
30816 following fields:
30817
30818 @table @code
30819 @item address
30820 The address at which this instruction was disassembled.
30821
30822 @item func-name
30823 The name of the function this instruction is within.
30824
30825 @item offset
30826 The decimal offset in bytes from the start of @samp{func-name}.
30827
30828 @item inst
30829 The text disassembly for this @samp{address}.
30830
30831 @item opcodes
30832 This field is only present for modes 2, 3 and 5.  This contains the raw opcode
30833 bytes for the @samp{inst} field.
30834
30835 @end table
30836
30837 For modes 1, 3, 4 and 5 the @samp{asm_insns} list contains tuples named
30838 @samp{src_and_asm_line}, each of which has the following fields:
30839
30840 @table @code
30841 @item line
30842 The line number within @samp{file}.
30843
30844 @item file
30845 The file name from the compilation unit.  This might be an absolute
30846 file name or a relative file name depending on the compile command
30847 used.
30848
30849 @item fullname
30850 Absolute file name of @samp{file}.  It is converted to a canonical form
30851 using the source file search path
30852 (@pxref{Source Path, ,Specifying Source Directories})
30853 and after resolving all the symbolic links.
30854
30855 If the source file is not found this field will contain the path as
30856 present in the debug information.
30857
30858 @item line_asm_insn
30859 This is a list of tuples containing the disassembly for @samp{line} in
30860 @samp{file}.  The fields of each tuple are the same as for
30861 @code{-data-disassemble} in @var{mode} 0 and 2, so @samp{address},
30862 @samp{func-name}, @samp{offset}, @samp{inst}, and optionally
30863 @samp{opcodes}.
30864
30865 @end table
30866
30867 Note that whatever included in the @samp{inst} field, is not
30868 manipulated directly by @sc{gdb/mi}, i.e., it is not possible to
30869 adjust its format.
30870
30871 @subsubheading @value{GDBN} Command
30872
30873 The corresponding @value{GDBN} command is @samp{disassemble}.
30874
30875 @subsubheading Example
30876
30877 Disassemble from the current value of @code{$pc} to @code{$pc + 20}:
30878
30879 @smallexample
30880 (gdb)
30881 -data-disassemble -s $pc -e "$pc + 20" -- 0
30882 ^done,
30883 asm_insns=[
30884 @{address="0x000107c0",func-name="main",offset="4",
30885 inst="mov  2, %o0"@},
30886 @{address="0x000107c4",func-name="main",offset="8",
30887 inst="sethi  %hi(0x11800), %o2"@},
30888 @{address="0x000107c8",func-name="main",offset="12",
30889 inst="or  %o2, 0x140, %o1\t! 0x11940 <_lib_version+8>"@},
30890 @{address="0x000107cc",func-name="main",offset="16",
30891 inst="sethi  %hi(0x11800), %o2"@},
30892 @{address="0x000107d0",func-name="main",offset="20",
30893 inst="or  %o2, 0x168, %o4\t! 0x11968 <_lib_version+48>"@}]
30894 (gdb)
30895 @end smallexample
30896
30897 Disassemble the whole @code{main} function.  Line 32 is part of
30898 @code{main}.
30899
30900 @smallexample
30901 -data-disassemble -f basics.c -l 32 -- 0
30902 ^done,asm_insns=[
30903 @{address="0x000107bc",func-name="main",offset="0",
30904 inst="save  %sp, -112, %sp"@},
30905 @{address="0x000107c0",func-name="main",offset="4",
30906 inst="mov   2, %o0"@},
30907 @{address="0x000107c4",func-name="main",offset="8",
30908 inst="sethi %hi(0x11800), %o2"@},
30909 [@dots{}]
30910 @{address="0x0001081c",func-name="main",offset="96",inst="ret "@},
30911 @{address="0x00010820",func-name="main",offset="100",inst="restore "@}]
30912 (gdb)
30913 @end smallexample
30914
30915 Disassemble 3 instructions from the start of @code{main}:
30916
30917 @smallexample
30918 (gdb)
30919 -data-disassemble -f basics.c -l 32 -n 3 -- 0
30920 ^done,asm_insns=[
30921 @{address="0x000107bc",func-name="main",offset="0",
30922 inst="save  %sp, -112, %sp"@},
30923 @{address="0x000107c0",func-name="main",offset="4",
30924 inst="mov  2, %o0"@},
30925 @{address="0x000107c4",func-name="main",offset="8",
30926 inst="sethi  %hi(0x11800), %o2"@}]
30927 (gdb)
30928 @end smallexample
30929
30930 Disassemble 3 instructions from the start of @code{main} in mixed mode:
30931
30932 @smallexample
30933 (gdb)
30934 -data-disassemble -f basics.c -l 32 -n 3 -- 1
30935 ^done,asm_insns=[
30936 src_and_asm_line=@{line="31",
30937 file="../../../src/gdb/testsuite/gdb.mi/basics.c",
30938 fullname="/absolute/path/to/src/gdb/testsuite/gdb.mi/basics.c",
30939 line_asm_insn=[@{address="0x000107bc",
30940 func-name="main",offset="0",inst="save  %sp, -112, %sp"@}]@},
30941 src_and_asm_line=@{line="32",
30942 file="../../../src/gdb/testsuite/gdb.mi/basics.c",
30943 fullname="/absolute/path/to/src/gdb/testsuite/gdb.mi/basics.c",
30944 line_asm_insn=[@{address="0x000107c0",
30945 func-name="main",offset="4",inst="mov  2, %o0"@},
30946 @{address="0x000107c4",func-name="main",offset="8",
30947 inst="sethi  %hi(0x11800), %o2"@}]@}]
30948 (gdb)
30949 @end smallexample
30950
30951
30952 @subheading The @code{-data-evaluate-expression} Command
30953 @findex -data-evaluate-expression
30954
30955 @subsubheading Synopsis
30956
30957 @smallexample
30958  -data-evaluate-expression @var{expr}
30959 @end smallexample
30960
30961 Evaluate @var{expr} as an expression.  The expression could contain an
30962 inferior function call.  The function call will execute synchronously.
30963 If the expression contains spaces, it must be enclosed in double quotes.
30964
30965 @subsubheading @value{GDBN} Command
30966
30967 The corresponding @value{GDBN} commands are @samp{print}, @samp{output}, and
30968 @samp{call}.  In @code{gdbtk} only, there's a corresponding
30969 @samp{gdb_eval} command.
30970
30971 @subsubheading Example
30972
30973 In the following example, the numbers that precede the commands are the
30974 @dfn{tokens} described in @ref{GDB/MI Command Syntax, ,@sc{gdb/mi}
30975 Command Syntax}.  Notice how @sc{gdb/mi} returns the same tokens in its
30976 output.
30977
30978 @smallexample
30979 211-data-evaluate-expression A
30980 211^done,value="1"
30981 (gdb)
30982 311-data-evaluate-expression &A
30983 311^done,value="0xefffeb7c"
30984 (gdb)
30985 411-data-evaluate-expression A+3
30986 411^done,value="4"
30987 (gdb)
30988 511-data-evaluate-expression "A + 3"
30989 511^done,value="4"
30990 (gdb)
30991 @end smallexample
30992
30993
30994 @subheading The @code{-data-list-changed-registers} Command
30995 @findex -data-list-changed-registers
30996
30997 @subsubheading Synopsis
30998
30999 @smallexample
31000  -data-list-changed-registers
31001 @end smallexample
31002
31003 Display a list of the registers that have changed.
31004
31005 @subsubheading @value{GDBN} Command
31006
31007 @value{GDBN} doesn't have a direct analog for this command; @code{gdbtk}
31008 has the corresponding command @samp{gdb_changed_register_list}.
31009
31010 @subsubheading Example
31011
31012 On a PPC MBX board:
31013
31014 @smallexample
31015 (gdb)
31016 -exec-continue
31017 ^running
31018
31019 (gdb)
31020 *stopped,reason="breakpoint-hit",disp="keep",bkptno="1",frame=@{
31021 func="main",args=[],file="try.c",fullname="/home/foo/bar/try.c",
31022 line="5"@}
31023 (gdb)
31024 -data-list-changed-registers
31025 ^done,changed-registers=["0","1","2","4","5","6","7","8","9",
31026 "10","11","13","14","15","16","17","18","19","20","21","22","23",
31027 "24","25","26","27","28","30","31","64","65","66","67","69"]
31028 (gdb)
31029 @end smallexample
31030
31031
31032 @subheading The @code{-data-list-register-names} Command
31033 @findex -data-list-register-names
31034
31035 @subsubheading Synopsis
31036
31037 @smallexample
31038  -data-list-register-names [ ( @var{regno} )+ ]
31039 @end smallexample
31040
31041 Show a list of register names for the current target.  If no arguments
31042 are given, it shows a list of the names of all the registers.  If
31043 integer numbers are given as arguments, it will print a list of the
31044 names of the registers corresponding to the arguments.  To ensure
31045 consistency between a register name and its number, the output list may
31046 include empty register names.
31047
31048 @subsubheading @value{GDBN} Command
31049
31050 @value{GDBN} does not have a command which corresponds to
31051 @samp{-data-list-register-names}.  In @code{gdbtk} there is a
31052 corresponding command @samp{gdb_regnames}.
31053
31054 @subsubheading Example
31055
31056 For the PPC MBX board:
31057 @smallexample
31058 (gdb)
31059 -data-list-register-names
31060 ^done,register-names=["r0","r1","r2","r3","r4","r5","r6","r7",
31061 "r8","r9","r10","r11","r12","r13","r14","r15","r16","r17","r18",
31062 "r19","r20","r21","r22","r23","r24","r25","r26","r27","r28","r29",
31063 "r30","r31","f0","f1","f2","f3","f4","f5","f6","f7","f8","f9",
31064 "f10","f11","f12","f13","f14","f15","f16","f17","f18","f19","f20",
31065 "f21","f22","f23","f24","f25","f26","f27","f28","f29","f30","f31",
31066 "", "pc","ps","cr","lr","ctr","xer"]
31067 (gdb)
31068 -data-list-register-names 1 2 3
31069 ^done,register-names=["r1","r2","r3"]
31070 (gdb)
31071 @end smallexample
31072
31073 @subheading The @code{-data-list-register-values} Command
31074 @findex -data-list-register-values
31075
31076 @subsubheading Synopsis
31077
31078 @smallexample
31079  -data-list-register-values
31080     [ @code{--skip-unavailable} ] @var{fmt} [ ( @var{regno} )*]
31081 @end smallexample
31082
31083 Display the registers' contents.  The format according to which the
31084 registers' contents are to be returned is given by @var{fmt}, followed
31085 by an optional list of numbers specifying the registers to display.  A
31086 missing list of numbers indicates that the contents of all the
31087 registers must be returned.  The @code{--skip-unavailable} option
31088 indicates that only the available registers are to be returned.
31089
31090 Allowed formats for @var{fmt} are:
31091
31092 @table @code
31093 @item x
31094 Hexadecimal
31095 @item o
31096 Octal
31097 @item t
31098 Binary
31099 @item d
31100 Decimal
31101 @item r
31102 Raw
31103 @item N
31104 Natural
31105 @end table
31106
31107 @subsubheading @value{GDBN} Command
31108
31109 The corresponding @value{GDBN} commands are @samp{info reg}, @samp{info
31110 all-reg}, and (in @code{gdbtk}) @samp{gdb_fetch_registers}.
31111
31112 @subsubheading Example
31113
31114 For a PPC MBX board (note: line breaks are for readability only, they
31115 don't appear in the actual output):
31116
31117 @smallexample
31118 (gdb)
31119 -data-list-register-values r 64 65
31120 ^done,register-values=[@{number="64",value="0xfe00a300"@},
31121 @{number="65",value="0x00029002"@}]
31122 (gdb)
31123 -data-list-register-values x
31124 ^done,register-values=[@{number="0",value="0xfe0043c8"@},
31125 @{number="1",value="0x3fff88"@},@{number="2",value="0xfffffffe"@},
31126 @{number="3",value="0x0"@},@{number="4",value="0xa"@},
31127 @{number="5",value="0x3fff68"@},@{number="6",value="0x3fff58"@},
31128 @{number="7",value="0xfe011e98"@},@{number="8",value="0x2"@},
31129 @{number="9",value="0xfa202820"@},@{number="10",value="0xfa202808"@},
31130 @{number="11",value="0x1"@},@{number="12",value="0x0"@},
31131 @{number="13",value="0x4544"@},@{number="14",value="0xffdfffff"@},
31132 @{number="15",value="0xffffffff"@},@{number="16",value="0xfffffeff"@},
31133 @{number="17",value="0xefffffed"@},@{number="18",value="0xfffffffe"@},
31134 @{number="19",value="0xffffffff"@},@{number="20",value="0xffffffff"@},
31135 @{number="21",value="0xffffffff"@},@{number="22",value="0xfffffff7"@},
31136 @{number="23",value="0xffffffff"@},@{number="24",value="0xffffffff"@},
31137 @{number="25",value="0xffffffff"@},@{number="26",value="0xfffffffb"@},
31138 @{number="27",value="0xffffffff"@},@{number="28",value="0xf7bfffff"@},
31139 @{number="29",value="0x0"@},@{number="30",value="0xfe010000"@},
31140 @{number="31",value="0x0"@},@{number="32",value="0x0"@},
31141 @{number="33",value="0x0"@},@{number="34",value="0x0"@},
31142 @{number="35",value="0x0"@},@{number="36",value="0x0"@},
31143 @{number="37",value="0x0"@},@{number="38",value="0x0"@},
31144 @{number="39",value="0x0"@},@{number="40",value="0x0"@},
31145 @{number="41",value="0x0"@},@{number="42",value="0x0"@},
31146 @{number="43",value="0x0"@},@{number="44",value="0x0"@},
31147 @{number="45",value="0x0"@},@{number="46",value="0x0"@},
31148 @{number="47",value="0x0"@},@{number="48",value="0x0"@},
31149 @{number="49",value="0x0"@},@{number="50",value="0x0"@},
31150 @{number="51",value="0x0"@},@{number="52",value="0x0"@},
31151 @{number="53",value="0x0"@},@{number="54",value="0x0"@},
31152 @{number="55",value="0x0"@},@{number="56",value="0x0"@},
31153 @{number="57",value="0x0"@},@{number="58",value="0x0"@},
31154 @{number="59",value="0x0"@},@{number="60",value="0x0"@},
31155 @{number="61",value="0x0"@},@{number="62",value="0x0"@},
31156 @{number="63",value="0x0"@},@{number="64",value="0xfe00a300"@},
31157 @{number="65",value="0x29002"@},@{number="66",value="0x202f04b5"@},
31158 @{number="67",value="0xfe0043b0"@},@{number="68",value="0xfe00b3e4"@},
31159 @{number="69",value="0x20002b03"@}]
31160 (gdb)
31161 @end smallexample
31162
31163
31164 @subheading The @code{-data-read-memory} Command
31165 @findex -data-read-memory
31166
31167 This command is deprecated, use @code{-data-read-memory-bytes} instead.
31168
31169 @subsubheading Synopsis
31170
31171 @smallexample
31172  -data-read-memory [ -o @var{byte-offset} ]
31173    @var{address} @var{word-format} @var{word-size}
31174    @var{nr-rows} @var{nr-cols} [ @var{aschar} ]
31175 @end smallexample
31176
31177 @noindent
31178 where:
31179
31180 @table @samp
31181 @item @var{address}
31182 An expression specifying the address of the first memory word to be
31183 read.  Complex expressions containing embedded white space should be
31184 quoted using the C convention.
31185
31186 @item @var{word-format}
31187 The format to be used to print the memory words.  The notation is the
31188 same as for @value{GDBN}'s @code{print} command (@pxref{Output Formats,
31189 ,Output Formats}).
31190
31191 @item @var{word-size}
31192 The size of each memory word in bytes.
31193
31194 @item @var{nr-rows}
31195 The number of rows in the output table.
31196
31197 @item @var{nr-cols}
31198 The number of columns in the output table.
31199
31200 @item @var{aschar}
31201 If present, indicates that each row should include an @sc{ascii} dump.  The
31202 value of @var{aschar} is used as a padding character when a byte is not a
31203 member of the printable @sc{ascii} character set (printable @sc{ascii}
31204 characters are those whose code is between 32 and 126, inclusively).
31205
31206 @item @var{byte-offset}
31207 An offset to add to the @var{address} before fetching memory.
31208 @end table
31209
31210 This command displays memory contents as a table of @var{nr-rows} by
31211 @var{nr-cols} words, each word being @var{word-size} bytes.  In total,
31212 @code{@var{nr-rows} * @var{nr-cols} * @var{word-size}} bytes are read
31213 (returned as @samp{total-bytes}).  Should less than the requested number
31214 of bytes be returned by the target, the missing words are identified
31215 using @samp{N/A}.  The number of bytes read from the target is returned
31216 in @samp{nr-bytes} and the starting address used to read memory in
31217 @samp{addr}.
31218
31219 The address of the next/previous row or page is available in
31220 @samp{next-row} and @samp{prev-row}, @samp{next-page} and
31221 @samp{prev-page}.
31222
31223 @subsubheading @value{GDBN} Command
31224
31225 The corresponding @value{GDBN} command is @samp{x}.  @code{gdbtk} has
31226 @samp{gdb_get_mem} memory read command.
31227
31228 @subsubheading Example
31229
31230 Read six bytes of memory starting at @code{bytes+6} but then offset by
31231 @code{-6} bytes.  Format as three rows of two columns.  One byte per
31232 word.  Display each word in hex.
31233
31234 @smallexample
31235 (gdb)
31236 9-data-read-memory -o -6 -- bytes+6 x 1 3 2
31237 9^done,addr="0x00001390",nr-bytes="6",total-bytes="6",
31238 next-row="0x00001396",prev-row="0x0000138e",next-page="0x00001396",
31239 prev-page="0x0000138a",memory=[
31240 @{addr="0x00001390",data=["0x00","0x01"]@},
31241 @{addr="0x00001392",data=["0x02","0x03"]@},
31242 @{addr="0x00001394",data=["0x04","0x05"]@}]
31243 (gdb)
31244 @end smallexample
31245
31246 Read two bytes of memory starting at address @code{shorts + 64} and
31247 display as a single word formatted in decimal.
31248
31249 @smallexample
31250 (gdb)
31251 5-data-read-memory shorts+64 d 2 1 1
31252 5^done,addr="0x00001510",nr-bytes="2",total-bytes="2",
31253 next-row="0x00001512",prev-row="0x0000150e",
31254 next-page="0x00001512",prev-page="0x0000150e",memory=[
31255 @{addr="0x00001510",data=["128"]@}]
31256 (gdb)
31257 @end smallexample
31258
31259 Read thirty two bytes of memory starting at @code{bytes+16} and format
31260 as eight rows of four columns.  Include a string encoding with @samp{x}
31261 used as the non-printable character.
31262
31263 @smallexample
31264 (gdb)
31265 4-data-read-memory bytes+16 x 1 8 4 x
31266 4^done,addr="0x000013a0",nr-bytes="32",total-bytes="32",
31267 next-row="0x000013c0",prev-row="0x0000139c",
31268 next-page="0x000013c0",prev-page="0x00001380",memory=[
31269 @{addr="0x000013a0",data=["0x10","0x11","0x12","0x13"],ascii="xxxx"@},
31270 @{addr="0x000013a4",data=["0x14","0x15","0x16","0x17"],ascii="xxxx"@},
31271 @{addr="0x000013a8",data=["0x18","0x19","0x1a","0x1b"],ascii="xxxx"@},
31272 @{addr="0x000013ac",data=["0x1c","0x1d","0x1e","0x1f"],ascii="xxxx"@},
31273 @{addr="0x000013b0",data=["0x20","0x21","0x22","0x23"],ascii=" !\"#"@},
31274 @{addr="0x000013b4",data=["0x24","0x25","0x26","0x27"],ascii="$%&'"@},
31275 @{addr="0x000013b8",data=["0x28","0x29","0x2a","0x2b"],ascii="()*+"@},
31276 @{addr="0x000013bc",data=["0x2c","0x2d","0x2e","0x2f"],ascii=",-./"@}]
31277 (gdb)
31278 @end smallexample
31279
31280 @subheading The @code{-data-read-memory-bytes} Command
31281 @findex -data-read-memory-bytes
31282
31283 @subsubheading Synopsis
31284
31285 @smallexample
31286  -data-read-memory-bytes [ -o @var{offset} ]
31287    @var{address} @var{count}
31288 @end smallexample
31289
31290 @noindent
31291 where:
31292
31293 @table @samp
31294 @item @var{address}
31295 An expression specifying the address of the first addressable memory unit
31296 to be read.  Complex expressions containing embedded white space should be
31297 quoted using the C convention.
31298
31299 @item @var{count}
31300 The number of addressable memory units to read.  This should be an integer
31301 literal.
31302
31303 @item @var{offset}
31304 The offset relative to @var{address} at which to start reading.  This
31305 should be an integer literal.  This option is provided so that a frontend
31306 is not required to first evaluate address and then perform address
31307 arithmetics itself.
31308
31309 @end table
31310
31311 This command attempts to read all accessible memory regions in the
31312 specified range.  First, all regions marked as unreadable in the memory
31313 map (if one is defined) will be skipped.  @xref{Memory Region
31314 Attributes}.  Second, @value{GDBN} will attempt to read the remaining
31315 regions.  For each one, if reading full region results in an errors,
31316 @value{GDBN} will try to read a subset of the region.
31317
31318 In general, every single memory unit in the region may be readable or not,
31319 and the only way to read every readable unit is to try a read at
31320 every address, which is not practical.   Therefore, @value{GDBN} will
31321 attempt to read all accessible memory units at either beginning or the end
31322 of the region, using a binary division scheme.  This heuristic works
31323 well for reading accross a memory map boundary.  Note that if a region
31324 has a readable range that is neither at the beginning or the end,
31325 @value{GDBN} will not read it.
31326
31327 The result record (@pxref{GDB/MI Result Records}) that is output of
31328 the command includes a field named @samp{memory} whose content is a
31329 list of tuples.  Each tuple represent a successfully read memory block
31330 and has the following fields:
31331
31332 @table @code
31333 @item begin
31334 The start address of the memory block, as hexadecimal literal.
31335
31336 @item end
31337 The end address of the memory block, as hexadecimal literal.
31338
31339 @item offset
31340 The offset of the memory block, as hexadecimal literal, relative to
31341 the start address passed to @code{-data-read-memory-bytes}.
31342
31343 @item contents
31344 The contents of the memory block, in hex.
31345
31346 @end table
31347
31348
31349
31350 @subsubheading @value{GDBN} Command
31351
31352 The corresponding @value{GDBN} command is @samp{x}.
31353
31354 @subsubheading Example
31355
31356 @smallexample
31357 (gdb)
31358 -data-read-memory-bytes &a 10
31359 ^done,memory=[@{begin="0xbffff154",offset="0x00000000",
31360               end="0xbffff15e",
31361               contents="01000000020000000300"@}]
31362 (gdb)
31363 @end smallexample
31364
31365
31366 @subheading The @code{-data-write-memory-bytes} Command
31367 @findex -data-write-memory-bytes
31368
31369 @subsubheading Synopsis
31370
31371 @smallexample
31372  -data-write-memory-bytes @var{address} @var{contents}
31373  -data-write-memory-bytes @var{address} @var{contents} @r{[}@var{count}@r{]}
31374 @end smallexample
31375
31376 @noindent
31377 where:
31378
31379 @table @samp
31380 @item @var{address}
31381 An expression specifying the address of the first addressable memory unit
31382 to be written.  Complex expressions containing embedded white space should
31383 be quoted using the C convention.
31384
31385 @item @var{contents}
31386 The hex-encoded data to write.  It is an error if @var{contents} does
31387 not represent an integral number of addressable memory units.
31388
31389 @item @var{count}
31390 Optional argument indicating the number of addressable memory units to be
31391 written.  If @var{count} is greater than @var{contents}' length,
31392 @value{GDBN} will repeatedly write @var{contents} until it fills
31393 @var{count} memory units.
31394
31395 @end table
31396
31397 @subsubheading @value{GDBN} Command
31398
31399 There's no corresponding @value{GDBN} command.
31400
31401 @subsubheading Example
31402
31403 @smallexample
31404 (gdb)
31405 -data-write-memory-bytes &a "aabbccdd"
31406 ^done
31407 (gdb)
31408 @end smallexample
31409
31410 @smallexample
31411 (gdb)
31412 -data-write-memory-bytes &a "aabbccdd" 16e
31413 ^done
31414 (gdb)
31415 @end smallexample
31416
31417 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
31418 @node GDB/MI Tracepoint Commands
31419 @section @sc{gdb/mi} Tracepoint Commands
31420
31421 The commands defined in this section implement MI support for
31422 tracepoints.  For detailed introduction, see @ref{Tracepoints}.
31423
31424 @subheading The @code{-trace-find} Command
31425 @findex -trace-find
31426
31427 @subsubheading Synopsis
31428
31429 @smallexample
31430  -trace-find @var{mode} [@var{parameters}@dots{}]
31431 @end smallexample
31432
31433 Find a trace frame using criteria defined by @var{mode} and
31434 @var{parameters}.  The following table lists permissible
31435 modes and their parameters.  For details of operation, see @ref{tfind}.
31436
31437 @table @samp
31438
31439 @item none
31440 No parameters are required.  Stops examining trace frames.
31441
31442 @item frame-number
31443 An integer is required as parameter.  Selects tracepoint frame with
31444 that index.
31445
31446 @item tracepoint-number
31447 An integer is required as parameter.  Finds next
31448 trace frame that corresponds to tracepoint with the specified number.
31449
31450 @item pc
31451 An address is required as parameter.  Finds
31452 next trace frame that corresponds to any tracepoint at the specified
31453 address.
31454
31455 @item pc-inside-range
31456 Two addresses are required as parameters.  Finds next trace
31457 frame that corresponds to a tracepoint at an address inside the
31458 specified range.  Both bounds are considered to be inside the range.
31459
31460 @item pc-outside-range
31461 Two addresses are required as parameters.  Finds
31462 next trace frame that corresponds to a tracepoint at an address outside
31463 the specified range.  Both bounds are considered to be inside the range.
31464
31465 @item line
31466 Line specification is required as parameter.  @xref{Specify Location}.
31467 Finds next trace frame that corresponds to a tracepoint at
31468 the specified location.
31469
31470 @end table
31471
31472 If @samp{none} was passed as @var{mode}, the response does not
31473 have fields.  Otherwise, the response may have the following fields:
31474
31475 @table @samp
31476 @item found
31477 This field has either @samp{0} or @samp{1} as the value, depending
31478 on whether a matching tracepoint was found.
31479
31480 @item traceframe
31481 The index of the found traceframe.  This field is present iff
31482 the @samp{found} field has value of @samp{1}.
31483
31484 @item tracepoint
31485 The index of the found tracepoint.  This field is present iff
31486 the @samp{found} field has value of @samp{1}.
31487
31488 @item frame
31489 The information about the frame corresponding to the found trace
31490 frame.  This field is present only if a trace frame was found.
31491 @xref{GDB/MI Frame Information}, for description of this field.
31492
31493 @end table
31494
31495 @subsubheading @value{GDBN} Command
31496
31497 The corresponding @value{GDBN} command is @samp{tfind}.
31498
31499 @subheading -trace-define-variable
31500 @findex -trace-define-variable
31501
31502 @subsubheading Synopsis
31503
31504 @smallexample
31505  -trace-define-variable @var{name} [ @var{value} ]
31506 @end smallexample
31507
31508 Create trace variable @var{name} if it does not exist.  If
31509 @var{value} is specified, sets the initial value of the specified
31510 trace variable to that value.  Note that the @var{name} should start
31511 with the @samp{$} character.
31512
31513 @subsubheading @value{GDBN} Command
31514
31515 The corresponding @value{GDBN} command is @samp{tvariable}.
31516
31517 @subheading The @code{-trace-frame-collected} Command
31518 @findex -trace-frame-collected
31519
31520 @subsubheading Synopsis
31521
31522 @smallexample
31523  -trace-frame-collected
31524     [--var-print-values @var{var_pval}]
31525     [--comp-print-values @var{comp_pval}]
31526     [--registers-format @var{regformat}]
31527     [--memory-contents]
31528 @end smallexample
31529
31530 This command returns the set of collected objects, register names,
31531 trace state variable names, memory ranges and computed expressions
31532 that have been collected at a particular trace frame.  The optional
31533 parameters to the command affect the output format in different ways.
31534 See the output description table below for more details.
31535
31536 The reported names can be used in the normal manner to create
31537 varobjs and inspect the objects themselves.  The items returned by
31538 this command are categorized so that it is clear which is a variable,
31539 which is a register, which is a trace state variable, which is a
31540 memory range and which is a computed expression.
31541
31542 For instance, if the actions were
31543 @smallexample
31544 collect myVar, myArray[myIndex], myObj.field, myPtr->field, myCount + 2
31545 collect *(int*)0xaf02bef0@@40
31546 @end smallexample
31547
31548 @noindent
31549 the object collected in its entirety would be @code{myVar}.  The
31550 object @code{myArray} would be partially collected, because only the
31551 element at index @code{myIndex} would be collected.  The remaining
31552 objects would be computed expressions.
31553
31554 An example output would be:
31555
31556 @smallexample
31557 (gdb)
31558 -trace-frame-collected
31559 ^done,
31560   explicit-variables=[@{name="myVar",value="1"@}],
31561   computed-expressions=[@{name="myArray[myIndex]",value="0"@},
31562                         @{name="myObj.field",value="0"@},
31563                         @{name="myPtr->field",value="1"@},
31564                         @{name="myCount + 2",value="3"@},
31565                         @{name="$tvar1 + 1",value="43970027"@}],
31566   registers=[@{number="0",value="0x7fe2c6e79ec8"@},
31567              @{number="1",value="0x0"@},
31568              @{number="2",value="0x4"@},
31569              ...
31570              @{number="125",value="0x0"@}],
31571   tvars=[@{name="$tvar1",current="43970026"@}],
31572   memory=[@{address="0x0000000000602264",length="4"@},
31573           @{address="0x0000000000615bc0",length="4"@}]
31574 (gdb)
31575 @end smallexample
31576
31577 Where:
31578
31579 @table @code
31580 @item explicit-variables
31581 The set of objects that have been collected in their entirety (as
31582 opposed to collecting just a few elements of an array or a few struct
31583 members).  For each object, its name and value are printed.
31584 The @code{--var-print-values} option affects how or whether the value
31585 field is output.  If @var{var_pval} is 0, then print only the names;
31586 if it is 1, print also their values; and if it is 2, print the name,
31587 type and value for simple data types, and the name and type for
31588 arrays, structures and unions.
31589
31590 @item computed-expressions
31591 The set of computed expressions that have been collected at the
31592 current trace frame.  The @code{--comp-print-values} option affects
31593 this set like the @code{--var-print-values} option affects the
31594 @code{explicit-variables} set.  See above.
31595
31596 @item registers
31597 The registers that have been collected at the current trace frame.
31598 For each register collected, the name and current value are returned.
31599 The value is formatted according to the @code{--registers-format}
31600 option.  See the @command{-data-list-register-values} command for a
31601 list of the allowed formats.  The default is @samp{x}.
31602
31603 @item tvars
31604 The trace state variables that have been collected at the current
31605 trace frame.  For each trace state variable collected, the name and
31606 current value are returned.
31607
31608 @item memory
31609 The set of memory ranges that have been collected at the current trace
31610 frame.  Its content is a list of tuples.  Each tuple represents a
31611 collected memory range and has the following fields:
31612
31613 @table @code
31614 @item address
31615 The start address of the memory range, as hexadecimal literal.
31616
31617 @item length
31618 The length of the memory range, as decimal literal.
31619
31620 @item contents
31621 The contents of the memory block, in hex.  This field is only present
31622 if the @code{--memory-contents} option is specified.
31623
31624 @end table
31625
31626 @end table
31627
31628 @subsubheading @value{GDBN} Command
31629
31630 There is no corresponding @value{GDBN} command.
31631
31632 @subsubheading Example
31633
31634 @subheading -trace-list-variables
31635 @findex -trace-list-variables
31636
31637 @subsubheading Synopsis
31638
31639 @smallexample
31640  -trace-list-variables
31641 @end smallexample
31642
31643 Return a table of all defined trace variables.  Each element of the
31644 table has the following fields:
31645
31646 @table @samp
31647 @item name
31648 The name of the trace variable.  This field is always present.
31649
31650 @item initial
31651 The initial value.  This is a 64-bit signed integer.  This
31652 field is always present.
31653
31654 @item current
31655 The value the trace variable has at the moment.  This is a 64-bit
31656 signed integer.  This field is absent iff current value is
31657 not defined, for example if the trace was never run, or is
31658 presently running.
31659
31660 @end table
31661
31662 @subsubheading @value{GDBN} Command
31663
31664 The corresponding @value{GDBN} command is @samp{tvariables}.
31665
31666 @subsubheading Example
31667
31668 @smallexample
31669 (gdb)
31670 -trace-list-variables
31671 ^done,trace-variables=@{nr_rows="1",nr_cols="3",
31672 hdr=[@{width="15",alignment="-1",col_name="name",colhdr="Name"@},
31673      @{width="11",alignment="-1",col_name="initial",colhdr="Initial"@},
31674      @{width="11",alignment="-1",col_name="current",colhdr="Current"@}],
31675 body=[variable=@{name="$trace_timestamp",initial="0"@}
31676       variable=@{name="$foo",initial="10",current="15"@}]@}
31677 (gdb)
31678 @end smallexample
31679
31680 @subheading -trace-save
31681 @findex -trace-save
31682
31683 @subsubheading Synopsis
31684
31685 @smallexample
31686  -trace-save [ -r ] [ -ctf ] @var{filename}
31687 @end smallexample
31688
31689 Saves the collected trace data to @var{filename}.  Without the
31690 @samp{-r} option, the data is downloaded from the target and saved
31691 in a local file.  With the @samp{-r} option the target is asked
31692 to perform the save.
31693
31694 By default, this command will save the trace in the tfile format.  You can
31695 supply the optional @samp{-ctf} argument to save it the CTF format. See
31696 @ref{Trace Files} for more information about CTF.
31697
31698 @subsubheading @value{GDBN} Command
31699
31700 The corresponding @value{GDBN} command is @samp{tsave}.
31701
31702
31703 @subheading -trace-start
31704 @findex -trace-start
31705
31706 @subsubheading Synopsis
31707
31708 @smallexample
31709  -trace-start
31710 @end smallexample
31711
31712 Starts a tracing experiment.  The result of this command does not
31713 have any fields.
31714
31715 @subsubheading @value{GDBN} Command
31716
31717 The corresponding @value{GDBN} command is @samp{tstart}.
31718
31719 @subheading -trace-status
31720 @findex -trace-status
31721
31722 @subsubheading Synopsis
31723
31724 @smallexample
31725  -trace-status
31726 @end smallexample
31727
31728 Obtains the status of a tracing experiment.  The result may include
31729 the following fields:
31730
31731 @table @samp
31732
31733 @item supported
31734 May have a value of either @samp{0}, when no tracing operations are
31735 supported, @samp{1}, when all tracing operations are supported, or
31736 @samp{file} when examining trace file.  In the latter case, examining
31737 of trace frame is possible but new tracing experiement cannot be
31738 started.  This field is always present.
31739
31740 @item running
31741 May have a value of either @samp{0} or @samp{1} depending on whether
31742 tracing experiement is in progress on target.  This field is present
31743 if @samp{supported} field is not @samp{0}.
31744
31745 @item stop-reason
31746 Report the reason why the tracing was stopped last time.  This field
31747 may be absent iff tracing was never stopped on target yet.  The
31748 value of @samp{request} means the tracing was stopped as result of
31749 the @code{-trace-stop} command.  The value of @samp{overflow} means
31750 the tracing buffer is full.  The value of @samp{disconnection} means
31751 tracing was automatically stopped when @value{GDBN} has disconnected.
31752 The value of @samp{passcount} means tracing was stopped when a
31753 tracepoint was passed a maximal number of times for that tracepoint.
31754 This field is present if @samp{supported} field is not @samp{0}.
31755
31756 @item stopping-tracepoint
31757 The number of tracepoint whose passcount as exceeded.  This field is
31758 present iff the @samp{stop-reason} field has the value of
31759 @samp{passcount}.
31760
31761 @item frames
31762 @itemx frames-created
31763 The @samp{frames} field is a count of the total number of trace frames
31764 in the trace buffer, while @samp{frames-created} is the total created
31765 during the run, including ones that were discarded, such as when a
31766 circular trace buffer filled up.  Both fields are optional.
31767
31768 @item buffer-size
31769 @itemx buffer-free
31770 These fields tell the current size of the tracing buffer and the
31771 remaining space.  These fields are optional.
31772
31773 @item circular
31774 The value of the circular trace buffer flag.  @code{1} means that the
31775 trace buffer is circular and old trace frames will be discarded if
31776 necessary to make room, @code{0} means that the trace buffer is linear
31777 and may fill up.
31778
31779 @item disconnected
31780 The value of the disconnected tracing flag.  @code{1} means that
31781 tracing will continue after @value{GDBN} disconnects, @code{0} means
31782 that the trace run will stop.
31783
31784 @item trace-file
31785 The filename of the trace file being examined.  This field is
31786 optional, and only present when examining a trace file.
31787
31788 @end table
31789
31790 @subsubheading @value{GDBN} Command
31791
31792 The corresponding @value{GDBN} command is @samp{tstatus}.
31793
31794 @subheading -trace-stop
31795 @findex -trace-stop
31796
31797 @subsubheading Synopsis
31798
31799 @smallexample
31800  -trace-stop
31801 @end smallexample
31802
31803 Stops a tracing experiment.  The result of this command has the same
31804 fields as @code{-trace-status}, except that the @samp{supported} and
31805 @samp{running} fields are not output.
31806
31807 @subsubheading @value{GDBN} Command
31808
31809 The corresponding @value{GDBN} command is @samp{tstop}.
31810
31811
31812 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
31813 @node GDB/MI Symbol Query
31814 @section @sc{gdb/mi} Symbol Query Commands
31815
31816
31817 @ignore
31818 @subheading The @code{-symbol-info-address} Command
31819 @findex -symbol-info-address
31820
31821 @subsubheading Synopsis
31822
31823 @smallexample
31824  -symbol-info-address @var{symbol}
31825 @end smallexample
31826
31827 Describe where @var{symbol} is stored.
31828
31829 @subsubheading @value{GDBN} Command
31830
31831 The corresponding @value{GDBN} command is @samp{info address}.
31832
31833 @subsubheading Example
31834 N.A.
31835
31836
31837 @subheading The @code{-symbol-info-file} Command
31838 @findex -symbol-info-file
31839
31840 @subsubheading Synopsis
31841
31842 @smallexample
31843  -symbol-info-file
31844 @end smallexample
31845
31846 Show the file for the symbol.
31847
31848 @subsubheading @value{GDBN} Command
31849
31850 There's no equivalent @value{GDBN} command.  @code{gdbtk} has
31851 @samp{gdb_find_file}.
31852
31853 @subsubheading Example
31854 N.A.
31855
31856
31857 @subheading The @code{-symbol-info-function} Command
31858 @findex -symbol-info-function
31859
31860 @subsubheading Synopsis
31861
31862 @smallexample
31863  -symbol-info-function
31864 @end smallexample
31865
31866 Show which function the symbol lives in.
31867
31868 @subsubheading @value{GDBN} Command
31869
31870 @samp{gdb_get_function} in @code{gdbtk}.
31871
31872 @subsubheading Example
31873 N.A.
31874
31875
31876 @subheading The @code{-symbol-info-line} Command
31877 @findex -symbol-info-line
31878
31879 @subsubheading Synopsis
31880
31881 @smallexample
31882  -symbol-info-line
31883 @end smallexample
31884
31885 Show the core addresses of the code for a source line.
31886
31887 @subsubheading @value{GDBN} Command
31888
31889 The corresponding @value{GDBN} command is @samp{info line}.
31890 @code{gdbtk} has the @samp{gdb_get_line} and @samp{gdb_get_file} commands.
31891
31892 @subsubheading Example
31893 N.A.
31894
31895
31896 @subheading The @code{-symbol-info-symbol} Command
31897 @findex -symbol-info-symbol
31898
31899 @subsubheading Synopsis
31900
31901 @smallexample
31902  -symbol-info-symbol @var{addr}
31903 @end smallexample
31904
31905 Describe what symbol is at location @var{addr}.
31906
31907 @subsubheading @value{GDBN} Command
31908
31909 The corresponding @value{GDBN} command is @samp{info symbol}.
31910
31911 @subsubheading Example
31912 N.A.
31913
31914
31915 @subheading The @code{-symbol-list-functions} Command
31916 @findex -symbol-list-functions
31917
31918 @subsubheading Synopsis
31919
31920 @smallexample
31921  -symbol-list-functions
31922 @end smallexample
31923
31924 List the functions in the executable.
31925
31926 @subsubheading @value{GDBN} Command
31927
31928 @samp{info functions} in @value{GDBN}, @samp{gdb_listfunc} and
31929 @samp{gdb_search} in @code{gdbtk}.
31930
31931 @subsubheading Example
31932 N.A.
31933 @end ignore
31934
31935
31936 @subheading The @code{-symbol-list-lines} Command
31937 @findex -symbol-list-lines
31938
31939 @subsubheading Synopsis
31940
31941 @smallexample
31942  -symbol-list-lines @var{filename}
31943 @end smallexample
31944
31945 Print the list of lines that contain code and their associated program
31946 addresses for the given source filename.  The entries are sorted in
31947 ascending PC order.
31948
31949 @subsubheading @value{GDBN} Command
31950
31951 There is no corresponding @value{GDBN} command.
31952
31953 @subsubheading Example
31954 @smallexample
31955 (gdb)
31956 -symbol-list-lines basics.c
31957 ^done,lines=[@{pc="0x08048554",line="7"@},@{pc="0x0804855a",line="8"@}]
31958 (gdb)
31959 @end smallexample
31960
31961
31962 @ignore
31963 @subheading The @code{-symbol-list-types} Command
31964 @findex -symbol-list-types
31965
31966 @subsubheading Synopsis
31967
31968 @smallexample
31969  -symbol-list-types
31970 @end smallexample
31971
31972 List all the type names.
31973
31974 @subsubheading @value{GDBN} Command
31975
31976 The corresponding commands are @samp{info types} in @value{GDBN},
31977 @samp{gdb_search} in @code{gdbtk}.
31978
31979 @subsubheading Example
31980 N.A.
31981
31982
31983 @subheading The @code{-symbol-list-variables} Command
31984 @findex -symbol-list-variables
31985
31986 @subsubheading Synopsis
31987
31988 @smallexample
31989  -symbol-list-variables
31990 @end smallexample
31991
31992 List all the global and static variable names.
31993
31994 @subsubheading @value{GDBN} Command
31995
31996 @samp{info variables} in @value{GDBN}, @samp{gdb_search} in @code{gdbtk}.
31997
31998 @subsubheading Example
31999 N.A.
32000
32001
32002 @subheading The @code{-symbol-locate} Command
32003 @findex -symbol-locate
32004
32005 @subsubheading Synopsis
32006
32007 @smallexample
32008  -symbol-locate
32009 @end smallexample
32010
32011 @subsubheading @value{GDBN} Command
32012
32013 @samp{gdb_loc} in @code{gdbtk}.
32014
32015 @subsubheading Example
32016 N.A.
32017
32018
32019 @subheading The @code{-symbol-type} Command
32020 @findex -symbol-type
32021
32022 @subsubheading Synopsis
32023
32024 @smallexample
32025  -symbol-type @var{variable}
32026 @end smallexample
32027
32028 Show type of @var{variable}.
32029
32030 @subsubheading @value{GDBN} Command
32031
32032 The corresponding @value{GDBN} command is @samp{ptype}, @code{gdbtk} has
32033 @samp{gdb_obj_variable}.
32034
32035 @subsubheading Example
32036 N.A.
32037 @end ignore
32038
32039
32040 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
32041 @node GDB/MI File Commands
32042 @section @sc{gdb/mi} File Commands
32043
32044 This section describes the GDB/MI commands to specify executable file names
32045 and to read in and obtain symbol table information.
32046
32047 @subheading The @code{-file-exec-and-symbols} Command
32048 @findex -file-exec-and-symbols
32049
32050 @subsubheading Synopsis
32051
32052 @smallexample
32053  -file-exec-and-symbols @var{file}
32054 @end smallexample
32055
32056 Specify the executable file to be debugged.  This file is the one from
32057 which the symbol table is also read.  If no file is specified, the
32058 command clears the executable and symbol information.  If breakpoints
32059 are set when using this command with no arguments, @value{GDBN} will produce
32060 error messages.  Otherwise, no output is produced, except a completion
32061 notification.
32062
32063 @subsubheading @value{GDBN} Command
32064
32065 The corresponding @value{GDBN} command is @samp{file}.
32066
32067 @subsubheading Example
32068
32069 @smallexample
32070 (gdb)
32071 -file-exec-and-symbols /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx
32072 ^done
32073 (gdb)
32074 @end smallexample
32075
32076
32077 @subheading The @code{-file-exec-file} Command
32078 @findex -file-exec-file
32079
32080 @subsubheading Synopsis
32081
32082 @smallexample
32083  -file-exec-file @var{file}
32084 @end smallexample
32085
32086 Specify the executable file to be debugged.  Unlike
32087 @samp{-file-exec-and-symbols}, the symbol table is @emph{not} read
32088 from this file.  If used without argument, @value{GDBN} clears the information
32089 about the executable file.  No output is produced, except a completion
32090 notification.
32091
32092 @subsubheading @value{GDBN} Command
32093
32094 The corresponding @value{GDBN} command is @samp{exec-file}.
32095
32096 @subsubheading Example
32097
32098 @smallexample
32099 (gdb)
32100 -file-exec-file /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx
32101 ^done
32102 (gdb)
32103 @end smallexample
32104
32105
32106 @ignore
32107 @subheading The @code{-file-list-exec-sections} Command
32108 @findex -file-list-exec-sections
32109
32110 @subsubheading Synopsis
32111
32112 @smallexample
32113  -file-list-exec-sections
32114 @end smallexample
32115
32116 List the sections of the current executable file.
32117
32118 @subsubheading @value{GDBN} Command
32119
32120 The @value{GDBN} command @samp{info file} shows, among the rest, the same
32121 information as this command.  @code{gdbtk} has a corresponding command
32122 @samp{gdb_load_info}.
32123
32124 @subsubheading Example
32125 N.A.
32126 @end ignore
32127
32128
32129 @subheading The @code{-file-list-exec-source-file} Command
32130 @findex -file-list-exec-source-file
32131
32132 @subsubheading Synopsis
32133
32134 @smallexample
32135  -file-list-exec-source-file
32136 @end smallexample
32137
32138 List the line number, the current source file, and the absolute path
32139 to the current source file for the current executable.  The macro
32140 information field has a value of @samp{1} or @samp{0} depending on
32141 whether or not the file includes preprocessor macro information.
32142
32143 @subsubheading @value{GDBN} Command
32144
32145 The @value{GDBN} equivalent is @samp{info source}
32146
32147 @subsubheading Example
32148
32149 @smallexample
32150 (gdb)
32151 123-file-list-exec-source-file
32152 123^done,line="1",file="foo.c",fullname="/home/bar/foo.c,macro-info="1"
32153 (gdb)
32154 @end smallexample
32155
32156
32157 @subheading The @code{-file-list-exec-source-files} Command
32158 @findex -file-list-exec-source-files
32159
32160 @subsubheading Synopsis
32161
32162 @smallexample
32163  -file-list-exec-source-files
32164 @end smallexample
32165
32166 List the source files for the current executable.
32167
32168 It will always output both the filename and fullname (absolute file
32169 name) of a source file.
32170
32171 @subsubheading @value{GDBN} Command
32172
32173 The @value{GDBN} equivalent is @samp{info sources}.
32174 @code{gdbtk} has an analogous command @samp{gdb_listfiles}.
32175
32176 @subsubheading Example
32177 @smallexample
32178 (gdb)
32179 -file-list-exec-source-files
32180 ^done,files=[
32181 @{file=foo.c,fullname=/home/foo.c@},
32182 @{file=/home/bar.c,fullname=/home/bar.c@},
32183 @{file=gdb_could_not_find_fullpath.c@}]
32184 (gdb)
32185 @end smallexample
32186
32187 @subheading The @code{-file-list-shared-libraries} Command
32188 @findex -file-list-shared-libraries
32189
32190 @subsubheading Synopsis
32191
32192 @smallexample
32193  -file-list-shared-libraries [ @var{regexp} ]
32194 @end smallexample
32195
32196 List the shared libraries in the program.
32197 With a regular expression @var{regexp}, only those libraries whose
32198 names match @var{regexp} are listed.
32199
32200 @subsubheading @value{GDBN} Command
32201
32202 The corresponding @value{GDBN} command is @samp{info shared}.  The fields
32203 have a similar meaning to the @code{=library-loaded} notification.
32204 The @code{ranges} field specifies the multiple segments belonging to this
32205 library.  Each range has the following fields:
32206
32207 @table @samp
32208 @item from
32209 The address defining the inclusive lower bound of the segment.
32210 @item to
32211 The address defining the exclusive upper bound of the segment.
32212 @end table
32213
32214 @subsubheading Example
32215 @smallexample
32216 (gdb)
32217 -file-list-exec-source-files
32218 ^done,shared-libraries=[
32219 @{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"@}]@},
32220 @{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"@}]@}]
32221 (gdb)
32222 @end smallexample
32223
32224
32225 @ignore
32226 @subheading The @code{-file-list-symbol-files} Command
32227 @findex -file-list-symbol-files
32228
32229 @subsubheading Synopsis
32230
32231 @smallexample
32232  -file-list-symbol-files
32233 @end smallexample
32234
32235 List symbol files.
32236
32237 @subsubheading @value{GDBN} Command
32238
32239 The corresponding @value{GDBN} command is @samp{info file} (part of it).
32240
32241 @subsubheading Example
32242 N.A.
32243 @end ignore
32244
32245
32246 @subheading The @code{-file-symbol-file} Command
32247 @findex -file-symbol-file
32248
32249 @subsubheading Synopsis
32250
32251 @smallexample
32252  -file-symbol-file @var{file}
32253 @end smallexample
32254
32255 Read symbol table info from the specified @var{file} argument.  When
32256 used without arguments, clears @value{GDBN}'s symbol table info.  No output is
32257 produced, except for a completion notification.
32258
32259 @subsubheading @value{GDBN} Command
32260
32261 The corresponding @value{GDBN} command is @samp{symbol-file}.
32262
32263 @subsubheading Example
32264
32265 @smallexample
32266 (gdb)
32267 -file-symbol-file /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx
32268 ^done
32269 (gdb)
32270 @end smallexample
32271
32272 @ignore
32273 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
32274 @node GDB/MI Memory Overlay Commands
32275 @section @sc{gdb/mi} Memory Overlay Commands
32276
32277 The memory overlay commands are not implemented.
32278
32279 @c @subheading -overlay-auto
32280
32281 @c @subheading -overlay-list-mapping-state
32282
32283 @c @subheading -overlay-list-overlays
32284
32285 @c @subheading -overlay-map
32286
32287 @c @subheading -overlay-off
32288
32289 @c @subheading -overlay-on
32290
32291 @c @subheading -overlay-unmap
32292
32293 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
32294 @node GDB/MI Signal Handling Commands
32295 @section @sc{gdb/mi} Signal Handling Commands
32296
32297 Signal handling commands are not implemented.
32298
32299 @c @subheading -signal-handle
32300
32301 @c @subheading -signal-list-handle-actions
32302
32303 @c @subheading -signal-list-signal-types
32304 @end ignore
32305
32306
32307 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
32308 @node GDB/MI Target Manipulation
32309 @section @sc{gdb/mi} Target Manipulation Commands
32310
32311
32312 @subheading The @code{-target-attach} Command
32313 @findex -target-attach
32314
32315 @subsubheading Synopsis
32316
32317 @smallexample
32318  -target-attach @var{pid} | @var{gid} | @var{file}
32319 @end smallexample
32320
32321 Attach to a process @var{pid} or a file @var{file} outside of
32322 @value{GDBN}, or a thread group @var{gid}.  If attaching to a thread
32323 group, the id previously returned by 
32324 @samp{-list-thread-groups --available} must be used.
32325
32326 @subsubheading @value{GDBN} Command
32327
32328 The corresponding @value{GDBN} command is @samp{attach}.
32329
32330 @subsubheading Example
32331 @smallexample
32332 (gdb)
32333 -target-attach 34
32334 =thread-created,id="1"
32335 *stopped,thread-id="1",frame=@{addr="0xb7f7e410",func="bar",args=[]@}
32336 ^done
32337 (gdb)
32338 @end smallexample
32339
32340 @ignore
32341 @subheading The @code{-target-compare-sections} Command
32342 @findex -target-compare-sections
32343
32344 @subsubheading Synopsis
32345
32346 @smallexample
32347  -target-compare-sections [ @var{section} ]
32348 @end smallexample
32349
32350 Compare data of section @var{section} on target to the exec file.
32351 Without the argument, all sections are compared.
32352
32353 @subsubheading @value{GDBN} Command
32354
32355 The @value{GDBN} equivalent is @samp{compare-sections}.
32356
32357 @subsubheading Example
32358 N.A.
32359 @end ignore
32360
32361
32362 @subheading The @code{-target-detach} Command
32363 @findex -target-detach
32364
32365 @subsubheading Synopsis
32366
32367 @smallexample
32368  -target-detach [ @var{pid} | @var{gid} ]
32369 @end smallexample
32370
32371 Detach from the remote target which normally resumes its execution.
32372 If either @var{pid} or @var{gid} is specified, detaches from either
32373 the specified process, or specified thread group.  There's no output.
32374
32375 @subsubheading @value{GDBN} Command
32376
32377 The corresponding @value{GDBN} command is @samp{detach}.
32378
32379 @subsubheading Example
32380
32381 @smallexample
32382 (gdb)
32383 -target-detach
32384 ^done
32385 (gdb)
32386 @end smallexample
32387
32388
32389 @subheading The @code{-target-disconnect} Command
32390 @findex -target-disconnect
32391
32392 @subsubheading Synopsis
32393
32394 @smallexample
32395  -target-disconnect
32396 @end smallexample
32397
32398 Disconnect from the remote target.  There's no output and the target is
32399 generally not resumed.
32400
32401 @subsubheading @value{GDBN} Command
32402
32403 The corresponding @value{GDBN} command is @samp{disconnect}.
32404
32405 @subsubheading Example
32406
32407 @smallexample
32408 (gdb)
32409 -target-disconnect
32410 ^done
32411 (gdb)
32412 @end smallexample
32413
32414
32415 @subheading The @code{-target-download} Command
32416 @findex -target-download
32417
32418 @subsubheading Synopsis
32419
32420 @smallexample
32421  -target-download
32422 @end smallexample
32423
32424 Loads the executable onto the remote target.
32425 It prints out an update message every half second, which includes the fields:
32426
32427 @table @samp
32428 @item section
32429 The name of the section.
32430 @item section-sent
32431 The size of what has been sent so far for that section.
32432 @item section-size
32433 The size of the section.
32434 @item total-sent
32435 The total size of what was sent so far (the current and the previous sections).
32436 @item total-size
32437 The size of the overall executable to download.
32438 @end table
32439
32440 @noindent
32441 Each message is sent as status record (@pxref{GDB/MI Output Syntax, ,
32442 @sc{gdb/mi} Output Syntax}).
32443
32444 In addition, it prints the name and size of the sections, as they are
32445 downloaded.  These messages include the following fields:
32446
32447 @table @samp
32448 @item section
32449 The name of the section.
32450 @item section-size
32451 The size of the section.
32452 @item total-size
32453 The size of the overall executable to download.
32454 @end table
32455
32456 @noindent
32457 At the end, a summary is printed.
32458
32459 @subsubheading @value{GDBN} Command
32460
32461 The corresponding @value{GDBN} command is @samp{load}.
32462
32463 @subsubheading Example
32464
32465 Note: each status message appears on a single line.  Here the messages
32466 have been broken down so that they can fit onto a page.
32467
32468 @smallexample
32469 (gdb)
32470 -target-download
32471 +download,@{section=".text",section-size="6668",total-size="9880"@}
32472 +download,@{section=".text",section-sent="512",section-size="6668",
32473 total-sent="512",total-size="9880"@}
32474 +download,@{section=".text",section-sent="1024",section-size="6668",
32475 total-sent="1024",total-size="9880"@}
32476 +download,@{section=".text",section-sent="1536",section-size="6668",
32477 total-sent="1536",total-size="9880"@}
32478 +download,@{section=".text",section-sent="2048",section-size="6668",
32479 total-sent="2048",total-size="9880"@}
32480 +download,@{section=".text",section-sent="2560",section-size="6668",
32481 total-sent="2560",total-size="9880"@}
32482 +download,@{section=".text",section-sent="3072",section-size="6668",
32483 total-sent="3072",total-size="9880"@}
32484 +download,@{section=".text",section-sent="3584",section-size="6668",
32485 total-sent="3584",total-size="9880"@}
32486 +download,@{section=".text",section-sent="4096",section-size="6668",
32487 total-sent="4096",total-size="9880"@}
32488 +download,@{section=".text",section-sent="4608",section-size="6668",
32489 total-sent="4608",total-size="9880"@}
32490 +download,@{section=".text",section-sent="5120",section-size="6668",
32491 total-sent="5120",total-size="9880"@}
32492 +download,@{section=".text",section-sent="5632",section-size="6668",
32493 total-sent="5632",total-size="9880"@}
32494 +download,@{section=".text",section-sent="6144",section-size="6668",
32495 total-sent="6144",total-size="9880"@}
32496 +download,@{section=".text",section-sent="6656",section-size="6668",
32497 total-sent="6656",total-size="9880"@}
32498 +download,@{section=".init",section-size="28",total-size="9880"@}
32499 +download,@{section=".fini",section-size="28",total-size="9880"@}
32500 +download,@{section=".data",section-size="3156",total-size="9880"@}
32501 +download,@{section=".data",section-sent="512",section-size="3156",
32502 total-sent="7236",total-size="9880"@}
32503 +download,@{section=".data",section-sent="1024",section-size="3156",
32504 total-sent="7748",total-size="9880"@}
32505 +download,@{section=".data",section-sent="1536",section-size="3156",
32506 total-sent="8260",total-size="9880"@}
32507 +download,@{section=".data",section-sent="2048",section-size="3156",
32508 total-sent="8772",total-size="9880"@}
32509 +download,@{section=".data",section-sent="2560",section-size="3156",
32510 total-sent="9284",total-size="9880"@}
32511 +download,@{section=".data",section-sent="3072",section-size="3156",
32512 total-sent="9796",total-size="9880"@}
32513 ^done,address="0x10004",load-size="9880",transfer-rate="6586",
32514 write-rate="429"
32515 (gdb)
32516 @end smallexample
32517
32518
32519 @ignore
32520 @subheading The @code{-target-exec-status} Command
32521 @findex -target-exec-status
32522
32523 @subsubheading Synopsis
32524
32525 @smallexample
32526  -target-exec-status
32527 @end smallexample
32528
32529 Provide information on the state of the target (whether it is running or
32530 not, for instance).
32531
32532 @subsubheading @value{GDBN} Command
32533
32534 There's no equivalent @value{GDBN} command.
32535
32536 @subsubheading Example
32537 N.A.
32538
32539
32540 @subheading The @code{-target-list-available-targets} Command
32541 @findex -target-list-available-targets
32542
32543 @subsubheading Synopsis
32544
32545 @smallexample
32546  -target-list-available-targets
32547 @end smallexample
32548
32549 List the possible targets to connect to.
32550
32551 @subsubheading @value{GDBN} Command
32552
32553 The corresponding @value{GDBN} command is @samp{help target}.
32554
32555 @subsubheading Example
32556 N.A.
32557
32558
32559 @subheading The @code{-target-list-current-targets} Command
32560 @findex -target-list-current-targets
32561
32562 @subsubheading Synopsis
32563
32564 @smallexample
32565  -target-list-current-targets
32566 @end smallexample
32567
32568 Describe the current target.
32569
32570 @subsubheading @value{GDBN} Command
32571
32572 The corresponding information is printed by @samp{info file} (among
32573 other things).
32574
32575 @subsubheading Example
32576 N.A.
32577
32578
32579 @subheading The @code{-target-list-parameters} Command
32580 @findex -target-list-parameters
32581
32582 @subsubheading Synopsis
32583
32584 @smallexample
32585  -target-list-parameters
32586 @end smallexample
32587
32588 @c ????
32589 @end ignore
32590
32591 @subsubheading @value{GDBN} Command
32592
32593 No equivalent.
32594
32595 @subsubheading Example
32596 N.A.
32597
32598 @subheading The @code{-target-flash-erase} Command
32599 @findex -target-flash-erase
32600
32601 @subsubheading Synopsis
32602
32603 @smallexample
32604  -target-flash-erase
32605 @end smallexample
32606
32607 Erases all known flash memory regions on the target.
32608
32609 The corresponding @value{GDBN} command is @samp{flash-erase}.
32610
32611 The output is a list of flash regions that have been erased, with starting
32612 addresses and memory region sizes.
32613
32614 @smallexample
32615 (gdb)
32616 -target-flash-erase
32617 ^done,erased-regions=@{address="0x0",size="0x40000"@}
32618 (gdb)
32619 @end smallexample
32620
32621 @subheading The @code{-target-select} Command
32622 @findex -target-select
32623
32624 @subsubheading Synopsis
32625
32626 @smallexample
32627  -target-select @var{type} @var{parameters @dots{}}
32628 @end smallexample
32629
32630 Connect @value{GDBN} to the remote target.  This command takes two args:
32631
32632 @table @samp
32633 @item @var{type}
32634 The type of target, for instance @samp{remote}, etc.
32635 @item @var{parameters}
32636 Device names, host names and the like.  @xref{Target Commands, ,
32637 Commands for Managing Targets}, for more details.
32638 @end table
32639
32640 The output is a connection notification, followed by the address at
32641 which the target program is, in the following form:
32642
32643 @smallexample
32644 ^connected,addr="@var{address}",func="@var{function name}",
32645   args=[@var{arg list}]
32646 @end smallexample
32647
32648 @subsubheading @value{GDBN} Command
32649
32650 The corresponding @value{GDBN} command is @samp{target}.
32651
32652 @subsubheading Example
32653
32654 @smallexample
32655 (gdb)
32656 -target-select remote /dev/ttya
32657 ^connected,addr="0xfe00a300",func="??",args=[]
32658 (gdb)
32659 @end smallexample
32660
32661 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
32662 @node GDB/MI File Transfer Commands
32663 @section @sc{gdb/mi} File Transfer Commands
32664
32665
32666 @subheading The @code{-target-file-put} Command
32667 @findex -target-file-put
32668
32669 @subsubheading Synopsis
32670
32671 @smallexample
32672  -target-file-put @var{hostfile} @var{targetfile}
32673 @end smallexample
32674
32675 Copy file @var{hostfile} from the host system (the machine running
32676 @value{GDBN}) to @var{targetfile} on the target system.
32677
32678 @subsubheading @value{GDBN} Command
32679
32680 The corresponding @value{GDBN} command is @samp{remote put}.
32681
32682 @subsubheading Example
32683
32684 @smallexample
32685 (gdb)
32686 -target-file-put localfile remotefile
32687 ^done
32688 (gdb)
32689 @end smallexample
32690
32691
32692 @subheading The @code{-target-file-get} Command
32693 @findex -target-file-get
32694
32695 @subsubheading Synopsis
32696
32697 @smallexample
32698  -target-file-get @var{targetfile} @var{hostfile}
32699 @end smallexample
32700
32701 Copy file @var{targetfile} from the target system to @var{hostfile}
32702 on the host system.
32703
32704 @subsubheading @value{GDBN} Command
32705
32706 The corresponding @value{GDBN} command is @samp{remote get}.
32707
32708 @subsubheading Example
32709
32710 @smallexample
32711 (gdb)
32712 -target-file-get remotefile localfile
32713 ^done
32714 (gdb)
32715 @end smallexample
32716
32717
32718 @subheading The @code{-target-file-delete} Command
32719 @findex -target-file-delete
32720
32721 @subsubheading Synopsis
32722
32723 @smallexample
32724  -target-file-delete @var{targetfile}
32725 @end smallexample
32726
32727 Delete @var{targetfile} from the target system.
32728
32729 @subsubheading @value{GDBN} Command
32730
32731 The corresponding @value{GDBN} command is @samp{remote delete}.
32732
32733 @subsubheading Example
32734
32735 @smallexample
32736 (gdb)
32737 -target-file-delete remotefile
32738 ^done
32739 (gdb)
32740 @end smallexample
32741
32742
32743 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
32744 @node GDB/MI Ada Exceptions Commands
32745 @section Ada Exceptions @sc{gdb/mi} Commands
32746
32747 @subheading The @code{-info-ada-exceptions} Command
32748 @findex -info-ada-exceptions
32749
32750 @subsubheading Synopsis
32751
32752 @smallexample
32753  -info-ada-exceptions [ @var{regexp}]
32754 @end smallexample
32755
32756 List all Ada exceptions defined within the program being debugged.
32757 With a regular expression @var{regexp}, only those exceptions whose
32758 names match @var{regexp} are listed.
32759
32760 @subsubheading @value{GDBN} Command
32761
32762 The corresponding @value{GDBN} command is @samp{info exceptions}.
32763
32764 @subsubheading Result
32765
32766 The result is a table of Ada exceptions.  The following columns are
32767 defined for each exception:
32768
32769 @table @samp
32770 @item name
32771 The name of the exception.
32772
32773 @item address
32774 The address of the exception.
32775
32776 @end table
32777
32778 @subsubheading Example
32779
32780 @smallexample
32781 -info-ada-exceptions aint
32782 ^done,ada-exceptions=@{nr_rows="2",nr_cols="2",
32783 hdr=[@{width="1",alignment="-1",col_name="name",colhdr="Name"@},
32784 @{width="1",alignment="-1",col_name="address",colhdr="Address"@}],
32785 body=[@{name="constraint_error",address="0x0000000000613da0"@},
32786 @{name="const.aint_global_e",address="0x0000000000613b00"@}]@}
32787 @end smallexample
32788
32789 @subheading Catching Ada Exceptions
32790
32791 The commands describing how to ask @value{GDBN} to stop when a program
32792 raises an exception are described at @ref{Ada Exception GDB/MI
32793 Catchpoint Commands}.
32794
32795
32796 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
32797 @node GDB/MI Support Commands
32798 @section @sc{gdb/mi} Support Commands
32799
32800 Since new commands and features get regularly added to @sc{gdb/mi},
32801 some commands are available to help front-ends query the debugger
32802 about support for these capabilities.  Similarly, it is also possible
32803 to query @value{GDBN} about target support of certain features.
32804
32805 @subheading The @code{-info-gdb-mi-command} Command
32806 @cindex @code{-info-gdb-mi-command}
32807 @findex -info-gdb-mi-command
32808
32809 @subsubheading Synopsis
32810
32811 @smallexample
32812  -info-gdb-mi-command @var{cmd_name}
32813 @end smallexample
32814
32815 Query support for the @sc{gdb/mi} command named @var{cmd_name}.
32816
32817 Note that the dash (@code{-}) starting all @sc{gdb/mi} commands
32818 is technically not part of the command name (@pxref{GDB/MI Input
32819 Syntax}), and thus should be omitted in @var{cmd_name}.  However,
32820 for ease of use, this command also accepts the form with the leading
32821 dash.
32822
32823 @subsubheading @value{GDBN} Command
32824
32825 There is no corresponding @value{GDBN} command.
32826
32827 @subsubheading Result
32828
32829 The result is a tuple.  There is currently only one field:
32830
32831 @table @samp
32832 @item exists
32833 This field is equal to @code{"true"} if the @sc{gdb/mi} command exists,
32834 @code{"false"} otherwise.
32835
32836 @end table
32837
32838 @subsubheading Example
32839
32840 Here is an example where the @sc{gdb/mi} command does not exist:
32841
32842 @smallexample
32843 -info-gdb-mi-command unsupported-command
32844 ^done,command=@{exists="false"@}
32845 @end smallexample
32846
32847 @noindent
32848 And here is an example where the @sc{gdb/mi} command is known
32849 to the debugger:
32850
32851 @smallexample
32852 -info-gdb-mi-command symbol-list-lines
32853 ^done,command=@{exists="true"@}
32854 @end smallexample
32855
32856 @subheading The @code{-list-features} Command
32857 @findex -list-features
32858 @cindex supported @sc{gdb/mi} features, list
32859
32860 Returns a list of particular features of the MI protocol that
32861 this version of gdb implements.  A feature can be a command,
32862 or a new field in an output of some command, or even an
32863 important bugfix.  While a frontend can sometimes detect presence
32864 of a feature at runtime, it is easier to perform detection at debugger
32865 startup.
32866
32867 The command returns a list of strings, with each string naming an
32868 available feature.  Each returned string is just a name, it does not
32869 have any internal structure.  The list of possible feature names
32870 is given below.
32871
32872 Example output:
32873
32874 @smallexample
32875 (gdb) -list-features
32876 ^done,result=["feature1","feature2"]
32877 @end smallexample
32878
32879 The current list of features is:
32880
32881 @ftable @samp
32882 @item frozen-varobjs
32883 Indicates support for the @code{-var-set-frozen} command, as well
32884 as possible presense of the @code{frozen} field in the output
32885 of @code{-varobj-create}.
32886 @item pending-breakpoints
32887 Indicates support for the @option{-f} option to the @code{-break-insert}
32888 command.
32889 @item python
32890 Indicates Python scripting support, Python-based
32891 pretty-printing commands, and possible presence of the
32892 @samp{display_hint} field in the output of @code{-var-list-children}
32893 @item thread-info
32894 Indicates support for the @code{-thread-info} command.
32895 @item data-read-memory-bytes
32896 Indicates support for the @code{-data-read-memory-bytes} and the
32897 @code{-data-write-memory-bytes} commands.
32898 @item breakpoint-notifications
32899 Indicates that changes to breakpoints and breakpoints created via the
32900 CLI will be announced via async records.
32901 @item ada-task-info
32902 Indicates support for the @code{-ada-task-info} command.
32903 @item language-option
32904 Indicates that all @sc{gdb/mi} commands accept the @option{--language}
32905 option (@pxref{Context management}).
32906 @item info-gdb-mi-command
32907 Indicates support for the @code{-info-gdb-mi-command} command.
32908 @item undefined-command-error-code
32909 Indicates support for the "undefined-command" error code in error result
32910 records, produced when trying to execute an undefined @sc{gdb/mi} command
32911 (@pxref{GDB/MI Result Records}).
32912 @item exec-run-start-option
32913 Indicates that the @code{-exec-run} command supports the @option{--start}
32914 option (@pxref{GDB/MI Program Execution}).
32915 @end ftable
32916
32917 @subheading The @code{-list-target-features} Command
32918 @findex -list-target-features
32919
32920 Returns a list of particular features that are supported by the
32921 target.  Those features affect the permitted MI commands, but 
32922 unlike the features reported by the @code{-list-features} command, the
32923 features depend on which target GDB is using at the moment.  Whenever
32924 a target can change, due to commands such as @code{-target-select},
32925 @code{-target-attach} or @code{-exec-run}, the list of target features
32926 may change, and the frontend should obtain it again.
32927 Example output:
32928
32929 @smallexample
32930 (gdb) -list-target-features
32931 ^done,result=["async"]
32932 @end smallexample
32933
32934 The current list of features is:
32935
32936 @table @samp
32937 @item async
32938 Indicates that the target is capable of asynchronous command
32939 execution, which means that @value{GDBN} will accept further commands
32940 while the target is running.
32941
32942 @item reverse
32943 Indicates that the target is capable of reverse execution.
32944 @xref{Reverse Execution}, for more information.
32945
32946 @end table
32947
32948 @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
32949 @node GDB/MI Miscellaneous Commands
32950 @section Miscellaneous @sc{gdb/mi} Commands
32951
32952 @c @subheading -gdb-complete
32953
32954 @subheading The @code{-gdb-exit} Command
32955 @findex -gdb-exit
32956
32957 @subsubheading Synopsis
32958
32959 @smallexample
32960  -gdb-exit
32961 @end smallexample
32962
32963 Exit @value{GDBN} immediately.
32964
32965 @subsubheading @value{GDBN} Command
32966
32967 Approximately corresponds to @samp{quit}.
32968
32969 @subsubheading Example
32970
32971 @smallexample
32972 (gdb)
32973 -gdb-exit
32974 ^exit
32975 @end smallexample
32976
32977
32978 @ignore
32979 @subheading The @code{-exec-abort} Command
32980 @findex -exec-abort
32981
32982 @subsubheading Synopsis
32983
32984 @smallexample
32985  -exec-abort
32986 @end smallexample
32987
32988 Kill the inferior running program.
32989
32990 @subsubheading @value{GDBN} Command
32991
32992 The corresponding @value{GDBN} command is @samp{kill}.
32993
32994 @subsubheading Example
32995 N.A.
32996 @end ignore
32997
32998
32999 @subheading The @code{-gdb-set} Command
33000 @findex -gdb-set
33001
33002 @subsubheading Synopsis
33003
33004 @smallexample
33005  -gdb-set
33006 @end smallexample
33007
33008 Set an internal @value{GDBN} variable.
33009 @c IS THIS A DOLLAR VARIABLE? OR SOMETHING LIKE ANNOTATE ?????
33010
33011 @subsubheading @value{GDBN} Command
33012
33013 The corresponding @value{GDBN} command is @samp{set}.
33014
33015 @subsubheading Example
33016
33017 @smallexample
33018 (gdb)
33019 -gdb-set $foo=3
33020 ^done
33021 (gdb)
33022 @end smallexample
33023
33024
33025 @subheading The @code{-gdb-show} Command
33026 @findex -gdb-show
33027
33028 @subsubheading Synopsis
33029
33030 @smallexample
33031  -gdb-show
33032 @end smallexample
33033
33034 Show the current value of a @value{GDBN} variable.
33035
33036 @subsubheading @value{GDBN} Command
33037
33038 The corresponding @value{GDBN} command is @samp{show}.
33039
33040 @subsubheading Example
33041
33042 @smallexample
33043 (gdb)
33044 -gdb-show annotate
33045 ^done,value="0"
33046 (gdb)
33047 @end smallexample
33048
33049 @c @subheading -gdb-source
33050
33051
33052 @subheading The @code{-gdb-version} Command
33053 @findex -gdb-version
33054
33055 @subsubheading Synopsis
33056
33057 @smallexample
33058  -gdb-version
33059 @end smallexample
33060
33061 Show version information for @value{GDBN}.  Used mostly in testing.
33062
33063 @subsubheading @value{GDBN} Command
33064
33065 The @value{GDBN} equivalent is @samp{show version}.  @value{GDBN} by
33066 default shows this information when you start an interactive session.
33067
33068 @subsubheading Example
33069
33070 @c This example modifies the actual output from GDB to avoid overfull
33071 @c box in TeX.
33072 @smallexample
33073 (gdb)
33074 -gdb-version
33075 ~GNU gdb 5.2.1
33076 ~Copyright 2000 Free Software Foundation, Inc.
33077 ~GDB is free software, covered by the GNU General Public License, and
33078 ~you are welcome to change it and/or distribute copies of it under
33079 ~ certain conditions.
33080 ~Type "show copying" to see the conditions.
33081 ~There is absolutely no warranty for GDB.  Type "show warranty" for
33082 ~ details.
33083 ~This GDB was configured as
33084  "--host=sparc-sun-solaris2.5.1 --target=ppc-eabi".
33085 ^done
33086 (gdb)
33087 @end smallexample
33088
33089 @subheading The @code{-list-thread-groups} Command
33090 @findex -list-thread-groups
33091
33092 @subheading Synopsis
33093
33094 @smallexample
33095 -list-thread-groups [ --available ] [ --recurse 1 ] [ @var{group} ... ]
33096 @end smallexample
33097
33098 Lists thread groups (@pxref{Thread groups}).  When a single thread
33099 group is passed as the argument, lists the children of that group.
33100 When several thread group are passed, lists information about those
33101 thread groups.  Without any parameters, lists information about all
33102 top-level thread groups.
33103
33104 Normally, thread groups that are being debugged are reported.
33105 With the @samp{--available} option, @value{GDBN} reports thread groups
33106 available on the target.
33107
33108 The output of this command may have either a @samp{threads} result or
33109 a @samp{groups} result.  The @samp{thread} result has a list of tuples
33110 as value, with each tuple describing a thread (@pxref{GDB/MI Thread
33111 Information}).  The @samp{groups} result has a list of tuples as value,
33112 each tuple describing a thread group.  If top-level groups are
33113 requested (that is, no parameter is passed), or when several groups
33114 are passed, the output always has a @samp{groups} result.  The format
33115 of the @samp{group} result is described below.
33116
33117 To reduce the number of roundtrips it's possible to list thread groups
33118 together with their children, by passing the @samp{--recurse} option
33119 and the recursion depth.  Presently, only recursion depth of 1 is
33120 permitted.  If this option is present, then every reported thread group
33121 will also include its children, either as @samp{group} or
33122 @samp{threads} field.
33123
33124 In general, any combination of option and parameters is permitted, with
33125 the following caveats:
33126
33127 @itemize @bullet
33128 @item
33129 When a single thread group is passed, the output will typically
33130 be the @samp{threads} result.  Because threads may not contain
33131 anything, the @samp{recurse} option will be ignored.
33132
33133 @item
33134 When the @samp{--available} option is passed, limited information may
33135 be available.  In particular, the list of threads of a process might
33136 be inaccessible.  Further, specifying specific thread groups might
33137 not give any performance advantage over listing all thread groups.
33138 The frontend should assume that @samp{-list-thread-groups --available}
33139 is always an expensive operation and cache the results.
33140
33141 @end itemize
33142
33143 The @samp{groups} result is a list of tuples, where each tuple may
33144 have the following fields:
33145
33146 @table @code
33147 @item id
33148 Identifier of the thread group.  This field is always present.
33149 The identifier is an opaque string; frontends should not try to
33150 convert it to an integer, even though it might look like one.
33151
33152 @item type
33153 The type of the thread group.  At present, only @samp{process} is a
33154 valid type.
33155
33156 @item pid
33157 The target-specific process identifier.  This field is only present
33158 for thread groups of type @samp{process} and only if the process exists.
33159
33160 @item exit-code
33161 The exit code of this group's last exited thread, formatted in octal.
33162 This field is only present for thread groups of type @samp{process} and
33163 only if the process is not running.
33164
33165 @item num_children
33166 The number of children this thread group has.  This field may be
33167 absent for an available thread group.
33168
33169 @item threads
33170 This field has a list of tuples as value, each tuple describing a
33171 thread.  It may be present if the @samp{--recurse} option is
33172 specified, and it's actually possible to obtain the threads.
33173
33174 @item cores
33175 This field is a list of integers, each identifying a core that one
33176 thread of the group is running on.  This field may be absent if
33177 such information is not available.
33178
33179 @item executable
33180 The name of the executable file that corresponds to this thread group.
33181 The field is only present for thread groups of type @samp{process},
33182 and only if there is a corresponding executable file.
33183
33184 @end table
33185
33186 @subheading Example
33187
33188 @smallexample
33189 @value{GDBP}
33190 -list-thread-groups
33191 ^done,groups=[@{id="17",type="process",pid="yyy",num_children="2"@}]
33192 -list-thread-groups 17
33193 ^done,threads=[@{id="2",target-id="Thread 0xb7e14b90 (LWP 21257)",
33194    frame=@{level="0",addr="0xffffe410",func="__kernel_vsyscall",args=[]@},state="running"@},
33195 @{id="1",target-id="Thread 0xb7e156b0 (LWP 21254)",
33196    frame=@{level="0",addr="0x0804891f",func="foo",args=[@{name="i",value="10"@}],
33197            file="/tmp/a.c",fullname="/tmp/a.c",line="158"@},state="running"@}]]
33198 -list-thread-groups --available
33199 ^done,groups=[@{id="17",type="process",pid="yyy",num_children="2",cores=[1,2]@}]
33200 -list-thread-groups --available --recurse 1
33201  ^done,groups=[@{id="17", types="process",pid="yyy",num_children="2",cores=[1,2],
33202                 threads=[@{id="1",target-id="Thread 0xb7e14b90",cores=[1]@},
33203                          @{id="2",target-id="Thread 0xb7e14b90",cores=[2]@}]@},..]
33204 -list-thread-groups --available --recurse 1 17 18
33205 ^done,groups=[@{id="17", types="process",pid="yyy",num_children="2",cores=[1,2],
33206                threads=[@{id="1",target-id="Thread 0xb7e14b90",cores=[1]@},
33207                         @{id="2",target-id="Thread 0xb7e14b90",cores=[2]@}]@},...]
33208 @end smallexample
33209
33210 @subheading The @code{-info-os} Command
33211 @findex -info-os
33212
33213 @subsubheading Synopsis
33214
33215 @smallexample
33216 -info-os [ @var{type} ]
33217 @end smallexample
33218
33219 If no argument is supplied, the command returns a table of available
33220 operating-system-specific information types.  If one of these types is
33221 supplied as an argument @var{type}, then the command returns a table
33222 of data of that type.
33223
33224 The types of information available depend on the target operating
33225 system.
33226
33227 @subsubheading @value{GDBN} Command
33228
33229 The corresponding @value{GDBN} command is @samp{info os}.
33230
33231 @subsubheading Example
33232
33233 When run on a @sc{gnu}/Linux system, the output will look something
33234 like this:
33235
33236 @smallexample
33237 @value{GDBP}
33238 -info-os
33239 ^done,OSDataTable=@{nr_rows="10",nr_cols="3",
33240 hdr=[@{width="10",alignment="-1",col_name="col0",colhdr="Type"@},
33241      @{width="10",alignment="-1",col_name="col1",colhdr="Description"@},
33242      @{width="10",alignment="-1",col_name="col2",colhdr="Title"@}],
33243 body=[item=@{col0="cpus",col1="Listing of all cpus/cores on the system",
33244             col2="CPUs"@},
33245       item=@{col0="files",col1="Listing of all file descriptors",
33246             col2="File descriptors"@},
33247       item=@{col0="modules",col1="Listing of all loaded kernel modules",
33248             col2="Kernel modules"@},
33249       item=@{col0="msg",col1="Listing of all message queues",
33250             col2="Message queues"@},
33251       item=@{col0="processes",col1="Listing of all processes",
33252             col2="Processes"@},
33253       item=@{col0="procgroups",col1="Listing of all process groups",
33254             col2="Process groups"@},
33255       item=@{col0="semaphores",col1="Listing of all semaphores",
33256             col2="Semaphores"@},
33257       item=@{col0="shm",col1="Listing of all shared-memory regions",
33258             col2="Shared-memory regions"@},
33259       item=@{col0="sockets",col1="Listing of all internet-domain sockets",
33260             col2="Sockets"@},
33261       item=@{col0="threads",col1="Listing of all threads",
33262             col2="Threads"@}]
33263 @value{GDBP}
33264 -info-os processes
33265 ^done,OSDataTable=@{nr_rows="190",nr_cols="4",
33266 hdr=[@{width="10",alignment="-1",col_name="col0",colhdr="pid"@},
33267      @{width="10",alignment="-1",col_name="col1",colhdr="user"@},
33268      @{width="10",alignment="-1",col_name="col2",colhdr="command"@},
33269      @{width="10",alignment="-1",col_name="col3",colhdr="cores"@}],
33270 body=[item=@{col0="1",col1="root",col2="/sbin/init",col3="0"@},
33271       item=@{col0="2",col1="root",col2="[kthreadd]",col3="1"@},
33272       item=@{col0="3",col1="root",col2="[ksoftirqd/0]",col3="0"@},
33273       ...
33274       item=@{col0="26446",col1="stan",col2="bash",col3="0"@},
33275       item=@{col0="28152",col1="stan",col2="bash",col3="1"@}]@}
33276 (gdb)
33277 @end smallexample
33278
33279 (Note that the MI output here includes a @code{"Title"} column that
33280 does not appear in command-line @code{info os}; this column is useful
33281 for MI clients that want to enumerate the types of data, such as in a
33282 popup menu, but is needless clutter on the command line, and
33283 @code{info os} omits it.)
33284
33285 @subheading The @code{-add-inferior} Command
33286 @findex -add-inferior
33287
33288 @subheading Synopsis
33289
33290 @smallexample
33291 -add-inferior
33292 @end smallexample
33293
33294 Creates a new inferior (@pxref{Inferiors and Programs}).  The created
33295 inferior is not associated with any executable.  Such association may
33296 be established with the @samp{-file-exec-and-symbols} command
33297 (@pxref{GDB/MI File Commands}).  The command response has a single
33298 field, @samp{inferior}, whose value is the identifier of the
33299 thread group corresponding to the new inferior.
33300
33301 @subheading Example
33302
33303 @smallexample
33304 @value{GDBP}
33305 -add-inferior
33306 ^done,inferior="i3"
33307 @end smallexample
33308
33309 @subheading The @code{-interpreter-exec} Command
33310 @findex -interpreter-exec
33311
33312 @subheading Synopsis
33313
33314 @smallexample
33315 -interpreter-exec @var{interpreter} @var{command}
33316 @end smallexample
33317 @anchor{-interpreter-exec} 
33318
33319 Execute the specified @var{command} in the given @var{interpreter}.
33320
33321 @subheading @value{GDBN} Command
33322
33323 The corresponding @value{GDBN} command is @samp{interpreter-exec}.
33324
33325 @subheading Example
33326
33327 @smallexample
33328 (gdb)
33329 -interpreter-exec console "break main"
33330 &"During symbol reading, couldn't parse type; debugger out of date?.\n"
33331 &"During symbol reading, bad structure-type format.\n"
33332 ~"Breakpoint 1 at 0x8074fc6: file ../../src/gdb/main.c, line 743.\n"
33333 ^done
33334 (gdb)
33335 @end smallexample
33336
33337 @subheading The @code{-inferior-tty-set} Command
33338 @findex -inferior-tty-set
33339
33340 @subheading Synopsis
33341
33342 @smallexample
33343 -inferior-tty-set /dev/pts/1
33344 @end smallexample
33345
33346 Set terminal for future runs of the program being debugged.
33347
33348 @subheading @value{GDBN} Command
33349
33350 The corresponding @value{GDBN} command is @samp{set inferior-tty} /dev/pts/1.
33351
33352 @subheading Example
33353
33354 @smallexample
33355 (gdb)
33356 -inferior-tty-set /dev/pts/1
33357 ^done
33358 (gdb)
33359 @end smallexample
33360
33361 @subheading The @code{-inferior-tty-show} Command
33362 @findex -inferior-tty-show
33363
33364 @subheading Synopsis
33365
33366 @smallexample
33367 -inferior-tty-show
33368 @end smallexample
33369
33370 Show terminal for future runs of program being debugged.
33371
33372 @subheading @value{GDBN} Command
33373
33374 The corresponding @value{GDBN} command is @samp{show inferior-tty}.
33375
33376 @subheading Example
33377
33378 @smallexample
33379 (gdb)
33380 -inferior-tty-set /dev/pts/1
33381 ^done
33382 (gdb)
33383 -inferior-tty-show
33384 ^done,inferior_tty_terminal="/dev/pts/1"
33385 (gdb)
33386 @end smallexample
33387
33388 @subheading The @code{-enable-timings} Command
33389 @findex -enable-timings
33390
33391 @subheading Synopsis
33392
33393 @smallexample
33394 -enable-timings [yes | no]
33395 @end smallexample
33396
33397 Toggle the printing of the wallclock, user and system times for an MI
33398 command as a field in its output.  This command is to help frontend
33399 developers optimize the performance of their code.  No argument is
33400 equivalent to @samp{yes}.
33401
33402 @subheading @value{GDBN} Command
33403
33404 No equivalent.
33405
33406 @subheading Example
33407
33408 @smallexample
33409 (gdb)
33410 -enable-timings
33411 ^done
33412 (gdb)
33413 -break-insert main
33414 ^done,bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y",
33415 addr="0x080484ed",func="main",file="myprog.c",
33416 fullname="/home/nickrob/myprog.c",line="73",thread-groups=["i1"],
33417 times="0"@},
33418 time=@{wallclock="0.05185",user="0.00800",system="0.00000"@}
33419 (gdb)
33420 -enable-timings no
33421 ^done
33422 (gdb)
33423 -exec-run
33424 ^running
33425 (gdb)
33426 *stopped,reason="breakpoint-hit",disp="keep",bkptno="1",thread-id="0",
33427 frame=@{addr="0x080484ed",func="main",args=[@{name="argc",value="1"@},
33428 @{name="argv",value="0xbfb60364"@}],file="myprog.c",
33429 fullname="/home/nickrob/myprog.c",line="73"@}
33430 (gdb)
33431 @end smallexample
33432
33433 @node Annotations
33434 @chapter @value{GDBN} Annotations
33435
33436 This chapter describes annotations in @value{GDBN}.  Annotations were
33437 designed to interface @value{GDBN} to graphical user interfaces or other
33438 similar programs which want to interact with @value{GDBN} at a
33439 relatively high level.
33440
33441 The annotation mechanism has largely been superseded by @sc{gdb/mi}
33442 (@pxref{GDB/MI}).
33443
33444 @ignore
33445 This is Edition @value{EDITION}, @value{DATE}.
33446 @end ignore
33447
33448 @menu
33449 * Annotations Overview::  What annotations are; the general syntax.
33450 * Server Prefix::       Issuing a command without affecting user state.
33451 * Prompting::           Annotations marking @value{GDBN}'s need for input.
33452 * Errors::              Annotations for error messages.
33453 * Invalidation::        Some annotations describe things now invalid.
33454 * Annotations for Running::
33455                         Whether the program is running, how it stopped, etc.
33456 * Source Annotations::  Annotations describing source code.
33457 @end menu
33458
33459 @node Annotations Overview
33460 @section What is an Annotation?
33461 @cindex annotations
33462
33463 Annotations start with a newline character, two @samp{control-z}
33464 characters, and the name of the annotation.  If there is no additional
33465 information associated with this annotation, the name of the annotation
33466 is followed immediately by a newline.  If there is additional
33467 information, the name of the annotation is followed by a space, the
33468 additional information, and a newline.  The additional information
33469 cannot contain newline characters.
33470
33471 Any output not beginning with a newline and two @samp{control-z}
33472 characters denotes literal output from @value{GDBN}.  Currently there is
33473 no need for @value{GDBN} to output a newline followed by two
33474 @samp{control-z} characters, but if there was such a need, the
33475 annotations could be extended with an @samp{escape} annotation which
33476 means those three characters as output.
33477
33478 The annotation @var{level}, which is specified using the
33479 @option{--annotate} command line option (@pxref{Mode Options}), controls
33480 how much information @value{GDBN} prints together with its prompt,
33481 values of expressions, source lines, and other types of output.  Level 0
33482 is for no annotations, level 1 is for use when @value{GDBN} is run as a
33483 subprocess of @sc{gnu} Emacs, level 3 is the maximum annotation suitable
33484 for programs that control @value{GDBN}, and level 2 annotations have
33485 been made obsolete (@pxref{Limitations, , Limitations of the Annotation
33486 Interface, annotate, GDB's Obsolete Annotations}).
33487
33488 @table @code
33489 @kindex set annotate
33490 @item set annotate @var{level}
33491 The @value{GDBN} command @code{set annotate} sets the level of
33492 annotations to the specified @var{level}.
33493
33494 @item show annotate
33495 @kindex show annotate
33496 Show the current annotation level.
33497 @end table
33498
33499 This chapter describes level 3 annotations.
33500
33501 A simple example of starting up @value{GDBN} with annotations is:
33502
33503 @smallexample
33504 $ @kbd{gdb --annotate=3}
33505 GNU gdb 6.0
33506 Copyright 2003 Free Software Foundation, Inc.
33507 GDB is free software, covered by the GNU General Public License,
33508 and you are welcome to change it and/or distribute copies of it
33509 under certain conditions.
33510 Type "show copying" to see the conditions.
33511 There is absolutely no warranty for GDB.  Type "show warranty"
33512 for details.
33513 This GDB was configured as "i386-pc-linux-gnu"
33514
33515 ^Z^Zpre-prompt
33516 (@value{GDBP})
33517 ^Z^Zprompt
33518 @kbd{quit}
33519
33520 ^Z^Zpost-prompt
33521 $
33522 @end smallexample
33523
33524 Here @samp{quit} is input to @value{GDBN}; the rest is output from
33525 @value{GDBN}.  The three lines beginning @samp{^Z^Z} (where @samp{^Z}
33526 denotes a @samp{control-z} character) are annotations; the rest is
33527 output from @value{GDBN}.
33528
33529 @node Server Prefix
33530 @section The Server Prefix
33531 @cindex server prefix
33532
33533 If you prefix a command with @samp{server } then it will not affect
33534 the command history, nor will it affect @value{GDBN}'s notion of which
33535 command to repeat if @key{RET} is pressed on a line by itself.  This
33536 means that commands can be run behind a user's back by a front-end in
33537 a transparent manner.
33538
33539 The @code{server } prefix does not affect the recording of values into
33540 the value history; to print a value without recording it into the
33541 value history, use the @code{output} command instead of the
33542 @code{print} command.
33543
33544 Using this prefix also disables confirmation requests
33545 (@pxref{confirmation requests}).
33546
33547 @node Prompting
33548 @section Annotation for @value{GDBN} Input
33549
33550 @cindex annotations for prompts
33551 When @value{GDBN} prompts for input, it annotates this fact so it is possible
33552 to know when to send output, when the output from a given command is
33553 over, etc.
33554
33555 Different kinds of input each have a different @dfn{input type}.  Each
33556 input type has three annotations: a @code{pre-} annotation, which
33557 denotes the beginning of any prompt which is being output, a plain
33558 annotation, which denotes the end of the prompt, and then a @code{post-}
33559 annotation which denotes the end of any echo which may (or may not) be
33560 associated with the input.  For example, the @code{prompt} input type
33561 features the following annotations:
33562
33563 @smallexample
33564 ^Z^Zpre-prompt
33565 ^Z^Zprompt
33566 ^Z^Zpost-prompt
33567 @end smallexample
33568
33569 The input types are
33570
33571 @table @code
33572 @findex pre-prompt annotation
33573 @findex prompt annotation
33574 @findex post-prompt annotation
33575 @item prompt
33576 When @value{GDBN} is prompting for a command (the main @value{GDBN} prompt).
33577
33578 @findex pre-commands annotation
33579 @findex commands annotation
33580 @findex post-commands annotation
33581 @item commands
33582 When @value{GDBN} prompts for a set of commands, like in the @code{commands}
33583 command.  The annotations are repeated for each command which is input.
33584
33585 @findex pre-overload-choice annotation
33586 @findex overload-choice annotation
33587 @findex post-overload-choice annotation
33588 @item overload-choice
33589 When @value{GDBN} wants the user to select between various overloaded functions.
33590
33591 @findex pre-query annotation
33592 @findex query annotation
33593 @findex post-query annotation
33594 @item query
33595 When @value{GDBN} wants the user to confirm a potentially dangerous operation.
33596
33597 @findex pre-prompt-for-continue annotation
33598 @findex prompt-for-continue annotation
33599 @findex post-prompt-for-continue annotation
33600 @item prompt-for-continue
33601 When @value{GDBN} is asking the user to press return to continue.  Note: Don't
33602 expect this to work well; instead use @code{set height 0} to disable
33603 prompting.  This is because the counting of lines is buggy in the
33604 presence of annotations.
33605 @end table
33606
33607 @node Errors
33608 @section Errors
33609 @cindex annotations for errors, warnings and interrupts
33610
33611 @findex quit annotation
33612 @smallexample
33613 ^Z^Zquit
33614 @end smallexample
33615
33616 This annotation occurs right before @value{GDBN} responds to an interrupt.
33617
33618 @findex error annotation
33619 @smallexample
33620 ^Z^Zerror
33621 @end smallexample
33622
33623 This annotation occurs right before @value{GDBN} responds to an error.
33624
33625 Quit and error annotations indicate that any annotations which @value{GDBN} was
33626 in the middle of may end abruptly.  For example, if a
33627 @code{value-history-begin} annotation is followed by a @code{error}, one
33628 cannot expect to receive the matching @code{value-history-end}.  One
33629 cannot expect not to receive it either, however; an error annotation
33630 does not necessarily mean that @value{GDBN} is immediately returning all the way
33631 to the top level.
33632
33633 @findex error-begin annotation
33634 A quit or error annotation may be preceded by
33635
33636 @smallexample
33637 ^Z^Zerror-begin
33638 @end smallexample
33639
33640 Any output between that and the quit or error annotation is the error
33641 message.
33642
33643 Warning messages are not yet annotated.
33644 @c If we want to change that, need to fix warning(), type_error(),
33645 @c range_error(), and possibly other places.
33646
33647 @node Invalidation
33648 @section Invalidation Notices
33649
33650 @cindex annotations for invalidation messages
33651 The following annotations say that certain pieces of state may have
33652 changed.
33653
33654 @table @code
33655 @findex frames-invalid annotation
33656 @item ^Z^Zframes-invalid
33657
33658 The frames (for example, output from the @code{backtrace} command) may
33659 have changed.
33660
33661 @findex breakpoints-invalid annotation
33662 @item ^Z^Zbreakpoints-invalid
33663
33664 The breakpoints may have changed.  For example, the user just added or
33665 deleted a breakpoint.
33666 @end table
33667
33668 @node Annotations for Running
33669 @section Running the Program
33670 @cindex annotations for running programs
33671
33672 @findex starting annotation
33673 @findex stopping annotation
33674 When the program starts executing due to a @value{GDBN} command such as
33675 @code{step} or @code{continue},
33676
33677 @smallexample
33678 ^Z^Zstarting
33679 @end smallexample
33680
33681 is output.  When the program stops,
33682
33683 @smallexample
33684 ^Z^Zstopped
33685 @end smallexample
33686
33687 is output.  Before the @code{stopped} annotation, a variety of
33688 annotations describe how the program stopped.
33689
33690 @table @code
33691 @findex exited annotation
33692 @item ^Z^Zexited @var{exit-status}
33693 The program exited, and @var{exit-status} is the exit status (zero for
33694 successful exit, otherwise nonzero).
33695
33696 @findex signalled annotation
33697 @findex signal-name annotation
33698 @findex signal-name-end annotation
33699 @findex signal-string annotation
33700 @findex signal-string-end annotation
33701 @item ^Z^Zsignalled
33702 The program exited with a signal.  After the @code{^Z^Zsignalled}, the
33703 annotation continues:
33704
33705 @smallexample
33706 @var{intro-text}
33707 ^Z^Zsignal-name
33708 @var{name}
33709 ^Z^Zsignal-name-end
33710 @var{middle-text}
33711 ^Z^Zsignal-string
33712 @var{string}
33713 ^Z^Zsignal-string-end
33714 @var{end-text}
33715 @end smallexample
33716
33717 @noindent
33718 where @var{name} is the name of the signal, such as @code{SIGILL} or
33719 @code{SIGSEGV}, and @var{string} is the explanation of the signal, such
33720 as @code{Illegal Instruction} or @code{Segmentation fault}.  The arguments
33721 @var{intro-text}, @var{middle-text}, and @var{end-text} are for the
33722 user's benefit and have no particular format.
33723
33724 @findex signal annotation
33725 @item ^Z^Zsignal
33726 The syntax of this annotation is just like @code{signalled}, but @value{GDBN} is
33727 just saying that the program received the signal, not that it was
33728 terminated with it.
33729
33730 @findex breakpoint annotation
33731 @item ^Z^Zbreakpoint @var{number}
33732 The program hit breakpoint number @var{number}.
33733
33734 @findex watchpoint annotation
33735 @item ^Z^Zwatchpoint @var{number}
33736 The program hit watchpoint number @var{number}.
33737 @end table
33738
33739 @node Source Annotations
33740 @section Displaying Source
33741 @cindex annotations for source display
33742
33743 @findex source annotation
33744 The following annotation is used instead of displaying source code:
33745
33746 @smallexample
33747 ^Z^Zsource @var{filename}:@var{line}:@var{character}:@var{middle}:@var{addr}
33748 @end smallexample
33749
33750 where @var{filename} is an absolute file name indicating which source
33751 file, @var{line} is the line number within that file (where 1 is the
33752 first line in the file), @var{character} is the character position
33753 within the file (where 0 is the first character in the file) (for most
33754 debug formats this will necessarily point to the beginning of a line),
33755 @var{middle} is @samp{middle} if @var{addr} is in the middle of the
33756 line, or @samp{beg} if @var{addr} is at the beginning of the line, and
33757 @var{addr} is the address in the target program associated with the
33758 source which is being displayed.  The @var{addr} is in the form @samp{0x}
33759 followed by one or more lowercase hex digits (note that this does not
33760 depend on the language).
33761
33762 @node JIT Interface
33763 @chapter JIT Compilation Interface
33764 @cindex just-in-time compilation
33765 @cindex JIT compilation interface
33766
33767 This chapter documents @value{GDBN}'s @dfn{just-in-time} (JIT) compilation
33768 interface.  A JIT compiler is a program or library that generates native
33769 executable code at runtime and executes it, usually in order to achieve good
33770 performance while maintaining platform independence. 
33771
33772 Programs that use JIT compilation are normally difficult to debug because
33773 portions of their code are generated at runtime, instead of being loaded from
33774 object files, which is where @value{GDBN} normally finds the program's symbols
33775 and debug information.  In order to debug programs that use JIT compilation,
33776 @value{GDBN} has an interface that allows the program to register in-memory
33777 symbol files with @value{GDBN} at runtime.
33778
33779 If you are using @value{GDBN} to debug a program that uses this interface, then
33780 it should work transparently so long as you have not stripped the binary.  If
33781 you are developing a JIT compiler, then the interface is documented in the rest
33782 of this chapter.  At this time, the only known client of this interface is the
33783 LLVM JIT.
33784
33785 Broadly speaking, the JIT interface mirrors the dynamic loader interface.  The
33786 JIT compiler communicates with @value{GDBN} by writing data into a global
33787 variable and calling a fuction at a well-known symbol.  When @value{GDBN}
33788 attaches, it reads a linked list of symbol files from the global variable to
33789 find existing code, and puts a breakpoint in the function so that it can find
33790 out about additional code.
33791
33792 @menu
33793 * Declarations::                Relevant C struct declarations
33794 * Registering Code::            Steps to register code
33795 * Unregistering Code::          Steps to unregister code
33796 * Custom Debug Info::           Emit debug information in a custom format
33797 @end menu
33798
33799 @node Declarations
33800 @section JIT Declarations
33801
33802 These are the relevant struct declarations that a C program should include to
33803 implement the interface:
33804
33805 @smallexample
33806 typedef enum
33807 @{
33808   JIT_NOACTION = 0,
33809   JIT_REGISTER_FN,
33810   JIT_UNREGISTER_FN
33811 @} jit_actions_t;
33812
33813 struct jit_code_entry
33814 @{
33815   struct jit_code_entry *next_entry;
33816   struct jit_code_entry *prev_entry;
33817   const char *symfile_addr;
33818   uint64_t symfile_size;
33819 @};
33820
33821 struct jit_descriptor
33822 @{
33823   uint32_t version;
33824   /* This type should be jit_actions_t, but we use uint32_t
33825      to be explicit about the bitwidth.  */
33826   uint32_t action_flag;
33827   struct jit_code_entry *relevant_entry;
33828   struct jit_code_entry *first_entry;
33829 @};
33830
33831 /* GDB puts a breakpoint in this function.  */
33832 void __attribute__((noinline)) __jit_debug_register_code() @{ @};
33833
33834 /* Make sure to specify the version statically, because the
33835    debugger may check the version before we can set it.  */
33836 struct jit_descriptor __jit_debug_descriptor = @{ 1, 0, 0, 0 @};
33837 @end smallexample
33838
33839 If the JIT is multi-threaded, then it is important that the JIT synchronize any
33840 modifications to this global data properly, which can easily be done by putting
33841 a global mutex around modifications to these structures.
33842
33843 @node Registering Code
33844 @section Registering Code
33845
33846 To register code with @value{GDBN}, the JIT should follow this protocol:
33847
33848 @itemize @bullet
33849 @item
33850 Generate an object file in memory with symbols and other desired debug
33851 information.  The file must include the virtual addresses of the sections.
33852
33853 @item
33854 Create a code entry for the file, which gives the start and size of the symbol
33855 file.
33856
33857 @item
33858 Add it to the linked list in the JIT descriptor.
33859
33860 @item
33861 Point the relevant_entry field of the descriptor at the entry.
33862
33863 @item
33864 Set @code{action_flag} to @code{JIT_REGISTER} and call
33865 @code{__jit_debug_register_code}.
33866 @end itemize
33867
33868 When @value{GDBN} is attached and the breakpoint fires, @value{GDBN} uses the
33869 @code{relevant_entry} pointer so it doesn't have to walk the list looking for
33870 new code.  However, the linked list must still be maintained in order to allow
33871 @value{GDBN} to attach to a running process and still find the symbol files.
33872
33873 @node Unregistering Code
33874 @section Unregistering Code
33875
33876 If code is freed, then the JIT should use the following protocol:
33877
33878 @itemize @bullet
33879 @item
33880 Remove the code entry corresponding to the code from the linked list.
33881
33882 @item
33883 Point the @code{relevant_entry} field of the descriptor at the code entry.
33884
33885 @item
33886 Set @code{action_flag} to @code{JIT_UNREGISTER} and call
33887 @code{__jit_debug_register_code}.
33888 @end itemize
33889
33890 If the JIT frees or recompiles code without unregistering it, then @value{GDBN}
33891 and the JIT will leak the memory used for the associated symbol files.
33892
33893 @node Custom Debug Info
33894 @section Custom Debug Info
33895 @cindex custom JIT debug info
33896 @cindex JIT debug info reader
33897
33898 Generating debug information in platform-native file formats (like ELF
33899 or COFF) may be an overkill for JIT compilers; especially if all the
33900 debug info is used for is displaying a meaningful backtrace.  The
33901 issue can be resolved by having the JIT writers decide on a debug info
33902 format and also provide a reader that parses the debug info generated
33903 by the JIT compiler.  This section gives a brief overview on writing
33904 such a parser.  More specific details can be found in the source file
33905 @file{gdb/jit-reader.in}, which is also installed as a header at
33906 @file{@var{includedir}/gdb/jit-reader.h} for easy inclusion.
33907
33908 The reader is implemented as a shared object (so this functionality is
33909 not available on platforms which don't allow loading shared objects at
33910 runtime).  Two @value{GDBN} commands, @code{jit-reader-load} and
33911 @code{jit-reader-unload} are provided, to be used to load and unload
33912 the readers from a preconfigured directory.  Once loaded, the shared
33913 object is used the parse the debug information emitted by the JIT
33914 compiler.
33915
33916 @menu
33917 * Using JIT Debug Info Readers::       How to use supplied readers correctly
33918 * Writing JIT Debug Info Readers::     Creating a debug-info reader
33919 @end menu
33920
33921 @node Using JIT Debug Info Readers
33922 @subsection Using JIT Debug Info Readers
33923 @kindex jit-reader-load
33924 @kindex jit-reader-unload
33925
33926 Readers can be loaded and unloaded using the @code{jit-reader-load}
33927 and @code{jit-reader-unload} commands.
33928
33929 @table @code
33930 @item jit-reader-load @var{reader}
33931 Load the JIT reader named @var{reader}, which is a shared
33932 object specified as either an absolute or a relative file name.  In
33933 the latter case, @value{GDBN} will try to load the reader from a
33934 pre-configured directory, usually @file{@var{libdir}/gdb/} on a UNIX
33935 system (here @var{libdir} is the system library directory, often
33936 @file{/usr/local/lib}).
33937
33938 Only one reader can be active at a time; trying to load a second
33939 reader when one is already loaded will result in @value{GDBN}
33940 reporting an error.  A new JIT reader can be loaded by first unloading
33941 the current one using @code{jit-reader-unload} and then invoking
33942 @code{jit-reader-load}.
33943
33944 @item jit-reader-unload
33945 Unload the currently loaded JIT reader.
33946
33947 @end table
33948
33949 @node Writing JIT Debug Info Readers
33950 @subsection Writing JIT Debug Info Readers
33951 @cindex writing JIT debug info readers
33952
33953 As mentioned, a reader is essentially a shared object conforming to a
33954 certain ABI.  This ABI is described in @file{jit-reader.h}.
33955
33956 @file{jit-reader.h} defines the structures, macros and functions
33957 required to write a reader.  It is installed (along with
33958 @value{GDBN}), in @file{@var{includedir}/gdb} where @var{includedir} is
33959 the system include directory.
33960
33961 Readers need to be released under a GPL compatible license.  A reader
33962 can be declared as released under such a license by placing the macro
33963 @code{GDB_DECLARE_GPL_COMPATIBLE_READER} in a source file.
33964
33965 The entry point for readers is the symbol @code{gdb_init_reader},
33966 which is expected to be a function with the prototype
33967
33968 @findex gdb_init_reader
33969 @smallexample
33970 extern struct gdb_reader_funcs *gdb_init_reader (void);
33971 @end smallexample
33972
33973 @cindex @code{struct gdb_reader_funcs}
33974
33975 @code{struct gdb_reader_funcs} contains a set of pointers to callback
33976 functions.  These functions are executed to read the debug info
33977 generated by the JIT compiler (@code{read}), to unwind stack frames
33978 (@code{unwind}) and to create canonical frame IDs
33979 (@code{get_Frame_id}).  It also has a callback that is called when the
33980 reader is being unloaded (@code{destroy}).  The struct looks like this
33981
33982 @smallexample
33983 struct gdb_reader_funcs
33984 @{
33985   /* Must be set to GDB_READER_INTERFACE_VERSION.  */
33986   int reader_version;
33987
33988   /* For use by the reader.  */
33989   void *priv_data;
33990
33991   gdb_read_debug_info *read;
33992   gdb_unwind_frame *unwind;
33993   gdb_get_frame_id *get_frame_id;
33994   gdb_destroy_reader *destroy;
33995 @};
33996 @end smallexample
33997
33998 @cindex @code{struct gdb_symbol_callbacks}
33999 @cindex @code{struct gdb_unwind_callbacks}
34000
34001 The callbacks are provided with another set of callbacks by
34002 @value{GDBN} to do their job.  For @code{read}, these callbacks are
34003 passed in a @code{struct gdb_symbol_callbacks} and for @code{unwind}
34004 and @code{get_frame_id}, in a @code{struct gdb_unwind_callbacks}.
34005 @code{struct gdb_symbol_callbacks} has callbacks to create new object
34006 files and new symbol tables inside those object files.  @code{struct
34007 gdb_unwind_callbacks} has callbacks to read registers off the current
34008 frame and to write out the values of the registers in the previous
34009 frame.  Both have a callback (@code{target_read}) to read bytes off the
34010 target's address space.
34011
34012 @node In-Process Agent
34013 @chapter In-Process Agent
34014 @cindex debugging agent
34015 The traditional debugging model is conceptually low-speed, but works fine,
34016 because most bugs can be reproduced in debugging-mode execution.  However,
34017 as multi-core or many-core processors are becoming mainstream, and
34018 multi-threaded programs become more and more popular, there should be more
34019 and more bugs that only manifest themselves at normal-mode execution, for
34020 example, thread races, because debugger's interference with the program's
34021 timing may conceal the bugs.  On the other hand, in some applications,
34022 it is not feasible for the debugger to interrupt the program's execution
34023 long enough for the developer to learn anything helpful about its behavior.
34024 If the program's correctness depends on its real-time behavior, delays
34025 introduced by a debugger might cause the program to fail, even when the
34026 code itself is correct.  It is useful to be able to observe the program's
34027 behavior without interrupting it.
34028
34029 Therefore, traditional debugging model is too intrusive to reproduce
34030 some bugs.  In order to reduce the interference with the program, we can
34031 reduce the number of operations performed by debugger.  The
34032 @dfn{In-Process Agent}, a shared library, is running within the same
34033 process with inferior, and is able to perform some debugging operations
34034 itself.  As a result, debugger is only involved when necessary, and
34035 performance of debugging can be improved accordingly.  Note that
34036 interference with program can be reduced but can't be removed completely,
34037 because the in-process agent will still stop or slow down the program.
34038
34039 The in-process agent can interpret and execute Agent Expressions
34040 (@pxref{Agent Expressions}) during performing debugging operations.  The
34041 agent expressions can be used for different purposes, such as collecting
34042 data in tracepoints, and condition evaluation in breakpoints.
34043
34044 @anchor{Control Agent}
34045 You can control whether the in-process agent is used as an aid for
34046 debugging with the following commands:
34047
34048 @table @code
34049 @kindex set agent on
34050 @item set agent on
34051 Causes the in-process agent to perform some operations on behalf of the
34052 debugger.  Just which operations requested by the user will be done
34053 by the in-process agent depends on the its capabilities.  For example,
34054 if you request to evaluate breakpoint conditions in the in-process agent,
34055 and the in-process agent has such capability as well, then breakpoint
34056 conditions will be evaluated in the in-process agent.
34057
34058 @kindex set agent off
34059 @item set agent off
34060 Disables execution of debugging operations by the in-process agent.  All
34061 of the operations will be performed by @value{GDBN}.
34062
34063 @kindex show agent
34064 @item show agent
34065 Display the current setting of execution of debugging operations by
34066 the in-process agent.
34067 @end table
34068
34069 @menu
34070 * In-Process Agent Protocol::
34071 @end menu
34072
34073 @node In-Process Agent Protocol
34074 @section In-Process Agent Protocol
34075 @cindex in-process agent protocol
34076
34077 The in-process agent is able to communicate with both @value{GDBN} and
34078 GDBserver (@pxref{In-Process Agent}).  This section documents the protocol
34079 used for communications between @value{GDBN} or GDBserver and the IPA.
34080 In general, @value{GDBN} or GDBserver sends commands
34081 (@pxref{IPA Protocol Commands}) and data to in-process agent, and then
34082 in-process agent replies back with the return result of the command, or
34083 some other information.  The data sent to in-process agent is composed
34084 of primitive data types, such as 4-byte or 8-byte type, and composite
34085 types, which are called objects (@pxref{IPA Protocol Objects}).
34086
34087 @menu
34088 * IPA Protocol Objects::
34089 * IPA Protocol Commands::
34090 @end menu
34091
34092 @node IPA Protocol Objects
34093 @subsection IPA Protocol Objects
34094 @cindex ipa protocol objects
34095
34096 The commands sent to and results received from agent may contain some
34097 complex data types called @dfn{objects}.
34098
34099 The in-process agent is running on the same machine with @value{GDBN}
34100 or GDBserver, so it doesn't have to handle as much differences between
34101 two ends as remote protocol (@pxref{Remote Protocol}) tries to handle.
34102 However, there are still some differences of two ends in two processes:
34103
34104 @enumerate
34105 @item
34106 word size.  On some 64-bit machines, @value{GDBN} or GDBserver can be
34107 compiled as a 64-bit executable, while in-process agent is a 32-bit one.
34108 @item
34109 ABI.  Some machines may have multiple types of ABI, @value{GDBN} or
34110 GDBserver is compiled with one, and in-process agent is compiled with
34111 the other one.
34112 @end enumerate
34113
34114 Here are the IPA Protocol Objects:
34115
34116 @enumerate
34117 @item
34118 agent expression object.  It represents an agent expression
34119 (@pxref{Agent Expressions}).
34120 @anchor{agent expression object}
34121 @item
34122 tracepoint action object.  It represents a tracepoint action
34123 (@pxref{Tracepoint Actions,,Tracepoint Action Lists}) to collect registers,
34124 memory, static trace data and to evaluate expression.
34125 @anchor{tracepoint action object}
34126 @item
34127 tracepoint object.  It represents a tracepoint (@pxref{Tracepoints}).
34128 @anchor{tracepoint object}
34129
34130 @end enumerate
34131
34132 The following table describes important attributes of each IPA protocol
34133 object:
34134
34135 @multitable @columnfractions .30 .20 .50
34136 @headitem Name @tab Size @tab Description
34137 @item @emph{agent expression object} @tab @tab
34138 @item length @tab 4 @tab length of bytes code
34139 @item byte code @tab @var{length} @tab contents of byte code
34140 @item @emph{tracepoint action for collecting memory} @tab @tab
34141 @item 'M' @tab 1 @tab type of tracepoint action
34142 @item addr @tab 8 @tab if @var{basereg} is @samp{-1}, @var{addr} is the
34143 address of the lowest byte to collect, otherwise @var{addr} is the offset
34144 of @var{basereg} for memory collecting.
34145 @item len @tab 8 @tab length of memory for collecting
34146 @item basereg @tab 4 @tab the register number containing the starting
34147 memory address for collecting.
34148 @item @emph{tracepoint action for collecting registers} @tab @tab
34149 @item 'R' @tab 1 @tab type of tracepoint action
34150 @item @emph{tracepoint action for collecting static trace data} @tab @tab
34151 @item 'L' @tab 1 @tab type of tracepoint action
34152 @item @emph{tracepoint action for expression evaluation} @tab @tab
34153 @item 'X' @tab 1 @tab type of tracepoint action
34154 @item agent expression @tab length of @tab @ref{agent expression object}
34155 @item @emph{tracepoint object} @tab @tab
34156 @item number @tab 4 @tab number of tracepoint
34157 @item address @tab 8 @tab address of tracepoint inserted on
34158 @item type @tab 4 @tab type of tracepoint
34159 @item enabled @tab 1 @tab enable or disable of tracepoint
34160 @item step_count @tab 8 @tab step
34161 @item pass_count @tab 8 @tab pass
34162 @item numactions @tab 4 @tab number of tracepoint actions
34163 @item hit count @tab 8 @tab hit count
34164 @item trace frame usage @tab 8 @tab trace frame usage
34165 @item compiled_cond @tab 8 @tab compiled condition
34166 @item orig_size @tab 8 @tab orig size
34167 @item condition @tab 4 if condition is NULL otherwise length of
34168 @ref{agent expression object}
34169 @tab zero if condition is NULL, otherwise is
34170 @ref{agent expression object}
34171 @item actions @tab variable
34172 @tab numactions number of @ref{tracepoint action object}
34173 @end multitable
34174
34175 @node IPA Protocol Commands
34176 @subsection IPA Protocol Commands
34177 @cindex ipa protocol commands
34178
34179 The spaces in each command are delimiters to ease reading this commands
34180 specification.  They don't exist in real commands.
34181
34182 @table @samp
34183
34184 @item FastTrace:@var{tracepoint_object} @var{gdb_jump_pad_head}
34185 Installs a new fast tracepoint described by @var{tracepoint_object}
34186 (@pxref{tracepoint object}).  The @var{gdb_jump_pad_head}, 8-byte long, is the
34187 head of @dfn{jumppad}, which is used to jump to data collection routine
34188 in IPA finally.
34189
34190 Replies:
34191 @table @samp
34192 @item OK @var{target_address} @var{gdb_jump_pad_head} @var{fjump_size} @var{fjump}
34193 @var{target_address} is address of tracepoint in the inferior.
34194 The @var{gdb_jump_pad_head} is updated head of jumppad.  Both of
34195 @var{target_address} and @var{gdb_jump_pad_head} are 8-byte long.
34196 The @var{fjump} contains a sequence of instructions jump to jumppad entry.
34197 The @var{fjump_size}, 4-byte long, is the size of @var{fjump}.
34198 @item E @var{NN}
34199 for an error
34200
34201 @end table
34202
34203 @item close
34204 Closes the in-process agent.  This command is sent when @value{GDBN} or GDBserver
34205 is about to kill inferiors.
34206
34207 @item qTfSTM
34208 @xref{qTfSTM}.
34209 @item qTsSTM
34210 @xref{qTsSTM}.
34211 @item qTSTMat
34212 @xref{qTSTMat}.
34213 @item probe_marker_at:@var{address}
34214 Asks in-process agent to probe the marker at @var{address}.
34215
34216 Replies:
34217 @table @samp
34218 @item E @var{NN}
34219 for an error
34220 @end table
34221 @item unprobe_marker_at:@var{address}
34222 Asks in-process agent to unprobe the marker at @var{address}.
34223 @end table
34224
34225 @node GDB Bugs
34226 @chapter Reporting Bugs in @value{GDBN}
34227 @cindex bugs in @value{GDBN}
34228 @cindex reporting bugs in @value{GDBN}
34229
34230 Your bug reports play an essential role in making @value{GDBN} reliable.
34231
34232 Reporting a bug may help you by bringing a solution to your problem, or it
34233 may not.  But in any case the principal function of a bug report is to help
34234 the entire community by making the next version of @value{GDBN} work better.  Bug
34235 reports are your contribution to the maintenance of @value{GDBN}.
34236
34237 In order for a bug report to serve its purpose, you must include the
34238 information that enables us to fix the bug.
34239
34240 @menu
34241 * Bug Criteria::                Have you found a bug?
34242 * Bug Reporting::               How to report bugs
34243 @end menu
34244
34245 @node Bug Criteria
34246 @section Have You Found a Bug?
34247 @cindex bug criteria
34248
34249 If you are not sure whether you have found a bug, here are some guidelines:
34250
34251 @itemize @bullet
34252 @cindex fatal signal
34253 @cindex debugger crash
34254 @cindex crash of debugger
34255 @item
34256 If the debugger gets a fatal signal, for any input whatever, that is a
34257 @value{GDBN} bug.  Reliable debuggers never crash.
34258
34259 @cindex error on valid input
34260 @item
34261 If @value{GDBN} produces an error message for valid input, that is a
34262 bug.  (Note that if you're cross debugging, the problem may also be
34263 somewhere in the connection to the target.)
34264
34265 @cindex invalid input
34266 @item
34267 If @value{GDBN} does not produce an error message for invalid input,
34268 that is a bug.  However, you should note that your idea of
34269 ``invalid input'' might be our idea of ``an extension'' or ``support
34270 for traditional practice''.
34271
34272 @item
34273 If you are an experienced user of debugging tools, your suggestions
34274 for improvement of @value{GDBN} are welcome in any case.
34275 @end itemize
34276
34277 @node Bug Reporting
34278 @section How to Report Bugs
34279 @cindex bug reports
34280 @cindex @value{GDBN} bugs, reporting
34281
34282 A number of companies and individuals offer support for @sc{gnu} products.
34283 If you obtained @value{GDBN} from a support organization, we recommend you
34284 contact that organization first.
34285
34286 You can find contact information for many support companies and
34287 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
34288 distribution.
34289 @c should add a web page ref...
34290
34291 @ifset BUGURL
34292 @ifset BUGURL_DEFAULT
34293 In any event, we also recommend that you submit bug reports for
34294 @value{GDBN}.  The preferred method is to submit them directly using
34295 @uref{http://www.gnu.org/software/gdb/bugs/, @value{GDBN}'s Bugs web
34296 page}.  Alternatively, the @email{bug-gdb@@gnu.org, e-mail gateway} can
34297 be used.
34298
34299 @strong{Do not send bug reports to @samp{info-gdb}, or to
34300 @samp{help-gdb}, or to any newsgroups.}  Most users of @value{GDBN} do
34301 not want to receive bug reports.  Those that do have arranged to receive
34302 @samp{bug-gdb}.
34303
34304 The mailing list @samp{bug-gdb} has a newsgroup @samp{gnu.gdb.bug} which
34305 serves as a repeater.  The mailing list and the newsgroup carry exactly
34306 the same messages.  Often people think of posting bug reports to the
34307 newsgroup instead of mailing them.  This appears to work, but it has one
34308 problem which can be crucial: a newsgroup posting often lacks a mail
34309 path back to the sender.  Thus, if we need to ask for more information,
34310 we may be unable to reach you.  For this reason, it is better to send
34311 bug reports to the mailing list.
34312 @end ifset
34313 @ifclear BUGURL_DEFAULT
34314 In any event, we also recommend that you submit bug reports for
34315 @value{GDBN} to @value{BUGURL}.
34316 @end ifclear
34317 @end ifset
34318
34319 The fundamental principle of reporting bugs usefully is this:
34320 @strong{report all the facts}.  If you are not sure whether to state a
34321 fact or leave it out, state it!
34322
34323 Often people omit facts because they think they know what causes the
34324 problem and assume that some details do not matter.  Thus, you might
34325 assume that the name of the variable you use in an example does not matter.
34326 Well, probably it does not, but one cannot be sure.  Perhaps the bug is a
34327 stray memory reference which happens to fetch from the location where that
34328 name is stored in memory; perhaps, if the name were different, the contents
34329 of that location would fool the debugger into doing the right thing despite
34330 the bug.  Play it safe and give a specific, complete example.  That is the
34331 easiest thing for you to do, and the most helpful.
34332
34333 Keep in mind that the purpose of a bug report is to enable us to fix the
34334 bug.  It may be that the bug has been reported previously, but neither
34335 you nor we can know that unless your bug report is complete and
34336 self-contained.
34337
34338 Sometimes people give a few sketchy facts and ask, ``Does this ring a
34339 bell?''  Those bug reports are useless, and we urge everyone to
34340 @emph{refuse to respond to them} except to chide the sender to report
34341 bugs properly.
34342
34343 To enable us to fix the bug, you should include all these things:
34344
34345 @itemize @bullet
34346 @item
34347 The version of @value{GDBN}.  @value{GDBN} announces it if you start
34348 with no arguments; you can also print it at any time using @code{show
34349 version}.
34350
34351 Without this, we will not know whether there is any point in looking for
34352 the bug in the current version of @value{GDBN}.
34353
34354 @item
34355 The type of machine you are using, and the operating system name and
34356 version number.
34357
34358 @item
34359 The details of the @value{GDBN} build-time configuration.
34360 @value{GDBN} shows these details if you invoke it with the
34361 @option{--configuration} command-line option, or if you type
34362 @code{show configuration} at @value{GDBN}'s prompt.
34363
34364 @item
34365 What compiler (and its version) was used to compile @value{GDBN}---e.g.@:
34366 ``@value{GCC}--2.8.1''.
34367
34368 @item
34369 What compiler (and its version) was used to compile the program you are
34370 debugging---e.g.@:  ``@value{GCC}--2.8.1'', or ``HP92453-01 A.10.32.03 HP
34371 C Compiler''.  For @value{NGCC}, you can say @kbd{@value{GCC} --version}
34372 to get this information; for other compilers, see the documentation for
34373 those compilers.
34374
34375 @item
34376 The command arguments you gave the compiler to compile your example and
34377 observe the bug.  For example, did you use @samp{-O}?  To guarantee
34378 you will not omit something important, list them all.  A copy of the
34379 Makefile (or the output from make) is sufficient.
34380
34381 If we were to try to guess the arguments, we would probably guess wrong
34382 and then we might not encounter the bug.
34383
34384 @item
34385 A complete input script, and all necessary source files, that will
34386 reproduce the bug.
34387
34388 @item
34389 A description of what behavior you observe that you believe is
34390 incorrect.  For example, ``It gets a fatal signal.''
34391
34392 Of course, if the bug is that @value{GDBN} gets a fatal signal, then we
34393 will certainly notice it.  But if the bug is incorrect output, we might
34394 not notice unless it is glaringly wrong.  You might as well not give us
34395 a chance to make a mistake.
34396
34397 Even if the problem you experience is a fatal signal, you should still
34398 say so explicitly.  Suppose something strange is going on, such as, your
34399 copy of @value{GDBN} is out of synch, or you have encountered a bug in
34400 the C library on your system.  (This has happened!)  Your copy might
34401 crash and ours would not.  If you told us to expect a crash, then when
34402 ours fails to crash, we would know that the bug was not happening for
34403 us.  If you had not told us to expect a crash, then we would not be able
34404 to draw any conclusion from our observations.
34405
34406 @pindex script
34407 @cindex recording a session script
34408 To collect all this information, you can use a session recording program
34409 such as @command{script}, which is available on many Unix systems.
34410 Just run your @value{GDBN} session inside @command{script} and then
34411 include the @file{typescript} file with your bug report.
34412
34413 Another way to record a @value{GDBN} session is to run @value{GDBN}
34414 inside Emacs and then save the entire buffer to a file.
34415
34416 @item
34417 If you wish to suggest changes to the @value{GDBN} source, send us context
34418 diffs.  If you even discuss something in the @value{GDBN} source, refer to
34419 it by context, not by line number.
34420
34421 The line numbers in our development sources will not match those in your
34422 sources.  Your line numbers would convey no useful information to us.
34423
34424 @end itemize
34425
34426 Here are some things that are not necessary:
34427
34428 @itemize @bullet
34429 @item
34430 A description of the envelope of the bug.
34431
34432 Often people who encounter a bug spend a lot of time investigating
34433 which changes to the input file will make the bug go away and which
34434 changes will not affect it.
34435
34436 This is often time consuming and not very useful, because the way we
34437 will find the bug is by running a single example under the debugger
34438 with breakpoints, not by pure deduction from a series of examples.
34439 We recommend that you save your time for something else.
34440
34441 Of course, if you can find a simpler example to report @emph{instead}
34442 of the original one, that is a convenience for us.  Errors in the
34443 output will be easier to spot, running under the debugger will take
34444 less time, and so on.
34445
34446 However, simplification is not vital; if you do not want to do this,
34447 report the bug anyway and send us the entire test case you used.
34448
34449 @item
34450 A patch for the bug.
34451
34452 A patch for the bug does help us if it is a good one.  But do not omit
34453 the necessary information, such as the test case, on the assumption that
34454 a patch is all we need.  We might see problems with your patch and decide
34455 to fix the problem another way, or we might not understand it at all.
34456
34457 Sometimes with a program as complicated as @value{GDBN} it is very hard to
34458 construct an example that will make the program follow a certain path
34459 through the code.  If you do not send us the example, we will not be able
34460 to construct one, so we will not be able to verify that the bug is fixed.
34461
34462 And if we cannot understand what bug you are trying to fix, or why your
34463 patch should be an improvement, we will not install it.  A test case will
34464 help us to understand.
34465
34466 @item
34467 A guess about what the bug is or what it depends on.
34468
34469 Such guesses are usually wrong.  Even we cannot guess right about such
34470 things without first using the debugger to find the facts.
34471 @end itemize
34472
34473 @c The readline documentation is distributed with the readline code
34474 @c and consists of the two following files:
34475 @c     rluser.texi
34476 @c     hsuser.texi
34477 @c Use -I with makeinfo to point to the appropriate directory,
34478 @c environment var TEXINPUTS with TeX.
34479 @ifclear SYSTEM_READLINE
34480 @include rluser.texi
34481 @include hsuser.texi
34482 @end ifclear
34483
34484 @node In Memoriam
34485 @appendix In Memoriam
34486
34487 The @value{GDBN} project mourns the loss of the following long-time
34488 contributors:
34489
34490 @table @code
34491 @item Fred Fish
34492 Fred was a long-standing contributor to @value{GDBN} (1991-2006), and
34493 to Free Software in general.  Outside of @value{GDBN}, he was known in
34494 the Amiga world for his series of Fish Disks, and the GeekGadget project.
34495
34496 @item Michael Snyder
34497 Michael was one of the Global Maintainers of the @value{GDBN} project,
34498 with contributions recorded as early as 1996, until 2011.  In addition
34499 to his day to day participation, he was a large driving force behind
34500 adding Reverse Debugging to @value{GDBN}.
34501 @end table
34502
34503 Beyond their technical contributions to the project, they were also
34504 enjoyable members of the Free Software Community.  We will miss them.
34505
34506 @node Formatting Documentation
34507 @appendix Formatting Documentation
34508
34509 @cindex @value{GDBN} reference card
34510 @cindex reference card
34511 The @value{GDBN} 4 release includes an already-formatted reference card, ready
34512 for printing with PostScript or Ghostscript, in the @file{gdb}
34513 subdirectory of the main source directory@footnote{In
34514 @file{gdb-@value{GDBVN}/gdb/refcard.ps} of the version @value{GDBVN}
34515 release.}.  If you can use PostScript or Ghostscript with your printer,
34516 you can print the reference card immediately with @file{refcard.ps}.
34517
34518 The release also includes the source for the reference card.  You
34519 can format it, using @TeX{}, by typing:
34520
34521 @smallexample
34522 make refcard.dvi
34523 @end smallexample
34524
34525 The @value{GDBN} reference card is designed to print in @dfn{landscape}
34526 mode on US ``letter'' size paper;
34527 that is, on a sheet 11 inches wide by 8.5 inches
34528 high.  You will need to specify this form of printing as an option to
34529 your @sc{dvi} output program.
34530
34531 @cindex documentation
34532
34533 All the documentation for @value{GDBN} comes as part of the machine-readable
34534 distribution.  The documentation is written in Texinfo format, which is
34535 a documentation system that uses a single source file to produce both
34536 on-line information and a printed manual.  You can use one of the Info
34537 formatting commands to create the on-line version of the documentation
34538 and @TeX{} (or @code{texi2roff}) to typeset the printed version.
34539
34540 @value{GDBN} includes an already formatted copy of the on-line Info
34541 version of this manual in the @file{gdb} subdirectory.  The main Info
34542 file is @file{gdb-@value{GDBVN}/gdb/gdb.info}, and it refers to
34543 subordinate files matching @samp{gdb.info*} in the same directory.  If
34544 necessary, you can print out these files, or read them with any editor;
34545 but they are easier to read using the @code{info} subsystem in @sc{gnu}
34546 Emacs or the standalone @code{info} program, available as part of the
34547 @sc{gnu} Texinfo distribution.
34548
34549 If you want to format these Info files yourself, you need one of the
34550 Info formatting programs, such as @code{texinfo-format-buffer} or
34551 @code{makeinfo}.
34552
34553 If you have @code{makeinfo} installed, and are in the top level
34554 @value{GDBN} source directory (@file{gdb-@value{GDBVN}}, in the case of
34555 version @value{GDBVN}), you can make the Info file by typing:
34556
34557 @smallexample
34558 cd gdb
34559 make gdb.info
34560 @end smallexample
34561
34562 If you want to typeset and print copies of this manual, you need @TeX{},
34563 a program to print its @sc{dvi} output files, and @file{texinfo.tex}, the
34564 Texinfo definitions file.
34565
34566 @TeX{} is a typesetting program; it does not print files directly, but
34567 produces output files called @sc{dvi} files.  To print a typeset
34568 document, you need a program to print @sc{dvi} files.  If your system
34569 has @TeX{} installed, chances are it has such a program.  The precise
34570 command to use depends on your system; @kbd{lpr -d} is common; another
34571 (for PostScript devices) is @kbd{dvips}.  The @sc{dvi} print command may
34572 require a file name without any extension or a @samp{.dvi} extension.
34573
34574 @TeX{} also requires a macro definitions file called
34575 @file{texinfo.tex}.  This file tells @TeX{} how to typeset a document
34576 written in Texinfo format.  On its own, @TeX{} cannot either read or
34577 typeset a Texinfo file.  @file{texinfo.tex} is distributed with GDB
34578 and is located in the @file{gdb-@var{version-number}/texinfo}
34579 directory.
34580
34581 If you have @TeX{} and a @sc{dvi} printer program installed, you can
34582 typeset and print this manual.  First switch to the @file{gdb}
34583 subdirectory of the main source directory (for example, to
34584 @file{gdb-@value{GDBVN}/gdb}) and type:
34585
34586 @smallexample
34587 make gdb.dvi
34588 @end smallexample
34589
34590 Then give @file{gdb.dvi} to your @sc{dvi} printing program.
34591
34592 @node Installing GDB
34593 @appendix Installing @value{GDBN}
34594 @cindex installation
34595
34596 @menu
34597 * Requirements::                Requirements for building @value{GDBN}
34598 * Running Configure::           Invoking the @value{GDBN} @file{configure} script
34599 * Separate Objdir::             Compiling @value{GDBN} in another directory
34600 * Config Names::                Specifying names for hosts and targets
34601 * Configure Options::           Summary of options for configure
34602 * System-wide configuration::   Having a system-wide init file
34603 @end menu
34604
34605 @node Requirements
34606 @section Requirements for Building @value{GDBN}
34607 @cindex building @value{GDBN}, requirements for
34608
34609 Building @value{GDBN} requires various tools and packages to be available.
34610 Other packages will be used only if they are found.
34611
34612 @heading Tools/Packages Necessary for Building @value{GDBN}
34613 @table @asis
34614 @item ISO C90 compiler
34615 @value{GDBN} is written in ISO C90.  It should be buildable with any
34616 working C90 compiler, e.g.@: GCC.
34617
34618 @end table
34619
34620 @heading Tools/Packages Optional for Building @value{GDBN}
34621 @table @asis
34622 @item Expat
34623 @anchor{Expat}
34624 @value{GDBN} can use the Expat XML parsing library.  This library may be
34625 included with your operating system distribution; if it is not, you
34626 can get the latest version from @url{http://expat.sourceforge.net}.
34627 The @file{configure} script will search for this library in several
34628 standard locations; if it is installed in an unusual path, you can
34629 use the @option{--with-libexpat-prefix} option to specify its location.
34630
34631 Expat is used for:
34632
34633 @itemize @bullet
34634 @item
34635 Remote protocol memory maps (@pxref{Memory Map Format})
34636 @item
34637 Target descriptions (@pxref{Target Descriptions})
34638 @item
34639 Remote shared library lists (@xref{Library List Format},
34640 or alternatively @pxref{Library List Format for SVR4 Targets})
34641 @item
34642 MS-Windows shared libraries (@pxref{Shared Libraries})
34643 @item
34644 Traceframe info (@pxref{Traceframe Info Format})
34645 @item
34646 Branch trace (@pxref{Branch Trace Format},
34647 @pxref{Branch Trace Configuration Format})
34648 @end itemize
34649
34650 @item MPFR
34651 @anchor{MPFR}
34652 @value{GDBN} can use the GNU MPFR multiple-precision floating-point
34653 library.  This library may be included with your operating system
34654 distribution; if it is not, you can get the latest version from
34655 @url{http://www.mpfr.org}.  The @file{configure} script will search
34656 for this library in several standard locations; if it is installed
34657 in an unusual path, you can use the @option{--with-libmpfr-prefix}
34658 option to specify its location.
34659
34660 GNU MPFR is used to emulate target floating-point arithmetic during
34661 expression evaluation when the target uses different floating-point
34662 formats than the host.  If GNU MPFR it is not available, @value{GDBN}
34663 will fall back to using host floating-point arithmetic.
34664
34665 @item zlib
34666 @cindex compressed debug sections 
34667 @value{GDBN} will use the @samp{zlib} library, if available, to read
34668 compressed debug sections.  Some linkers, such as GNU gold, are capable
34669 of producing binaries with compressed debug sections.  If @value{GDBN}
34670 is compiled with @samp{zlib}, it will be able to read the debug
34671 information in such binaries.
34672
34673 The @samp{zlib} library is likely included with your operating system
34674 distribution; if it is not, you can get the latest version from
34675 @url{http://zlib.net}.
34676
34677 @item iconv
34678 @value{GDBN}'s features related to character sets (@pxref{Character
34679 Sets}) require a functioning @code{iconv} implementation.  If you are
34680 on a GNU system, then this is provided by the GNU C Library.  Some
34681 other systems also provide a working @code{iconv}.
34682
34683 If @value{GDBN} is using the @code{iconv} program which is installed
34684 in a non-standard place, you will need to tell @value{GDBN} where to find it.
34685 This is done with @option{--with-iconv-bin} which specifies the
34686 directory that contains the @code{iconv} program.
34687
34688 On systems without @code{iconv}, you can install GNU Libiconv.  If you
34689 have previously installed Libiconv, you can use the
34690 @option{--with-libiconv-prefix} option to configure.
34691
34692 @value{GDBN}'s top-level @file{configure} and @file{Makefile} will
34693 arrange to build Libiconv if a directory named @file{libiconv} appears
34694 in the top-most source directory.  If Libiconv is built this way, and
34695 if the operating system does not provide a suitable @code{iconv}
34696 implementation, then the just-built library will automatically be used
34697 by @value{GDBN}.  One easy way to set this up is to download GNU
34698 Libiconv, unpack it, and then rename the directory holding the
34699 Libiconv source code to @samp{libiconv}.
34700 @end table
34701
34702 @node Running Configure
34703 @section Invoking the @value{GDBN} @file{configure} Script
34704 @cindex configuring @value{GDBN}
34705 @value{GDBN} comes with a @file{configure} script that automates the process
34706 of preparing @value{GDBN} for installation; you can then use @code{make} to
34707 build the @code{gdb} program.
34708 @iftex
34709 @c irrelevant in info file; it's as current as the code it lives with.
34710 @footnote{If you have a more recent version of @value{GDBN} than @value{GDBVN},
34711 look at the @file{README} file in the sources; we may have improved the
34712 installation procedures since publishing this manual.}
34713 @end iftex
34714
34715 The @value{GDBN} distribution includes all the source code you need for
34716 @value{GDBN} in a single directory, whose name is usually composed by
34717 appending the version number to @samp{gdb}.
34718
34719 For example, the @value{GDBN} version @value{GDBVN} distribution is in the
34720 @file{gdb-@value{GDBVN}} directory.  That directory contains:
34721
34722 @table @code
34723 @item gdb-@value{GDBVN}/configure @r{(and supporting files)}
34724 script for configuring @value{GDBN} and all its supporting libraries
34725
34726 @item gdb-@value{GDBVN}/gdb
34727 the source specific to @value{GDBN} itself
34728
34729 @item gdb-@value{GDBVN}/bfd
34730 source for the Binary File Descriptor library
34731
34732 @item gdb-@value{GDBVN}/include
34733 @sc{gnu} include files
34734
34735 @item gdb-@value{GDBVN}/libiberty
34736 source for the @samp{-liberty} free software library
34737
34738 @item gdb-@value{GDBVN}/opcodes
34739 source for the library of opcode tables and disassemblers
34740
34741 @item gdb-@value{GDBVN}/readline
34742 source for the @sc{gnu} command-line interface
34743
34744 @item gdb-@value{GDBVN}/glob
34745 source for the @sc{gnu} filename pattern-matching subroutine
34746
34747 @item gdb-@value{GDBVN}/mmalloc
34748 source for the @sc{gnu} memory-mapped malloc package
34749 @end table
34750
34751 The simplest way to configure and build @value{GDBN} is to run @file{configure}
34752 from the @file{gdb-@var{version-number}} source directory, which in
34753 this example is the @file{gdb-@value{GDBVN}} directory.
34754
34755 First switch to the @file{gdb-@var{version-number}} source directory
34756 if you are not already in it; then run @file{configure}.  Pass the
34757 identifier for the platform on which @value{GDBN} will run as an
34758 argument.
34759
34760 For example:
34761
34762 @smallexample
34763 cd gdb-@value{GDBVN}
34764 ./configure @var{host}
34765 make
34766 @end smallexample
34767
34768 @noindent
34769 where @var{host} is an identifier such as @samp{sun4} or
34770 @samp{decstation}, that identifies the platform where @value{GDBN} will run.
34771 (You can often leave off @var{host}; @file{configure} tries to guess the
34772 correct value by examining your system.)
34773
34774 Running @samp{configure @var{host}} and then running @code{make} builds the
34775 @file{bfd}, @file{readline}, @file{mmalloc}, and @file{libiberty}
34776 libraries, then @code{gdb} itself.  The configured source files, and the
34777 binaries, are left in the corresponding source directories.
34778
34779 @need 750
34780 @file{configure} is a Bourne-shell (@code{/bin/sh}) script; if your
34781 system does not recognize this automatically when you run a different
34782 shell, you may need to run @code{sh} on it explicitly:
34783
34784 @smallexample
34785 sh configure @var{host}
34786 @end smallexample
34787
34788 If you run @file{configure} from a directory that contains source
34789 directories for multiple libraries or programs, such as the
34790 @file{gdb-@value{GDBVN}} source directory for version @value{GDBVN},
34791 @file{configure}
34792 creates configuration files for every directory level underneath (unless
34793 you tell it not to, with the @samp{--norecursion} option).
34794
34795 You should run the @file{configure} script from the top directory in the
34796 source tree, the @file{gdb-@var{version-number}} directory.  If you run
34797 @file{configure} from one of the subdirectories, you will configure only
34798 that subdirectory.  That is usually not what you want.  In particular,
34799 if you run the first @file{configure} from the @file{gdb} subdirectory
34800 of the @file{gdb-@var{version-number}} directory, you will omit the
34801 configuration of @file{bfd}, @file{readline}, and other sibling
34802 directories of the @file{gdb} subdirectory.  This leads to build errors
34803 about missing include files such as @file{bfd/bfd.h}.
34804
34805 You can install @code{@value{GDBP}} anywhere; it has no hardwired paths.
34806 However, you should make sure that the shell on your path (named by
34807 the @samp{SHELL} environment variable) is publicly readable.  Remember
34808 that @value{GDBN} uses the shell to start your program---some systems refuse to
34809 let @value{GDBN} debug child processes whose programs are not readable.
34810
34811 @node Separate Objdir
34812 @section Compiling @value{GDBN} in Another Directory
34813
34814 If you want to run @value{GDBN} versions for several host or target machines,
34815 you need a different @code{gdb} compiled for each combination of
34816 host and target.  @file{configure} is designed to make this easy by
34817 allowing you to generate each configuration in a separate subdirectory,
34818 rather than in the source directory.  If your @code{make} program
34819 handles the @samp{VPATH} feature (@sc{gnu} @code{make} does), running
34820 @code{make} in each of these directories builds the @code{gdb}
34821 program specified there.
34822
34823 To build @code{gdb} in a separate directory, run @file{configure}
34824 with the @samp{--srcdir} option to specify where to find the source.
34825 (You also need to specify a path to find @file{configure}
34826 itself from your working directory.  If the path to @file{configure}
34827 would be the same as the argument to @samp{--srcdir}, you can leave out
34828 the @samp{--srcdir} option; it is assumed.)
34829
34830 For example, with version @value{GDBVN}, you can build @value{GDBN} in a
34831 separate directory for a Sun 4 like this:
34832
34833 @smallexample
34834 @group
34835 cd gdb-@value{GDBVN}
34836 mkdir ../gdb-sun4
34837 cd ../gdb-sun4
34838 ../gdb-@value{GDBVN}/configure sun4
34839 make
34840 @end group
34841 @end smallexample
34842
34843 When @file{configure} builds a configuration using a remote source
34844 directory, it creates a tree for the binaries with the same structure
34845 (and using the same names) as the tree under the source directory.  In
34846 the example, you'd find the Sun 4 library @file{libiberty.a} in the
34847 directory @file{gdb-sun4/libiberty}, and @value{GDBN} itself in
34848 @file{gdb-sun4/gdb}.
34849
34850 Make sure that your path to the @file{configure} script has just one
34851 instance of @file{gdb} in it.  If your path to @file{configure} looks
34852 like @file{../gdb-@value{GDBVN}/gdb/configure}, you are configuring only
34853 one subdirectory of @value{GDBN}, not the whole package.  This leads to
34854 build errors about missing include files such as @file{bfd/bfd.h}.
34855
34856 One popular reason to build several @value{GDBN} configurations in separate
34857 directories is to configure @value{GDBN} for cross-compiling (where
34858 @value{GDBN} runs on one machine---the @dfn{host}---while debugging
34859 programs that run on another machine---the @dfn{target}).
34860 You specify a cross-debugging target by
34861 giving the @samp{--target=@var{target}} option to @file{configure}.
34862
34863 When you run @code{make} to build a program or library, you must run
34864 it in a configured directory---whatever directory you were in when you
34865 called @file{configure} (or one of its subdirectories).
34866
34867 The @code{Makefile} that @file{configure} generates in each source
34868 directory also runs recursively.  If you type @code{make} in a source
34869 directory such as @file{gdb-@value{GDBVN}} (or in a separate configured
34870 directory configured with @samp{--srcdir=@var{dirname}/gdb-@value{GDBVN}}), you
34871 will build all the required libraries, and then build GDB.
34872
34873 When you have multiple hosts or targets configured in separate
34874 directories, you can run @code{make} on them in parallel (for example,
34875 if they are NFS-mounted on each of the hosts); they will not interfere
34876 with each other.
34877
34878 @node Config Names
34879 @section Specifying Names for Hosts and Targets
34880
34881 The specifications used for hosts and targets in the @file{configure}
34882 script are based on a three-part naming scheme, but some short predefined
34883 aliases are also supported.  The full naming scheme encodes three pieces
34884 of information in the following pattern:
34885
34886 @smallexample
34887 @var{architecture}-@var{vendor}-@var{os}
34888 @end smallexample
34889
34890 For example, you can use the alias @code{sun4} as a @var{host} argument,
34891 or as the value for @var{target} in a @code{--target=@var{target}}
34892 option.  The equivalent full name is @samp{sparc-sun-sunos4}.
34893
34894 The @file{configure} script accompanying @value{GDBN} does not provide
34895 any query facility to list all supported host and target names or
34896 aliases.  @file{configure} calls the Bourne shell script
34897 @code{config.sub} to map abbreviations to full names; you can read the
34898 script, if you wish, or you can use it to test your guesses on
34899 abbreviations---for example:
34900
34901 @smallexample
34902 % sh config.sub i386-linux
34903 i386-pc-linux-gnu
34904 % sh config.sub alpha-linux
34905 alpha-unknown-linux-gnu
34906 % sh config.sub hp9k700
34907 hppa1.1-hp-hpux
34908 % sh config.sub sun4
34909 sparc-sun-sunos4.1.1
34910 % sh config.sub sun3
34911 m68k-sun-sunos4.1.1
34912 % sh config.sub i986v
34913 Invalid configuration `i986v': machine `i986v' not recognized
34914 @end smallexample
34915
34916 @noindent
34917 @code{config.sub} is also distributed in the @value{GDBN} source
34918 directory (@file{gdb-@value{GDBVN}}, for version @value{GDBVN}).
34919
34920 @node Configure Options
34921 @section @file{configure} Options
34922
34923 Here is a summary of the @file{configure} options and arguments that
34924 are most often useful for building @value{GDBN}.  @file{configure} also has
34925 several other options not listed here.  @inforef{What Configure
34926 Does,,configure.info}, for a full explanation of @file{configure}.
34927
34928 @smallexample
34929 configure @r{[}--help@r{]}
34930           @r{[}--prefix=@var{dir}@r{]}
34931           @r{[}--exec-prefix=@var{dir}@r{]}
34932           @r{[}--srcdir=@var{dirname}@r{]}
34933           @r{[}--norecursion@r{]} @r{[}--rm@r{]}
34934           @r{[}--target=@var{target}@r{]}
34935           @var{host}
34936 @end smallexample
34937
34938 @noindent
34939 You may introduce options with a single @samp{-} rather than
34940 @samp{--} if you prefer; but you may abbreviate option names if you use
34941 @samp{--}.
34942
34943 @table @code
34944 @item --help
34945 Display a quick summary of how to invoke @file{configure}.
34946
34947 @item --prefix=@var{dir}
34948 Configure the source to install programs and files under directory
34949 @file{@var{dir}}.
34950
34951 @item --exec-prefix=@var{dir}
34952 Configure the source to install programs under directory
34953 @file{@var{dir}}.
34954
34955 @c avoid splitting the warning from the explanation:
34956 @need 2000
34957 @item --srcdir=@var{dirname}
34958 @strong{Warning: using this option requires @sc{gnu} @code{make}, or another
34959 @code{make} that implements the @code{VPATH} feature.}@*
34960 Use this option to make configurations in directories separate from the
34961 @value{GDBN} source directories.  Among other things, you can use this to
34962 build (or maintain) several configurations simultaneously, in separate
34963 directories.  @file{configure} writes configuration-specific files in
34964 the current directory, but arranges for them to use the source in the
34965 directory @var{dirname}.  @file{configure} creates directories under
34966 the working directory in parallel to the source directories below
34967 @var{dirname}.
34968
34969 @item --norecursion
34970 Configure only the directory level where @file{configure} is executed; do not
34971 propagate configuration to subdirectories.
34972
34973 @item --target=@var{target}
34974 Configure @value{GDBN} for cross-debugging programs running on the specified
34975 @var{target}.  Without this option, @value{GDBN} is configured to debug
34976 programs that run on the same machine (@var{host}) as @value{GDBN} itself.
34977
34978 There is no convenient way to generate a list of all available targets.
34979
34980 @item @var{host} @dots{}
34981 Configure @value{GDBN} to run on the specified @var{host}.
34982
34983 There is no convenient way to generate a list of all available hosts.
34984 @end table
34985
34986 There are many other options available as well, but they are generally
34987 needed for special purposes only.
34988
34989 @node System-wide configuration
34990 @section System-wide configuration and settings
34991 @cindex system-wide init file
34992
34993 @value{GDBN} can be configured to have a system-wide init file;
34994 this file will be read and executed at startup (@pxref{Startup, , What
34995 @value{GDBN} does during startup}).
34996
34997 Here is the corresponding configure option:
34998
34999 @table @code
35000 @item --with-system-gdbinit=@var{file}
35001 Specify that the default location of the system-wide init file is
35002 @var{file}.
35003 @end table
35004
35005 If @value{GDBN} has been configured with the option @option{--prefix=$prefix},
35006 it may be subject to relocation.  Two possible cases:
35007
35008 @itemize @bullet
35009 @item 
35010 If the default location of this init file contains @file{$prefix},
35011 it will be subject to relocation.  Suppose that the configure options
35012 are @option{--prefix=$prefix --with-system-gdbinit=$prefix/etc/gdbinit};
35013 if @value{GDBN} is moved from @file{$prefix} to @file{$install}, the system
35014 init file is looked for as @file{$install/etc/gdbinit} instead of
35015 @file{$prefix/etc/gdbinit}.
35016
35017 @item
35018 By contrast, if the default location does not contain the prefix,
35019 it will not be relocated.  E.g.@: if @value{GDBN} has been configured with
35020 @option{--prefix=/usr/local --with-system-gdbinit=/usr/share/gdb/gdbinit},
35021 then @value{GDBN} will always look for @file{/usr/share/gdb/gdbinit},
35022 wherever @value{GDBN} is installed.
35023 @end itemize
35024
35025 If the configured location of the system-wide init file (as given by the
35026 @option{--with-system-gdbinit} option at configure time) is in the
35027 data-directory (as specified by @option{--with-gdb-datadir} at configure
35028 time) or in one of its subdirectories, then @value{GDBN} will look for the
35029 system-wide init file in the directory specified by the
35030 @option{--data-directory} command-line option.
35031 Note that the system-wide init file is only read once, during @value{GDBN}
35032 initialization.  If the data-directory is changed after @value{GDBN} has
35033 started with the @code{set data-directory} command, the file will not be
35034 reread.
35035
35036 @menu
35037 * System-wide Configuration Scripts::  Installed System-wide Configuration Scripts
35038 @end menu
35039
35040 @node System-wide Configuration Scripts
35041 @subsection Installed System-wide Configuration Scripts
35042 @cindex system-wide configuration scripts
35043
35044 The @file{system-gdbinit} directory, located inside the data-directory
35045 (as specified by @option{--with-gdb-datadir} at configure time) contains
35046 a number of scripts which can be used as system-wide init files.  To
35047 automatically source those scripts at startup, @value{GDBN} should be
35048 configured with @option{--with-system-gdbinit}.  Otherwise, any user
35049 should be able to source them by hand as needed.
35050
35051 The following scripts are currently available:
35052 @itemize @bullet
35053
35054 @item @file{elinos.py}
35055 @pindex elinos.py
35056 @cindex ELinOS system-wide configuration script
35057 This script is useful when debugging a program on an ELinOS target.
35058 It takes advantage of the environment variables defined in a standard
35059 ELinOS environment in order to determine the location of the system
35060 shared libraries, and then sets the @samp{solib-absolute-prefix}
35061 and @samp{solib-search-path} variables appropriately.
35062
35063 @item @file{wrs-linux.py}
35064 @pindex wrs-linux.py
35065 @cindex Wind River Linux system-wide configuration script
35066 This script is useful when debugging a program on a target running
35067 Wind River Linux.  It expects the @env{ENV_PREFIX} to be set to
35068 the host-side sysroot used by the target system.
35069
35070 @end itemize
35071
35072 @node Maintenance Commands
35073 @appendix Maintenance Commands
35074 @cindex maintenance commands
35075 @cindex internal commands
35076
35077 In addition to commands intended for @value{GDBN} users, @value{GDBN}
35078 includes a number of commands intended for @value{GDBN} developers,
35079 that are not documented elsewhere in this manual.  These commands are
35080 provided here for reference.  (For commands that turn on debugging
35081 messages, see @ref{Debugging Output}.)
35082
35083 @table @code
35084 @kindex maint agent
35085 @kindex maint agent-eval
35086 @item maint agent @r{[}-at @var{location}@r{,}@r{]} @var{expression}
35087 @itemx maint agent-eval @r{[}-at @var{location}@r{,}@r{]} @var{expression}
35088 Translate the given @var{expression} into remote agent bytecodes.
35089 This command is useful for debugging the Agent Expression mechanism
35090 (@pxref{Agent Expressions}).  The @samp{agent} version produces an
35091 expression useful for data collection, such as by tracepoints, while
35092 @samp{maint agent-eval} produces an expression that evaluates directly
35093 to a result.  For instance, a collection expression for @code{globa +
35094 globb} will include bytecodes to record four bytes of memory at each
35095 of the addresses of @code{globa} and @code{globb}, while discarding
35096 the result of the addition, while an evaluation expression will do the
35097 addition and return the sum.
35098 If @code{-at} is given, generate remote agent bytecode for @var{location}.
35099 If not, generate remote agent bytecode for current frame PC address.
35100
35101 @kindex maint agent-printf
35102 @item maint agent-printf @var{format},@var{expr},...
35103 Translate the given format string and list of argument expressions
35104 into remote agent bytecodes and display them as a disassembled list.
35105 This command is useful for debugging the agent version of dynamic
35106 printf (@pxref{Dynamic Printf}).
35107
35108 @kindex maint info breakpoints
35109 @item @anchor{maint info breakpoints}maint info breakpoints
35110 Using the same format as @samp{info breakpoints}, display both the
35111 breakpoints you've set explicitly, and those @value{GDBN} is using for
35112 internal purposes.  Internal breakpoints are shown with negative
35113 breakpoint numbers.  The type column identifies what kind of breakpoint
35114 is shown:
35115
35116 @table @code
35117 @item breakpoint
35118 Normal, explicitly set breakpoint.
35119
35120 @item watchpoint
35121 Normal, explicitly set watchpoint.
35122
35123 @item longjmp
35124 Internal breakpoint, used to handle correctly stepping through
35125 @code{longjmp} calls.
35126
35127 @item longjmp resume
35128 Internal breakpoint at the target of a @code{longjmp}.
35129
35130 @item until
35131 Temporary internal breakpoint used by the @value{GDBN} @code{until} command.
35132
35133 @item finish
35134 Temporary internal breakpoint used by the @value{GDBN} @code{finish} command.
35135
35136 @item shlib events
35137 Shared library events.
35138
35139 @end table
35140
35141 @kindex maint info btrace
35142 @item maint info btrace
35143 Pint information about raw branch tracing data.
35144
35145 @kindex maint btrace packet-history
35146 @item maint btrace packet-history
35147 Print the raw branch trace packets that are used to compute the
35148 execution history for the @samp{record btrace} command.  Both the
35149 information and the format in which it is printed depend on the btrace
35150 recording format.
35151
35152 @table @code
35153 @item bts
35154 For the BTS recording format, print a list of blocks of sequential
35155 code.  For each block, the following information is printed:
35156
35157 @table @asis
35158 @item Block number
35159 Newer blocks have higher numbers.  The oldest block has number zero.
35160 @item Lowest @samp{PC}
35161 @item Highest @samp{PC}
35162 @end table
35163
35164 @item pt
35165 For the Intel Processor Trace recording format, print a list of
35166 Intel Processor Trace packets.  For each packet, the following
35167 information is printed:
35168
35169 @table @asis
35170 @item Packet number
35171 Newer packets have higher numbers.  The oldest packet has number zero.
35172 @item Trace offset
35173 The packet's offset in the trace stream.
35174 @item Packet opcode and payload
35175 @end table
35176 @end table
35177
35178 @kindex maint btrace clear-packet-history
35179 @item maint btrace clear-packet-history
35180 Discards the cached packet history printed by the @samp{maint btrace
35181 packet-history} command.  The history will be computed again when
35182 needed.
35183
35184 @kindex maint btrace clear
35185 @item maint btrace clear
35186 Discard the branch trace data.  The data will be fetched anew and the
35187 branch trace will be recomputed when needed.
35188
35189 This implicitly truncates the branch trace to a single branch trace
35190 buffer.  When updating branch trace incrementally, the branch trace
35191 available to @value{GDBN} may be bigger than a single branch trace
35192 buffer.
35193
35194 @kindex maint set btrace pt skip-pad
35195 @item maint set btrace pt skip-pad
35196 @kindex maint show btrace pt skip-pad
35197 @item maint show btrace pt skip-pad
35198 Control whether @value{GDBN} will skip PAD packets when computing the
35199 packet history.
35200
35201 @kindex set displaced-stepping
35202 @kindex show displaced-stepping
35203 @cindex displaced stepping support
35204 @cindex out-of-line single-stepping
35205 @item set displaced-stepping
35206 @itemx show displaced-stepping
35207 Control whether or not @value{GDBN} will do @dfn{displaced stepping}
35208 if the target supports it.  Displaced stepping is a way to single-step
35209 over breakpoints without removing them from the inferior, by executing
35210 an out-of-line copy of the instruction that was originally at the
35211 breakpoint location.  It is also known as out-of-line single-stepping.
35212
35213 @table @code
35214 @item set displaced-stepping on
35215 If the target architecture supports it, @value{GDBN} will use
35216 displaced stepping to step over breakpoints.
35217
35218 @item set displaced-stepping off
35219 @value{GDBN} will not use displaced stepping to step over breakpoints,
35220 even if such is supported by the target architecture.
35221
35222 @cindex non-stop mode, and @samp{set displaced-stepping}
35223 @item set displaced-stepping auto
35224 This is the default mode.  @value{GDBN} will use displaced stepping
35225 only if non-stop mode is active (@pxref{Non-Stop Mode}) and the target
35226 architecture supports displaced stepping.
35227 @end table
35228
35229 @kindex maint check-psymtabs
35230 @item maint check-psymtabs
35231 Check the consistency of currently expanded psymtabs versus symtabs.
35232 Use this to check, for example, whether a symbol is in one but not the other.
35233
35234 @kindex maint check-symtabs
35235 @item maint check-symtabs
35236 Check the consistency of currently expanded symtabs.
35237
35238 @kindex maint expand-symtabs
35239 @item maint expand-symtabs [@var{regexp}]
35240 Expand symbol tables.
35241 If @var{regexp} is specified, only expand symbol tables for file
35242 names matching @var{regexp}.
35243
35244 @kindex maint set catch-demangler-crashes
35245 @kindex maint show catch-demangler-crashes
35246 @cindex demangler crashes
35247 @item maint set catch-demangler-crashes [on|off]
35248 @itemx maint show catch-demangler-crashes
35249 Control whether @value{GDBN} should attempt to catch crashes in the
35250 symbol name demangler.  The default is to attempt to catch crashes.
35251 If enabled, the first time a crash is caught, a core file is created,
35252 the offending symbol is displayed and the user is presented with the
35253 option to terminate the current session.
35254
35255 @kindex maint cplus first_component
35256 @item maint cplus first_component @var{name}
35257 Print the first C@t{++} class/namespace component of @var{name}.
35258
35259 @kindex maint cplus namespace
35260 @item maint cplus namespace
35261 Print the list of possible C@t{++} namespaces.
35262
35263 @kindex maint deprecate
35264 @kindex maint undeprecate
35265 @cindex deprecated commands
35266 @item maint deprecate @var{command} @r{[}@var{replacement}@r{]}
35267 @itemx maint undeprecate @var{command}
35268 Deprecate or undeprecate the named @var{command}.  Deprecated commands
35269 cause @value{GDBN} to issue a warning when you use them.  The optional
35270 argument @var{replacement} says which newer command should be used in
35271 favor of the deprecated one; if it is given, @value{GDBN} will mention
35272 the replacement as part of the warning.
35273
35274 @kindex maint dump-me
35275 @item maint dump-me
35276 @cindex @code{SIGQUIT} signal, dump core of @value{GDBN}
35277 Cause a fatal signal in the debugger and force it to dump its core.
35278 This is supported only on systems which support aborting a program
35279 with the @code{SIGQUIT} signal.
35280
35281 @kindex maint internal-error
35282 @kindex maint internal-warning
35283 @kindex maint demangler-warning
35284 @cindex demangler crashes
35285 @item maint internal-error @r{[}@var{message-text}@r{]}
35286 @itemx maint internal-warning @r{[}@var{message-text}@r{]}
35287 @itemx maint demangler-warning @r{[}@var{message-text}@r{]}
35288
35289 Cause @value{GDBN} to call the internal function @code{internal_error},
35290 @code{internal_warning} or @code{demangler_warning} and hence behave
35291 as though an internal problem has been detected.  In addition to
35292 reporting the internal problem, these functions give the user the
35293 opportunity to either quit @value{GDBN} or (for @code{internal_error}
35294 and @code{internal_warning}) create a core file of the current
35295 @value{GDBN} session.
35296
35297 These commands take an optional parameter @var{message-text} that is
35298 used as the text of the error or warning message.
35299
35300 Here's an example of using @code{internal-error}:
35301
35302 @smallexample
35303 (@value{GDBP}) @kbd{maint internal-error testing, 1, 2}
35304 @dots{}/maint.c:121: internal-error: testing, 1, 2
35305 A problem internal to GDB has been detected.  Further
35306 debugging may prove unreliable.
35307 Quit this debugging session? (y or n) @kbd{n}
35308 Create a core file? (y or n) @kbd{n}
35309 (@value{GDBP})
35310 @end smallexample
35311
35312 @cindex @value{GDBN} internal error
35313 @cindex internal errors, control of @value{GDBN} behavior
35314 @cindex demangler crashes
35315
35316 @kindex maint set internal-error
35317 @kindex maint show internal-error
35318 @kindex maint set internal-warning
35319 @kindex maint show internal-warning
35320 @kindex maint set demangler-warning
35321 @kindex maint show demangler-warning
35322 @item maint set internal-error @var{action} [ask|yes|no]
35323 @itemx maint show internal-error @var{action}
35324 @itemx maint set internal-warning @var{action} [ask|yes|no]
35325 @itemx maint show internal-warning @var{action}
35326 @itemx maint set demangler-warning @var{action} [ask|yes|no]
35327 @itemx maint show demangler-warning @var{action}
35328 When @value{GDBN} reports an internal problem (error or warning) it
35329 gives the user the opportunity to both quit @value{GDBN} and create a
35330 core file of the current @value{GDBN} session.  These commands let you
35331 override the default behaviour for each particular @var{action},
35332 described in the table below.
35333
35334 @table @samp
35335 @item quit
35336 You can specify that @value{GDBN} should always (yes) or never (no)
35337 quit.  The default is to ask the user what to do.
35338
35339 @item corefile
35340 You can specify that @value{GDBN} should always (yes) or never (no)
35341 create a core file.  The default is to ask the user what to do.  Note
35342 that there is no @code{corefile} option for @code{demangler-warning}:
35343 demangler warnings always create a core file and this cannot be
35344 disabled.
35345 @end table
35346
35347 @kindex maint packet
35348 @item maint packet @var{text}
35349 If @value{GDBN} is talking to an inferior via the serial protocol,
35350 then this command sends the string @var{text} to the inferior, and
35351 displays the response packet.  @value{GDBN} supplies the initial
35352 @samp{$} character, the terminating @samp{#} character, and the
35353 checksum.
35354
35355 @kindex maint print architecture
35356 @item maint print architecture @r{[}@var{file}@r{]}
35357 Print the entire architecture configuration.  The optional argument
35358 @var{file} names the file where the output goes.
35359
35360 @kindex maint print c-tdesc @r{[}@var{file}@r{]}
35361 @item maint print c-tdesc
35362 Print the target description (@pxref{Target Descriptions}) as
35363 a C source file.  By default, the target description is for the current
35364 target, but if the optional argument @var{file} is provided, that file
35365 is used to produce the description.  The @var{file} should be an XML
35366 document, of the form described in @ref{Target Description Format}.
35367 The created source file is built into @value{GDBN} when @value{GDBN} is
35368 built again.  This command is used by developers after they add or
35369 modify XML target descriptions.
35370
35371 @kindex maint check xml-descriptions
35372 @item maint check xml-descriptions @var{dir}
35373 Check that the target descriptions dynamically created by @value{GDBN}
35374 equal the descriptions created from XML files found in @var{dir}.
35375
35376 @kindex maint print dummy-frames
35377 @item maint print dummy-frames
35378 Prints the contents of @value{GDBN}'s internal dummy-frame stack.
35379
35380 @smallexample
35381 (@value{GDBP}) @kbd{b add}
35382 @dots{}
35383 (@value{GDBP}) @kbd{print add(2,3)}
35384 Breakpoint 2, add (a=2, b=3) at @dots{}
35385 58        return (a + b);
35386 The program being debugged stopped while in a function called from GDB.
35387 @dots{}
35388 (@value{GDBP}) @kbd{maint print dummy-frames}
35389 0xa8206d8: id=@{stack=0xbfffe734,code=0xbfffe73f,!special@}, ptid=process 9353
35390 (@value{GDBP})
35391 @end smallexample
35392
35393 Takes an optional file parameter.
35394
35395 @kindex maint print registers
35396 @kindex maint print raw-registers
35397 @kindex maint print cooked-registers
35398 @kindex maint print register-groups
35399 @kindex maint print remote-registers
35400 @item maint print registers @r{[}@var{file}@r{]}
35401 @itemx maint print raw-registers @r{[}@var{file}@r{]}
35402 @itemx maint print cooked-registers @r{[}@var{file}@r{]}
35403 @itemx maint print register-groups @r{[}@var{file}@r{]}
35404 @itemx maint print remote-registers @r{[}@var{file}@r{]}
35405 Print @value{GDBN}'s internal register data structures.
35406
35407 The command @code{maint print raw-registers} includes the contents of
35408 the raw register cache; the command @code{maint print
35409 cooked-registers} includes the (cooked) value of all registers,
35410 including registers which aren't available on the target nor visible
35411 to user; the command @code{maint print register-groups} includes the
35412 groups that each register is a member of; and the command @code{maint
35413 print remote-registers} includes the remote target's register numbers
35414 and offsets in the `G' packets.
35415
35416 These commands take an optional parameter, a file name to which to
35417 write the information.
35418
35419 @kindex maint print reggroups
35420 @item maint print reggroups @r{[}@var{file}@r{]}
35421 Print @value{GDBN}'s internal register group data structures.  The
35422 optional argument @var{file} tells to what file to write the
35423 information.
35424
35425 The register groups info looks like this:
35426
35427 @smallexample
35428 (@value{GDBP}) @kbd{maint print reggroups}
35429  Group      Type
35430  general    user
35431  float      user
35432  all        user
35433  vector     user
35434  system     user
35435  save       internal
35436  restore    internal
35437 @end smallexample
35438
35439 @kindex flushregs
35440 @item flushregs
35441 This command forces @value{GDBN} to flush its internal register cache.
35442
35443 @kindex maint print objfiles
35444 @cindex info for known object files
35445 @item maint print objfiles @r{[}@var{regexp}@r{]}
35446 Print a dump of all known object files.
35447 If @var{regexp} is specified, only print object files whose names
35448 match @var{regexp}.  For each object file, this command prints its name,
35449 address in memory, and all of its psymtabs and symtabs.
35450
35451 @kindex maint print user-registers
35452 @cindex user registers
35453 @item maint print user-registers
35454 List all currently available @dfn{user registers}.  User registers
35455 typically provide alternate names for actual hardware registers.  They
35456 include the four ``standard'' registers @code{$fp}, @code{$pc},
35457 @code{$sp}, and @code{$ps}.  @xref{standard registers}.  User
35458 registers can be used in expressions in the same way as the canonical
35459 register names, but only the latter are listed by the @code{info
35460 registers} and @code{maint print registers} commands.
35461
35462 @kindex maint print section-scripts
35463 @cindex info for known .debug_gdb_scripts-loaded scripts
35464 @item maint print section-scripts [@var{regexp}]
35465 Print a dump of scripts specified in the @code{.debug_gdb_section} section.
35466 If @var{regexp} is specified, only print scripts loaded by object files
35467 matching @var{regexp}.
35468 For each script, this command prints its name as specified in the objfile,
35469 and the full path if known.
35470 @xref{dotdebug_gdb_scripts section}.
35471
35472 @kindex maint print statistics
35473 @cindex bcache statistics
35474 @item maint print statistics
35475 This command prints, for each object file in the program, various data
35476 about that object file followed by the byte cache (@dfn{bcache})
35477 statistics for the object file.  The objfile data includes the number
35478 of minimal, partial, full, and stabs symbols, the number of types
35479 defined by the objfile, the number of as yet unexpanded psym tables,
35480 the number of line tables and string tables, and the amount of memory
35481 used by the various tables.  The bcache statistics include the counts,
35482 sizes, and counts of duplicates of all and unique objects, max,
35483 average, and median entry size, total memory used and its overhead and
35484 savings, and various measures of the hash table size and chain
35485 lengths.
35486
35487 @kindex maint print target-stack
35488 @cindex target stack description
35489 @item maint print target-stack
35490 A @dfn{target} is an interface between the debugger and a particular
35491 kind of file or process.  Targets can be stacked in @dfn{strata},
35492 so that more than one target can potentially respond to a request.
35493 In particular, memory accesses will walk down the stack of targets
35494 until they find a target that is interested in handling that particular
35495 address.
35496
35497 This command prints a short description of each layer that was pushed on
35498 the @dfn{target stack}, starting from the top layer down to the bottom one.
35499
35500 @kindex maint print type
35501 @cindex type chain of a data type
35502 @item maint print type @var{expr}
35503 Print the type chain for a type specified by @var{expr}.  The argument
35504 can be either a type name or a symbol.  If it is a symbol, the type of
35505 that symbol is described.  The type chain produced by this command is
35506 a recursive definition of the data type as stored in @value{GDBN}'s
35507 data structures, including its flags and contained types.
35508
35509 @kindex maint selftest
35510 @cindex self tests
35511 @item maint selftest @r{[}@var{filter}@r{]}
35512 Run any self tests that were compiled in to @value{GDBN}.  This will
35513 print a message showing how many tests were run, and how many failed.
35514 If a @var{filter} is passed, only the tests with @var{filter} in their
35515 name will by ran.
35516
35517 @kindex "maint info selftests"
35518 @cindex self tests
35519 @item maint info selftests
35520 List the selftests compiled in to @value{GDBN}.
35521
35522 @kindex maint set dwarf always-disassemble
35523 @kindex maint show dwarf always-disassemble
35524 @item maint set dwarf always-disassemble
35525 @item maint show dwarf always-disassemble
35526 Control the behavior of @code{info address} when using DWARF debugging
35527 information.
35528
35529 The default is @code{off}, which means that @value{GDBN} should try to
35530 describe a variable's location in an easily readable format.  When
35531 @code{on}, @value{GDBN} will instead display the DWARF location
35532 expression in an assembly-like format.  Note that some locations are
35533 too complex for @value{GDBN} to describe simply; in this case you will
35534 always see the disassembly form.
35535
35536 Here is an example of the resulting disassembly:
35537
35538 @smallexample
35539 (gdb) info addr argc
35540 Symbol "argc" is a complex DWARF expression:
35541      1: DW_OP_fbreg 0
35542 @end smallexample
35543
35544 For more information on these expressions, see
35545 @uref{http://www.dwarfstd.org/, the DWARF standard}.
35546
35547 @kindex maint set dwarf max-cache-age
35548 @kindex maint show dwarf max-cache-age
35549 @item maint set dwarf max-cache-age
35550 @itemx maint show dwarf max-cache-age
35551 Control the DWARF compilation unit cache.
35552
35553 @cindex DWARF compilation units cache
35554 In object files with inter-compilation-unit references, such as those
35555 produced by the GCC option @samp{-feliminate-dwarf2-dups}, the DWARF
35556 reader needs to frequently refer to previously read compilation units.
35557 This setting controls how long a compilation unit will remain in the
35558 cache if it is not referenced.  A higher limit means that cached
35559 compilation units will be stored in memory longer, and more total
35560 memory will be used.  Setting it to zero disables caching, which will
35561 slow down @value{GDBN} startup, but reduce memory consumption.
35562
35563 @kindex maint set profile
35564 @kindex maint show profile
35565 @cindex profiling GDB
35566 @item maint set profile
35567 @itemx maint show profile
35568 Control profiling of @value{GDBN}.
35569
35570 Profiling will be disabled until you use the @samp{maint set profile}
35571 command to enable it.  When you enable profiling, the system will begin
35572 collecting timing and execution count data; when you disable profiling or
35573 exit @value{GDBN}, the results will be written to a log file.  Remember that
35574 if you use profiling, @value{GDBN} will overwrite the profiling log file
35575 (often called @file{gmon.out}).  If you have a record of important profiling
35576 data in a @file{gmon.out} file, be sure to move it to a safe location.
35577
35578 Configuring with @samp{--enable-profiling} arranges for @value{GDBN} to be
35579 compiled with the @samp{-pg} compiler option.
35580
35581 @kindex maint set show-debug-regs
35582 @kindex maint show show-debug-regs
35583 @cindex hardware debug registers
35584 @item maint set show-debug-regs
35585 @itemx maint show show-debug-regs
35586 Control whether to show variables that mirror the hardware debug
35587 registers.  Use @code{on} to enable, @code{off} to disable.  If
35588 enabled, the debug registers values are shown when @value{GDBN} inserts or
35589 removes a hardware breakpoint or watchpoint, and when the inferior
35590 triggers a hardware-assisted breakpoint or watchpoint.
35591
35592 @kindex maint set show-all-tib
35593 @kindex maint show show-all-tib
35594 @item maint set show-all-tib
35595 @itemx maint show show-all-tib
35596 Control whether to show all non zero areas within a 1k block starting
35597 at thread local base, when using the @samp{info w32 thread-information-block}
35598 command.
35599
35600 @kindex maint set target-async
35601 @kindex maint show target-async
35602 @item maint set target-async
35603 @itemx maint show target-async
35604 This controls whether @value{GDBN} targets operate in synchronous or
35605 asynchronous mode (@pxref{Background Execution}).  Normally the
35606 default is asynchronous, if it is available; but this can be changed
35607 to more easily debug problems occurring only in synchronous mode.
35608
35609 @kindex maint set target-non-stop @var{mode} [on|off|auto]
35610 @kindex maint show target-non-stop
35611 @item maint set target-non-stop
35612 @itemx maint show target-non-stop
35613
35614 This controls whether @value{GDBN} targets always operate in non-stop
35615 mode even if @code{set non-stop} is @code{off} (@pxref{Non-Stop
35616 Mode}).  The default is @code{auto}, meaning non-stop mode is enabled
35617 if supported by the target.
35618
35619 @table @code
35620 @item maint set target-non-stop auto
35621 This is the default mode.  @value{GDBN} controls the target in
35622 non-stop mode if the target supports it.
35623
35624 @item maint set target-non-stop on
35625 @value{GDBN} controls the target in non-stop mode even if the target
35626 does not indicate support.
35627
35628 @item maint set target-non-stop off
35629 @value{GDBN} does not control the target in non-stop mode even if the
35630 target supports it.
35631 @end table
35632
35633 @kindex maint set per-command
35634 @kindex maint show per-command
35635 @item maint set per-command
35636 @itemx maint show per-command
35637 @cindex resources used by commands
35638
35639 @value{GDBN} can display the resources used by each command.
35640 This is useful in debugging performance problems.
35641
35642 @table @code
35643 @item maint set per-command space [on|off]
35644 @itemx maint show per-command space
35645 Enable or disable the printing of the memory used by GDB for each command.
35646 If enabled, @value{GDBN} will display how much memory each command
35647 took, following the command's own output.
35648 This can also be requested by invoking @value{GDBN} with the
35649 @option{--statistics} command-line switch (@pxref{Mode Options}).
35650
35651 @item maint set per-command time [on|off]
35652 @itemx maint show per-command time
35653 Enable or disable the printing of the execution time of @value{GDBN}
35654 for each command.
35655 If enabled, @value{GDBN} will display how much time it
35656 took to execute each command, following the command's own output.
35657 Both CPU time and wallclock time are printed.
35658 Printing both is useful when trying to determine whether the cost is
35659 CPU or, e.g., disk/network latency.
35660 Note that the CPU time printed is for @value{GDBN} only, it does not include
35661 the execution time of the inferior because there's no mechanism currently
35662 to compute how much time was spent by @value{GDBN} and how much time was
35663 spent by the program been debugged.
35664 This can also be requested by invoking @value{GDBN} with the
35665 @option{--statistics} command-line switch (@pxref{Mode Options}).
35666
35667 @item maint set per-command symtab [on|off]
35668 @itemx maint show per-command symtab
35669 Enable or disable the printing of basic symbol table statistics
35670 for each command.
35671 If enabled, @value{GDBN} will display the following information:
35672
35673 @enumerate a
35674 @item
35675 number of symbol tables
35676 @item
35677 number of primary symbol tables
35678 @item
35679 number of blocks in the blockvector
35680 @end enumerate
35681 @end table
35682
35683 @kindex maint space
35684 @cindex memory used by commands
35685 @item maint space @var{value}
35686 An alias for @code{maint set per-command space}.
35687 A non-zero value enables it, zero disables it.
35688
35689 @kindex maint time
35690 @cindex time of command execution
35691 @item maint time @var{value}
35692 An alias for @code{maint set per-command time}.
35693 A non-zero value enables it, zero disables it.
35694
35695 @kindex maint translate-address
35696 @item maint translate-address @r{[}@var{section}@r{]} @var{addr}
35697 Find the symbol stored at the location specified by the address
35698 @var{addr} and an optional section name @var{section}.  If found,
35699 @value{GDBN} prints the name of the closest symbol and an offset from
35700 the symbol's location to the specified address.  This is similar to
35701 the @code{info address} command (@pxref{Symbols}), except that this
35702 command also allows to find symbols in other sections.
35703
35704 If section was not specified, the section in which the symbol was found
35705 is also printed.  For dynamically linked executables, the name of
35706 executable or shared library containing the symbol is printed as well.
35707
35708 @end table
35709
35710 The following command is useful for non-interactive invocations of
35711 @value{GDBN}, such as in the test suite.
35712
35713 @table @code
35714 @item set watchdog @var{nsec}
35715 @kindex set watchdog
35716 @cindex watchdog timer
35717 @cindex timeout for commands
35718 Set the maximum number of seconds @value{GDBN} will wait for the
35719 target operation to finish.  If this time expires, @value{GDBN}
35720 reports and error and the command is aborted.
35721
35722 @item show watchdog
35723 Show the current setting of the target wait timeout.
35724 @end table
35725
35726 @node Remote Protocol
35727 @appendix @value{GDBN} Remote Serial Protocol
35728
35729 @menu
35730 * Overview::
35731 * Packets::
35732 * Stop Reply Packets::
35733 * General Query Packets::
35734 * Architecture-Specific Protocol Details::
35735 * Tracepoint Packets::
35736 * Host I/O Packets::
35737 * Interrupts::
35738 * Notification Packets::
35739 * Remote Non-Stop::
35740 * Packet Acknowledgment::
35741 * Examples::
35742 * File-I/O Remote Protocol Extension::
35743 * Library List Format::
35744 * Library List Format for SVR4 Targets::
35745 * Memory Map Format::
35746 * Thread List Format::
35747 * Traceframe Info Format::
35748 * Branch Trace Format::
35749 * Branch Trace Configuration Format::
35750 @end menu
35751
35752 @node Overview
35753 @section Overview
35754
35755 There may be occasions when you need to know something about the
35756 protocol---for example, if there is only one serial port to your target
35757 machine, you might want your program to do something special if it
35758 recognizes a packet meant for @value{GDBN}.
35759
35760 In the examples below, @samp{->} and @samp{<-} are used to indicate
35761 transmitted and received data, respectively.
35762
35763 @cindex protocol, @value{GDBN} remote serial
35764 @cindex serial protocol, @value{GDBN} remote
35765 @cindex remote serial protocol
35766 All @value{GDBN} commands and responses (other than acknowledgments
35767 and notifications, see @ref{Notification Packets}) are sent as a
35768 @var{packet}.  A @var{packet} is introduced with the character
35769 @samp{$}, the actual @var{packet-data}, and the terminating character
35770 @samp{#} followed by a two-digit @var{checksum}:
35771
35772 @smallexample
35773 @code{$}@var{packet-data}@code{#}@var{checksum}
35774 @end smallexample
35775 @noindent
35776
35777 @cindex checksum, for @value{GDBN} remote
35778 @noindent
35779 The two-digit @var{checksum} is computed as the modulo 256 sum of all
35780 characters between the leading @samp{$} and the trailing @samp{#} (an
35781 eight bit unsigned checksum).
35782
35783 Implementors should note that prior to @value{GDBN} 5.0 the protocol
35784 specification also included an optional two-digit @var{sequence-id}:
35785
35786 @smallexample
35787 @code{$}@var{sequence-id}@code{:}@var{packet-data}@code{#}@var{checksum}
35788 @end smallexample
35789
35790 @cindex sequence-id, for @value{GDBN} remote
35791 @noindent
35792 That @var{sequence-id} was appended to the acknowledgment.  @value{GDBN}
35793 has never output @var{sequence-id}s.  Stubs that handle packets added
35794 since @value{GDBN} 5.0 must not accept @var{sequence-id}.
35795
35796 When either the host or the target machine receives a packet, the first
35797 response expected is an acknowledgment: either @samp{+} (to indicate
35798 the package was received correctly) or @samp{-} (to request
35799 retransmission):
35800
35801 @smallexample
35802 -> @code{$}@var{packet-data}@code{#}@var{checksum}
35803 <- @code{+}
35804 @end smallexample
35805 @noindent
35806
35807 The @samp{+}/@samp{-} acknowledgments can be disabled
35808 once a connection is established.
35809 @xref{Packet Acknowledgment}, for details.
35810
35811 The host (@value{GDBN}) sends @var{command}s, and the target (the
35812 debugging stub incorporated in your program) sends a @var{response}.  In
35813 the case of step and continue @var{command}s, the response is only sent
35814 when the operation has completed, and the target has again stopped all
35815 threads in all attached processes.  This is the default all-stop mode
35816 behavior, but the remote protocol also supports @value{GDBN}'s non-stop 
35817 execution mode; see @ref{Remote Non-Stop}, for details.
35818
35819 @var{packet-data} consists of a sequence of characters with the
35820 exception of @samp{#} and @samp{$} (see @samp{X} packet for additional
35821 exceptions).
35822
35823 @cindex remote protocol, field separator
35824 Fields within the packet should be separated using @samp{,} @samp{;} or
35825 @samp{:}.  Except where otherwise noted all numbers are represented in
35826 @sc{hex} with leading zeros suppressed.
35827
35828 Implementors should note that prior to @value{GDBN} 5.0, the character
35829 @samp{:} could not appear as the third character in a packet (as it
35830 would potentially conflict with the @var{sequence-id}).
35831
35832 @cindex remote protocol, binary data
35833 @anchor{Binary Data}
35834 Binary data in most packets is encoded either as two hexadecimal
35835 digits per byte of binary data.  This allowed the traditional remote
35836 protocol to work over connections which were only seven-bit clean.
35837 Some packets designed more recently assume an eight-bit clean
35838 connection, and use a more efficient encoding to send and receive
35839 binary data.
35840
35841 The binary data representation uses @code{7d} (@sc{ascii} @samp{@}})
35842 as an escape character.  Any escaped byte is transmitted as the escape
35843 character followed by the original character XORed with @code{0x20}.
35844 For example, the byte @code{0x7d} would be transmitted as the two
35845 bytes @code{0x7d 0x5d}.  The bytes @code{0x23} (@sc{ascii} @samp{#}),
35846 @code{0x24} (@sc{ascii} @samp{$}), and @code{0x7d} (@sc{ascii}
35847 @samp{@}}) must always be escaped.  Responses sent by the stub
35848 must also escape @code{0x2a} (@sc{ascii} @samp{*}), so that it
35849 is not interpreted as the start of a run-length encoded sequence
35850 (described next).
35851
35852 Response @var{data} can be run-length encoded to save space.
35853 Run-length encoding replaces runs of identical characters with one
35854 instance of the repeated character, followed by a @samp{*} and a
35855 repeat count.  The repeat count is itself sent encoded, to avoid
35856 binary characters in @var{data}: a value of @var{n} is sent as
35857 @code{@var{n}+29}.  For a repeat count greater or equal to 3, this
35858 produces a printable @sc{ascii} character, e.g.@: a space (@sc{ascii}
35859 code 32) for a repeat count of 3.  (This is because run-length
35860 encoding starts to win for counts 3 or more.)  Thus, for example,
35861 @samp{0* } is a run-length encoding of ``0000'': the space character
35862 after @samp{*} means repeat the leading @code{0} @w{@code{32 - 29 =
35863 3}} more times.
35864
35865 The printable characters @samp{#} and @samp{$} or with a numeric value
35866 greater than 126 must not be used.  Runs of six repeats (@samp{#}) or
35867 seven repeats (@samp{$}) can be expanded using a repeat count of only
35868 five (@samp{"}).  For example, @samp{00000000} can be encoded as
35869 @samp{0*"00}.
35870
35871 The error response returned for some packets includes a two character
35872 error number.  That number is not well defined.
35873
35874 @cindex empty response, for unsupported packets
35875 For any @var{command} not supported by the stub, an empty response
35876 (@samp{$#00}) should be returned.  That way it is possible to extend the
35877 protocol.  A newer @value{GDBN} can tell if a packet is supported based
35878 on that response.
35879
35880 At a minimum, a stub is required to support the @samp{g} and @samp{G}
35881 commands for register access, and the @samp{m} and @samp{M} commands
35882 for memory access.  Stubs that only control single-threaded targets
35883 can implement run control with the @samp{c} (continue), and @samp{s}
35884 (step) commands.  Stubs that support multi-threading targets should
35885 support the @samp{vCont} command.  All other commands are optional.
35886
35887 @node Packets
35888 @section Packets
35889
35890 The following table provides a complete list of all currently defined
35891 @var{command}s and their corresponding response @var{data}.
35892 @xref{File-I/O Remote Protocol Extension}, for details about the File
35893 I/O extension of the remote protocol.
35894
35895 Each packet's description has a template showing the packet's overall
35896 syntax, followed by an explanation of the packet's meaning.  We
35897 include spaces in some of the templates for clarity; these are not
35898 part of the packet's syntax.  No @value{GDBN} packet uses spaces to
35899 separate its components.  For example, a template like @samp{foo
35900 @var{bar} @var{baz}} describes a packet beginning with the three ASCII
35901 bytes @samp{foo}, followed by a @var{bar}, followed directly by a
35902 @var{baz}.  @value{GDBN} does not transmit a space character between the
35903 @samp{foo} and the @var{bar}, or between the @var{bar} and the
35904 @var{baz}.
35905
35906 @cindex @var{thread-id}, in remote protocol
35907 @anchor{thread-id syntax} 
35908 Several packets and replies include a @var{thread-id} field to identify
35909 a thread.  Normally these are positive numbers with a target-specific
35910 interpretation, formatted as big-endian hex strings.  A @var{thread-id}
35911 can also be a literal @samp{-1} to indicate all threads, or @samp{0} to
35912 pick any thread.
35913
35914 In addition, the remote protocol supports a multiprocess feature in
35915 which the @var{thread-id} syntax is extended to optionally include both
35916 process and thread ID fields, as @samp{p@var{pid}.@var{tid}}.
35917 The @var{pid} (process) and @var{tid} (thread) components each have the
35918 format described above: a positive number with target-specific
35919 interpretation formatted as a big-endian hex string, literal @samp{-1}
35920 to indicate all processes or threads (respectively), or @samp{0} to
35921 indicate an arbitrary process or thread.  Specifying just a process, as
35922 @samp{p@var{pid}}, is equivalent to @samp{p@var{pid}.-1}.  It is an
35923 error to specify all processes but a specific thread, such as
35924 @samp{p-1.@var{tid}}.  Note that the @samp{p} prefix is @emph{not} used
35925 for those packets and replies explicitly documented to include a process
35926 ID, rather than a @var{thread-id}.
35927
35928 The multiprocess @var{thread-id} syntax extensions are only used if both
35929 @value{GDBN} and the stub report support for the @samp{multiprocess}
35930 feature using @samp{qSupported}.  @xref{multiprocess extensions}, for
35931 more information.
35932
35933 Note that all packet forms beginning with an upper- or lower-case
35934 letter, other than those described here, are reserved for future use.
35935
35936 Here are the packet descriptions.
35937
35938 @table @samp
35939
35940 @item !
35941 @cindex @samp{!} packet
35942 @anchor{extended mode}
35943 Enable extended mode.  In extended mode, the remote server is made
35944 persistent.  The @samp{R} packet is used to restart the program being
35945 debugged.
35946
35947 Reply:
35948 @table @samp
35949 @item OK
35950 The remote target both supports and has enabled extended mode.
35951 @end table
35952
35953 @item ?
35954 @cindex @samp{?} packet
35955 @anchor{? packet}
35956 Indicate the reason the target halted.  The reply is the same as for
35957 step and continue.  This packet has a special interpretation when the
35958 target is in non-stop mode; see @ref{Remote Non-Stop}.
35959
35960 Reply:
35961 @xref{Stop Reply Packets}, for the reply specifications.
35962
35963 @item A @var{arglen},@var{argnum},@var{arg},@dots{}
35964 @cindex @samp{A} packet
35965 Initialized @code{argv[]} array passed into program. @var{arglen}
35966 specifies the number of bytes in the hex encoded byte stream
35967 @var{arg}.  See @code{gdbserver} for more details.
35968
35969 Reply:
35970 @table @samp
35971 @item OK
35972 The arguments were set.
35973 @item E @var{NN}
35974 An error occurred.
35975 @end table
35976
35977 @item b @var{baud}
35978 @cindex @samp{b} packet
35979 (Don't use this packet; its behavior is not well-defined.)
35980 Change the serial line speed to @var{baud}.
35981
35982 JTC: @emph{When does the transport layer state change?  When it's
35983 received, or after the ACK is transmitted.  In either case, there are
35984 problems if the command or the acknowledgment packet is dropped.}
35985
35986 Stan: @emph{If people really wanted to add something like this, and get
35987 it working for the first time, they ought to modify ser-unix.c to send
35988 some kind of out-of-band message to a specially-setup stub and have the
35989 switch happen "in between" packets, so that from remote protocol's point
35990 of view, nothing actually happened.}
35991
35992 @item B @var{addr},@var{mode}
35993 @cindex @samp{B} packet
35994 Set (@var{mode} is @samp{S}) or clear (@var{mode} is @samp{C}) a
35995 breakpoint at @var{addr}.
35996
35997 Don't use this packet.  Use the @samp{Z} and @samp{z} packets instead
35998 (@pxref{insert breakpoint or watchpoint packet}).
35999
36000 @cindex @samp{bc} packet
36001 @anchor{bc}
36002 @item bc
36003 Backward continue.  Execute the target system in reverse.  No parameter.
36004 @xref{Reverse Execution}, for more information.
36005
36006 Reply:
36007 @xref{Stop Reply Packets}, for the reply specifications.
36008
36009 @cindex @samp{bs} packet
36010 @anchor{bs}
36011 @item bs
36012 Backward single step.  Execute one instruction in reverse.  No parameter.
36013 @xref{Reverse Execution}, for more information.
36014
36015 Reply:
36016 @xref{Stop Reply Packets}, for the reply specifications.
36017
36018 @item c @r{[}@var{addr}@r{]}
36019 @cindex @samp{c} packet
36020 Continue at @var{addr}, which is the address to resume.  If @var{addr}
36021 is omitted, resume at current address.
36022
36023 This packet is deprecated for multi-threading support.  @xref{vCont
36024 packet}.
36025
36026 Reply:
36027 @xref{Stop Reply Packets}, for the reply specifications.
36028
36029 @item C @var{sig}@r{[};@var{addr}@r{]}
36030 @cindex @samp{C} packet
36031 Continue with signal @var{sig} (hex signal number).  If
36032 @samp{;@var{addr}} is omitted, resume at same address.
36033
36034 This packet is deprecated for multi-threading support.  @xref{vCont
36035 packet}.
36036
36037 Reply:
36038 @xref{Stop Reply Packets}, for the reply specifications.
36039
36040 @item d
36041 @cindex @samp{d} packet
36042 Toggle debug flag.
36043
36044 Don't use this packet; instead, define a general set packet
36045 (@pxref{General Query Packets}).
36046
36047 @item D
36048 @itemx D;@var{pid}
36049 @cindex @samp{D} packet
36050 The first form of the packet is used to detach @value{GDBN} from the 
36051 remote system.  It is sent to the remote target
36052 before @value{GDBN} disconnects via the @code{detach} command.
36053
36054 The second form, including a process ID, is used when multiprocess
36055 protocol extensions are enabled (@pxref{multiprocess extensions}), to
36056 detach only a specific process.  The @var{pid} is specified as a
36057 big-endian hex string.
36058
36059 Reply:
36060 @table @samp
36061 @item OK
36062 for success
36063 @item E @var{NN}
36064 for an error
36065 @end table
36066
36067 @item F @var{RC},@var{EE},@var{CF};@var{XX}
36068 @cindex @samp{F} packet
36069 A reply from @value{GDBN} to an @samp{F} packet sent by the target.
36070 This is part of the File-I/O protocol extension.  @xref{File-I/O
36071 Remote Protocol Extension}, for the specification.
36072
36073 @item g
36074 @anchor{read registers packet}
36075 @cindex @samp{g} packet
36076 Read general registers.
36077
36078 Reply:
36079 @table @samp
36080 @item @var{XX@dots{}}
36081 Each byte of register data is described by two hex digits.  The bytes
36082 with the register are transmitted in target byte order.  The size of
36083 each register and their position within the @samp{g} packet are
36084 determined by the @value{GDBN} internal gdbarch functions
36085 @code{DEPRECATED_REGISTER_RAW_SIZE} and @code{gdbarch_register_name}.
36086
36087 When reading registers from a trace frame (@pxref{Analyze Collected
36088 Data,,Using the Collected Data}), the stub may also return a string of
36089 literal @samp{x}'s in place of the register data digits, to indicate
36090 that the corresponding register has not been collected, thus its value
36091 is unavailable.  For example, for an architecture with 4 registers of
36092 4 bytes each, the following reply indicates to @value{GDBN} that
36093 registers 0 and 2 have not been collected, while registers 1 and 3
36094 have been collected, and both have zero value:
36095
36096 @smallexample
36097 -> @code{g}
36098 <- @code{xxxxxxxx00000000xxxxxxxx00000000}
36099 @end smallexample
36100
36101 @item E @var{NN}
36102 for an error.
36103 @end table
36104
36105 @item G @var{XX@dots{}}
36106 @cindex @samp{G} packet
36107 Write general registers.  @xref{read registers packet}, for a
36108 description of the @var{XX@dots{}} data.
36109
36110 Reply:
36111 @table @samp
36112 @item OK
36113 for success
36114 @item E @var{NN}
36115 for an error
36116 @end table
36117
36118 @item H @var{op} @var{thread-id}
36119 @cindex @samp{H} packet
36120 Set thread for subsequent operations (@samp{m}, @samp{M}, @samp{g},
36121 @samp{G}, et.al.).  Depending on the operation to be performed, @var{op}
36122 should be @samp{c} for step and continue operations (note that this
36123 is deprecated, supporting the @samp{vCont} command is a better
36124 option), and @samp{g} for other operations.  The thread designator
36125 @var{thread-id} has the format and interpretation described in
36126 @ref{thread-id syntax}.
36127
36128 Reply:
36129 @table @samp
36130 @item OK
36131 for success
36132 @item E @var{NN}
36133 for an error
36134 @end table
36135
36136 @c FIXME: JTC:
36137 @c   'H': How restrictive (or permissive) is the thread model.  If a
36138 @c        thread is selected and stopped, are other threads allowed
36139 @c        to continue to execute?  As I mentioned above, I think the
36140 @c        semantics of each command when a thread is selected must be
36141 @c        described.  For example:
36142 @c
36143 @c        'g':    If the stub supports threads and a specific thread is
36144 @c                selected, returns the register block from that thread;
36145 @c                otherwise returns current registers.
36146 @c
36147 @c        'G'     If the stub supports threads and a specific thread is
36148 @c                selected, sets the registers of the register block of
36149 @c                that thread; otherwise sets current registers.
36150
36151 @item i @r{[}@var{addr}@r{[},@var{nnn}@r{]]}
36152 @anchor{cycle step packet}
36153 @cindex @samp{i} packet
36154 Step the remote target by a single clock cycle.  If @samp{,@var{nnn}} is
36155 present, cycle step @var{nnn} cycles.  If @var{addr} is present, cycle
36156 step starting at that address.
36157
36158 @item I
36159 @cindex @samp{I} packet
36160 Signal, then cycle step.  @xref{step with signal packet}.  @xref{cycle
36161 step packet}.
36162
36163 @item k
36164 @cindex @samp{k} packet
36165 Kill request.
36166
36167 The exact effect of this packet is not specified.
36168
36169 For a bare-metal target, it may power cycle or reset the target
36170 system.  For that reason, the @samp{k} packet has no reply.
36171
36172 For a single-process target, it may kill that process if possible.
36173
36174 A multiple-process target may choose to kill just one process, or all
36175 that are under @value{GDBN}'s control.  For more precise control, use
36176 the vKill packet (@pxref{vKill packet}).
36177
36178 If the target system immediately closes the connection in response to
36179 @samp{k}, @value{GDBN} does not consider the lack of packet
36180 acknowledgment to be an error, and assumes the kill was successful.
36181
36182 If connected using @kbd{target extended-remote}, and the target does
36183 not close the connection in response to a kill request, @value{GDBN}
36184 probes the target state as if a new connection was opened
36185 (@pxref{? packet}).
36186
36187 @item m @var{addr},@var{length}
36188 @cindex @samp{m} packet
36189 Read @var{length} addressable memory units starting at address @var{addr}
36190 (@pxref{addressable memory unit}).  Note that @var{addr} may not be aligned to
36191 any particular boundary.
36192
36193 The stub need not use any particular size or alignment when gathering
36194 data from memory for the response; even if @var{addr} is word-aligned
36195 and @var{length} is a multiple of the word size, the stub is free to
36196 use byte accesses, or not.  For this reason, this packet may not be
36197 suitable for accessing memory-mapped I/O devices.
36198 @cindex alignment of remote memory accesses
36199 @cindex size of remote memory accesses
36200 @cindex memory, alignment and size of remote accesses
36201
36202 Reply:
36203 @table @samp
36204 @item @var{XX@dots{}}
36205 Memory contents; each byte is transmitted as a two-digit hexadecimal number.
36206 The reply may contain fewer addressable memory units than requested if the
36207 server was able to read only part of the region of memory.
36208 @item E @var{NN}
36209 @var{NN} is errno
36210 @end table
36211
36212 @item M @var{addr},@var{length}:@var{XX@dots{}}
36213 @cindex @samp{M} packet
36214 Write @var{length} addressable memory units starting at address @var{addr}
36215 (@pxref{addressable memory unit}).  The data is given by @var{XX@dots{}}; each
36216 byte is transmitted as a two-digit hexadecimal number.
36217
36218 Reply:
36219 @table @samp
36220 @item OK
36221 for success
36222 @item E @var{NN}
36223 for an error (this includes the case where only part of the data was
36224 written).
36225 @end table
36226
36227 @item p @var{n}
36228 @cindex @samp{p} packet
36229 Read the value of register @var{n}; @var{n} is in hex.
36230 @xref{read registers packet}, for a description of how the returned
36231 register value is encoded.
36232
36233 Reply:
36234 @table @samp
36235 @item @var{XX@dots{}}
36236 the register's value
36237 @item E @var{NN}
36238 for an error
36239 @item @w{}
36240 Indicating an unrecognized @var{query}.
36241 @end table
36242
36243 @item P @var{n@dots{}}=@var{r@dots{}}
36244 @anchor{write register packet}
36245 @cindex @samp{P} packet
36246 Write register @var{n@dots{}} with value @var{r@dots{}}.  The register
36247 number @var{n} is in hexadecimal, and @var{r@dots{}} contains two hex
36248 digits for each byte in the register (target byte order).
36249
36250 Reply:
36251 @table @samp
36252 @item OK
36253 for success
36254 @item E @var{NN}
36255 for an error
36256 @end table
36257
36258 @item q @var{name} @var{params}@dots{}
36259 @itemx Q @var{name} @var{params}@dots{}
36260 @cindex @samp{q} packet
36261 @cindex @samp{Q} packet
36262 General query (@samp{q}) and set (@samp{Q}).  These packets are
36263 described fully in @ref{General Query Packets}.
36264
36265 @item r
36266 @cindex @samp{r} packet
36267 Reset the entire system.
36268
36269 Don't use this packet; use the @samp{R} packet instead.
36270
36271 @item R @var{XX}
36272 @cindex @samp{R} packet
36273 Restart the program being debugged.  The @var{XX}, while needed, is ignored.
36274 This packet is only available in extended mode (@pxref{extended mode}).
36275
36276 The @samp{R} packet has no reply.
36277
36278 @item s @r{[}@var{addr}@r{]}
36279 @cindex @samp{s} packet
36280 Single step, resuming at @var{addr}.  If
36281 @var{addr} is omitted, resume at same address.
36282
36283 This packet is deprecated for multi-threading support.  @xref{vCont
36284 packet}.
36285
36286 Reply:
36287 @xref{Stop Reply Packets}, for the reply specifications.
36288
36289 @item S @var{sig}@r{[};@var{addr}@r{]}
36290 @anchor{step with signal packet}
36291 @cindex @samp{S} packet
36292 Step with signal.  This is analogous to the @samp{C} packet, but
36293 requests a single-step, rather than a normal resumption of execution.
36294
36295 This packet is deprecated for multi-threading support.  @xref{vCont
36296 packet}.
36297
36298 Reply:
36299 @xref{Stop Reply Packets}, for the reply specifications.
36300
36301 @item t @var{addr}:@var{PP},@var{MM}
36302 @cindex @samp{t} packet
36303 Search backwards starting at address @var{addr} for a match with pattern
36304 @var{PP} and mask @var{MM}, both of which are are 4 byte long.
36305 There must be at least 3 digits in @var{addr}.
36306
36307 @item T @var{thread-id}
36308 @cindex @samp{T} packet
36309 Find out if the thread @var{thread-id} is alive.  @xref{thread-id syntax}.
36310
36311 Reply:
36312 @table @samp
36313 @item OK
36314 thread is still alive
36315 @item E @var{NN}
36316 thread is dead
36317 @end table
36318
36319 @item v
36320 Packets starting with @samp{v} are identified by a multi-letter name,
36321 up to the first @samp{;} or @samp{?} (or the end of the packet).
36322
36323 @item vAttach;@var{pid}
36324 @cindex @samp{vAttach} packet
36325 Attach to a new process with the specified process ID @var{pid}.
36326 The process ID is a
36327 hexadecimal integer identifying the process.  In all-stop mode, all
36328 threads in the attached process are stopped; in non-stop mode, it may be
36329 attached without being stopped if that is supported by the target.
36330
36331 @c In non-stop mode, on a successful vAttach, the stub should set the
36332 @c current thread to a thread of the newly-attached process.  After
36333 @c attaching, GDB queries for the attached process's thread ID with qC.
36334 @c Also note that, from a user perspective, whether or not the 
36335 @c target is stopped on attach in non-stop mode depends on whether you 
36336 @c use the foreground or background version of the attach command, not 
36337 @c on what vAttach does; GDB does the right thing with respect to either 
36338 @c stopping or restarting threads.
36339
36340 This packet is only available in extended mode (@pxref{extended mode}).
36341
36342 Reply:
36343 @table @samp
36344 @item E @var{nn}
36345 for an error
36346 @item @r{Any stop packet}
36347 for success in all-stop mode (@pxref{Stop Reply Packets})
36348 @item OK
36349 for success in non-stop mode (@pxref{Remote Non-Stop})
36350 @end table
36351
36352 @item vCont@r{[};@var{action}@r{[}:@var{thread-id}@r{]]}@dots{}
36353 @cindex @samp{vCont} packet
36354 @anchor{vCont packet}
36355 Resume the inferior, specifying different actions for each thread.
36356
36357 For each inferior thread, the leftmost action with a matching
36358 @var{thread-id} is applied.  Threads that don't match any action
36359 remain in their current state.  Thread IDs are specified using the
36360 syntax described in @ref{thread-id syntax}.  If multiprocess
36361 extensions (@pxref{multiprocess extensions}) are supported, actions
36362 can be specified to match all threads in a process by using the
36363 @samp{p@var{pid}.-1} form of the @var{thread-id}.  An action with no
36364 @var{thread-id} matches all threads.  Specifying no actions is an
36365 error.
36366
36367 Currently supported actions are:
36368
36369 @table @samp
36370 @item c
36371 Continue.
36372 @item C @var{sig}
36373 Continue with signal @var{sig}.  The signal @var{sig} should be two hex digits.
36374 @item s
36375 Step.
36376 @item S @var{sig}
36377 Step with signal @var{sig}.  The signal @var{sig} should be two hex digits.
36378 @item t
36379 Stop.
36380 @item r @var{start},@var{end}
36381 Step once, and then keep stepping as long as the thread stops at
36382 addresses between @var{start} (inclusive) and @var{end} (exclusive).
36383 The remote stub reports a stop reply when either the thread goes out
36384 of the range or is stopped due to an unrelated reason, such as hitting
36385 a breakpoint.  @xref{range stepping}.
36386
36387 If the range is empty (@var{start} == @var{end}), then the action
36388 becomes equivalent to the @samp{s} action.  In other words,
36389 single-step once, and report the stop (even if the stepped instruction
36390 jumps to @var{start}).
36391
36392 (A stop reply may be sent at any point even if the PC is still within
36393 the stepping range; for example, it is valid to implement this packet
36394 in a degenerate way as a single instruction step operation.)
36395
36396 @end table
36397
36398 The optional argument @var{addr} normally associated with the 
36399 @samp{c}, @samp{C}, @samp{s}, and @samp{S} packets is
36400 not supported in @samp{vCont}.
36401
36402 The @samp{t} action is only relevant in non-stop mode
36403 (@pxref{Remote Non-Stop}) and may be ignored by the stub otherwise.
36404 A stop reply should be generated for any affected thread not already stopped.
36405 When a thread is stopped by means of a @samp{t} action,
36406 the corresponding stop reply should indicate that the thread has stopped with
36407 signal @samp{0}, regardless of whether the target uses some other signal
36408 as an implementation detail.
36409
36410 The server must ignore @samp{c}, @samp{C}, @samp{s}, @samp{S}, and
36411 @samp{r} actions for threads that are already running.  Conversely,
36412 the server must ignore @samp{t} actions for threads that are already
36413 stopped.
36414
36415 @emph{Note:} In non-stop mode, a thread is considered running until
36416 @value{GDBN} acknowleges an asynchronous stop notification for it with
36417 the @samp{vStopped} packet (@pxref{Remote Non-Stop}).
36418
36419 The stub must support @samp{vCont} if it reports support for
36420 multiprocess extensions (@pxref{multiprocess extensions}).
36421
36422 Reply:
36423 @xref{Stop Reply Packets}, for the reply specifications.
36424
36425 @item vCont?
36426 @cindex @samp{vCont?} packet
36427 Request a list of actions supported by the @samp{vCont} packet.
36428
36429 Reply:
36430 @table @samp
36431 @item vCont@r{[};@var{action}@dots{}@r{]}
36432 The @samp{vCont} packet is supported.  Each @var{action} is a supported
36433 command in the @samp{vCont} packet.
36434 @item @w{}
36435 The @samp{vCont} packet is not supported.
36436 @end table
36437
36438 @anchor{vCtrlC packet}
36439 @item vCtrlC
36440 @cindex @samp{vCtrlC} packet
36441 Interrupt remote target as if a control-C was pressed on the remote
36442 terminal.  This is the equivalent to reacting to the @code{^C}
36443 (@samp{\003}, the control-C character) character in all-stop mode
36444 while the target is running, except this works in non-stop mode.
36445 @xref{interrupting remote targets}, for more info on the all-stop
36446 variant.
36447
36448 Reply:
36449 @table @samp
36450 @item E @var{nn}
36451 for an error
36452 @item OK
36453 for success
36454 @end table
36455
36456 @item vFile:@var{operation}:@var{parameter}@dots{}
36457 @cindex @samp{vFile} packet
36458 Perform a file operation on the target system.  For details,
36459 see @ref{Host I/O Packets}.
36460
36461 @item vFlashErase:@var{addr},@var{length}
36462 @cindex @samp{vFlashErase} packet
36463 Direct the stub to erase @var{length} bytes of flash starting at
36464 @var{addr}.  The region may enclose any number of flash blocks, but
36465 its start and end must fall on block boundaries, as indicated by the
36466 flash block size appearing in the memory map (@pxref{Memory Map
36467 Format}).  @value{GDBN} groups flash memory programming operations
36468 together, and sends a @samp{vFlashDone} request after each group; the
36469 stub is allowed to delay erase operation until the @samp{vFlashDone}
36470 packet is received.
36471
36472 Reply:
36473 @table @samp
36474 @item OK
36475 for success
36476 @item E @var{NN}
36477 for an error
36478 @end table
36479
36480 @item vFlashWrite:@var{addr}:@var{XX@dots{}}
36481 @cindex @samp{vFlashWrite} packet
36482 Direct the stub to write data to flash address @var{addr}.  The data
36483 is passed in binary form using the same encoding as for the @samp{X}
36484 packet (@pxref{Binary Data}).  The memory ranges specified by
36485 @samp{vFlashWrite} packets preceding a @samp{vFlashDone} packet must
36486 not overlap, and must appear in order of increasing addresses
36487 (although @samp{vFlashErase} packets for higher addresses may already
36488 have been received; the ordering is guaranteed only between
36489 @samp{vFlashWrite} packets).  If a packet writes to an address that was
36490 neither erased by a preceding @samp{vFlashErase} packet nor by some other
36491 target-specific method, the results are unpredictable.
36492
36493
36494 Reply:
36495 @table @samp
36496 @item OK
36497 for success
36498 @item E.memtype
36499 for vFlashWrite addressing non-flash memory
36500 @item E @var{NN}
36501 for an error
36502 @end table
36503
36504 @item vFlashDone
36505 @cindex @samp{vFlashDone} packet
36506 Indicate to the stub that flash programming operation is finished.
36507 The stub is permitted to delay or batch the effects of a group of
36508 @samp{vFlashErase} and @samp{vFlashWrite} packets until a
36509 @samp{vFlashDone} packet is received.  The contents of the affected
36510 regions of flash memory are unpredictable until the @samp{vFlashDone}
36511 request is completed.
36512
36513 @item vKill;@var{pid}
36514 @cindex @samp{vKill} packet
36515 @anchor{vKill packet}
36516 Kill the process with the specified process ID @var{pid}, which is a
36517 hexadecimal integer identifying the process.  This packet is used in
36518 preference to @samp{k} when multiprocess protocol extensions are
36519 supported; see @ref{multiprocess extensions}.
36520
36521 Reply:
36522 @table @samp
36523 @item E @var{nn}
36524 for an error
36525 @item OK
36526 for success
36527 @end table
36528
36529 @item vMustReplyEmpty
36530 @cindex @samp{vMustReplyEmpty} packet
36531 The correct reply to an unknown @samp{v} packet is to return the empty
36532 string, however, some older versions of @command{gdbserver} would
36533 incorrectly return @samp{OK} for unknown @samp{v} packets.
36534
36535 The @samp{vMustReplyEmpty} is used as a feature test to check how
36536 @command{gdbserver} handles unknown packets, it is important that this
36537 packet be handled in the same way as other unknown @samp{v} packets.
36538 If this packet is handled differently to other unknown @samp{v}
36539 packets then it is possile that @value{GDBN} may run into problems in
36540 other areas, specifically around use of @samp{vFile:setfs:}.
36541
36542 @item vRun;@var{filename}@r{[};@var{argument}@r{]}@dots{}
36543 @cindex @samp{vRun} packet
36544 Run the program @var{filename}, passing it each @var{argument} on its
36545 command line.  The file and arguments are hex-encoded strings.  If
36546 @var{filename} is an empty string, the stub may use a default program
36547 (e.g.@: the last program run).  The program is created in the stopped
36548 state.
36549
36550 @c FIXME:  What about non-stop mode?
36551
36552 This packet is only available in extended mode (@pxref{extended mode}).
36553
36554 Reply:
36555 @table @samp
36556 @item E @var{nn}
36557 for an error
36558 @item @r{Any stop packet}
36559 for success (@pxref{Stop Reply Packets})
36560 @end table
36561
36562 @item vStopped
36563 @cindex @samp{vStopped} packet
36564 @xref{Notification Packets}.
36565
36566 @item X @var{addr},@var{length}:@var{XX@dots{}}
36567 @anchor{X packet}
36568 @cindex @samp{X} packet
36569 Write data to memory, where the data is transmitted in binary.
36570 Memory is specified by its address @var{addr} and number of addressable memory
36571 units @var{length} (@pxref{addressable memory unit});
36572 @samp{@var{XX}@dots{}} is binary data (@pxref{Binary Data}).
36573
36574 Reply:
36575 @table @samp
36576 @item OK
36577 for success
36578 @item E @var{NN}
36579 for an error
36580 @end table
36581
36582 @item z @var{type},@var{addr},@var{kind}
36583 @itemx Z @var{type},@var{addr},@var{kind}
36584 @anchor{insert breakpoint or watchpoint packet}
36585 @cindex @samp{z} packet
36586 @cindex @samp{Z} packets
36587 Insert (@samp{Z}) or remove (@samp{z}) a @var{type} breakpoint or
36588 watchpoint starting at address @var{address} of kind @var{kind}.
36589
36590 Each breakpoint and watchpoint packet @var{type} is documented
36591 separately.
36592
36593 @emph{Implementation notes: A remote target shall return an empty string
36594 for an unrecognized breakpoint or watchpoint packet @var{type}.  A
36595 remote target shall support either both or neither of a given
36596 @samp{Z@var{type}@dots{}} and @samp{z@var{type}@dots{}} packet pair.  To
36597 avoid potential problems with duplicate packets, the operations should
36598 be implemented in an idempotent way.}
36599
36600 @item z0,@var{addr},@var{kind}
36601 @itemx Z0,@var{addr},@var{kind}@r{[};@var{cond_list}@dots{}@r{]}@r{[};cmds:@var{persist},@var{cmd_list}@dots{}@r{]}
36602 @cindex @samp{z0} packet
36603 @cindex @samp{Z0} packet
36604 Insert (@samp{Z0}) or remove (@samp{z0}) a software breakpoint at address
36605 @var{addr} of type @var{kind}.
36606
36607 A software breakpoint is implemented by replacing the instruction at
36608 @var{addr} with a software breakpoint or trap instruction.  The
36609 @var{kind} is target-specific and typically indicates the size of the
36610 breakpoint in bytes that should be inserted.  E.g., the @sc{arm} and
36611 @sc{mips} can insert either a 2 or 4 byte breakpoint.  Some
36612 architectures have additional meanings for @var{kind}
36613 (@pxref{Architecture-Specific Protocol Details}); if no
36614 architecture-specific value is being used, it should be @samp{0}.
36615 @var{kind} is hex-encoded.  @var{cond_list} is an optional list of
36616 conditional expressions in bytecode form that should be evaluated on
36617 the target's side.  These are the conditions that should be taken into
36618 consideration when deciding if the breakpoint trigger should be
36619 reported back to @value{GDBN}.
36620
36621 See also the @samp{swbreak} stop reason (@pxref{swbreak stop reason})
36622 for how to best report a software breakpoint event to @value{GDBN}.
36623
36624 The @var{cond_list} parameter is comprised of a series of expressions,
36625 concatenated without separators. Each expression has the following form:
36626
36627 @table @samp
36628
36629 @item X @var{len},@var{expr}
36630 @var{len} is the length of the bytecode expression and @var{expr} is the
36631 actual conditional expression in bytecode form.
36632
36633 @end table
36634
36635 The optional @var{cmd_list} parameter introduces commands that may be
36636 run on the target, rather than being reported back to @value{GDBN}.
36637 The parameter starts with a numeric flag @var{persist}; if the flag is
36638 nonzero, then the breakpoint may remain active and the commands
36639 continue to be run even when @value{GDBN} disconnects from the target.
36640 Following this flag is a series of expressions concatenated with no
36641 separators.  Each expression has the following form:
36642
36643 @table @samp
36644
36645 @item X @var{len},@var{expr}
36646 @var{len} is the length of the bytecode expression and @var{expr} is the
36647 actual commands expression in bytecode form.
36648
36649 @end table
36650
36651 @emph{Implementation note: It is possible for a target to copy or move
36652 code that contains software breakpoints (e.g., when implementing
36653 overlays).  The behavior of this packet, in the presence of such a
36654 target, is not defined.}
36655
36656 Reply:
36657 @table @samp
36658 @item OK
36659 success
36660 @item @w{}
36661 not supported
36662 @item E @var{NN}
36663 for an error
36664 @end table
36665
36666 @item z1,@var{addr},@var{kind}
36667 @itemx Z1,@var{addr},@var{kind}@r{[};@var{cond_list}@dots{}@r{]}@r{[};cmds:@var{persist},@var{cmd_list}@dots{}@r{]}
36668 @cindex @samp{z1} packet
36669 @cindex @samp{Z1} packet
36670 Insert (@samp{Z1}) or remove (@samp{z1}) a hardware breakpoint at
36671 address @var{addr}.
36672
36673 A hardware breakpoint is implemented using a mechanism that is not
36674 dependent on being able to modify the target's memory.  The
36675 @var{kind}, @var{cond_list}, and @var{cmd_list} arguments have the
36676 same meaning as in @samp{Z0} packets.
36677
36678 @emph{Implementation note: A hardware breakpoint is not affected by code
36679 movement.}
36680
36681 Reply:
36682 @table @samp
36683 @item OK
36684 success
36685 @item @w{}
36686 not supported
36687 @item E @var{NN}
36688 for an error
36689 @end table
36690
36691 @item z2,@var{addr},@var{kind}
36692 @itemx Z2,@var{addr},@var{kind}
36693 @cindex @samp{z2} packet
36694 @cindex @samp{Z2} packet
36695 Insert (@samp{Z2}) or remove (@samp{z2}) a write watchpoint at @var{addr}.
36696 The number of bytes to watch is specified by @var{kind}.
36697
36698 Reply:
36699 @table @samp
36700 @item OK
36701 success
36702 @item @w{}
36703 not supported
36704 @item E @var{NN}
36705 for an error
36706 @end table
36707
36708 @item z3,@var{addr},@var{kind}
36709 @itemx Z3,@var{addr},@var{kind}
36710 @cindex @samp{z3} packet
36711 @cindex @samp{Z3} packet
36712 Insert (@samp{Z3}) or remove (@samp{z3}) a read watchpoint at @var{addr}.
36713 The number of bytes to watch is specified by @var{kind}.
36714
36715 Reply:
36716 @table @samp
36717 @item OK
36718 success
36719 @item @w{}
36720 not supported
36721 @item E @var{NN}
36722 for an error
36723 @end table
36724
36725 @item z4,@var{addr},@var{kind}
36726 @itemx Z4,@var{addr},@var{kind}
36727 @cindex @samp{z4} packet
36728 @cindex @samp{Z4} packet
36729 Insert (@samp{Z4}) or remove (@samp{z4}) an access watchpoint at @var{addr}.
36730 The number of bytes to watch is specified by @var{kind}.
36731
36732 Reply:
36733 @table @samp
36734 @item OK
36735 success
36736 @item @w{}
36737 not supported
36738 @item E @var{NN}
36739 for an error
36740 @end table
36741
36742 @end table
36743
36744 @node Stop Reply Packets
36745 @section Stop Reply Packets
36746 @cindex stop reply packets
36747
36748 The @samp{C}, @samp{c}, @samp{S}, @samp{s}, @samp{vCont},
36749 @samp{vAttach}, @samp{vRun}, @samp{vStopped}, and @samp{?} packets can
36750 receive any of the below as a reply.  Except for @samp{?}
36751 and @samp{vStopped}, that reply is only returned
36752 when the target halts.  In the below the exact meaning of @dfn{signal
36753 number} is defined by the header @file{include/gdb/signals.h} in the
36754 @value{GDBN} source code.
36755
36756 In non-stop mode, the server will simply reply @samp{OK} to commands
36757 such as @samp{vCont}; any stop will be the subject of a future
36758 notification.  @xref{Remote Non-Stop}.
36759
36760 As in the description of request packets, we include spaces in the
36761 reply templates for clarity; these are not part of the reply packet's
36762 syntax.  No @value{GDBN} stop reply packet uses spaces to separate its
36763 components.
36764
36765 @table @samp
36766
36767 @item S @var{AA}
36768 The program received signal number @var{AA} (a two-digit hexadecimal
36769 number).  This is equivalent to a @samp{T} response with no
36770 @var{n}:@var{r} pairs.
36771
36772 @item T @var{AA} @var{n1}:@var{r1};@var{n2}:@var{r2};@dots{}
36773 @cindex @samp{T} packet reply
36774 The program received signal number @var{AA} (a two-digit hexadecimal
36775 number).  This is equivalent to an @samp{S} response, except that the
36776 @samp{@var{n}:@var{r}} pairs can carry values of important registers
36777 and other information directly in the stop reply packet, reducing
36778 round-trip latency.  Single-step and breakpoint traps are reported
36779 this way.  Each @samp{@var{n}:@var{r}} pair is interpreted as follows:
36780
36781 @itemize @bullet
36782 @item
36783 If @var{n} is a hexadecimal number, it is a register number, and the
36784 corresponding @var{r} gives that register's value.  The data @var{r} is a
36785 series of bytes in target byte order, with each byte given by a
36786 two-digit hex number.
36787
36788 @item
36789 If @var{n} is @samp{thread}, then @var{r} is the @var{thread-id} of
36790 the stopped thread, as specified in @ref{thread-id syntax}.
36791
36792 @item
36793 If @var{n} is @samp{core}, then @var{r} is the hexadecimal number of
36794 the core on which the stop event was detected.
36795
36796 @item
36797 If @var{n} is a recognized @dfn{stop reason}, it describes a more
36798 specific event that stopped the target.  The currently defined stop
36799 reasons are listed below.  The @var{aa} should be @samp{05}, the trap
36800 signal.  At most one stop reason should be present.
36801
36802 @item
36803 Otherwise, @value{GDBN} should ignore this @samp{@var{n}:@var{r}} pair
36804 and go on to the next; this allows us to extend the protocol in the
36805 future.
36806 @end itemize
36807
36808 The currently defined stop reasons are:
36809
36810 @table @samp
36811 @item watch
36812 @itemx rwatch
36813 @itemx awatch
36814 The packet indicates a watchpoint hit, and @var{r} is the data address, in
36815 hex.
36816
36817 @item syscall_entry
36818 @itemx syscall_return
36819 The packet indicates a syscall entry or return, and @var{r} is the
36820 syscall number, in hex.
36821
36822 @cindex shared library events, remote reply
36823 @item library
36824 The packet indicates that the loaded libraries have changed.
36825 @value{GDBN} should use @samp{qXfer:libraries:read} to fetch a new
36826 list of loaded libraries.  The @var{r} part is ignored.
36827
36828 @cindex replay log events, remote reply
36829 @item replaylog
36830 The packet indicates that the target cannot continue replaying 
36831 logged execution events, because it has reached the end (or the
36832 beginning when executing backward) of the log.  The value of @var{r}
36833 will be either @samp{begin} or @samp{end}.  @xref{Reverse Execution}, 
36834 for more information.
36835
36836 @item swbreak
36837 @anchor{swbreak stop reason}
36838 The packet indicates a software breakpoint instruction was executed,
36839 irrespective of whether it was @value{GDBN} that planted the
36840 breakpoint or the breakpoint is hardcoded in the program.  The @var{r}
36841 part must be left empty.
36842
36843 On some architectures, such as x86, at the architecture level, when a
36844 breakpoint instruction executes the program counter points at the
36845 breakpoint address plus an offset.  On such targets, the stub is
36846 responsible for adjusting the PC to point back at the breakpoint
36847 address.
36848
36849 This packet should not be sent by default; older @value{GDBN} versions
36850 did not support it.  @value{GDBN} requests it, by supplying an
36851 appropriate @samp{qSupported} feature (@pxref{qSupported}).  The
36852 remote stub must also supply the appropriate @samp{qSupported} feature
36853 indicating support.
36854
36855 This packet is required for correct non-stop mode operation.
36856
36857 @item hwbreak
36858 The packet indicates the target stopped for a hardware breakpoint.
36859 The @var{r} part must be left empty.
36860
36861 The same remarks about @samp{qSupported} and non-stop mode above
36862 apply.
36863
36864 @cindex fork events, remote reply
36865 @item fork
36866 The packet indicates that @code{fork} was called, and @var{r}
36867 is the thread ID of the new child process.  Refer to
36868 @ref{thread-id syntax} for the format of the @var{thread-id}
36869 field.  This packet is only applicable to targets that support
36870 fork events.
36871
36872 This packet should not be sent by default; older @value{GDBN} versions
36873 did not support it.  @value{GDBN} requests it, by supplying an
36874 appropriate @samp{qSupported} feature (@pxref{qSupported}).  The
36875 remote stub must also supply the appropriate @samp{qSupported} feature
36876 indicating support.
36877
36878 @cindex vfork events, remote reply
36879 @item vfork
36880 The packet indicates that @code{vfork} was called, and @var{r}
36881 is the thread ID of the new child process. Refer to
36882 @ref{thread-id syntax} for the format of the @var{thread-id}
36883 field.  This packet is only applicable to targets that support
36884 vfork events.
36885
36886 This packet should not be sent by default; older @value{GDBN} versions
36887 did not support it.  @value{GDBN} requests it, by supplying an
36888 appropriate @samp{qSupported} feature (@pxref{qSupported}).  The
36889 remote stub must also supply the appropriate @samp{qSupported} feature
36890 indicating support.
36891
36892 @cindex vforkdone events, remote reply
36893 @item vforkdone
36894 The packet indicates that a child process created by a vfork
36895 has either called @code{exec} or terminated, so that the
36896 address spaces of the parent and child process are no longer
36897 shared. The @var{r} part is ignored.  This packet is only
36898 applicable to targets that support vforkdone events.
36899
36900 This packet should not be sent by default; older @value{GDBN} versions
36901 did not support it.  @value{GDBN} requests it, by supplying an
36902 appropriate @samp{qSupported} feature (@pxref{qSupported}).  The
36903 remote stub must also supply the appropriate @samp{qSupported} feature
36904 indicating support.
36905
36906 @cindex exec events, remote reply
36907 @item exec
36908 The packet indicates that @code{execve} was called, and @var{r}
36909 is the absolute pathname of the file that was executed, in hex.
36910 This packet is only applicable to targets that support exec events.
36911
36912 This packet should not be sent by default; older @value{GDBN} versions
36913 did not support it.  @value{GDBN} requests it, by supplying an
36914 appropriate @samp{qSupported} feature (@pxref{qSupported}).  The
36915 remote stub must also supply the appropriate @samp{qSupported} feature
36916 indicating support.
36917
36918 @cindex thread create event, remote reply
36919 @anchor{thread create event}
36920 @item create
36921 The packet indicates that the thread was just created.  The new thread
36922 is stopped until @value{GDBN} sets it running with a resumption packet
36923 (@pxref{vCont packet}).  This packet should not be sent by default;
36924 @value{GDBN} requests it with the @ref{QThreadEvents} packet.  See
36925 also the @samp{w} (@pxref{thread exit event}) remote reply below.  The
36926 @var{r} part is ignored.
36927
36928 @end table
36929
36930 @item W @var{AA}
36931 @itemx W @var{AA} ; process:@var{pid}
36932 The process exited, and @var{AA} is the exit status.  This is only
36933 applicable to certain targets.
36934
36935 The second form of the response, including the process ID of the
36936 exited process, can be used only when @value{GDBN} has reported
36937 support for multiprocess protocol extensions; see @ref{multiprocess
36938 extensions}.  Both @var{AA} and @var{pid} are formatted as big-endian
36939 hex strings.
36940
36941 @item X @var{AA}
36942 @itemx X @var{AA} ; process:@var{pid}
36943 The process terminated with signal @var{AA}.
36944
36945 The second form of the response, including the process ID of the
36946 terminated process, can be used only when @value{GDBN} has reported
36947 support for multiprocess protocol extensions; see @ref{multiprocess
36948 extensions}.  Both @var{AA} and @var{pid} are formatted as big-endian
36949 hex strings.
36950
36951 @anchor{thread exit event}
36952 @cindex thread exit event, remote reply
36953 @item w @var{AA} ; @var{tid}
36954
36955 The thread exited, and @var{AA} is the exit status.  This response
36956 should not be sent by default; @value{GDBN} requests it with the
36957 @ref{QThreadEvents} packet.  See also @ref{thread create event} above.
36958 @var{AA} is formatted as a big-endian hex string.
36959
36960 @item N
36961 There are no resumed threads left in the target.  In other words, even
36962 though the process is alive, the last resumed thread has exited.  For
36963 example, say the target process has two threads: thread 1 and thread
36964 2.  The client leaves thread 1 stopped, and resumes thread 2, which
36965 subsequently exits.  At this point, even though the process is still
36966 alive, and thus no @samp{W} stop reply is sent, no thread is actually
36967 executing either.  The @samp{N} stop reply thus informs the client
36968 that it can stop waiting for stop replies.  This packet should not be
36969 sent by default; older @value{GDBN} versions did not support it.
36970 @value{GDBN} requests it, by supplying an appropriate
36971 @samp{qSupported} feature (@pxref{qSupported}).  The remote stub must
36972 also supply the appropriate @samp{qSupported} feature indicating
36973 support.
36974
36975 @item O @var{XX}@dots{}
36976 @samp{@var{XX}@dots{}} is hex encoding of @sc{ascii} data, to be
36977 written as the program's console output.  This can happen at any time
36978 while the program is running and the debugger should continue to wait
36979 for @samp{W}, @samp{T}, etc.  This reply is not permitted in non-stop mode.
36980
36981 @item F @var{call-id},@var{parameter}@dots{}
36982 @var{call-id} is the identifier which says which host system call should
36983 be called.  This is just the name of the function.  Translation into the
36984 correct system call is only applicable as it's defined in @value{GDBN}.
36985 @xref{File-I/O Remote Protocol Extension}, for a list of implemented
36986 system calls.
36987
36988 @samp{@var{parameter}@dots{}} is a list of parameters as defined for
36989 this very system call.
36990
36991 The target replies with this packet when it expects @value{GDBN} to
36992 call a host system call on behalf of the target.  @value{GDBN} replies
36993 with an appropriate @samp{F} packet and keeps up waiting for the next
36994 reply packet from the target.  The latest @samp{C}, @samp{c}, @samp{S}
36995 or @samp{s} action is expected to be continued.  @xref{File-I/O Remote
36996 Protocol Extension}, for more details.
36997
36998 @end table
36999
37000 @node General Query Packets
37001 @section General Query Packets
37002 @cindex remote query requests
37003
37004 Packets starting with @samp{q} are @dfn{general query packets};
37005 packets starting with @samp{Q} are @dfn{general set packets}.  General
37006 query and set packets are a semi-unified form for retrieving and
37007 sending information to and from the stub.
37008
37009 The initial letter of a query or set packet is followed by a name
37010 indicating what sort of thing the packet applies to.  For example,
37011 @value{GDBN} may use a @samp{qSymbol} packet to exchange symbol
37012 definitions with the stub.  These packet names follow some
37013 conventions:
37014
37015 @itemize @bullet
37016 @item
37017 The name must not contain commas, colons or semicolons.
37018 @item
37019 Most @value{GDBN} query and set packets have a leading upper case
37020 letter.
37021 @item
37022 The names of custom vendor packets should use a company prefix, in
37023 lower case, followed by a period.  For example, packets designed at
37024 the Acme Corporation might begin with @samp{qacme.foo} (for querying
37025 foos) or @samp{Qacme.bar} (for setting bars).
37026 @end itemize
37027
37028 The name of a query or set packet should be separated from any
37029 parameters by a @samp{:}; the parameters themselves should be
37030 separated by @samp{,} or @samp{;}.  Stubs must be careful to match the
37031 full packet name, and check for a separator or the end of the packet,
37032 in case two packet names share a common prefix.  New packets should not begin
37033 with @samp{qC}, @samp{qP}, or @samp{qL}@footnote{The @samp{qP} and @samp{qL}
37034 packets predate these conventions, and have arguments without any terminator
37035 for the packet name; we suspect they are in widespread use in places that
37036 are difficult to upgrade.  The @samp{qC} packet has no arguments, but some
37037 existing stubs (e.g.@: RedBoot) are known to not check for the end of the
37038 packet.}.
37039
37040 Like the descriptions of the other packets, each description here
37041 has a template showing the packet's overall syntax, followed by an
37042 explanation of the packet's meaning.  We include spaces in some of the
37043 templates for clarity; these are not part of the packet's syntax.  No
37044 @value{GDBN} packet uses spaces to separate its components.
37045
37046 Here are the currently defined query and set packets:
37047
37048 @table @samp
37049
37050 @item QAgent:1
37051 @itemx QAgent:0
37052 Turn on or off the agent as a helper to perform some debugging operations
37053 delegated from @value{GDBN} (@pxref{Control Agent}).
37054
37055 @item QAllow:@var{op}:@var{val}@dots{}
37056 @cindex @samp{QAllow} packet
37057 Specify which operations @value{GDBN} expects to request of the
37058 target, as a semicolon-separated list of operation name and value
37059 pairs.  Possible values for @var{op} include @samp{WriteReg},
37060 @samp{WriteMem}, @samp{InsertBreak}, @samp{InsertTrace},
37061 @samp{InsertFastTrace}, and @samp{Stop}. @var{val} is either 0,
37062 indicating that @value{GDBN} will not request the operation, or 1,
37063 indicating that it may.  (The target can then use this to set up its
37064 own internals optimally, for instance if the debugger never expects to
37065 insert breakpoints, it may not need to install its own trap handler.)
37066
37067 @item qC
37068 @cindex current thread, remote request
37069 @cindex @samp{qC} packet
37070 Return the current thread ID.
37071
37072 Reply:
37073 @table @samp
37074 @item QC @var{thread-id}
37075 Where @var{thread-id} is a thread ID as documented in 
37076 @ref{thread-id syntax}.
37077 @item @r{(anything else)}
37078 Any other reply implies the old thread ID.
37079 @end table
37080
37081 @item qCRC:@var{addr},@var{length}
37082 @cindex CRC of memory block, remote request
37083 @cindex @samp{qCRC} packet
37084 @anchor{qCRC packet}
37085 Compute the CRC checksum of a block of memory using CRC-32 defined in
37086 IEEE 802.3.  The CRC is computed byte at a time, taking the most
37087 significant bit of each byte first.  The initial pattern code
37088 @code{0xffffffff} is used to ensure leading zeros affect the CRC.
37089
37090 @emph{Note:} This is the same CRC used in validating separate debug
37091 files (@pxref{Separate Debug Files, , Debugging Information in Separate
37092 Files}).  However the algorithm is slightly different.  When validating
37093 separate debug files, the CRC is computed taking the @emph{least}
37094 significant bit of each byte first, and the final result is inverted to
37095 detect trailing zeros.
37096
37097 Reply:
37098 @table @samp
37099 @item E @var{NN}
37100 An error (such as memory fault)
37101 @item C @var{crc32}
37102 The specified memory region's checksum is @var{crc32}.
37103 @end table
37104
37105 @item QDisableRandomization:@var{value}
37106 @cindex disable address space randomization, remote request
37107 @cindex @samp{QDisableRandomization} packet
37108 Some target operating systems will randomize the virtual address space
37109 of the inferior process as a security feature, but provide a feature
37110 to disable such randomization, e.g.@: to allow for a more deterministic
37111 debugging experience.  On such systems, this packet with a @var{value}
37112 of 1 directs the target to disable address space randomization for
37113 processes subsequently started via @samp{vRun} packets, while a packet
37114 with a @var{value} of 0 tells the target to enable address space
37115 randomization.
37116
37117 This packet is only available in extended mode (@pxref{extended mode}).
37118
37119 Reply:
37120 @table @samp
37121 @item OK
37122 The request succeeded.
37123
37124 @item E @var{nn}
37125 An error occurred.  The error number @var{nn} is given as hex digits.
37126
37127 @item @w{}
37128 An empty reply indicates that @samp{QDisableRandomization} is not supported
37129 by the stub.
37130 @end table
37131
37132 This packet is not probed by default; the remote stub must request it,
37133 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
37134 This should only be done on targets that actually support disabling
37135 address space randomization.
37136
37137 @item QStartupWithShell:@var{value}
37138 @cindex startup with shell, remote request
37139 @cindex @samp{QStartupWithShell} packet
37140 On UNIX-like targets, it is possible to start the inferior using a
37141 shell program.  This is the default behavior on both @value{GDBN} and
37142 @command{gdbserver} (@pxref{set startup-with-shell}).  This packet is
37143 used to inform @command{gdbserver} whether it should start the
37144 inferior using a shell or not.
37145
37146 If @var{value} is @samp{0}, @command{gdbserver} will not use a shell
37147 to start the inferior.  If @var{value} is @samp{1},
37148 @command{gdbserver} will use a shell to start the inferior.  All other
37149 values are considered an error.
37150
37151 This packet is only available in extended mode (@pxref{extended
37152 mode}).
37153
37154 Reply:
37155 @table @samp
37156 @item OK
37157 The request succeeded.
37158
37159 @item E @var{nn}
37160 An error occurred.  The error number @var{nn} is given as hex digits.
37161 @end table
37162
37163 This packet is not probed by default; the remote stub must request it,
37164 by supplying an appropriate @samp{qSupported} response
37165 (@pxref{qSupported}).  This should only be done on targets that
37166 actually support starting the inferior using a shell.
37167
37168 Use of this packet is controlled by the @code{set startup-with-shell}
37169 command; @pxref{set startup-with-shell}.
37170
37171 @item QEnvironmentHexEncoded:@var{hex-value}
37172 @anchor{QEnvironmentHexEncoded}
37173 @cindex set environment variable, remote request
37174 @cindex @samp{QEnvironmentHexEncoded} packet
37175 On UNIX-like targets, it is possible to set environment variables that
37176 will be passed to the inferior during the startup process.  This
37177 packet is used to inform @command{gdbserver} of an environment
37178 variable that has been defined by the user on @value{GDBN} (@pxref{set
37179 environment}).
37180
37181 The packet is composed by @var{hex-value}, an hex encoded
37182 representation of the @var{name=value} format representing an
37183 environment variable.  The name of the environment variable is
37184 represented by @var{name}, and the value to be assigned to the
37185 environment variable is represented by @var{value}.  If the variable
37186 has no value (i.e., the value is @code{null}), then @var{value} will
37187 not be present.
37188
37189 This packet is only available in extended mode (@pxref{extended
37190 mode}).
37191
37192 Reply:
37193 @table @samp
37194 @item OK
37195 The request succeeded.
37196 @end table
37197
37198 This packet is not probed by default; the remote stub must request it,
37199 by supplying an appropriate @samp{qSupported} response
37200 (@pxref{qSupported}).  This should only be done on targets that
37201 actually support passing environment variables to the starting
37202 inferior.
37203
37204 This packet is related to the @code{set environment} command;
37205 @pxref{set environment}.
37206
37207 @item QEnvironmentUnset:@var{hex-value}
37208 @anchor{QEnvironmentUnset}
37209 @cindex unset environment variable, remote request
37210 @cindex @samp{QEnvironmentUnset} packet
37211 On UNIX-like targets, it is possible to unset environment variables
37212 before starting the inferior in the remote target.  This packet is
37213 used to inform @command{gdbserver} of an environment variable that has
37214 been unset by the user on @value{GDBN} (@pxref{unset environment}).
37215
37216 The packet is composed by @var{hex-value}, an hex encoded
37217 representation of the name of the environment variable to be unset.
37218
37219 This packet is only available in extended mode (@pxref{extended
37220 mode}).
37221
37222 Reply:
37223 @table @samp
37224 @item OK
37225 The request succeeded.
37226 @end table
37227
37228 This packet is not probed by default; the remote stub must request it,
37229 by supplying an appropriate @samp{qSupported} response
37230 (@pxref{qSupported}).  This should only be done on targets that
37231 actually support passing environment variables to the starting
37232 inferior.
37233
37234 This packet is related to the @code{unset environment} command;
37235 @pxref{unset environment}.
37236
37237 @item QEnvironmentReset
37238 @anchor{QEnvironmentReset}
37239 @cindex reset environment, remote request
37240 @cindex @samp{QEnvironmentReset} packet
37241 On UNIX-like targets, this packet is used to reset the state of
37242 environment variables in the remote target before starting the
37243 inferior.  In this context, reset means unsetting all environment
37244 variables that were previously set by the user (i.e., were not
37245 initially present in the environment).  It is sent to
37246 @command{gdbserver} before the @samp{QEnvironmentHexEncoded}
37247 (@pxref{QEnvironmentHexEncoded}) and the @samp{QEnvironmentUnset}
37248 (@pxref{QEnvironmentUnset}) packets.
37249
37250 This packet is only available in extended mode (@pxref{extended
37251 mode}).
37252
37253 Reply:
37254 @table @samp
37255 @item OK
37256 The request succeeded.
37257 @end table
37258
37259 This packet is not probed by default; the remote stub must request it,
37260 by supplying an appropriate @samp{qSupported} response
37261 (@pxref{qSupported}).  This should only be done on targets that
37262 actually support passing environment variables to the starting
37263 inferior.
37264
37265 @item QSetWorkingDir:@r{[}@var{directory}@r{]}
37266 @anchor{QSetWorkingDir packet}
37267 @cindex set working directory, remote request
37268 @cindex @samp{QSetWorkingDir} packet
37269 This packet is used to inform the remote server of the intended
37270 current working directory for programs that are going to be executed.
37271
37272 The packet is composed by @var{directory}, an hex encoded
37273 representation of the directory that the remote inferior will use as
37274 its current working directory.  If @var{directory} is an empty string,
37275 the remote server should reset the inferior's current working
37276 directory to its original, empty value.
37277
37278 This packet is only available in extended mode (@pxref{extended
37279 mode}).
37280
37281 Reply:
37282 @table @samp
37283 @item OK
37284 The request succeeded.
37285 @end table
37286
37287 @item qfThreadInfo
37288 @itemx qsThreadInfo
37289 @cindex list active threads, remote request
37290 @cindex @samp{qfThreadInfo} packet
37291 @cindex @samp{qsThreadInfo} packet
37292 Obtain a list of all active thread IDs from the target (OS).  Since there
37293 may be too many active threads to fit into one reply packet, this query
37294 works iteratively: it may require more than one query/reply sequence to
37295 obtain the entire list of threads.  The first query of the sequence will
37296 be the @samp{qfThreadInfo} query; subsequent queries in the
37297 sequence will be the @samp{qsThreadInfo} query.
37298
37299 NOTE: This packet replaces the @samp{qL} query (see below).
37300
37301 Reply:
37302 @table @samp
37303 @item m @var{thread-id}
37304 A single thread ID
37305 @item m @var{thread-id},@var{thread-id}@dots{}
37306 a comma-separated list of thread IDs
37307 @item l
37308 (lower case letter @samp{L}) denotes end of list.
37309 @end table
37310
37311 In response to each query, the target will reply with a list of one or
37312 more thread IDs, separated by commas.
37313 @value{GDBN} will respond to each reply with a request for more thread
37314 ids (using the @samp{qs} form of the query), until the target responds
37315 with @samp{l} (lower-case ell, for @dfn{last}).
37316 Refer to @ref{thread-id syntax}, for the format of the @var{thread-id}
37317 fields.
37318
37319 @emph{Note: @value{GDBN} will send the @code{qfThreadInfo} query during the
37320 initial connection with the remote target, and the very first thread ID
37321 mentioned in the reply will be stopped by @value{GDBN} in a subsequent
37322 message.  Therefore, the stub should ensure that the first thread ID in
37323 the @code{qfThreadInfo} reply is suitable for being stopped by @value{GDBN}.}
37324
37325 @item qGetTLSAddr:@var{thread-id},@var{offset},@var{lm}
37326 @cindex get thread-local storage address, remote request
37327 @cindex @samp{qGetTLSAddr} packet
37328 Fetch the address associated with thread local storage specified
37329 by @var{thread-id}, @var{offset}, and @var{lm}.
37330
37331 @var{thread-id} is the thread ID associated with the
37332 thread for which to fetch the TLS address.  @xref{thread-id syntax}.
37333
37334 @var{offset} is the (big endian, hex encoded) offset associated with the
37335 thread local variable.  (This offset is obtained from the debug
37336 information associated with the variable.)
37337
37338 @var{lm} is the (big endian, hex encoded) OS/ABI-specific encoding of the
37339 load module associated with the thread local storage.  For example,
37340 a @sc{gnu}/Linux system will pass the link map address of the shared
37341 object associated with the thread local storage under consideration. 
37342 Other operating environments may choose to represent the load module
37343 differently, so the precise meaning of this parameter will vary.
37344
37345 Reply:
37346 @table @samp
37347 @item @var{XX}@dots{}
37348 Hex encoded (big endian) bytes representing the address of the thread
37349 local storage requested.
37350
37351 @item E @var{nn}
37352 An error occurred.  The error number @var{nn} is given as hex digits.
37353
37354 @item @w{}
37355 An empty reply indicates that @samp{qGetTLSAddr} is not supported by the stub.
37356 @end table
37357
37358 @item qGetTIBAddr:@var{thread-id}
37359 @cindex get thread information block address
37360 @cindex @samp{qGetTIBAddr} packet
37361 Fetch address of the Windows OS specific Thread Information Block.
37362
37363 @var{thread-id} is the thread ID associated with the thread.
37364
37365 Reply:
37366 @table @samp
37367 @item @var{XX}@dots{}
37368 Hex encoded (big endian) bytes representing the linear address of the
37369 thread information block.
37370
37371 @item E @var{nn}
37372 An error occured.  This means that either the thread was not found, or the
37373 address could not be retrieved.
37374
37375 @item @w{}
37376 An empty reply indicates that @samp{qGetTIBAddr} is not supported by the stub.
37377 @end table
37378
37379 @item qL @var{startflag} @var{threadcount} @var{nextthread}
37380 Obtain thread information from RTOS.  Where: @var{startflag} (one hex
37381 digit) is one to indicate the first query and zero to indicate a
37382 subsequent query; @var{threadcount} (two hex digits) is the maximum
37383 number of threads the response packet can contain; and @var{nextthread}
37384 (eight hex digits), for subsequent queries (@var{startflag} is zero), is
37385 returned in the response as @var{argthread}.
37386
37387 Don't use this packet; use the @samp{qfThreadInfo} query instead (see above).
37388
37389 Reply:
37390 @table @samp
37391 @item qM @var{count} @var{done} @var{argthread} @var{thread}@dots{}
37392 Where: @var{count} (two hex digits) is the number of threads being
37393 returned; @var{done} (one hex digit) is zero to indicate more threads
37394 and one indicates no further threads; @var{argthreadid} (eight hex
37395 digits) is @var{nextthread} from the request packet; @var{thread}@dots{}
37396 is a sequence of thread IDs, @var{threadid} (eight hex
37397 digits), from the target.  See @code{remote.c:parse_threadlist_response()}.
37398 @end table
37399
37400 @item qOffsets
37401 @cindex section offsets, remote request
37402 @cindex @samp{qOffsets} packet
37403 Get section offsets that the target used when relocating the downloaded
37404 image.
37405
37406 Reply:
37407 @table @samp
37408 @item Text=@var{xxx};Data=@var{yyy}@r{[};Bss=@var{zzz}@r{]}
37409 Relocate the @code{Text} section by @var{xxx} from its original address.
37410 Relocate the @code{Data} section by @var{yyy} from its original address.
37411 If the object file format provides segment information (e.g.@: @sc{elf}
37412 @samp{PT_LOAD} program headers), @value{GDBN} will relocate entire
37413 segments by the supplied offsets.
37414
37415 @emph{Note: while a @code{Bss} offset may be included in the response,
37416 @value{GDBN} ignores this and instead applies the @code{Data} offset
37417 to the @code{Bss} section.}
37418
37419 @item TextSeg=@var{xxx}@r{[};DataSeg=@var{yyy}@r{]}
37420 Relocate the first segment of the object file, which conventionally
37421 contains program code, to a starting address of @var{xxx}.  If
37422 @samp{DataSeg} is specified, relocate the second segment, which
37423 conventionally contains modifiable data, to a starting address of
37424 @var{yyy}.  @value{GDBN} will report an error if the object file
37425 does not contain segment information, or does not contain at least
37426 as many segments as mentioned in the reply.  Extra segments are
37427 kept at fixed offsets relative to the last relocated segment.
37428 @end table
37429
37430 @item qP @var{mode} @var{thread-id}
37431 @cindex thread information, remote request
37432 @cindex @samp{qP} packet
37433 Returns information on @var{thread-id}.  Where: @var{mode} is a hex
37434 encoded 32 bit mode; @var{thread-id} is a thread ID 
37435 (@pxref{thread-id syntax}).
37436
37437 Don't use this packet; use the @samp{qThreadExtraInfo} query instead
37438 (see below).
37439
37440 Reply: see @code{remote.c:remote_unpack_thread_info_response()}.
37441
37442 @item QNonStop:1
37443 @itemx QNonStop:0
37444 @cindex non-stop mode, remote request
37445 @cindex @samp{QNonStop} packet
37446 @anchor{QNonStop}
37447 Enter non-stop (@samp{QNonStop:1}) or all-stop (@samp{QNonStop:0}) mode.
37448 @xref{Remote Non-Stop}, for more information.
37449
37450 Reply:
37451 @table @samp
37452 @item OK
37453 The request succeeded.
37454
37455 @item E @var{nn}
37456 An error occurred.  The error number @var{nn} is given as hex digits.
37457
37458 @item @w{}
37459 An empty reply indicates that @samp{QNonStop} is not supported by
37460 the stub.
37461 @end table
37462
37463 This packet is not probed by default; the remote stub must request it,
37464 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
37465 Use of this packet is controlled by the @code{set non-stop} command; 
37466 @pxref{Non-Stop Mode}.
37467
37468 @item QCatchSyscalls:1 @r{[};@var{sysno}@r{]}@dots{}
37469 @itemx QCatchSyscalls:0
37470 @cindex catch syscalls from inferior, remote request
37471 @cindex @samp{QCatchSyscalls} packet
37472 @anchor{QCatchSyscalls}
37473 Enable (@samp{QCatchSyscalls:1}) or disable (@samp{QCatchSyscalls:0})
37474 catching syscalls from the inferior process.
37475
37476 For @samp{QCatchSyscalls:1}, each listed syscall @var{sysno} (encoded
37477 in hex) should be reported to @value{GDBN}.  If no syscall @var{sysno}
37478 is listed, every system call should be reported.
37479
37480 Note that if a syscall not in the list is reported, @value{GDBN} will
37481 still filter the event according to its own list from all corresponding
37482 @code{catch syscall} commands.  However, it is more efficient to only
37483 report the requested syscalls.
37484
37485 Multiple @samp{QCatchSyscalls:1} packets do not combine; any earlier
37486 @samp{QCatchSyscalls:1} list is completely replaced by the new list.
37487
37488 If the inferior process execs, the state of @samp{QCatchSyscalls} is
37489 kept for the new process too.  On targets where exec may affect syscall
37490 numbers, for example with exec between 32 and 64-bit processes, the
37491 client should send a new packet with the new syscall list.
37492
37493 Reply:
37494 @table @samp
37495 @item OK
37496 The request succeeded.
37497
37498 @item E @var{nn}
37499 An error occurred.  @var{nn} are hex digits.
37500
37501 @item @w{}
37502 An empty reply indicates that @samp{QCatchSyscalls} is not supported by
37503 the stub.
37504 @end table
37505
37506 Use of this packet is controlled by the @code{set remote catch-syscalls}
37507 command (@pxref{Remote Configuration, set remote catch-syscalls}).
37508 This packet is not probed by default; the remote stub must request it,
37509 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
37510
37511 @item QPassSignals: @var{signal} @r{[};@var{signal}@r{]}@dots{}
37512 @cindex pass signals to inferior, remote request
37513 @cindex @samp{QPassSignals} packet
37514 @anchor{QPassSignals}
37515 Each listed @var{signal} should be passed directly to the inferior process. 
37516 Signals are numbered identically to continue packets and stop replies
37517 (@pxref{Stop Reply Packets}).  Each @var{signal} list item should be
37518 strictly greater than the previous item.  These signals do not need to stop
37519 the inferior, or be reported to @value{GDBN}.  All other signals should be
37520 reported to @value{GDBN}.  Multiple @samp{QPassSignals} packets do not
37521 combine; any earlier @samp{QPassSignals} list is completely replaced by the
37522 new list.  This packet improves performance when using @samp{handle
37523 @var{signal} nostop noprint pass}.
37524
37525 Reply:
37526 @table @samp
37527 @item OK
37528 The request succeeded.
37529
37530 @item E @var{nn}
37531 An error occurred.  The error number @var{nn} is given as hex digits.
37532
37533 @item @w{}
37534 An empty reply indicates that @samp{QPassSignals} is not supported by
37535 the stub.
37536 @end table
37537
37538 Use of this packet is controlled by the @code{set remote pass-signals}
37539 command (@pxref{Remote Configuration, set remote pass-signals}).
37540 This packet is not probed by default; the remote stub must request it,
37541 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
37542
37543 @item QProgramSignals: @var{signal} @r{[};@var{signal}@r{]}@dots{}
37544 @cindex signals the inferior may see, remote request
37545 @cindex @samp{QProgramSignals} packet
37546 @anchor{QProgramSignals}
37547 Each listed @var{signal} may be delivered to the inferior process.
37548 Others should be silently discarded.
37549
37550 In some cases, the remote stub may need to decide whether to deliver a
37551 signal to the program or not without @value{GDBN} involvement.  One
37552 example of that is while detaching --- the program's threads may have
37553 stopped for signals that haven't yet had a chance of being reported to
37554 @value{GDBN}, and so the remote stub can use the signal list specified
37555 by this packet to know whether to deliver or ignore those pending
37556 signals.
37557
37558 This does not influence whether to deliver a signal as requested by a
37559 resumption packet (@pxref{vCont packet}).
37560
37561 Signals are numbered identically to continue packets and stop replies
37562 (@pxref{Stop Reply Packets}).  Each @var{signal} list item should be
37563 strictly greater than the previous item.  Multiple
37564 @samp{QProgramSignals} packets do not combine; any earlier
37565 @samp{QProgramSignals} list is completely replaced by the new list.
37566
37567 Reply:
37568 @table @samp
37569 @item OK
37570 The request succeeded.
37571
37572 @item E @var{nn}
37573 An error occurred.  The error number @var{nn} is given as hex digits.
37574
37575 @item @w{}
37576 An empty reply indicates that @samp{QProgramSignals} is not supported
37577 by the stub.
37578 @end table
37579
37580 Use of this packet is controlled by the @code{set remote program-signals}
37581 command (@pxref{Remote Configuration, set remote program-signals}).
37582 This packet is not probed by default; the remote stub must request it,
37583 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
37584
37585 @anchor{QThreadEvents}
37586 @item QThreadEvents:1
37587 @itemx QThreadEvents:0
37588 @cindex thread create/exit events, remote request
37589 @cindex @samp{QThreadEvents} packet
37590
37591 Enable (@samp{QThreadEvents:1}) or disable (@samp{QThreadEvents:0})
37592 reporting of thread create and exit events.  @xref{thread create
37593 event}, for the reply specifications.  For example, this is used in
37594 non-stop mode when @value{GDBN} stops a set of threads and
37595 synchronously waits for the their corresponding stop replies.  Without
37596 exit events, if one of the threads exits, @value{GDBN} would hang
37597 forever not knowing that it should no longer expect a stop for that
37598 same thread.  @value{GDBN} does not enable this feature unless the
37599 stub reports that it supports it by including @samp{QThreadEvents+} in
37600 its @samp{qSupported} reply.
37601
37602 Reply:
37603 @table @samp
37604 @item OK
37605 The request succeeded.
37606
37607 @item E @var{nn}
37608 An error occurred.  The error number @var{nn} is given as hex digits.
37609
37610 @item @w{}
37611 An empty reply indicates that @samp{QThreadEvents} is not supported by
37612 the stub.
37613 @end table
37614
37615 Use of this packet is controlled by the @code{set remote thread-events}
37616 command (@pxref{Remote Configuration, set remote thread-events}).
37617
37618 @item qRcmd,@var{command}
37619 @cindex execute remote command, remote request
37620 @cindex @samp{qRcmd} packet
37621 @var{command} (hex encoded) is passed to the local interpreter for
37622 execution.  Invalid commands should be reported using the output
37623 string.  Before the final result packet, the target may also respond
37624 with a number of intermediate @samp{O@var{output}} console output
37625 packets.  @emph{Implementors should note that providing access to a
37626 stubs's interpreter may have security implications}.
37627
37628 Reply:
37629 @table @samp
37630 @item OK
37631 A command response with no output.
37632 @item @var{OUTPUT}
37633 A command response with the hex encoded output string @var{OUTPUT}.
37634 @item E @var{NN}
37635 Indicate a badly formed request.
37636 @item @w{}
37637 An empty reply indicates that @samp{qRcmd} is not recognized.
37638 @end table
37639
37640 (Note that the @code{qRcmd} packet's name is separated from the
37641 command by a @samp{,}, not a @samp{:}, contrary to the naming
37642 conventions above.  Please don't use this packet as a model for new
37643 packets.)
37644
37645 @item qSearch:memory:@var{address};@var{length};@var{search-pattern}
37646 @cindex searching memory, in remote debugging
37647 @ifnotinfo
37648 @cindex @samp{qSearch:memory} packet
37649 @end ifnotinfo
37650 @cindex @samp{qSearch memory} packet
37651 @anchor{qSearch memory}
37652 Search @var{length} bytes at @var{address} for @var{search-pattern}.
37653 Both @var{address} and @var{length} are encoded in hex;
37654 @var{search-pattern} is a sequence of bytes, also hex encoded.
37655
37656 Reply:
37657 @table @samp
37658 @item 0
37659 The pattern was not found.
37660 @item 1,address
37661 The pattern was found at @var{address}.
37662 @item E @var{NN}
37663 A badly formed request or an error was encountered while searching memory.
37664 @item @w{}
37665 An empty reply indicates that @samp{qSearch:memory} is not recognized.
37666 @end table
37667
37668 @item QStartNoAckMode
37669 @cindex @samp{QStartNoAckMode} packet
37670 @anchor{QStartNoAckMode}
37671 Request that the remote stub disable the normal @samp{+}/@samp{-}
37672 protocol acknowledgments (@pxref{Packet Acknowledgment}).
37673
37674 Reply:
37675 @table @samp
37676 @item OK
37677 The stub has switched to no-acknowledgment mode.
37678 @value{GDBN} acknowledges this reponse,
37679 but neither the stub nor @value{GDBN} shall send or expect further
37680 @samp{+}/@samp{-} acknowledgments in the current connection.
37681 @item @w{}
37682 An empty reply indicates that the stub does not support no-acknowledgment mode.
37683 @end table
37684
37685 @item qSupported @r{[}:@var{gdbfeature} @r{[};@var{gdbfeature}@r{]}@dots{} @r{]}
37686 @cindex supported packets, remote query
37687 @cindex features of the remote protocol
37688 @cindex @samp{qSupported} packet
37689 @anchor{qSupported}
37690 Tell the remote stub about features supported by @value{GDBN}, and
37691 query the stub for features it supports.  This packet allows
37692 @value{GDBN} and the remote stub to take advantage of each others'
37693 features.  @samp{qSupported} also consolidates multiple feature probes
37694 at startup, to improve @value{GDBN} performance---a single larger
37695 packet performs better than multiple smaller probe packets on
37696 high-latency links.  Some features may enable behavior which must not
37697 be on by default, e.g.@: because it would confuse older clients or
37698 stubs.  Other features may describe packets which could be
37699 automatically probed for, but are not.  These features must be
37700 reported before @value{GDBN} will use them.  This ``default
37701 unsupported'' behavior is not appropriate for all packets, but it
37702 helps to keep the initial connection time under control with new
37703 versions of @value{GDBN} which support increasing numbers of packets.
37704
37705 Reply:
37706 @table @samp
37707 @item @var{stubfeature} @r{[};@var{stubfeature}@r{]}@dots{}
37708 The stub supports or does not support each returned @var{stubfeature},
37709 depending on the form of each @var{stubfeature} (see below for the
37710 possible forms).
37711 @item @w{}
37712 An empty reply indicates that @samp{qSupported} is not recognized,
37713 or that no features needed to be reported to @value{GDBN}.
37714 @end table
37715
37716 The allowed forms for each feature (either a @var{gdbfeature} in the
37717 @samp{qSupported} packet, or a @var{stubfeature} in the response)
37718 are:
37719
37720 @table @samp
37721 @item @var{name}=@var{value}
37722 The remote protocol feature @var{name} is supported, and associated
37723 with the specified @var{value}.  The format of @var{value} depends
37724 on the feature, but it must not include a semicolon.
37725 @item @var{name}+
37726 The remote protocol feature @var{name} is supported, and does not
37727 need an associated value.
37728 @item @var{name}-
37729 The remote protocol feature @var{name} is not supported.
37730 @item @var{name}?
37731 The remote protocol feature @var{name} may be supported, and
37732 @value{GDBN} should auto-detect support in some other way when it is
37733 needed.  This form will not be used for @var{gdbfeature} notifications,
37734 but may be used for @var{stubfeature} responses.
37735 @end table
37736
37737 Whenever the stub receives a @samp{qSupported} request, the
37738 supplied set of @value{GDBN} features should override any previous
37739 request.  This allows @value{GDBN} to put the stub in a known
37740 state, even if the stub had previously been communicating with
37741 a different version of @value{GDBN}.
37742
37743 The following values of @var{gdbfeature} (for the packet sent by @value{GDBN})
37744 are defined:  
37745
37746 @table @samp
37747 @item multiprocess
37748 This feature indicates whether @value{GDBN} supports multiprocess 
37749 extensions to the remote protocol.  @value{GDBN} does not use such
37750 extensions unless the stub also reports that it supports them by
37751 including @samp{multiprocess+} in its @samp{qSupported} reply.
37752 @xref{multiprocess extensions}, for details.
37753
37754 @item xmlRegisters
37755 This feature indicates that @value{GDBN} supports the XML target
37756 description.  If the stub sees @samp{xmlRegisters=} with target
37757 specific strings separated by a comma, it will report register
37758 description.
37759
37760 @item qRelocInsn
37761 This feature indicates whether @value{GDBN} supports the
37762 @samp{qRelocInsn} packet (@pxref{Tracepoint Packets,,Relocate
37763 instruction reply packet}).
37764
37765 @item swbreak
37766 This feature indicates whether @value{GDBN} supports the swbreak stop
37767 reason in stop replies.  @xref{swbreak stop reason}, for details.
37768
37769 @item hwbreak
37770 This feature indicates whether @value{GDBN} supports the hwbreak stop
37771 reason in stop replies.  @xref{swbreak stop reason}, for details.
37772
37773 @item fork-events
37774 This feature indicates whether @value{GDBN} supports fork event
37775 extensions to the remote protocol.  @value{GDBN} does not use such
37776 extensions unless the stub also reports that it supports them by
37777 including @samp{fork-events+} in its @samp{qSupported} reply.
37778
37779 @item vfork-events
37780 This feature indicates whether @value{GDBN} supports vfork event
37781 extensions to the remote protocol.  @value{GDBN} does not use such
37782 extensions unless the stub also reports that it supports them by
37783 including @samp{vfork-events+} in its @samp{qSupported} reply.
37784
37785 @item exec-events
37786 This feature indicates whether @value{GDBN} supports exec event
37787 extensions to the remote protocol.  @value{GDBN} does not use such
37788 extensions unless the stub also reports that it supports them by
37789 including @samp{exec-events+} in its @samp{qSupported} reply.
37790
37791 @item vContSupported
37792 This feature indicates whether @value{GDBN} wants to know the
37793 supported actions in the reply to @samp{vCont?} packet.
37794 @end table
37795
37796 Stubs should ignore any unknown values for
37797 @var{gdbfeature}.  Any @value{GDBN} which sends a @samp{qSupported}
37798 packet supports receiving packets of unlimited length (earlier
37799 versions of @value{GDBN} may reject overly long responses).  Additional values
37800 for @var{gdbfeature} may be defined in the future to let the stub take
37801 advantage of new features in @value{GDBN}, e.g.@: incompatible
37802 improvements in the remote protocol---the @samp{multiprocess} feature is
37803 an example of such a feature.  The stub's reply should be independent
37804 of the @var{gdbfeature} entries sent by @value{GDBN}; first @value{GDBN}
37805 describes all the features it supports, and then the stub replies with
37806 all the features it supports.
37807
37808 Similarly, @value{GDBN} will silently ignore unrecognized stub feature
37809 responses, as long as each response uses one of the standard forms.
37810
37811 Some features are flags.  A stub which supports a flag feature
37812 should respond with a @samp{+} form response.  Other features
37813 require values, and the stub should respond with an @samp{=}
37814 form response.
37815
37816 Each feature has a default value, which @value{GDBN} will use if
37817 @samp{qSupported} is not available or if the feature is not mentioned
37818 in the @samp{qSupported} response.  The default values are fixed; a
37819 stub is free to omit any feature responses that match the defaults.
37820
37821 Not all features can be probed, but for those which can, the probing
37822 mechanism is useful: in some cases, a stub's internal
37823 architecture may not allow the protocol layer to know some information
37824 about the underlying target in advance.  This is especially common in
37825 stubs which may be configured for multiple targets.
37826
37827 These are the currently defined stub features and their properties:
37828
37829 @multitable @columnfractions 0.35 0.2 0.12 0.2
37830 @c NOTE: The first row should be @headitem, but we do not yet require
37831 @c a new enough version of Texinfo (4.7) to use @headitem.
37832 @item Feature Name
37833 @tab Value Required
37834 @tab Default
37835 @tab Probe Allowed
37836
37837 @item @samp{PacketSize}
37838 @tab Yes
37839 @tab @samp{-}
37840 @tab No
37841
37842 @item @samp{qXfer:auxv:read}
37843 @tab No
37844 @tab @samp{-}
37845 @tab Yes
37846
37847 @item @samp{qXfer:btrace:read}
37848 @tab No
37849 @tab @samp{-}
37850 @tab Yes
37851
37852 @item @samp{qXfer:btrace-conf:read}
37853 @tab No
37854 @tab @samp{-}
37855 @tab Yes
37856
37857 @item @samp{qXfer:exec-file:read}
37858 @tab No
37859 @tab @samp{-}
37860 @tab Yes
37861
37862 @item @samp{qXfer:features:read}
37863 @tab No
37864 @tab @samp{-}
37865 @tab Yes
37866
37867 @item @samp{qXfer:libraries:read}
37868 @tab No
37869 @tab @samp{-}
37870 @tab Yes
37871
37872 @item @samp{qXfer:libraries-svr4:read}
37873 @tab No
37874 @tab @samp{-}
37875 @tab Yes
37876
37877 @item @samp{augmented-libraries-svr4-read}
37878 @tab No
37879 @tab @samp{-}
37880 @tab No
37881
37882 @item @samp{qXfer:memory-map:read}
37883 @tab No
37884 @tab @samp{-}
37885 @tab Yes
37886
37887 @item @samp{qXfer:sdata:read}
37888 @tab No
37889 @tab @samp{-}
37890 @tab Yes
37891
37892 @item @samp{qXfer:spu:read}
37893 @tab No
37894 @tab @samp{-}
37895 @tab Yes
37896
37897 @item @samp{qXfer:spu:write}
37898 @tab No
37899 @tab @samp{-}
37900 @tab Yes
37901
37902 @item @samp{qXfer:siginfo:read}
37903 @tab No
37904 @tab @samp{-}
37905 @tab Yes
37906
37907 @item @samp{qXfer:siginfo:write}
37908 @tab No
37909 @tab @samp{-}
37910 @tab Yes
37911
37912 @item @samp{qXfer:threads:read}
37913 @tab No
37914 @tab @samp{-}
37915 @tab Yes
37916
37917 @item @samp{qXfer:traceframe-info:read}
37918 @tab No
37919 @tab @samp{-}
37920 @tab Yes
37921
37922 @item @samp{qXfer:uib:read}
37923 @tab No
37924 @tab @samp{-}
37925 @tab Yes
37926
37927 @item @samp{qXfer:fdpic:read}
37928 @tab No
37929 @tab @samp{-}
37930 @tab Yes
37931
37932 @item @samp{Qbtrace:off}
37933 @tab Yes
37934 @tab @samp{-}
37935 @tab Yes
37936
37937 @item @samp{Qbtrace:bts}
37938 @tab Yes
37939 @tab @samp{-}
37940 @tab Yes
37941
37942 @item @samp{Qbtrace:pt}
37943 @tab Yes
37944 @tab @samp{-}
37945 @tab Yes
37946
37947 @item @samp{Qbtrace-conf:bts:size}
37948 @tab Yes
37949 @tab @samp{-}
37950 @tab Yes
37951
37952 @item @samp{Qbtrace-conf:pt:size}
37953 @tab Yes
37954 @tab @samp{-}
37955 @tab Yes
37956
37957 @item @samp{QNonStop}
37958 @tab No
37959 @tab @samp{-}
37960 @tab Yes
37961
37962 @item @samp{QCatchSyscalls}
37963 @tab No
37964 @tab @samp{-}
37965 @tab Yes
37966
37967 @item @samp{QPassSignals}
37968 @tab No
37969 @tab @samp{-}
37970 @tab Yes
37971
37972 @item @samp{QStartNoAckMode}
37973 @tab No
37974 @tab @samp{-}
37975 @tab Yes
37976
37977 @item @samp{multiprocess}
37978 @tab No
37979 @tab @samp{-}
37980 @tab No
37981
37982 @item @samp{ConditionalBreakpoints}
37983 @tab No
37984 @tab @samp{-}
37985 @tab No
37986
37987 @item @samp{ConditionalTracepoints}
37988 @tab No
37989 @tab @samp{-}
37990 @tab No
37991
37992 @item @samp{ReverseContinue}
37993 @tab No
37994 @tab @samp{-}
37995 @tab No
37996
37997 @item @samp{ReverseStep}
37998 @tab No
37999 @tab @samp{-}
38000 @tab No
38001
38002 @item @samp{TracepointSource}
38003 @tab No
38004 @tab @samp{-}
38005 @tab No
38006
38007 @item @samp{QAgent}
38008 @tab No
38009 @tab @samp{-}
38010 @tab No
38011
38012 @item @samp{QAllow}
38013 @tab No
38014 @tab @samp{-}
38015 @tab No
38016
38017 @item @samp{QDisableRandomization}
38018 @tab No
38019 @tab @samp{-}
38020 @tab No
38021
38022 @item @samp{EnableDisableTracepoints}
38023 @tab No
38024 @tab @samp{-}
38025 @tab No
38026
38027 @item @samp{QTBuffer:size}
38028 @tab No
38029 @tab @samp{-}
38030 @tab No
38031
38032 @item @samp{tracenz}
38033 @tab No
38034 @tab @samp{-}
38035 @tab No
38036
38037 @item @samp{BreakpointCommands}
38038 @tab No
38039 @tab @samp{-}
38040 @tab No
38041
38042 @item @samp{swbreak}
38043 @tab No
38044 @tab @samp{-}
38045 @tab No
38046
38047 @item @samp{hwbreak}
38048 @tab No
38049 @tab @samp{-}
38050 @tab No
38051
38052 @item @samp{fork-events}
38053 @tab No
38054 @tab @samp{-}
38055 @tab No
38056
38057 @item @samp{vfork-events}
38058 @tab No
38059 @tab @samp{-}
38060 @tab No
38061
38062 @item @samp{exec-events}
38063 @tab No
38064 @tab @samp{-}
38065 @tab No
38066
38067 @item @samp{QThreadEvents}
38068 @tab No
38069 @tab @samp{-}
38070 @tab No
38071
38072 @item @samp{no-resumed}
38073 @tab No
38074 @tab @samp{-}
38075 @tab No
38076
38077 @end multitable
38078
38079 These are the currently defined stub features, in more detail:
38080
38081 @table @samp
38082 @cindex packet size, remote protocol
38083 @item PacketSize=@var{bytes}
38084 The remote stub can accept packets up to at least @var{bytes} in
38085 length.  @value{GDBN} will send packets up to this size for bulk
38086 transfers, and will never send larger packets.  This is a limit on the
38087 data characters in the packet, including the frame and checksum.
38088 There is no trailing NUL byte in a remote protocol packet; if the stub
38089 stores packets in a NUL-terminated format, it should allow an extra
38090 byte in its buffer for the NUL.  If this stub feature is not supported,
38091 @value{GDBN} guesses based on the size of the @samp{g} packet response.
38092
38093 @item qXfer:auxv:read
38094 The remote stub understands the @samp{qXfer:auxv:read} packet
38095 (@pxref{qXfer auxiliary vector read}).
38096
38097 @item qXfer:btrace:read
38098 The remote stub understands the @samp{qXfer:btrace:read}
38099 packet (@pxref{qXfer btrace read}).
38100
38101 @item qXfer:btrace-conf:read
38102 The remote stub understands the @samp{qXfer:btrace-conf:read}
38103 packet (@pxref{qXfer btrace-conf read}).
38104
38105 @item qXfer:exec-file:read
38106 The remote stub understands the @samp{qXfer:exec-file:read} packet
38107 (@pxref{qXfer executable filename read}).
38108
38109 @item qXfer:features:read
38110 The remote stub understands the @samp{qXfer:features:read} packet
38111 (@pxref{qXfer target description read}).
38112
38113 @item qXfer:libraries:read
38114 The remote stub understands the @samp{qXfer:libraries:read} packet
38115 (@pxref{qXfer library list read}).
38116
38117 @item qXfer:libraries-svr4:read
38118 The remote stub understands the @samp{qXfer:libraries-svr4:read} packet
38119 (@pxref{qXfer svr4 library list read}).
38120
38121 @item augmented-libraries-svr4-read
38122 The remote stub understands the augmented form of the
38123 @samp{qXfer:libraries-svr4:read} packet
38124 (@pxref{qXfer svr4 library list read}).
38125
38126 @item qXfer:memory-map:read
38127 The remote stub understands the @samp{qXfer:memory-map:read} packet
38128 (@pxref{qXfer memory map read}).
38129
38130 @item qXfer:sdata:read
38131 The remote stub understands the @samp{qXfer:sdata:read} packet
38132 (@pxref{qXfer sdata read}).
38133
38134 @item qXfer:spu:read
38135 The remote stub understands the @samp{qXfer:spu:read} packet
38136 (@pxref{qXfer spu read}).
38137
38138 @item qXfer:spu:write
38139 The remote stub understands the @samp{qXfer:spu:write} packet
38140 (@pxref{qXfer spu write}).
38141
38142 @item qXfer:siginfo:read
38143 The remote stub understands the @samp{qXfer:siginfo:read} packet
38144 (@pxref{qXfer siginfo read}).
38145
38146 @item qXfer:siginfo:write
38147 The remote stub understands the @samp{qXfer:siginfo:write} packet
38148 (@pxref{qXfer siginfo write}).
38149
38150 @item qXfer:threads:read
38151 The remote stub understands the @samp{qXfer:threads:read} packet
38152 (@pxref{qXfer threads read}).
38153
38154 @item qXfer:traceframe-info:read
38155 The remote stub understands the @samp{qXfer:traceframe-info:read}
38156 packet (@pxref{qXfer traceframe info read}).
38157
38158 @item qXfer:uib:read
38159 The remote stub understands the @samp{qXfer:uib:read}
38160 packet (@pxref{qXfer unwind info block}).
38161
38162 @item qXfer:fdpic:read
38163 The remote stub understands the @samp{qXfer:fdpic:read}
38164 packet (@pxref{qXfer fdpic loadmap read}).
38165
38166 @item QNonStop
38167 The remote stub understands the @samp{QNonStop} packet
38168 (@pxref{QNonStop}).
38169
38170 @item QCatchSyscalls
38171 The remote stub understands the @samp{QCatchSyscalls} packet
38172 (@pxref{QCatchSyscalls}).
38173
38174 @item QPassSignals
38175 The remote stub understands the @samp{QPassSignals} packet
38176 (@pxref{QPassSignals}).
38177
38178 @item QStartNoAckMode
38179 The remote stub understands the @samp{QStartNoAckMode} packet and
38180 prefers to operate in no-acknowledgment mode.  @xref{Packet Acknowledgment}.
38181
38182 @item multiprocess
38183 @anchor{multiprocess extensions}
38184 @cindex multiprocess extensions, in remote protocol
38185 The remote stub understands the multiprocess extensions to the remote
38186 protocol syntax.  The multiprocess extensions affect the syntax of
38187 thread IDs in both packets and replies (@pxref{thread-id syntax}), and
38188 add process IDs to the @samp{D} packet and @samp{W} and @samp{X}
38189 replies.  Note that reporting this feature indicates support for the
38190 syntactic extensions only, not that the stub necessarily supports
38191 debugging of more than one process at a time.  The stub must not use
38192 multiprocess extensions in packet replies unless @value{GDBN} has also
38193 indicated it supports them in its @samp{qSupported} request.
38194
38195 @item qXfer:osdata:read
38196 The remote stub understands the @samp{qXfer:osdata:read} packet
38197 ((@pxref{qXfer osdata read}).
38198
38199 @item ConditionalBreakpoints
38200 The target accepts and implements evaluation of conditional expressions
38201 defined for breakpoints.  The target will only report breakpoint triggers
38202 when such conditions are true (@pxref{Conditions, ,Break Conditions}).
38203
38204 @item ConditionalTracepoints
38205 The remote stub accepts and implements conditional expressions defined
38206 for tracepoints (@pxref{Tracepoint Conditions}).
38207
38208 @item ReverseContinue
38209 The remote stub accepts and implements the reverse continue packet
38210 (@pxref{bc}).
38211
38212 @item ReverseStep
38213 The remote stub accepts and implements the reverse step packet
38214 (@pxref{bs}).
38215
38216 @item TracepointSource
38217 The remote stub understands the @samp{QTDPsrc} packet that supplies
38218 the source form of tracepoint definitions.
38219
38220 @item QAgent
38221 The remote stub understands the @samp{QAgent} packet.
38222
38223 @item QAllow
38224 The remote stub understands the @samp{QAllow} packet.
38225
38226 @item QDisableRandomization
38227 The remote stub understands the @samp{QDisableRandomization} packet.
38228
38229 @item StaticTracepoint
38230 @cindex static tracepoints, in remote protocol
38231 The remote stub supports static tracepoints.
38232
38233 @item InstallInTrace
38234 @anchor{install tracepoint in tracing}
38235 The remote stub supports installing tracepoint in tracing.
38236
38237 @item EnableDisableTracepoints
38238 The remote stub supports the @samp{QTEnable} (@pxref{QTEnable}) and
38239 @samp{QTDisable} (@pxref{QTDisable}) packets that allow tracepoints
38240 to be enabled and disabled while a trace experiment is running.
38241
38242 @item QTBuffer:size
38243 The remote stub supports the @samp{QTBuffer:size} (@pxref{QTBuffer-size})
38244 packet that allows to change the size of the trace buffer.
38245
38246 @item tracenz
38247 @cindex string tracing, in remote protocol
38248 The remote stub supports the @samp{tracenz} bytecode for collecting strings.
38249 See @ref{Bytecode Descriptions} for details about the bytecode.
38250
38251 @item BreakpointCommands
38252 @cindex breakpoint commands, in remote protocol
38253 The remote stub supports running a breakpoint's command list itself,
38254 rather than reporting the hit to @value{GDBN}.
38255
38256 @item Qbtrace:off
38257 The remote stub understands the @samp{Qbtrace:off} packet.
38258
38259 @item Qbtrace:bts
38260 The remote stub understands the @samp{Qbtrace:bts} packet.
38261
38262 @item Qbtrace:pt
38263 The remote stub understands the @samp{Qbtrace:pt} packet.
38264
38265 @item Qbtrace-conf:bts:size
38266 The remote stub understands the @samp{Qbtrace-conf:bts:size} packet.
38267
38268 @item Qbtrace-conf:pt:size
38269 The remote stub understands the @samp{Qbtrace-conf:pt:size} packet.
38270
38271 @item swbreak
38272 The remote stub reports the @samp{swbreak} stop reason for memory
38273 breakpoints.
38274
38275 @item hwbreak
38276 The remote stub reports the @samp{hwbreak} stop reason for hardware
38277 breakpoints.
38278
38279 @item fork-events
38280 The remote stub reports the @samp{fork} stop reason for fork events.
38281
38282 @item vfork-events
38283 The remote stub reports the @samp{vfork} stop reason for vfork events
38284 and vforkdone events.
38285
38286 @item exec-events
38287 The remote stub reports the @samp{exec} stop reason for exec events.
38288
38289 @item vContSupported
38290 The remote stub reports the supported actions in the reply to
38291 @samp{vCont?} packet.
38292
38293 @item QThreadEvents
38294 The remote stub understands the @samp{QThreadEvents} packet.
38295
38296 @item no-resumed
38297 The remote stub reports the @samp{N} stop reply.
38298
38299 @end table
38300
38301 @item qSymbol::
38302 @cindex symbol lookup, remote request
38303 @cindex @samp{qSymbol} packet
38304 Notify the target that @value{GDBN} is prepared to serve symbol lookup
38305 requests.  Accept requests from the target for the values of symbols.
38306
38307 Reply:
38308 @table @samp
38309 @item OK
38310 The target does not need to look up any (more) symbols.
38311 @item qSymbol:@var{sym_name}
38312 The target requests the value of symbol @var{sym_name} (hex encoded).
38313 @value{GDBN} may provide the value by using the
38314 @samp{qSymbol:@var{sym_value}:@var{sym_name}} message, described
38315 below.
38316 @end table
38317
38318 @item qSymbol:@var{sym_value}:@var{sym_name}
38319 Set the value of @var{sym_name} to @var{sym_value}.
38320
38321 @var{sym_name} (hex encoded) is the name of a symbol whose value the
38322 target has previously requested.
38323
38324 @var{sym_value} (hex) is the value for symbol @var{sym_name}.  If
38325 @value{GDBN} cannot supply a value for @var{sym_name}, then this field
38326 will be empty.
38327
38328 Reply:
38329 @table @samp
38330 @item OK
38331 The target does not need to look up any (more) symbols.
38332 @item qSymbol:@var{sym_name}
38333 The target requests the value of a new symbol @var{sym_name} (hex
38334 encoded).  @value{GDBN} will continue to supply the values of symbols
38335 (if available), until the target ceases to request them.
38336 @end table
38337
38338 @item qTBuffer
38339 @itemx QTBuffer
38340 @itemx QTDisconnected
38341 @itemx QTDP
38342 @itemx QTDPsrc
38343 @itemx QTDV
38344 @itemx qTfP
38345 @itemx qTfV
38346 @itemx QTFrame
38347 @itemx qTMinFTPILen
38348
38349 @xref{Tracepoint Packets}.
38350
38351 @item qThreadExtraInfo,@var{thread-id}
38352 @cindex thread attributes info, remote request
38353 @cindex @samp{qThreadExtraInfo} packet
38354 Obtain from the target OS a printable string description of thread
38355 attributes for the thread @var{thread-id}; see @ref{thread-id syntax},
38356 for the forms of @var{thread-id}.  This
38357 string may contain anything that the target OS thinks is interesting
38358 for @value{GDBN} to tell the user about the thread.  The string is
38359 displayed in @value{GDBN}'s @code{info threads} display.  Some
38360 examples of possible thread extra info strings are @samp{Runnable}, or
38361 @samp{Blocked on Mutex}.
38362
38363 Reply:
38364 @table @samp
38365 @item @var{XX}@dots{}
38366 Where @samp{@var{XX}@dots{}} is a hex encoding of @sc{ascii} data,
38367 comprising the printable string containing the extra information about
38368 the thread's attributes.
38369 @end table
38370
38371 (Note that the @code{qThreadExtraInfo} packet's name is separated from
38372 the command by a @samp{,}, not a @samp{:}, contrary to the naming
38373 conventions above.  Please don't use this packet as a model for new
38374 packets.)
38375
38376 @item QTNotes
38377 @itemx qTP
38378 @itemx QTSave
38379 @itemx qTsP
38380 @itemx qTsV
38381 @itemx QTStart    
38382 @itemx QTStop     
38383 @itemx QTEnable
38384 @itemx QTDisable
38385 @itemx QTinit     
38386 @itemx QTro       
38387 @itemx qTStatus   
38388 @itemx qTV
38389 @itemx qTfSTM
38390 @itemx qTsSTM
38391 @itemx qTSTMat
38392 @xref{Tracepoint Packets}.
38393
38394 @item qXfer:@var{object}:read:@var{annex}:@var{offset},@var{length}
38395 @cindex read special object, remote request
38396 @cindex @samp{qXfer} packet
38397 @anchor{qXfer read}
38398 Read uninterpreted bytes from the target's special data area
38399 identified by the keyword @var{object}.  Request @var{length} bytes
38400 starting at @var{offset} bytes into the data.  The content and
38401 encoding of @var{annex} is specific to @var{object}; it can supply
38402 additional details about what data to access.
38403
38404 Reply:
38405 @table @samp
38406 @item m @var{data}
38407 Data @var{data} (@pxref{Binary Data}) has been read from the
38408 target.  There may be more data at a higher address (although
38409 it is permitted to return @samp{m} even for the last valid
38410 block of data, as long as at least one byte of data was read).
38411 It is possible for @var{data} to have fewer bytes than the @var{length} in the
38412 request.
38413
38414 @item l @var{data}
38415 Data @var{data} (@pxref{Binary Data}) has been read from the target.
38416 There is no more data to be read.  It is possible for @var{data} to
38417 have fewer bytes than the @var{length} in the request.
38418
38419 @item l
38420 The @var{offset} in the request is at the end of the data.
38421 There is no more data to be read.
38422
38423 @item E00
38424 The request was malformed, or @var{annex} was invalid.
38425
38426 @item E @var{nn}
38427 The offset was invalid, or there was an error encountered reading the data.
38428 The @var{nn} part is a hex-encoded @code{errno} value.
38429
38430 @item @w{}
38431 An empty reply indicates the @var{object} string was not recognized by
38432 the stub, or that the object does not support reading.
38433 @end table
38434
38435 Here are the specific requests of this form defined so far.  All the
38436 @samp{qXfer:@var{object}:read:@dots{}} requests use the same reply
38437 formats, listed above.
38438
38439 @table @samp
38440 @item qXfer:auxv:read::@var{offset},@var{length}
38441 @anchor{qXfer auxiliary vector read}
38442 Access the target's @dfn{auxiliary vector}.  @xref{OS Information,
38443 auxiliary vector}.  Note @var{annex} must be empty.
38444
38445 This packet is not probed by default; the remote stub must request it,
38446 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
38447
38448 @item qXfer:btrace:read:@var{annex}:@var{offset},@var{length}
38449 @anchor{qXfer btrace read}
38450
38451 Return a description of the current branch trace.
38452 @xref{Branch Trace Format}.  The annex part of the generic @samp{qXfer}
38453 packet may have one of the following values:
38454
38455 @table @code
38456 @item all
38457 Returns all available branch trace.
38458
38459 @item new
38460 Returns all available branch trace if the branch trace changed since
38461 the last read request.
38462
38463 @item delta
38464 Returns the new branch trace since the last read request.  Adds a new
38465 block to the end of the trace that begins at zero and ends at the source
38466 location of the first branch in the trace buffer.  This extra block is
38467 used to stitch traces together.
38468
38469 If the trace buffer overflowed, returns an error indicating the overflow.
38470 @end table
38471
38472 This packet is not probed by default; the remote stub must request it
38473 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
38474
38475 @item qXfer:btrace-conf:read::@var{offset},@var{length}
38476 @anchor{qXfer btrace-conf read}
38477
38478 Return a description of the current branch trace configuration.
38479 @xref{Branch Trace Configuration Format}.
38480
38481 This packet is not probed by default; the remote stub must request it
38482 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
38483
38484 @item qXfer:exec-file:read:@var{annex}:@var{offset},@var{length}
38485 @anchor{qXfer executable filename read}
38486 Return the full absolute name of the file that was executed to create
38487 a process running on the remote system.  The annex specifies the
38488 numeric process ID of the process to query, encoded as a hexadecimal
38489 number.  If the annex part is empty the remote stub should return the
38490 filename corresponding to the currently executing process.
38491
38492 This packet is not probed by default; the remote stub must request it,
38493 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
38494
38495 @item qXfer:features:read:@var{annex}:@var{offset},@var{length}
38496 @anchor{qXfer target description read}
38497 Access the @dfn{target description}.  @xref{Target Descriptions}.  The
38498 annex specifies which XML document to access.  The main description is
38499 always loaded from the @samp{target.xml} annex.
38500
38501 This packet is not probed by default; the remote stub must request it,
38502 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
38503
38504 @item qXfer:libraries:read:@var{annex}:@var{offset},@var{length}
38505 @anchor{qXfer library list read}
38506 Access the target's list of loaded libraries.  @xref{Library List Format}.
38507 The annex part of the generic @samp{qXfer} packet must be empty
38508 (@pxref{qXfer read}).
38509
38510 Targets which maintain a list of libraries in the program's memory do
38511 not need to implement this packet; it is designed for platforms where
38512 the operating system manages the list of loaded libraries.
38513
38514 This packet is not probed by default; the remote stub must request it,
38515 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
38516
38517 @item qXfer:libraries-svr4:read:@var{annex}:@var{offset},@var{length}
38518 @anchor{qXfer svr4 library list read}
38519 Access the target's list of loaded libraries when the target is an SVR4
38520 platform.  @xref{Library List Format for SVR4 Targets}.  The annex part
38521 of the generic @samp{qXfer} packet must be empty unless the remote
38522 stub indicated it supports the augmented form of this packet
38523 by supplying an appropriate @samp{qSupported} response
38524 (@pxref{qXfer read}, @ref{qSupported}).
38525
38526 This packet is optional for better performance on SVR4 targets.  
38527 @value{GDBN} uses memory read packets to read the SVR4 library list otherwise.
38528
38529 This packet is not probed by default; the remote stub must request it,
38530 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
38531
38532 If the remote stub indicates it supports the augmented form of this
38533 packet then the annex part of the generic @samp{qXfer} packet may
38534 contain a semicolon-separated list of @samp{@var{name}=@var{value}}
38535 arguments.  The currently supported arguments are:
38536
38537 @table @code
38538 @item start=@var{address}
38539 A hexadecimal number specifying the address of the @samp{struct
38540 link_map} to start reading the library list from.  If unset or zero
38541 then the first @samp{struct link_map} in the library list will be
38542 chosen as the starting point.
38543
38544 @item prev=@var{address}
38545 A hexadecimal number specifying the address of the @samp{struct
38546 link_map} immediately preceding the @samp{struct link_map}
38547 specified by the @samp{start} argument.  If unset or zero then
38548 the remote stub will expect that no @samp{struct link_map}
38549 exists prior to the starting point.
38550
38551 @end table
38552
38553 Arguments that are not understood by the remote stub will be silently
38554 ignored.
38555
38556 @item qXfer:memory-map:read::@var{offset},@var{length}
38557 @anchor{qXfer memory map read}
38558 Access the target's @dfn{memory-map}.  @xref{Memory Map Format}.  The
38559 annex part of the generic @samp{qXfer} packet must be empty
38560 (@pxref{qXfer read}).
38561
38562 This packet is not probed by default; the remote stub must request it,
38563 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
38564
38565 @item qXfer:sdata:read::@var{offset},@var{length}
38566 @anchor{qXfer sdata read}
38567
38568 Read contents of the extra collected static tracepoint marker
38569 information.  The annex part of the generic @samp{qXfer} packet must
38570 be empty (@pxref{qXfer read}).  @xref{Tracepoint Actions,,Tracepoint
38571 Action Lists}.
38572
38573 This packet is not probed by default; the remote stub must request it,
38574 by supplying an appropriate @samp{qSupported} response
38575 (@pxref{qSupported}).
38576
38577 @item qXfer:siginfo:read::@var{offset},@var{length}
38578 @anchor{qXfer siginfo read}
38579 Read contents of the extra signal information on the target
38580 system.  The annex part of the generic @samp{qXfer} packet must be
38581 empty (@pxref{qXfer read}).
38582
38583 This packet is not probed by default; the remote stub must request it,
38584 by supplying an appropriate @samp{qSupported} response
38585 (@pxref{qSupported}).
38586
38587 @item qXfer:spu:read:@var{annex}:@var{offset},@var{length}
38588 @anchor{qXfer spu read}
38589 Read contents of an @code{spufs} file on the target system.  The
38590 annex specifies which file to read; it must be of the form 
38591 @file{@var{id}/@var{name}}, where @var{id} specifies an SPU context ID
38592 in the target process, and @var{name} identifes the @code{spufs} file
38593 in that context to be accessed.
38594
38595 This packet is not probed by default; the remote stub must request it,
38596 by supplying an appropriate @samp{qSupported} response
38597 (@pxref{qSupported}).
38598
38599 @item qXfer:threads:read::@var{offset},@var{length}
38600 @anchor{qXfer threads read}
38601 Access the list of threads on target.  @xref{Thread List Format}.  The
38602 annex part of the generic @samp{qXfer} packet must be empty
38603 (@pxref{qXfer read}).
38604
38605 This packet is not probed by default; the remote stub must request it,
38606 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
38607
38608 @item qXfer:traceframe-info:read::@var{offset},@var{length}
38609 @anchor{qXfer traceframe info read}
38610
38611 Return a description of the current traceframe's contents.
38612 @xref{Traceframe Info Format}.  The annex part of the generic
38613 @samp{qXfer} packet must be empty (@pxref{qXfer read}).
38614
38615 This packet is not probed by default; the remote stub must request it,
38616 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
38617
38618 @item qXfer:uib:read:@var{pc}:@var{offset},@var{length}
38619 @anchor{qXfer unwind info block}
38620
38621 Return the unwind information block for @var{pc}.  This packet is used
38622 on OpenVMS/ia64 to ask the kernel unwind information.
38623
38624 This packet is not probed by default.
38625
38626 @item qXfer:fdpic:read:@var{annex}:@var{offset},@var{length}
38627 @anchor{qXfer fdpic loadmap read}
38628 Read contents of @code{loadmap}s on the target system.  The
38629 annex, either @samp{exec} or @samp{interp}, specifies which @code{loadmap},
38630 executable @code{loadmap} or interpreter @code{loadmap} to read.
38631
38632 This packet is not probed by default; the remote stub must request it,
38633 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
38634
38635 @item qXfer:osdata:read::@var{offset},@var{length}
38636 @anchor{qXfer osdata read}
38637 Access the target's @dfn{operating system information}.
38638 @xref{Operating System Information}.
38639
38640 @end table
38641
38642 @item qXfer:@var{object}:write:@var{annex}:@var{offset}:@var{data}@dots{}
38643 @cindex write data into object, remote request
38644 @anchor{qXfer write}
38645 Write uninterpreted bytes into the target's special data area
38646 identified by the keyword @var{object}, starting at @var{offset} bytes
38647 into the data.  The binary-encoded data (@pxref{Binary Data}) to be
38648 written is given by @var{data}@dots{}.  The content and encoding of @var{annex}
38649 is specific to @var{object}; it can supply additional details about what data
38650 to access.
38651
38652 Reply:
38653 @table @samp
38654 @item @var{nn}
38655 @var{nn} (hex encoded) is the number of bytes written.
38656 This may be fewer bytes than supplied in the request.
38657
38658 @item E00
38659 The request was malformed, or @var{annex} was invalid.
38660
38661 @item E @var{nn}
38662 The offset was invalid, or there was an error encountered writing the data.
38663 The @var{nn} part is a hex-encoded @code{errno} value.
38664
38665 @item @w{}
38666 An empty reply indicates the @var{object} string was not
38667 recognized by the stub, or that the object does not support writing.
38668 @end table
38669
38670 Here are the specific requests of this form defined so far.  All the
38671 @samp{qXfer:@var{object}:write:@dots{}} requests use the same reply
38672 formats, listed above.
38673
38674 @table @samp
38675 @item qXfer:siginfo:write::@var{offset}:@var{data}@dots{}
38676 @anchor{qXfer siginfo write}
38677 Write @var{data} to the extra signal information on the target system.
38678 The annex part of the generic @samp{qXfer} packet must be
38679 empty (@pxref{qXfer write}).
38680
38681 This packet is not probed by default; the remote stub must request it,
38682 by supplying an appropriate @samp{qSupported} response
38683 (@pxref{qSupported}).
38684
38685 @item qXfer:spu:write:@var{annex}:@var{offset}:@var{data}@dots{}
38686 @anchor{qXfer spu write}
38687 Write @var{data} to an @code{spufs} file on the target system.  The
38688 annex specifies which file to write; it must be of the form
38689 @file{@var{id}/@var{name}}, where @var{id} specifies an SPU context ID
38690 in the target process, and @var{name} identifes the @code{spufs} file
38691 in that context to be accessed.
38692
38693 This packet is not probed by default; the remote stub must request it,
38694 by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}).
38695 @end table
38696
38697 @item qXfer:@var{object}:@var{operation}:@dots{}
38698 Requests of this form may be added in the future.  When a stub does
38699 not recognize the @var{object} keyword, or its support for
38700 @var{object} does not recognize the @var{operation} keyword, the stub
38701 must respond with an empty packet.
38702
38703 @item qAttached:@var{pid}
38704 @cindex query attached, remote request
38705 @cindex @samp{qAttached} packet
38706 Return an indication of whether the remote server attached to an
38707 existing process or created a new process.  When the multiprocess
38708 protocol extensions are supported (@pxref{multiprocess extensions}),
38709 @var{pid} is an integer in hexadecimal format identifying the target
38710 process.  Otherwise, @value{GDBN} will omit the @var{pid} field and
38711 the query packet will be simplified as @samp{qAttached}.
38712
38713 This query is used, for example, to know whether the remote process
38714 should be detached or killed when a @value{GDBN} session is ended with
38715 the @code{quit} command.
38716
38717 Reply:
38718 @table @samp
38719 @item 1
38720 The remote server attached to an existing process.
38721 @item 0
38722 The remote server created a new process.
38723 @item E @var{NN}
38724 A badly formed request or an error was encountered.
38725 @end table
38726
38727 @item Qbtrace:bts
38728 Enable branch tracing for the current thread using Branch Trace Store.
38729
38730 Reply:
38731 @table @samp
38732 @item OK
38733 Branch tracing has been enabled.
38734 @item E.errtext
38735 A badly formed request or an error was encountered.
38736 @end table
38737
38738 @item Qbtrace:pt
38739 Enable branch tracing for the current thread using Intel Processor Trace.
38740
38741 Reply:
38742 @table @samp
38743 @item OK
38744 Branch tracing has been enabled.
38745 @item E.errtext
38746 A badly formed request or an error was encountered.
38747 @end table
38748
38749 @item Qbtrace:off
38750 Disable branch tracing for the current thread.
38751
38752 Reply:
38753 @table @samp
38754 @item OK
38755 Branch tracing has been disabled.
38756 @item E.errtext
38757 A badly formed request or an error was encountered.
38758 @end table
38759
38760 @item Qbtrace-conf:bts:size=@var{value}
38761 Set the requested ring buffer size for new threads that use the
38762 btrace recording method in bts format.
38763
38764 Reply:
38765 @table @samp
38766 @item OK
38767 The ring buffer size has been set.
38768 @item E.errtext
38769 A badly formed request or an error was encountered.
38770 @end table
38771
38772 @item Qbtrace-conf:pt:size=@var{value}
38773 Set the requested ring buffer size for new threads that use the
38774 btrace recording method in pt format.
38775
38776 Reply:
38777 @table @samp
38778 @item OK
38779 The ring buffer size has been set.
38780 @item E.errtext
38781 A badly formed request or an error was encountered.
38782 @end table
38783
38784 @end table
38785
38786 @node Architecture-Specific Protocol Details
38787 @section Architecture-Specific Protocol Details
38788
38789 This section describes how the remote protocol is applied to specific
38790 target architectures.  Also see @ref{Standard Target Features}, for
38791 details of XML target descriptions for each architecture.
38792
38793 @menu
38794 * ARM-Specific Protocol Details::
38795 * MIPS-Specific Protocol Details::
38796 @end menu
38797
38798 @node ARM-Specific Protocol Details
38799 @subsection @acronym{ARM}-specific Protocol Details
38800
38801 @menu
38802 * ARM Breakpoint Kinds::
38803 @end menu
38804
38805 @node ARM Breakpoint Kinds
38806 @subsubsection @acronym{ARM} Breakpoint Kinds
38807 @cindex breakpoint kinds, @acronym{ARM}
38808
38809 These breakpoint kinds are defined for the @samp{Z0} and @samp{Z1} packets.
38810
38811 @table @r
38812
38813 @item 2
38814 16-bit Thumb mode breakpoint.
38815
38816 @item 3
38817 32-bit Thumb mode (Thumb-2) breakpoint.
38818
38819 @item 4
38820 32-bit @acronym{ARM} mode breakpoint.
38821
38822 @end table
38823
38824 @node MIPS-Specific Protocol Details
38825 @subsection @acronym{MIPS}-specific Protocol Details
38826
38827 @menu
38828 * MIPS Register packet Format::
38829 * MIPS Breakpoint Kinds::
38830 @end menu
38831
38832 @node MIPS Register packet Format
38833 @subsubsection @acronym{MIPS} Register Packet Format
38834 @cindex register packet format, @acronym{MIPS}
38835
38836 The following @code{g}/@code{G} packets have previously been defined.
38837 In the below, some thirty-two bit registers are transferred as
38838 sixty-four bits.  Those registers should be zero/sign extended (which?)
38839 to fill the space allocated.  Register bytes are transferred in target
38840 byte order.  The two nibbles within a register byte are transferred
38841 most-significant -- least-significant.
38842
38843 @table @r
38844
38845 @item MIPS32
38846 All registers are transferred as thirty-two bit quantities in the order:
38847 32 general-purpose; sr; lo; hi; bad; cause; pc; 32 floating-point
38848 registers; fsr; fir; fp.
38849
38850 @item MIPS64
38851 All registers are transferred as sixty-four bit quantities (including
38852 thirty-two bit registers such as @code{sr}).  The ordering is the same
38853 as @code{MIPS32}.
38854
38855 @end table
38856
38857 @node MIPS Breakpoint Kinds
38858 @subsubsection @acronym{MIPS} Breakpoint Kinds
38859 @cindex breakpoint kinds, @acronym{MIPS}
38860
38861 These breakpoint kinds are defined for the @samp{Z0} and @samp{Z1} packets.
38862
38863 @table @r
38864
38865 @item 2
38866 16-bit @acronym{MIPS16} mode breakpoint.
38867
38868 @item 3
38869 16-bit @acronym{microMIPS} mode breakpoint.
38870
38871 @item 4
38872 32-bit standard @acronym{MIPS} mode breakpoint.
38873
38874 @item 5
38875 32-bit @acronym{microMIPS} mode breakpoint.
38876
38877 @end table
38878
38879 @node Tracepoint Packets
38880 @section Tracepoint Packets
38881 @cindex tracepoint packets
38882 @cindex packets, tracepoint
38883
38884 Here we describe the packets @value{GDBN} uses to implement
38885 tracepoints (@pxref{Tracepoints}).
38886
38887 @table @samp
38888
38889 @item QTDP:@var{n}:@var{addr}:@var{ena}:@var{step}:@var{pass}[:F@var{flen}][:X@var{len},@var{bytes}]@r{[}-@r{]}
38890 @cindex @samp{QTDP} packet
38891 Create a new tracepoint, number @var{n}, at @var{addr}.  If @var{ena}
38892 is @samp{E}, then the tracepoint is enabled; if it is @samp{D}, then
38893 the tracepoint is disabled.  The @var{step} gives the tracepoint's step
38894 count, and @var{pass} gives its pass count.  If an @samp{F} is present,
38895 then the tracepoint is to be a fast tracepoint, and the @var{flen} is
38896 the number of bytes that the target should copy elsewhere to make room
38897 for the tracepoint.  If an @samp{X} is present, it introduces a
38898 tracepoint condition, which consists of a hexadecimal length, followed
38899 by a comma and hex-encoded bytes, in a manner similar to action
38900 encodings as described below.  If the trailing @samp{-} is present,
38901 further @samp{QTDP} packets will follow to specify this tracepoint's
38902 actions.
38903
38904 Replies:
38905 @table @samp
38906 @item OK
38907 The packet was understood and carried out.
38908 @item qRelocInsn
38909 @xref{Tracepoint Packets,,Relocate instruction reply packet}.
38910 @item  @w{}
38911 The packet was not recognized.
38912 @end table
38913
38914 @item QTDP:-@var{n}:@var{addr}:@r{[}S@r{]}@var{action}@dots{}@r{[}-@r{]}
38915 Define actions to be taken when a tracepoint is hit.  The @var{n} and
38916 @var{addr} must be the same as in the initial @samp{QTDP} packet for
38917 this tracepoint.  This packet may only be sent immediately after
38918 another @samp{QTDP} packet that ended with a @samp{-}.  If the
38919 trailing @samp{-} is present, further @samp{QTDP} packets will follow,
38920 specifying more actions for this tracepoint.
38921
38922 In the series of action packets for a given tracepoint, at most one
38923 can have an @samp{S} before its first @var{action}.  If such a packet
38924 is sent, it and the following packets define ``while-stepping''
38925 actions.  Any prior packets define ordinary actions --- that is, those
38926 taken when the tracepoint is first hit.  If no action packet has an
38927 @samp{S}, then all the packets in the series specify ordinary
38928 tracepoint actions.
38929
38930 The @samp{@var{action}@dots{}} portion of the packet is a series of
38931 actions, concatenated without separators.  Each action has one of the
38932 following forms:
38933
38934 @table @samp
38935
38936 @item R @var{mask}
38937 Collect the registers whose bits are set in @var{mask},
38938 a hexadecimal number whose @var{i}'th bit is set if register number
38939 @var{i} should be collected.  (The least significant bit is numbered
38940 zero.)  Note that @var{mask} may be any number of digits long; it may
38941 not fit in a 32-bit word.
38942
38943 @item M @var{basereg},@var{offset},@var{len}
38944 Collect @var{len} bytes of memory starting at the address in register
38945 number @var{basereg}, plus @var{offset}.  If @var{basereg} is
38946 @samp{-1}, then the range has a fixed address: @var{offset} is the
38947 address of the lowest byte to collect.  The @var{basereg},
38948 @var{offset}, and @var{len} parameters are all unsigned hexadecimal
38949 values (the @samp{-1} value for @var{basereg} is a special case).
38950
38951 @item X @var{len},@var{expr}
38952 Evaluate @var{expr}, whose length is @var{len}, and collect memory as
38953 it directs.  The agent expression @var{expr} is as described in
38954 @ref{Agent Expressions}.  Each byte of the expression is encoded as a
38955 two-digit hex number in the packet; @var{len} is the number of bytes
38956 in the expression (and thus one-half the number of hex digits in the
38957 packet).
38958
38959 @end table
38960
38961 Any number of actions may be packed together in a single @samp{QTDP}
38962 packet, as long as the packet does not exceed the maximum packet
38963 length (400 bytes, for many stubs).  There may be only one @samp{R}
38964 action per tracepoint, and it must precede any @samp{M} or @samp{X}
38965 actions.  Any registers referred to by @samp{M} and @samp{X} actions
38966 must be collected by a preceding @samp{R} action.  (The
38967 ``while-stepping'' actions are treated as if they were attached to a
38968 separate tracepoint, as far as these restrictions are concerned.)
38969
38970 Replies:
38971 @table @samp
38972 @item OK
38973 The packet was understood and carried out.
38974 @item qRelocInsn
38975 @xref{Tracepoint Packets,,Relocate instruction reply packet}.
38976 @item  @w{}
38977 The packet was not recognized.
38978 @end table
38979
38980 @item QTDPsrc:@var{n}:@var{addr}:@var{type}:@var{start}:@var{slen}:@var{bytes}
38981 @cindex @samp{QTDPsrc} packet
38982 Specify a source string of tracepoint @var{n} at address @var{addr}.
38983 This is useful to get accurate reproduction of the tracepoints
38984 originally downloaded at the beginning of the trace run.  The @var{type}
38985 is the name of the tracepoint part, such as @samp{cond} for the
38986 tracepoint's conditional expression (see below for a list of types), while
38987 @var{bytes} is the string, encoded in hexadecimal.
38988
38989 @var{start} is the offset of the @var{bytes} within the overall source
38990 string, while @var{slen} is the total length of the source string.
38991 This is intended for handling source strings that are longer than will
38992 fit in a single packet.
38993 @c Add detailed example when this info is moved into a dedicated
38994 @c tracepoint descriptions section.
38995
38996 The available string types are @samp{at} for the location,
38997 @samp{cond} for the conditional, and @samp{cmd} for an action command.
38998 @value{GDBN} sends a separate packet for each command in the action
38999 list, in the same order in which the commands are stored in the list.
39000
39001 The target does not need to do anything with source strings except
39002 report them back as part of the replies to the @samp{qTfP}/@samp{qTsP}
39003 query packets.
39004
39005 Although this packet is optional, and @value{GDBN} will only send it
39006 if the target replies with @samp{TracepointSource} @xref{General
39007 Query Packets}, it makes both disconnected tracing and trace files
39008 much easier to use.  Otherwise the user must be careful that the
39009 tracepoints in effect while looking at trace frames are identical to
39010 the ones in effect during the trace run; even a small discrepancy
39011 could cause @samp{tdump} not to work, or a particular trace frame not
39012 be found.
39013
39014 @item QTDV:@var{n}:@var{value}:@var{builtin}:@var{name}
39015 @cindex define trace state variable, remote request
39016 @cindex @samp{QTDV} packet
39017 Create a new trace state variable, number @var{n}, with an initial
39018 value of @var{value}, which is a 64-bit signed integer.  Both @var{n}
39019 and @var{value} are encoded as hexadecimal values. @value{GDBN} has
39020 the option of not using this packet for initial values of zero; the
39021 target should simply create the trace state variables as they are
39022 mentioned in expressions.  The value @var{builtin} should be 1 (one)
39023 if the trace state variable is builtin and 0 (zero) if it is not builtin.
39024 @value{GDBN} only sets @var{builtin} to 1 if a previous @samp{qTfV} or
39025 @samp{qTsV} packet had it set.  The contents of @var{name} is the
39026 hex-encoded name (without the leading @samp{$}) of the trace state
39027 variable.
39028
39029 @item QTFrame:@var{n}
39030 @cindex @samp{QTFrame} packet
39031 Select the @var{n}'th tracepoint frame from the buffer, and use the
39032 register and memory contents recorded there to answer subsequent
39033 request packets from @value{GDBN}.
39034
39035 A successful reply from the stub indicates that the stub has found the
39036 requested frame.  The response is a series of parts, concatenated
39037 without separators, describing the frame we selected.  Each part has
39038 one of the following forms:
39039
39040 @table @samp
39041 @item F @var{f}
39042 The selected frame is number @var{n} in the trace frame buffer;
39043 @var{f} is a hexadecimal number.  If @var{f} is @samp{-1}, then there
39044 was no frame matching the criteria in the request packet.
39045
39046 @item T @var{t}
39047 The selected trace frame records a hit of tracepoint number @var{t};
39048 @var{t} is a hexadecimal number.
39049
39050 @end table
39051
39052 @item QTFrame:pc:@var{addr}
39053 Like @samp{QTFrame:@var{n}}, but select the first tracepoint frame after the
39054 currently selected frame whose PC is @var{addr};
39055 @var{addr} is a hexadecimal number.
39056
39057 @item QTFrame:tdp:@var{t}
39058 Like @samp{QTFrame:@var{n}}, but select the first tracepoint frame after the
39059 currently selected frame that is a hit of tracepoint @var{t}; @var{t}
39060 is a hexadecimal number.
39061
39062 @item QTFrame:range:@var{start}:@var{end}
39063 Like @samp{QTFrame:@var{n}}, but select the first tracepoint frame after the
39064 currently selected frame whose PC is between @var{start} (inclusive)
39065 and @var{end} (inclusive); @var{start} and @var{end} are hexadecimal
39066 numbers.
39067
39068 @item QTFrame:outside:@var{start}:@var{end}
39069 Like @samp{QTFrame:range:@var{start}:@var{end}}, but select the first
39070 frame @emph{outside} the given range of addresses (exclusive).
39071
39072 @item qTMinFTPILen
39073 @cindex @samp{qTMinFTPILen} packet
39074 This packet requests the minimum length of instruction at which a fast
39075 tracepoint (@pxref{Set Tracepoints}) may be placed.  For instance, on
39076 the 32-bit x86 architecture, it is possible to use a 4-byte jump, but
39077 it depends on the target system being able to create trampolines in
39078 the first 64K of memory, which might or might not be possible for that
39079 system.  So the reply to this packet will be 4 if it is able to
39080 arrange for that.
39081
39082 Replies:
39083
39084 @table @samp
39085 @item 0
39086 The minimum instruction length is currently unknown.
39087 @item @var{length}
39088 The minimum instruction length is @var{length}, where @var{length}
39089 is a hexadecimal number greater or equal to 1.  A reply
39090 of 1 means that a fast tracepoint may be placed on any instruction
39091 regardless of size.
39092 @item E
39093 An error has occurred.
39094 @item @w{}
39095 An empty reply indicates that the request is not supported by the stub.
39096 @end table
39097
39098 @item QTStart
39099 @cindex @samp{QTStart} packet
39100 Begin the tracepoint experiment.  Begin collecting data from
39101 tracepoint hits in the trace frame buffer.  This packet supports the
39102 @samp{qRelocInsn} reply (@pxref{Tracepoint Packets,,Relocate
39103 instruction reply packet}).
39104
39105 @item QTStop
39106 @cindex @samp{QTStop} packet
39107 End the tracepoint experiment.  Stop collecting trace frames.
39108
39109 @item QTEnable:@var{n}:@var{addr}
39110 @anchor{QTEnable}
39111 @cindex @samp{QTEnable} packet
39112 Enable tracepoint @var{n} at address @var{addr} in a started tracepoint
39113 experiment.  If the tracepoint was previously disabled, then collection
39114 of data from it will resume.
39115
39116 @item QTDisable:@var{n}:@var{addr}
39117 @anchor{QTDisable}
39118 @cindex @samp{QTDisable} packet
39119 Disable tracepoint @var{n} at address @var{addr} in a started tracepoint
39120 experiment.  No more data will be collected from the tracepoint unless
39121 @samp{QTEnable:@var{n}:@var{addr}} is subsequently issued.
39122
39123 @item QTinit
39124 @cindex @samp{QTinit} packet
39125 Clear the table of tracepoints, and empty the trace frame buffer.
39126
39127 @item QTro:@var{start1},@var{end1}:@var{start2},@var{end2}:@dots{}
39128 @cindex @samp{QTro} packet
39129 Establish the given ranges of memory as ``transparent''.  The stub
39130 will answer requests for these ranges from memory's current contents,
39131 if they were not collected as part of the tracepoint hit.
39132
39133 @value{GDBN} uses this to mark read-only regions of memory, like those
39134 containing program code.  Since these areas never change, they should
39135 still have the same contents they did when the tracepoint was hit, so
39136 there's no reason for the stub to refuse to provide their contents.
39137
39138 @item QTDisconnected:@var{value}
39139 @cindex @samp{QTDisconnected} packet
39140 Set the choice to what to do with the tracing run when @value{GDBN}
39141 disconnects from the target.  A @var{value} of 1 directs the target to
39142 continue the tracing run, while 0 tells the target to stop tracing if
39143 @value{GDBN} is no longer in the picture.
39144
39145 @item qTStatus
39146 @cindex @samp{qTStatus} packet
39147 Ask the stub if there is a trace experiment running right now.
39148
39149 The reply has the form:
39150
39151 @table @samp
39152
39153 @item T@var{running}@r{[};@var{field}@r{]}@dots{}
39154 @var{running} is a single digit @code{1} if the trace is presently
39155 running, or @code{0} if not.  It is followed by semicolon-separated
39156 optional fields that an agent may use to report additional status.
39157
39158 @end table
39159
39160 If the trace is not running, the agent may report any of several
39161 explanations as one of the optional fields:
39162
39163 @table @samp
39164
39165 @item tnotrun:0
39166 No trace has been run yet.
39167
39168 @item tstop[:@var{text}]:0
39169 The trace was stopped by a user-originated stop command.  The optional
39170 @var{text} field is a user-supplied string supplied as part of the
39171 stop command (for instance, an explanation of why the trace was
39172 stopped manually).  It is hex-encoded.
39173
39174 @item tfull:0
39175 The trace stopped because the trace buffer filled up.
39176
39177 @item tdisconnected:0
39178 The trace stopped because @value{GDBN} disconnected from the target.
39179
39180 @item tpasscount:@var{tpnum}
39181 The trace stopped because tracepoint @var{tpnum} exceeded its pass count.
39182
39183 @item terror:@var{text}:@var{tpnum}
39184 The trace stopped because tracepoint @var{tpnum} had an error.  The
39185 string @var{text} is available to describe the nature of the error
39186 (for instance, a divide by zero in the condition expression); it
39187 is hex encoded.
39188
39189 @item tunknown:0
39190 The trace stopped for some other reason.
39191
39192 @end table
39193
39194 Additional optional fields supply statistical and other information.
39195 Although not required, they are extremely useful for users monitoring
39196 the progress of a trace run.  If a trace has stopped, and these
39197 numbers are reported, they must reflect the state of the just-stopped
39198 trace.
39199
39200 @table @samp
39201
39202 @item tframes:@var{n}
39203 The number of trace frames in the buffer.
39204
39205 @item tcreated:@var{n}
39206 The total number of trace frames created during the run. This may
39207 be larger than the trace frame count, if the buffer is circular.
39208
39209 @item tsize:@var{n}
39210 The total size of the trace buffer, in bytes.
39211
39212 @item tfree:@var{n}
39213 The number of bytes still unused in the buffer.
39214
39215 @item circular:@var{n}
39216 The value of the circular trace buffer flag.  @code{1} means that the
39217 trace buffer is circular and old trace frames will be discarded if
39218 necessary to make room, @code{0} means that the trace buffer is linear
39219 and may fill up.
39220
39221 @item disconn:@var{n}
39222 The value of the disconnected tracing flag.  @code{1} means that
39223 tracing will continue after @value{GDBN} disconnects, @code{0} means
39224 that the trace run will stop.
39225
39226 @end table
39227
39228 @item qTP:@var{tp}:@var{addr}
39229 @cindex tracepoint status, remote request
39230 @cindex @samp{qTP} packet
39231 Ask the stub for the current state of tracepoint number @var{tp} at
39232 address @var{addr}.
39233
39234 Replies:
39235 @table @samp
39236 @item V@var{hits}:@var{usage}
39237 The tracepoint has been hit @var{hits} times so far during the trace
39238 run, and accounts for @var{usage} in the trace buffer.  Note that
39239 @code{while-stepping} steps are not counted as separate hits, but the
39240 steps' space consumption is added into the usage number.
39241
39242 @end table
39243
39244 @item qTV:@var{var}
39245 @cindex trace state variable value, remote request
39246 @cindex @samp{qTV} packet
39247 Ask the stub for the value of the trace state variable number @var{var}.
39248
39249 Replies:
39250 @table @samp
39251 @item V@var{value}
39252 The value of the variable is @var{value}.  This will be the current
39253 value of the variable if the user is examining a running target, or a
39254 saved value if the variable was collected in the trace frame that the
39255 user is looking at.  Note that multiple requests may result in
39256 different reply values, such as when requesting values while the
39257 program is running.
39258
39259 @item U
39260 The value of the variable is unknown.  This would occur, for example,
39261 if the user is examining a trace frame in which the requested variable
39262 was not collected.
39263 @end table
39264
39265 @item qTfP
39266 @cindex @samp{qTfP} packet
39267 @itemx qTsP
39268 @cindex @samp{qTsP} packet
39269 These packets request data about tracepoints that are being used by
39270 the target.  @value{GDBN} sends @code{qTfP} to get the first piece
39271 of data, and multiple @code{qTsP} to get additional pieces.  Replies
39272 to these packets generally take the form of the @code{QTDP} packets
39273 that define tracepoints. (FIXME add detailed syntax)
39274
39275 @item qTfV
39276 @cindex @samp{qTfV} packet
39277 @itemx qTsV
39278 @cindex @samp{qTsV} packet
39279 These packets request data about trace state variables that are on the
39280 target.  @value{GDBN} sends @code{qTfV} to get the first vari of data,
39281 and multiple @code{qTsV} to get additional variables.  Replies to
39282 these packets follow the syntax of the @code{QTDV} packets that define
39283 trace state variables.
39284
39285 @item qTfSTM
39286 @itemx qTsSTM
39287 @anchor{qTfSTM}
39288 @anchor{qTsSTM}
39289 @cindex @samp{qTfSTM} packet
39290 @cindex @samp{qTsSTM} packet
39291 These packets request data about static tracepoint markers that exist
39292 in the target program.  @value{GDBN} sends @code{qTfSTM} to get the
39293 first piece of data, and multiple @code{qTsSTM} to get additional
39294 pieces.  Replies to these packets take the following form:
39295
39296 Reply:
39297 @table @samp
39298 @item m @var{address}:@var{id}:@var{extra}
39299 A single marker
39300 @item m @var{address}:@var{id}:@var{extra},@var{address}:@var{id}:@var{extra}@dots{}
39301 a comma-separated list of markers
39302 @item l
39303 (lower case letter @samp{L}) denotes end of list.
39304 @item E @var{nn}
39305 An error occurred.  The error number @var{nn} is given as hex digits.
39306 @item @w{}
39307 An empty reply indicates that the request is not supported by the
39308 stub.
39309 @end table
39310
39311 The @var{address} is encoded in hex;
39312 @var{id} and @var{extra} are strings encoded in hex.
39313
39314 In response to each query, the target will reply with a list of one or
39315 more markers, separated by commas.  @value{GDBN} will respond to each
39316 reply with a request for more markers (using the @samp{qs} form of the
39317 query), until the target responds with @samp{l} (lower-case ell, for
39318 @dfn{last}).
39319
39320 @item qTSTMat:@var{address}
39321 @anchor{qTSTMat}
39322 @cindex @samp{qTSTMat} packet
39323 This packets requests data about static tracepoint markers in the
39324 target program at @var{address}.  Replies to this packet follow the
39325 syntax of the @samp{qTfSTM} and @code{qTsSTM} packets that list static
39326 tracepoint markers.
39327
39328 @item QTSave:@var{filename}
39329 @cindex @samp{QTSave} packet
39330 This packet directs the target to save trace data to the file name
39331 @var{filename} in the target's filesystem.  The @var{filename} is encoded
39332 as a hex string; the interpretation of the file name (relative vs
39333 absolute, wild cards, etc) is up to the target.
39334
39335 @item qTBuffer:@var{offset},@var{len}
39336 @cindex @samp{qTBuffer} packet
39337 Return up to @var{len} bytes of the current contents of trace buffer,
39338 starting at @var{offset}.  The trace buffer is treated as if it were
39339 a contiguous collection of traceframes, as per the trace file format.
39340 The reply consists as many hex-encoded bytes as the target can deliver
39341 in a packet; it is not an error to return fewer than were asked for.
39342 A reply consisting of just @code{l} indicates that no bytes are
39343 available.
39344
39345 @item QTBuffer:circular:@var{value}
39346 This packet directs the target to use a circular trace buffer if
39347 @var{value} is 1, or a linear buffer if the value is 0.
39348
39349 @item QTBuffer:size:@var{size}
39350 @anchor{QTBuffer-size}
39351 @cindex @samp{QTBuffer size} packet
39352 This packet directs the target to make the trace buffer be of size
39353 @var{size} if possible.  A value of @code{-1} tells the target to
39354 use whatever size it prefers.
39355
39356 @item QTNotes:@r{[}@var{type}:@var{text}@r{]}@r{[};@var{type}:@var{text}@r{]}@dots{}
39357 @cindex @samp{QTNotes} packet
39358 This packet adds optional textual notes to the trace run.  Allowable
39359 types include @code{user}, @code{notes}, and @code{tstop}, the
39360 @var{text} fields are arbitrary strings, hex-encoded.
39361
39362 @end table
39363
39364 @subsection Relocate instruction reply packet
39365 When installing fast tracepoints in memory, the target may need to
39366 relocate the instruction currently at the tracepoint address to a
39367 different address in memory.  For most instructions, a simple copy is
39368 enough, but, for example, call instructions that implicitly push the
39369 return address on the stack, and relative branches or other
39370 PC-relative instructions require offset adjustment, so that the effect
39371 of executing the instruction at a different address is the same as if
39372 it had executed in the original location.
39373
39374 In response to several of the tracepoint packets, the target may also
39375 respond with a number of intermediate @samp{qRelocInsn} request
39376 packets before the final result packet, to have @value{GDBN} handle
39377 this relocation operation.  If a packet supports this mechanism, its
39378 documentation will explicitly say so.  See for example the above
39379 descriptions for the @samp{QTStart} and @samp{QTDP} packets.  The
39380 format of the request is:
39381
39382 @table @samp
39383 @item qRelocInsn:@var{from};@var{to}
39384
39385 This requests @value{GDBN} to copy instruction at address @var{from}
39386 to address @var{to}, possibly adjusted so that executing the
39387 instruction at @var{to} has the same effect as executing it at
39388 @var{from}.  @value{GDBN} writes the adjusted instruction to target
39389 memory starting at @var{to}.
39390 @end table
39391
39392 Replies:
39393 @table @samp
39394 @item qRelocInsn:@var{adjusted_size}
39395 Informs the stub the relocation is complete.  The @var{adjusted_size} is
39396 the length in bytes of resulting relocated instruction sequence.
39397 @item E @var{NN}
39398 A badly formed request was detected, or an error was encountered while
39399 relocating the instruction.
39400 @end table
39401
39402 @node Host I/O Packets
39403 @section Host I/O Packets
39404 @cindex Host I/O, remote protocol
39405 @cindex file transfer, remote protocol
39406
39407 The @dfn{Host I/O} packets allow @value{GDBN} to perform I/O
39408 operations on the far side of a remote link.  For example, Host I/O is
39409 used to upload and download files to a remote target with its own
39410 filesystem.  Host I/O uses the same constant values and data structure
39411 layout as the target-initiated File-I/O protocol.  However, the
39412 Host I/O packets are structured differently.  The target-initiated
39413 protocol relies on target memory to store parameters and buffers.
39414 Host I/O requests are initiated by @value{GDBN}, and the
39415 target's memory is not involved.  @xref{File-I/O Remote Protocol
39416 Extension}, for more details on the target-initiated protocol.
39417
39418 The Host I/O request packets all encode a single operation along with
39419 its arguments.  They have this format:
39420
39421 @table @samp
39422
39423 @item vFile:@var{operation}: @var{parameter}@dots{}
39424 @var{operation} is the name of the particular request; the target
39425 should compare the entire packet name up to the second colon when checking
39426 for a supported operation.  The format of @var{parameter} depends on
39427 the operation.  Numbers are always passed in hexadecimal.  Negative
39428 numbers have an explicit minus sign (i.e.@: two's complement is not
39429 used).  Strings (e.g.@: filenames) are encoded as a series of
39430 hexadecimal bytes.  The last argument to a system call may be a
39431 buffer of escaped binary data (@pxref{Binary Data}).
39432
39433 @end table
39434
39435 The valid responses to Host I/O packets are:
39436
39437 @table @samp
39438
39439 @item F @var{result} [, @var{errno}] [; @var{attachment}]
39440 @var{result} is the integer value returned by this operation, usually
39441 non-negative for success and -1 for errors.  If an error has occured,
39442 @var{errno} will be included in the result specifying a
39443 value defined by the File-I/O protocol (@pxref{Errno Values}).  For
39444 operations which return data, @var{attachment} supplies the data as a
39445 binary buffer.  Binary buffers in response packets are escaped in the
39446 normal way (@pxref{Binary Data}).  See the individual packet
39447 documentation for the interpretation of @var{result} and
39448 @var{attachment}.
39449
39450 @item @w{}
39451 An empty response indicates that this operation is not recognized.
39452
39453 @end table
39454
39455 These are the supported Host I/O operations:
39456
39457 @table @samp
39458 @item vFile:open: @var{filename}, @var{flags}, @var{mode}
39459 Open a file at @var{filename} and return a file descriptor for it, or
39460 return -1 if an error occurs.  The @var{filename} is a string,
39461 @var{flags} is an integer indicating a mask of open flags
39462 (@pxref{Open Flags}), and @var{mode} is an integer indicating a mask
39463 of mode bits to use if the file is created (@pxref{mode_t Values}).
39464 @xref{open}, for details of the open flags and mode values.
39465
39466 @item vFile:close: @var{fd}
39467 Close the open file corresponding to @var{fd} and return 0, or
39468 -1 if an error occurs.
39469
39470 @item vFile:pread: @var{fd}, @var{count}, @var{offset}
39471 Read data from the open file corresponding to @var{fd}.  Up to
39472 @var{count} bytes will be read from the file, starting at @var{offset}
39473 relative to the start of the file.  The target may read fewer bytes;
39474 common reasons include packet size limits and an end-of-file
39475 condition.  The number of bytes read is returned.  Zero should only be
39476 returned for a successful read at the end of the file, or if
39477 @var{count} was zero.
39478
39479 The data read should be returned as a binary attachment on success.
39480 If zero bytes were read, the response should include an empty binary
39481 attachment (i.e.@: a trailing semicolon).  The return value is the
39482 number of target bytes read; the binary attachment may be longer if
39483 some characters were escaped.
39484
39485 @item vFile:pwrite: @var{fd}, @var{offset}, @var{data}
39486 Write @var{data} (a binary buffer) to the open file corresponding
39487 to @var{fd}.  Start the write at @var{offset} from the start of the
39488 file.  Unlike many @code{write} system calls, there is no
39489 separate @var{count} argument; the length of @var{data} in the
39490 packet is used.  @samp{vFile:write} returns the number of bytes written,
39491 which may be shorter than the length of @var{data}, or -1 if an
39492 error occurred.
39493
39494 @item vFile:fstat: @var{fd}
39495 Get information about the open file corresponding to @var{fd}.
39496 On success the information is returned as a binary attachment
39497 and the return value is the size of this attachment in bytes.
39498 If an error occurs the return value is -1.  The format of the
39499 returned binary attachment is as described in @ref{struct stat}.
39500
39501 @item vFile:unlink: @var{filename}
39502 Delete the file at @var{filename} on the target.  Return 0,
39503 or -1 if an error occurs.  The @var{filename} is a string.
39504
39505 @item vFile:readlink: @var{filename}
39506 Read value of symbolic link @var{filename} on the target.  Return
39507 the number of bytes read, or -1 if an error occurs.
39508
39509 The data read should be returned as a binary attachment on success.
39510 If zero bytes were read, the response should include an empty binary
39511 attachment (i.e.@: a trailing semicolon).  The return value is the
39512 number of target bytes read; the binary attachment may be longer if
39513 some characters were escaped.
39514
39515 @item vFile:setfs: @var{pid}
39516 Select the filesystem on which @code{vFile} operations with
39517 @var{filename} arguments will operate.  This is required for
39518 @value{GDBN} to be able to access files on remote targets where
39519 the remote stub does not share a common filesystem with the
39520 inferior(s).
39521
39522 If @var{pid} is nonzero, select the filesystem as seen by process
39523 @var{pid}.  If @var{pid} is zero, select the filesystem as seen by
39524 the remote stub.  Return 0 on success, or -1 if an error occurs.
39525 If @code{vFile:setfs:} indicates success, the selected filesystem
39526 remains selected until the next successful @code{vFile:setfs:}
39527 operation.
39528
39529 @end table
39530
39531 @node Interrupts
39532 @section Interrupts
39533 @cindex interrupts (remote protocol)
39534 @anchor{interrupting remote targets}
39535
39536 In all-stop mode, when a program on the remote target is running,
39537 @value{GDBN} may attempt to interrupt it by sending a @samp{Ctrl-C},
39538 @code{BREAK} or a @code{BREAK} followed by @code{g}, control of which
39539 is specified via @value{GDBN}'s @samp{interrupt-sequence}.
39540
39541 The precise meaning of @code{BREAK} is defined by the transport
39542 mechanism and may, in fact, be undefined.  @value{GDBN} does not
39543 currently define a @code{BREAK} mechanism for any of the network
39544 interfaces except for TCP, in which case @value{GDBN} sends the
39545 @code{telnet} BREAK sequence.
39546
39547 @samp{Ctrl-C}, on the other hand, is defined and implemented for all
39548 transport mechanisms.  It is represented by sending the single byte
39549 @code{0x03} without any of the usual packet overhead described in
39550 the Overview section (@pxref{Overview}).  When a @code{0x03} byte is
39551 transmitted as part of a packet, it is considered to be packet data
39552 and does @emph{not} represent an interrupt.  E.g., an @samp{X} packet
39553 (@pxref{X packet}), used for binary downloads, may include an unescaped
39554 @code{0x03} as part of its packet.
39555
39556 @code{BREAK} followed by @code{g} is also known as Magic SysRq g.
39557 When Linux kernel receives this sequence from serial port,
39558 it stops execution and connects to gdb.
39559
39560 In non-stop mode, because packet resumptions are asynchronous
39561 (@pxref{vCont packet}), @value{GDBN} is always free to send a remote
39562 command to the remote stub, even when the target is running.  For that
39563 reason, @value{GDBN} instead sends a regular packet (@pxref{vCtrlC
39564 packet}) with the usual packet framing instead of the single byte
39565 @code{0x03}.
39566
39567 Stubs are not required to recognize these interrupt mechanisms and the
39568 precise meaning associated with receipt of the interrupt is
39569 implementation defined.  If the target supports debugging of multiple
39570 threads and/or processes, it should attempt to interrupt all 
39571 currently-executing threads and processes.
39572 If the stub is successful at interrupting the
39573 running program, it should send one of the stop
39574 reply packets (@pxref{Stop Reply Packets}) to @value{GDBN} as a result
39575 of successfully stopping the program in all-stop mode, and a stop reply
39576 for each stopped thread in non-stop mode.
39577 Interrupts received while the
39578 program is stopped are queued and the program will be interrupted when
39579 it is resumed next time.
39580
39581 @node Notification Packets
39582 @section Notification Packets
39583 @cindex notification packets
39584 @cindex packets, notification
39585
39586 The @value{GDBN} remote serial protocol includes @dfn{notifications},
39587 packets that require no acknowledgment.  Both the GDB and the stub
39588 may send notifications (although the only notifications defined at
39589 present are sent by the stub).  Notifications carry information
39590 without incurring the round-trip latency of an acknowledgment, and so
39591 are useful for low-impact communications where occasional packet loss
39592 is not a problem.
39593
39594 A notification packet has the form @samp{% @var{data} #
39595 @var{checksum}}, where @var{data} is the content of the notification,
39596 and @var{checksum} is a checksum of @var{data}, computed and formatted
39597 as for ordinary @value{GDBN} packets.  A notification's @var{data}
39598 never contains @samp{$}, @samp{%} or @samp{#} characters.  Upon
39599 receiving a notification, the recipient sends no @samp{+} or @samp{-}
39600 to acknowledge the notification's receipt or to report its corruption.
39601
39602 Every notification's @var{data} begins with a name, which contains no
39603 colon characters, followed by a colon character.
39604
39605 Recipients should silently ignore corrupted notifications and
39606 notifications they do not understand.  Recipients should restart
39607 timeout periods on receipt of a well-formed notification, whether or
39608 not they understand it.
39609
39610 Senders should only send the notifications described here when this
39611 protocol description specifies that they are permitted.  In the
39612 future, we may extend the protocol to permit existing notifications in
39613 new contexts; this rule helps older senders avoid confusing newer
39614 recipients.
39615
39616 (Older versions of @value{GDBN} ignore bytes received until they see
39617 the @samp{$} byte that begins an ordinary packet, so new stubs may
39618 transmit notifications without fear of confusing older clients.  There
39619 are no notifications defined for @value{GDBN} to send at the moment, but we
39620 assume that most older stubs would ignore them, as well.)
39621
39622 Each notification is comprised of three parts:
39623 @table @samp
39624 @item @var{name}:@var{event}
39625 The notification packet is sent by the side that initiates the
39626 exchange (currently, only the stub does that), with @var{event}
39627 carrying the specific information about the notification, and
39628 @var{name} specifying the name of the notification.
39629 @item @var{ack}
39630 The acknowledge sent by the other side, usually @value{GDBN}, to
39631 acknowledge the exchange and request the event.
39632 @end table
39633
39634 The purpose of an asynchronous notification mechanism is to report to
39635 @value{GDBN} that something interesting happened in the remote stub.
39636
39637 The remote stub may send notification @var{name}:@var{event}
39638 at any time, but @value{GDBN} acknowledges the notification when
39639 appropriate.  The notification event is pending before @value{GDBN}
39640 acknowledges.  Only one notification at a time may be pending; if
39641 additional events occur before @value{GDBN} has acknowledged the
39642 previous notification, they must be queued by the stub for later
39643 synchronous transmission in response to @var{ack} packets from
39644 @value{GDBN}.  Because the notification mechanism is unreliable,
39645 the stub is permitted to resend a notification if it believes
39646 @value{GDBN} may not have received it.
39647
39648 Specifically, notifications may appear when @value{GDBN} is not
39649 otherwise reading input from the stub, or when @value{GDBN} is
39650 expecting to read a normal synchronous response or a
39651 @samp{+}/@samp{-} acknowledgment to a packet it has sent.
39652 Notification packets are distinct from any other communication from
39653 the stub so there is no ambiguity.
39654
39655 After receiving a notification, @value{GDBN} shall acknowledge it by
39656 sending a @var{ack} packet as a regular, synchronous request to the
39657 stub.  Such acknowledgment is not required to happen immediately, as
39658 @value{GDBN} is permitted to send other, unrelated packets to the
39659 stub first, which the stub should process normally.
39660
39661 Upon receiving a @var{ack} packet, if the stub has other queued
39662 events to report to @value{GDBN}, it shall respond by sending a
39663 normal @var{event}.  @value{GDBN} shall then send another @var{ack}
39664 packet to solicit further responses; again, it is permitted to send
39665 other, unrelated packets as well which the stub should process
39666 normally.
39667
39668 If the stub receives a @var{ack} packet and there are no additional
39669 @var{event} to report, the stub shall return an @samp{OK} response.
39670 At this point, @value{GDBN} has finished processing a notification
39671 and the stub has completed sending any queued events.  @value{GDBN}
39672 won't accept any new notifications until the final @samp{OK} is
39673 received .  If further notification events occur, the stub shall send
39674 a new notification, @value{GDBN} shall accept the notification, and
39675 the process shall be repeated.
39676
39677 The process of asynchronous notification can be illustrated by the
39678 following example:
39679 @smallexample
39680 <- @code{%Stop:T0505:98e7ffbf;04:4ce6ffbf;08:b1b6e54c;thread:p7526.7526;core:0;}
39681 @code{...}
39682 -> @code{vStopped}
39683 <- @code{T0505:68f37db7;04:40f37db7;08:63850408;thread:p7526.7528;core:0;}
39684 -> @code{vStopped}
39685 <- @code{T0505:68e3fdb6;04:40e3fdb6;08:63850408;thread:p7526.7529;core:0;}
39686 -> @code{vStopped}
39687 <- @code{OK}
39688 @end smallexample
39689
39690 The following notifications are defined:
39691 @multitable @columnfractions 0.12 0.12 0.38 0.38
39692
39693 @item Notification
39694 @tab Ack
39695 @tab Event
39696 @tab Description
39697
39698 @item Stop
39699 @tab vStopped
39700 @tab @var{reply}.  The @var{reply} has the form of a stop reply, as
39701 described in @ref{Stop Reply Packets}.  Refer to @ref{Remote Non-Stop},
39702 for information on how these notifications are acknowledged by 
39703 @value{GDBN}.
39704 @tab Report an asynchronous stop event in non-stop mode.
39705
39706 @end multitable
39707
39708 @node Remote Non-Stop
39709 @section Remote Protocol Support for Non-Stop Mode
39710
39711 @value{GDBN}'s remote protocol supports non-stop debugging of
39712 multi-threaded programs, as described in @ref{Non-Stop Mode}.  If the stub
39713 supports non-stop mode, it should report that to @value{GDBN} by including
39714 @samp{QNonStop+} in its @samp{qSupported} response (@pxref{qSupported}).
39715
39716 @value{GDBN} typically sends a @samp{QNonStop} packet only when
39717 establishing a new connection with the stub.  Entering non-stop mode
39718 does not alter the state of any currently-running threads, but targets
39719 must stop all threads in any already-attached processes when entering
39720 all-stop mode.  @value{GDBN} uses the @samp{?} packet as necessary to
39721 probe the target state after a mode change.
39722
39723 In non-stop mode, when an attached process encounters an event that
39724 would otherwise be reported with a stop reply, it uses the
39725 asynchronous notification mechanism (@pxref{Notification Packets}) to
39726 inform @value{GDBN}.  In contrast to all-stop mode, where all threads
39727 in all processes are stopped when a stop reply is sent, in non-stop
39728 mode only the thread reporting the stop event is stopped.  That is,
39729 when reporting a @samp{S} or @samp{T} response to indicate completion
39730 of a step operation, hitting a breakpoint, or a fault, only the
39731 affected thread is stopped; any other still-running threads continue
39732 to run.  When reporting a @samp{W} or @samp{X} response, all running
39733 threads belonging to other attached processes continue to run.
39734
39735 In non-stop mode, the target shall respond to the @samp{?} packet as
39736 follows.  First, any incomplete stop reply notification/@samp{vStopped} 
39737 sequence in progress is abandoned.  The target must begin a new
39738 sequence reporting stop events for all stopped threads, whether or not
39739 it has previously reported those events to @value{GDBN}.  The first
39740 stop reply is sent as a synchronous reply to the @samp{?} packet, and
39741 subsequent stop replies are sent as responses to @samp{vStopped} packets
39742 using the mechanism described above.  The target must not send
39743 asynchronous stop reply notifications until the sequence is complete.
39744 If all threads are running when the target receives the @samp{?} packet,
39745 or if the target is not attached to any process, it shall respond
39746 @samp{OK}.
39747
39748 If the stub supports non-stop mode, it should also support the
39749 @samp{swbreak} stop reason if software breakpoints are supported, and
39750 the @samp{hwbreak} stop reason if hardware breakpoints are supported
39751 (@pxref{swbreak stop reason}).  This is because given the asynchronous
39752 nature of non-stop mode, between the time a thread hits a breakpoint
39753 and the time the event is finally processed by @value{GDBN}, the
39754 breakpoint may have already been removed from the target.  Due to
39755 this, @value{GDBN} needs to be able to tell whether a trap stop was
39756 caused by a delayed breakpoint event, which should be ignored, as
39757 opposed to a random trap signal, which should be reported to the user.
39758 Note the @samp{swbreak} feature implies that the target is responsible
39759 for adjusting the PC when a software breakpoint triggers, if
39760 necessary, such as on the x86 architecture.
39761
39762 @node Packet Acknowledgment
39763 @section Packet Acknowledgment
39764
39765 @cindex acknowledgment, for @value{GDBN} remote
39766 @cindex packet acknowledgment, for @value{GDBN} remote
39767 By default, when either the host or the target machine receives a packet,
39768 the first response expected is an acknowledgment: either @samp{+} (to indicate
39769 the package was received correctly) or @samp{-} (to request retransmission).
39770 This mechanism allows the @value{GDBN} remote protocol to operate over
39771 unreliable transport mechanisms, such as a serial line.
39772
39773 In cases where the transport mechanism is itself reliable (such as a pipe or
39774 TCP connection), the @samp{+}/@samp{-} acknowledgments are redundant.
39775 It may be desirable to disable them in that case to reduce communication
39776 overhead, or for other reasons.  This can be accomplished by means of the
39777 @samp{QStartNoAckMode} packet; @pxref{QStartNoAckMode}.
39778
39779 When in no-acknowledgment mode, neither the stub nor @value{GDBN} shall send or
39780 expect @samp{+}/@samp{-} protocol acknowledgments.  The packet
39781 and response format still includes the normal checksum, as described in
39782 @ref{Overview}, but the checksum may be ignored by the receiver.
39783
39784 If the stub supports @samp{QStartNoAckMode} and prefers to operate in
39785 no-acknowledgment mode, it should report that to @value{GDBN}
39786 by including @samp{QStartNoAckMode+} in its response to @samp{qSupported};
39787 @pxref{qSupported}.
39788 If @value{GDBN} also supports @samp{QStartNoAckMode} and it has not been
39789 disabled via the @code{set remote noack-packet off} command
39790 (@pxref{Remote Configuration}),
39791 @value{GDBN} may then send a @samp{QStartNoAckMode} packet to the stub.
39792 Only then may the stub actually turn off packet acknowledgments.
39793 @value{GDBN} sends a final @samp{+} acknowledgment of the stub's @samp{OK}
39794 response, which can be safely ignored by the stub.
39795
39796 Note that @code{set remote noack-packet} command only affects negotiation
39797 between @value{GDBN} and the stub when subsequent connections are made;
39798 it does not affect the protocol acknowledgment state for any current
39799 connection.
39800 Since @samp{+}/@samp{-} acknowledgments are enabled by default when a
39801 new connection is established,
39802 there is also no protocol request to re-enable the acknowledgments
39803 for the current connection, once disabled.
39804
39805 @node Examples
39806 @section Examples
39807
39808 Example sequence of a target being re-started.  Notice how the restart
39809 does not get any direct output:
39810
39811 @smallexample
39812 -> @code{R00}
39813 <- @code{+}
39814 @emph{target restarts}
39815 -> @code{?}
39816 <- @code{+}
39817 <- @code{T001:1234123412341234}
39818 -> @code{+}
39819 @end smallexample
39820
39821 Example sequence of a target being stepped by a single instruction:
39822
39823 @smallexample
39824 -> @code{G1445@dots{}}
39825 <- @code{+}
39826 -> @code{s}
39827 <- @code{+}
39828 @emph{time passes}
39829 <- @code{T001:1234123412341234}
39830 -> @code{+}
39831 -> @code{g}
39832 <- @code{+}
39833 <- @code{1455@dots{}}
39834 -> @code{+}
39835 @end smallexample
39836
39837 @node File-I/O Remote Protocol Extension
39838 @section File-I/O Remote Protocol Extension
39839 @cindex File-I/O remote protocol extension
39840
39841 @menu
39842 * File-I/O Overview::
39843 * Protocol Basics::
39844 * The F Request Packet::
39845 * The F Reply Packet::
39846 * The Ctrl-C Message::
39847 * Console I/O::
39848 * List of Supported Calls::
39849 * Protocol-specific Representation of Datatypes::
39850 * Constants::
39851 * File-I/O Examples::
39852 @end menu
39853
39854 @node File-I/O Overview
39855 @subsection File-I/O Overview
39856 @cindex file-i/o overview
39857
39858 The @dfn{File I/O remote protocol extension} (short: File-I/O) allows the
39859 target to use the host's file system and console I/O to perform various
39860 system calls.  System calls on the target system are translated into a
39861 remote protocol packet to the host system, which then performs the needed
39862 actions and returns a response packet to the target system.
39863 This simulates file system operations even on targets that lack file systems.
39864
39865 The protocol is defined to be independent of both the host and target systems.
39866 It uses its own internal representation of datatypes and values.  Both
39867 @value{GDBN} and the target's @value{GDBN} stub are responsible for
39868 translating the system-dependent value representations into the internal
39869 protocol representations when data is transmitted.
39870
39871 The communication is synchronous.  A system call is possible only when 
39872 @value{GDBN} is waiting for a response from the @samp{C}, @samp{c}, @samp{S} 
39873 or @samp{s} packets.  While @value{GDBN} handles the request for a system call,
39874 the target is stopped to allow deterministic access to the target's
39875 memory.  Therefore File-I/O is not interruptible by target signals.  On
39876 the other hand, it is possible to interrupt File-I/O by a user interrupt 
39877 (@samp{Ctrl-C}) within @value{GDBN}.
39878
39879 The target's request to perform a host system call does not finish
39880 the latest @samp{C}, @samp{c}, @samp{S} or @samp{s} action.  That means,
39881 after finishing the system call, the target returns to continuing the
39882 previous activity (continue, step).  No additional continue or step
39883 request from @value{GDBN} is required.
39884
39885 @smallexample
39886 (@value{GDBP}) continue
39887   <- target requests 'system call X'
39888   target is stopped, @value{GDBN} executes system call
39889   -> @value{GDBN} returns result
39890   ... target continues, @value{GDBN} returns to wait for the target
39891   <- target hits breakpoint and sends a Txx packet
39892 @end smallexample
39893
39894 The protocol only supports I/O on the console and to regular files on 
39895 the host file system.  Character or block special devices, pipes,
39896 named pipes, sockets or any other communication method on the host
39897 system are not supported by this protocol.
39898
39899 File I/O is not supported in non-stop mode.
39900
39901 @node Protocol Basics
39902 @subsection Protocol Basics
39903 @cindex protocol basics, file-i/o
39904
39905 The File-I/O protocol uses the @code{F} packet as the request as well
39906 as reply packet.  Since a File-I/O system call can only occur when
39907 @value{GDBN} is waiting for a response from the continuing or stepping target, 
39908 the File-I/O request is a reply that @value{GDBN} has to expect as a result
39909 of a previous @samp{C}, @samp{c}, @samp{S} or @samp{s} packet.
39910 This @code{F} packet contains all information needed to allow @value{GDBN}
39911 to call the appropriate host system call:
39912
39913 @itemize @bullet
39914 @item
39915 A unique identifier for the requested system call.
39916
39917 @item
39918 All parameters to the system call.  Pointers are given as addresses
39919 in the target memory address space.  Pointers to strings are given as
39920 pointer/length pair.  Numerical values are given as they are.
39921 Numerical control flags are given in a protocol-specific representation.
39922
39923 @end itemize
39924
39925 At this point, @value{GDBN} has to perform the following actions.
39926
39927 @itemize @bullet
39928 @item
39929 If the parameters include pointer values to data needed as input to a 
39930 system call, @value{GDBN} requests this data from the target with a
39931 standard @code{m} packet request.  This additional communication has to be
39932 expected by the target implementation and is handled as any other @code{m}
39933 packet.
39934
39935 @item
39936 @value{GDBN} translates all value from protocol representation to host
39937 representation as needed.  Datatypes are coerced into the host types.
39938
39939 @item
39940 @value{GDBN} calls the system call.
39941
39942 @item
39943 It then coerces datatypes back to protocol representation.
39944
39945 @item
39946 If the system call is expected to return data in buffer space specified
39947 by pointer parameters to the call, the data is transmitted to the
39948 target using a @code{M} or @code{X} packet.  This packet has to be expected
39949 by the target implementation and is handled as any other @code{M} or @code{X}
39950 packet.
39951
39952 @end itemize
39953
39954 Eventually @value{GDBN} replies with another @code{F} packet which contains all
39955 necessary information for the target to continue.  This at least contains
39956
39957 @itemize @bullet
39958 @item
39959 Return value.
39960
39961 @item
39962 @code{errno}, if has been changed by the system call.
39963
39964 @item
39965 ``Ctrl-C'' flag.
39966
39967 @end itemize
39968
39969 After having done the needed type and value coercion, the target continues
39970 the latest continue or step action.
39971
39972 @node The F Request Packet
39973 @subsection The @code{F} Request Packet
39974 @cindex file-i/o request packet
39975 @cindex @code{F} request packet
39976
39977 The @code{F} request packet has the following format:
39978
39979 @table @samp
39980 @item F@var{call-id},@var{parameter@dots{}}
39981
39982 @var{call-id} is the identifier to indicate the host system call to be called.
39983 This is just the name of the function.
39984
39985 @var{parameter@dots{}} are the parameters to the system call.  
39986 Parameters are hexadecimal integer values, either the actual values in case
39987 of scalar datatypes, pointers to target buffer space in case of compound
39988 datatypes and unspecified memory areas, or pointer/length pairs in case
39989 of string parameters.  These are appended to the @var{call-id} as a 
39990 comma-delimited list.  All values are transmitted in ASCII
39991 string representation, pointer/length pairs separated by a slash.
39992
39993 @end table
39994
39995
39996
39997 @node The F Reply Packet
39998 @subsection The @code{F} Reply Packet
39999 @cindex file-i/o reply packet
40000 @cindex @code{F} reply packet
40001
40002 The @code{F} reply packet has the following format:
40003
40004 @table @samp
40005
40006 @item F@var{retcode},@var{errno},@var{Ctrl-C flag};@var{call-specific attachment}
40007
40008 @var{retcode} is the return code of the system call as hexadecimal value.
40009
40010 @var{errno} is the @code{errno} set by the call, in protocol-specific
40011 representation.
40012 This parameter can be omitted if the call was successful.
40013
40014 @var{Ctrl-C flag} is only sent if the user requested a break.  In this
40015 case, @var{errno} must be sent as well, even if the call was successful.
40016 The @var{Ctrl-C flag} itself consists of the character @samp{C}:
40017
40018 @smallexample
40019 F0,0,C
40020 @end smallexample
40021
40022 @noindent
40023 or, if the call was interrupted before the host call has been performed:
40024
40025 @smallexample
40026 F-1,4,C
40027 @end smallexample
40028
40029 @noindent
40030 assuming 4 is the protocol-specific representation of @code{EINTR}.
40031
40032 @end table
40033
40034
40035 @node The Ctrl-C Message
40036 @subsection The @samp{Ctrl-C} Message
40037 @cindex ctrl-c message, in file-i/o protocol
40038
40039 If the @samp{Ctrl-C} flag is set in the @value{GDBN}
40040 reply packet (@pxref{The F Reply Packet}),
40041 the target should behave as if it had
40042 gotten a break message.  The meaning for the target is ``system call
40043 interrupted by @code{SIGINT}''.  Consequentially, the target should actually stop
40044 (as with a break message) and return to @value{GDBN} with a @code{T02}
40045 packet.
40046
40047 It's important for the target to know in which
40048 state the system call was interrupted.  There are two possible cases:
40049
40050 @itemize @bullet
40051 @item
40052 The system call hasn't been performed on the host yet.
40053
40054 @item
40055 The system call on the host has been finished.
40056
40057 @end itemize
40058
40059 These two states can be distinguished by the target by the value of the
40060 returned @code{errno}.  If it's the protocol representation of @code{EINTR}, the system
40061 call hasn't been performed.  This is equivalent to the @code{EINTR} handling
40062 on POSIX systems.  In any other case, the target may presume that the
40063 system call has been finished --- successfully or not --- and should behave
40064 as if the break message arrived right after the system call.
40065
40066 @value{GDBN} must behave reliably.  If the system call has not been called
40067 yet, @value{GDBN} may send the @code{F} reply immediately, setting @code{EINTR} as
40068 @code{errno} in the packet.  If the system call on the host has been finished
40069 before the user requests a break, the full action must be finished by
40070 @value{GDBN}.  This requires sending @code{M} or @code{X} packets as necessary.
40071 The @code{F} packet may only be sent when either nothing has happened
40072 or the full action has been completed.
40073
40074 @node Console I/O
40075 @subsection Console I/O
40076 @cindex console i/o as part of file-i/o
40077
40078 By default and if not explicitly closed by the target system, the file
40079 descriptors 0, 1 and 2 are connected to the @value{GDBN} console.  Output
40080 on the @value{GDBN} console is handled as any other file output operation
40081 (@code{write(1, @dots{})} or @code{write(2, @dots{})}).  Console input is handled
40082 by @value{GDBN} so that after the target read request from file descriptor
40083 0 all following typing is buffered until either one of the following
40084 conditions is met:
40085
40086 @itemize @bullet
40087 @item
40088 The user types @kbd{Ctrl-c}.  The behaviour is as explained above, and the
40089 @code{read}
40090 system call is treated as finished.
40091
40092 @item
40093 The user presses @key{RET}.  This is treated as end of input with a trailing
40094 newline.
40095
40096 @item
40097 The user types @kbd{Ctrl-d}.  This is treated as end of input.  No trailing
40098 character (neither newline nor @samp{Ctrl-D}) is appended to the input.
40099
40100 @end itemize
40101
40102 If the user has typed more characters than fit in the buffer given to
40103 the @code{read} call, the trailing characters are buffered in @value{GDBN} until
40104 either another @code{read(0, @dots{})} is requested by the target, or debugging
40105 is stopped at the user's request.
40106
40107
40108 @node List of Supported Calls
40109 @subsection List of Supported Calls
40110 @cindex list of supported file-i/o calls
40111
40112 @menu
40113 * open::
40114 * close::
40115 * read::
40116 * write::
40117 * lseek::
40118 * rename::
40119 * unlink::
40120 * stat/fstat::
40121 * gettimeofday::
40122 * isatty::
40123 * system::
40124 @end menu
40125
40126 @node open
40127 @unnumberedsubsubsec open
40128 @cindex open, file-i/o system call
40129
40130 @table @asis
40131 @item Synopsis:
40132 @smallexample
40133 int open(const char *pathname, int flags);
40134 int open(const char *pathname, int flags, mode_t mode);
40135 @end smallexample
40136
40137 @item Request:
40138 @samp{Fopen,@var{pathptr}/@var{len},@var{flags},@var{mode}}
40139
40140 @noindent
40141 @var{flags} is the bitwise @code{OR} of the following values:
40142
40143 @table @code
40144 @item O_CREAT
40145 If the file does not exist it will be created.  The host
40146 rules apply as far as file ownership and time stamps
40147 are concerned.
40148
40149 @item O_EXCL
40150 When used with @code{O_CREAT}, if the file already exists it is
40151 an error and open() fails.
40152
40153 @item O_TRUNC
40154 If the file already exists and the open mode allows
40155 writing (@code{O_RDWR} or @code{O_WRONLY} is given) it will be
40156 truncated to zero length.
40157
40158 @item O_APPEND
40159 The file is opened in append mode.
40160
40161 @item O_RDONLY
40162 The file is opened for reading only.
40163
40164 @item O_WRONLY
40165 The file is opened for writing only.
40166
40167 @item O_RDWR
40168 The file is opened for reading and writing.
40169 @end table
40170
40171 @noindent
40172 Other bits are silently ignored.
40173
40174
40175 @noindent
40176 @var{mode} is the bitwise @code{OR} of the following values:
40177
40178 @table @code
40179 @item S_IRUSR
40180 User has read permission.
40181
40182 @item S_IWUSR
40183 User has write permission.
40184
40185 @item S_IRGRP
40186 Group has read permission.
40187
40188 @item S_IWGRP
40189 Group has write permission.
40190
40191 @item S_IROTH
40192 Others have read permission.
40193
40194 @item S_IWOTH
40195 Others have write permission.
40196 @end table
40197
40198 @noindent
40199 Other bits are silently ignored.
40200
40201
40202 @item Return value:
40203 @code{open} returns the new file descriptor or -1 if an error
40204 occurred.
40205
40206 @item Errors:
40207
40208 @table @code
40209 @item EEXIST
40210 @var{pathname} already exists and @code{O_CREAT} and @code{O_EXCL} were used.
40211
40212 @item EISDIR
40213 @var{pathname} refers to a directory.
40214
40215 @item EACCES
40216 The requested access is not allowed.
40217
40218 @item ENAMETOOLONG
40219 @var{pathname} was too long.
40220
40221 @item ENOENT
40222 A directory component in @var{pathname} does not exist.
40223
40224 @item ENODEV
40225 @var{pathname} refers to a device, pipe, named pipe or socket.
40226
40227 @item EROFS
40228 @var{pathname} refers to a file on a read-only filesystem and
40229 write access was requested.
40230
40231 @item EFAULT
40232 @var{pathname} is an invalid pointer value.
40233
40234 @item ENOSPC
40235 No space on device to create the file.
40236
40237 @item EMFILE
40238 The process already has the maximum number of files open.
40239
40240 @item ENFILE
40241 The limit on the total number of files open on the system
40242 has been reached.
40243
40244 @item EINTR
40245 The call was interrupted by the user.
40246 @end table
40247
40248 @end table
40249
40250 @node close
40251 @unnumberedsubsubsec close
40252 @cindex close, file-i/o system call
40253
40254 @table @asis
40255 @item Synopsis:
40256 @smallexample
40257 int close(int fd);
40258 @end smallexample
40259
40260 @item Request:
40261 @samp{Fclose,@var{fd}}
40262
40263 @item Return value:
40264 @code{close} returns zero on success, or -1 if an error occurred.
40265
40266 @item Errors:
40267
40268 @table @code
40269 @item EBADF
40270 @var{fd} isn't a valid open file descriptor.
40271
40272 @item EINTR
40273 The call was interrupted by the user.
40274 @end table
40275
40276 @end table
40277
40278 @node read
40279 @unnumberedsubsubsec read
40280 @cindex read, file-i/o system call
40281
40282 @table @asis
40283 @item Synopsis:
40284 @smallexample
40285 int read(int fd, void *buf, unsigned int count);
40286 @end smallexample
40287
40288 @item Request:
40289 @samp{Fread,@var{fd},@var{bufptr},@var{count}}
40290
40291 @item Return value:
40292 On success, the number of bytes read is returned.
40293 Zero indicates end of file.  If count is zero, read
40294 returns zero as well.  On error, -1 is returned.
40295
40296 @item Errors:
40297
40298 @table @code
40299 @item EBADF
40300 @var{fd} is not a valid file descriptor or is not open for
40301 reading.
40302
40303 @item EFAULT
40304 @var{bufptr} is an invalid pointer value.
40305
40306 @item EINTR
40307 The call was interrupted by the user.
40308 @end table
40309
40310 @end table
40311
40312 @node write
40313 @unnumberedsubsubsec write
40314 @cindex write, file-i/o system call
40315
40316 @table @asis
40317 @item Synopsis:
40318 @smallexample
40319 int write(int fd, const void *buf, unsigned int count);
40320 @end smallexample
40321
40322 @item Request:
40323 @samp{Fwrite,@var{fd},@var{bufptr},@var{count}}
40324
40325 @item Return value:
40326 On success, the number of bytes written are returned.
40327 Zero indicates nothing was written.  On error, -1
40328 is returned.
40329
40330 @item Errors:
40331
40332 @table @code
40333 @item EBADF
40334 @var{fd} is not a valid file descriptor or is not open for
40335 writing.
40336
40337 @item EFAULT
40338 @var{bufptr} is an invalid pointer value.
40339
40340 @item EFBIG
40341 An attempt was made to write a file that exceeds the
40342 host-specific maximum file size allowed.
40343
40344 @item ENOSPC
40345 No space on device to write the data.
40346
40347 @item EINTR
40348 The call was interrupted by the user.
40349 @end table
40350
40351 @end table
40352
40353 @node lseek
40354 @unnumberedsubsubsec lseek
40355 @cindex lseek, file-i/o system call
40356
40357 @table @asis
40358 @item Synopsis:
40359 @smallexample
40360 long lseek (int fd, long offset, int flag);
40361 @end smallexample
40362
40363 @item Request:
40364 @samp{Flseek,@var{fd},@var{offset},@var{flag}}
40365
40366 @var{flag} is one of:
40367
40368 @table @code
40369 @item SEEK_SET
40370 The offset is set to @var{offset} bytes.
40371
40372 @item SEEK_CUR
40373 The offset is set to its current location plus @var{offset}
40374 bytes.
40375
40376 @item SEEK_END
40377 The offset is set to the size of the file plus @var{offset}
40378 bytes.
40379 @end table
40380
40381 @item Return value:
40382 On success, the resulting unsigned offset in bytes from
40383 the beginning of the file is returned.  Otherwise, a
40384 value of -1 is returned.
40385
40386 @item Errors:
40387
40388 @table @code
40389 @item EBADF
40390 @var{fd} is not a valid open file descriptor.
40391
40392 @item ESPIPE
40393 @var{fd} is associated with the @value{GDBN} console.
40394
40395 @item EINVAL
40396 @var{flag} is not a proper value.
40397
40398 @item EINTR
40399 The call was interrupted by the user.
40400 @end table
40401
40402 @end table
40403
40404 @node rename
40405 @unnumberedsubsubsec rename
40406 @cindex rename, file-i/o system call
40407
40408 @table @asis
40409 @item Synopsis:
40410 @smallexample
40411 int rename(const char *oldpath, const char *newpath);
40412 @end smallexample
40413
40414 @item Request:
40415 @samp{Frename,@var{oldpathptr}/@var{len},@var{newpathptr}/@var{len}}
40416
40417 @item Return value:
40418 On success, zero is returned.  On error, -1 is returned.
40419
40420 @item Errors:
40421
40422 @table @code
40423 @item EISDIR
40424 @var{newpath} is an existing directory, but @var{oldpath} is not a
40425 directory.
40426
40427 @item EEXIST
40428 @var{newpath} is a non-empty directory.
40429
40430 @item EBUSY
40431 @var{oldpath} or @var{newpath} is a directory that is in use by some
40432 process.
40433
40434 @item EINVAL
40435 An attempt was made to make a directory a subdirectory
40436 of itself.
40437
40438 @item ENOTDIR
40439 A  component used as a directory in @var{oldpath} or new
40440 path is not a directory.  Or @var{oldpath} is a directory
40441 and @var{newpath} exists but is not a directory.
40442
40443 @item EFAULT
40444 @var{oldpathptr} or @var{newpathptr} are invalid pointer values.
40445
40446 @item EACCES
40447 No access to the file or the path of the file.
40448
40449 @item ENAMETOOLONG
40450
40451 @var{oldpath} or @var{newpath} was too long.
40452
40453 @item ENOENT
40454 A directory component in @var{oldpath} or @var{newpath} does not exist.
40455
40456 @item EROFS
40457 The file is on a read-only filesystem.
40458
40459 @item ENOSPC
40460 The device containing the file has no room for the new
40461 directory entry.
40462
40463 @item EINTR
40464 The call was interrupted by the user.
40465 @end table
40466
40467 @end table
40468
40469 @node unlink
40470 @unnumberedsubsubsec unlink
40471 @cindex unlink, file-i/o system call
40472
40473 @table @asis
40474 @item Synopsis:
40475 @smallexample
40476 int unlink(const char *pathname);
40477 @end smallexample
40478
40479 @item Request:
40480 @samp{Funlink,@var{pathnameptr}/@var{len}}
40481
40482 @item Return value:
40483 On success, zero is returned.  On error, -1 is returned.
40484
40485 @item Errors:
40486
40487 @table @code
40488 @item EACCES
40489 No access to the file or the path of the file.
40490
40491 @item EPERM
40492 The system does not allow unlinking of directories.
40493
40494 @item EBUSY
40495 The file @var{pathname} cannot be unlinked because it's
40496 being used by another process.
40497
40498 @item EFAULT
40499 @var{pathnameptr} is an invalid pointer value.
40500
40501 @item ENAMETOOLONG
40502 @var{pathname} was too long.
40503
40504 @item ENOENT
40505 A directory component in @var{pathname} does not exist.
40506
40507 @item ENOTDIR
40508 A component of the path is not a directory.
40509
40510 @item EROFS
40511 The file is on a read-only filesystem.
40512
40513 @item EINTR
40514 The call was interrupted by the user.
40515 @end table
40516
40517 @end table
40518
40519 @node stat/fstat
40520 @unnumberedsubsubsec stat/fstat
40521 @cindex fstat, file-i/o system call
40522 @cindex stat, file-i/o system call
40523
40524 @table @asis
40525 @item Synopsis:
40526 @smallexample
40527 int stat(const char *pathname, struct stat *buf);
40528 int fstat(int fd, struct stat *buf);
40529 @end smallexample
40530
40531 @item Request:
40532 @samp{Fstat,@var{pathnameptr}/@var{len},@var{bufptr}}@*
40533 @samp{Ffstat,@var{fd},@var{bufptr}}
40534
40535 @item Return value:
40536 On success, zero is returned.  On error, -1 is returned.
40537
40538 @item Errors:
40539
40540 @table @code
40541 @item EBADF
40542 @var{fd} is not a valid open file.
40543
40544 @item ENOENT
40545 A directory component in @var{pathname} does not exist or the
40546 path is an empty string.
40547
40548 @item ENOTDIR
40549 A component of the path is not a directory.
40550
40551 @item EFAULT
40552 @var{pathnameptr} is an invalid pointer value.
40553
40554 @item EACCES
40555 No access to the file or the path of the file.
40556
40557 @item ENAMETOOLONG
40558 @var{pathname} was too long.
40559
40560 @item EINTR
40561 The call was interrupted by the user.
40562 @end table
40563
40564 @end table
40565
40566 @node gettimeofday
40567 @unnumberedsubsubsec gettimeofday
40568 @cindex gettimeofday, file-i/o system call
40569
40570 @table @asis
40571 @item Synopsis:
40572 @smallexample
40573 int gettimeofday(struct timeval *tv, void *tz);
40574 @end smallexample
40575
40576 @item Request:
40577 @samp{Fgettimeofday,@var{tvptr},@var{tzptr}}
40578
40579 @item Return value:
40580 On success, 0 is returned, -1 otherwise.
40581
40582 @item Errors:
40583
40584 @table @code
40585 @item EINVAL
40586 @var{tz} is a non-NULL pointer.
40587
40588 @item EFAULT
40589 @var{tvptr} and/or @var{tzptr} is an invalid pointer value.
40590 @end table
40591
40592 @end table
40593
40594 @node isatty
40595 @unnumberedsubsubsec isatty
40596 @cindex isatty, file-i/o system call
40597
40598 @table @asis
40599 @item Synopsis:
40600 @smallexample
40601 int isatty(int fd);
40602 @end smallexample
40603
40604 @item Request:
40605 @samp{Fisatty,@var{fd}}
40606
40607 @item Return value:
40608 Returns 1 if @var{fd} refers to the @value{GDBN} console, 0 otherwise.
40609
40610 @item Errors:
40611
40612 @table @code
40613 @item EINTR
40614 The call was interrupted by the user.
40615 @end table
40616
40617 @end table
40618
40619 Note that the @code{isatty} call is treated as a special case: it returns
40620 1 to the target if the file descriptor is attached
40621 to the @value{GDBN} console, 0 otherwise.  Implementing through system calls
40622 would require implementing @code{ioctl} and would be more complex than
40623 needed.
40624
40625
40626 @node system
40627 @unnumberedsubsubsec system
40628 @cindex system, file-i/o system call
40629
40630 @table @asis
40631 @item Synopsis:
40632 @smallexample
40633 int system(const char *command);
40634 @end smallexample
40635
40636 @item Request:
40637 @samp{Fsystem,@var{commandptr}/@var{len}}
40638
40639 @item Return value:
40640 If @var{len} is zero, the return value indicates whether a shell is
40641 available.  A zero return value indicates a shell is not available.
40642 For non-zero @var{len}, the value returned is -1 on error and the
40643 return status of the command otherwise.  Only the exit status of the
40644 command is returned, which is extracted from the host's @code{system}
40645 return value by calling @code{WEXITSTATUS(retval)}.  In case
40646 @file{/bin/sh} could not be executed, 127 is returned.
40647
40648 @item Errors:
40649
40650 @table @code
40651 @item EINTR
40652 The call was interrupted by the user.
40653 @end table
40654
40655 @end table
40656
40657 @value{GDBN} takes over the full task of calling the necessary host calls 
40658 to perform the @code{system} call.  The return value of @code{system} on 
40659 the host is simplified before it's returned
40660 to the target.  Any termination signal information from the child process 
40661 is discarded, and the return value consists
40662 entirely of the exit status of the called command.
40663
40664 Due to security concerns, the @code{system} call is by default refused
40665 by @value{GDBN}.  The user has to allow this call explicitly with the
40666 @code{set remote system-call-allowed 1} command.
40667
40668 @table @code
40669 @item set remote system-call-allowed
40670 @kindex set remote system-call-allowed
40671 Control whether to allow the @code{system} calls in the File I/O
40672 protocol for the remote target.  The default is zero (disabled).
40673
40674 @item show remote system-call-allowed
40675 @kindex show remote system-call-allowed
40676 Show whether the @code{system} calls are allowed in the File I/O
40677 protocol.
40678 @end table
40679
40680 @node Protocol-specific Representation of Datatypes
40681 @subsection Protocol-specific Representation of Datatypes
40682 @cindex protocol-specific representation of datatypes, in file-i/o protocol
40683
40684 @menu
40685 * Integral Datatypes::
40686 * Pointer Values::
40687 * Memory Transfer::
40688 * struct stat::
40689 * struct timeval::
40690 @end menu
40691
40692 @node Integral Datatypes
40693 @unnumberedsubsubsec Integral Datatypes
40694 @cindex integral datatypes, in file-i/o protocol
40695
40696 The integral datatypes used in the system calls are @code{int}, 
40697 @code{unsigned int}, @code{long}, @code{unsigned long},
40698 @code{mode_t}, and @code{time_t}.  
40699
40700 @code{int}, @code{unsigned int}, @code{mode_t} and @code{time_t} are
40701 implemented as 32 bit values in this protocol.
40702
40703 @code{long} and @code{unsigned long} are implemented as 64 bit types.
40704
40705 @xref{Limits}, for corresponding MIN and MAX values (similar to those
40706 in @file{limits.h}) to allow range checking on host and target.
40707
40708 @code{time_t} datatypes are defined as seconds since the Epoch.
40709
40710 All integral datatypes transferred as part of a memory read or write of a
40711 structured datatype e.g.@: a @code{struct stat} have to be given in big endian
40712 byte order.
40713
40714 @node Pointer Values
40715 @unnumberedsubsubsec Pointer Values
40716 @cindex pointer values, in file-i/o protocol
40717
40718 Pointers to target data are transmitted as they are.  An exception
40719 is made for pointers to buffers for which the length isn't
40720 transmitted as part of the function call, namely strings.  Strings
40721 are transmitted as a pointer/length pair, both as hex values, e.g.@:
40722
40723 @smallexample
40724 @code{1aaf/12}
40725 @end smallexample
40726
40727 @noindent
40728 which is a pointer to data of length 18 bytes at position 0x1aaf.
40729 The length is defined as the full string length in bytes, including
40730 the trailing null byte.  For example, the string @code{"hello world"}
40731 at address 0x123456 is transmitted as
40732
40733 @smallexample
40734 @code{123456/d}
40735 @end smallexample
40736
40737 @node Memory Transfer
40738 @unnumberedsubsubsec Memory Transfer
40739 @cindex memory transfer, in file-i/o protocol
40740
40741 Structured data which is transferred using a memory read or write (for
40742 example, a @code{struct stat}) is expected to be in a protocol-specific format 
40743 with all scalar multibyte datatypes being big endian.  Translation to
40744 this representation needs to be done both by the target before the @code{F} 
40745 packet is sent, and by @value{GDBN} before 
40746 it transfers memory to the target.  Transferred pointers to structured
40747 data should point to the already-coerced data at any time.
40748
40749
40750 @node struct stat
40751 @unnumberedsubsubsec struct stat
40752 @cindex struct stat, in file-i/o protocol
40753
40754 The buffer of type @code{struct stat} used by the target and @value{GDBN} 
40755 is defined as follows:
40756
40757 @smallexample
40758 struct stat @{
40759     unsigned int  st_dev;      /* device */
40760     unsigned int  st_ino;      /* inode */
40761     mode_t        st_mode;     /* protection */
40762     unsigned int  st_nlink;    /* number of hard links */
40763     unsigned int  st_uid;      /* user ID of owner */
40764     unsigned int  st_gid;      /* group ID of owner */
40765     unsigned int  st_rdev;     /* device type (if inode device) */
40766     unsigned long st_size;     /* total size, in bytes */
40767     unsigned long st_blksize;  /* blocksize for filesystem I/O */
40768     unsigned long st_blocks;   /* number of blocks allocated */
40769     time_t        st_atime;    /* time of last access */
40770     time_t        st_mtime;    /* time of last modification */
40771     time_t        st_ctime;    /* time of last change */
40772 @};
40773 @end smallexample
40774
40775 The integral datatypes conform to the definitions given in the
40776 appropriate section (see @ref{Integral Datatypes}, for details) so this
40777 structure is of size 64 bytes.
40778
40779 The values of several fields have a restricted meaning and/or
40780 range of values.
40781
40782 @table @code
40783
40784 @item st_dev
40785 A value of 0 represents a file, 1 the console.
40786
40787 @item st_ino
40788 No valid meaning for the target.  Transmitted unchanged.
40789
40790 @item st_mode
40791 Valid mode bits are described in @ref{Constants}.  Any other
40792 bits have currently no meaning for the target.
40793
40794 @item st_uid
40795 @itemx st_gid
40796 @itemx st_rdev
40797 No valid meaning for the target.  Transmitted unchanged.
40798
40799 @item st_atime
40800 @itemx st_mtime
40801 @itemx st_ctime
40802 These values have a host and file system dependent
40803 accuracy.  Especially on Windows hosts, the file system may not
40804 support exact timing values.
40805 @end table
40806
40807 The target gets a @code{struct stat} of the above representation and is
40808 responsible for coercing it to the target representation before
40809 continuing.
40810
40811 Note that due to size differences between the host, target, and protocol
40812 representations of @code{struct stat} members, these members could eventually
40813 get truncated on the target.
40814
40815 @node struct timeval
40816 @unnumberedsubsubsec struct timeval
40817 @cindex struct timeval, in file-i/o protocol
40818
40819 The buffer of type @code{struct timeval} used by the File-I/O protocol
40820 is defined as follows:
40821
40822 @smallexample
40823 struct timeval @{
40824     time_t tv_sec;  /* second */
40825     long   tv_usec; /* microsecond */
40826 @};
40827 @end smallexample
40828
40829 The integral datatypes conform to the definitions given in the
40830 appropriate section (see @ref{Integral Datatypes}, for details) so this
40831 structure is of size 8 bytes.
40832
40833 @node Constants
40834 @subsection Constants
40835 @cindex constants, in file-i/o protocol
40836
40837 The following values are used for the constants inside of the
40838 protocol.  @value{GDBN} and target are responsible for translating these
40839 values before and after the call as needed.
40840
40841 @menu
40842 * Open Flags::
40843 * mode_t Values::
40844 * Errno Values::
40845 * Lseek Flags::
40846 * Limits::
40847 @end menu
40848
40849 @node Open Flags
40850 @unnumberedsubsubsec Open Flags
40851 @cindex open flags, in file-i/o protocol
40852
40853 All values are given in hexadecimal representation.
40854
40855 @smallexample
40856   O_RDONLY        0x0
40857   O_WRONLY        0x1
40858   O_RDWR          0x2
40859   O_APPEND        0x8
40860   O_CREAT       0x200
40861   O_TRUNC       0x400
40862   O_EXCL        0x800
40863 @end smallexample
40864
40865 @node mode_t Values
40866 @unnumberedsubsubsec mode_t Values
40867 @cindex mode_t values, in file-i/o protocol
40868
40869 All values are given in octal representation.
40870
40871 @smallexample
40872   S_IFREG       0100000
40873   S_IFDIR        040000
40874   S_IRUSR          0400
40875   S_IWUSR          0200
40876   S_IXUSR          0100
40877   S_IRGRP           040
40878   S_IWGRP           020
40879   S_IXGRP           010
40880   S_IROTH            04
40881   S_IWOTH            02
40882   S_IXOTH            01
40883 @end smallexample
40884
40885 @node Errno Values
40886 @unnumberedsubsubsec Errno Values
40887 @cindex errno values, in file-i/o protocol
40888
40889 All values are given in decimal representation.
40890
40891 @smallexample
40892   EPERM           1
40893   ENOENT          2
40894   EINTR           4
40895   EBADF           9
40896   EACCES         13
40897   EFAULT         14
40898   EBUSY          16
40899   EEXIST         17
40900   ENODEV         19
40901   ENOTDIR        20
40902   EISDIR         21
40903   EINVAL         22
40904   ENFILE         23
40905   EMFILE         24
40906   EFBIG          27
40907   ENOSPC         28
40908   ESPIPE         29
40909   EROFS          30
40910   ENAMETOOLONG   91
40911   EUNKNOWN       9999
40912 @end smallexample
40913
40914   @code{EUNKNOWN} is used as a fallback error value if a host system returns
40915   any error value not in the list of supported error numbers.
40916
40917 @node Lseek Flags
40918 @unnumberedsubsubsec Lseek Flags
40919 @cindex lseek flags, in file-i/o protocol
40920
40921 @smallexample
40922   SEEK_SET      0
40923   SEEK_CUR      1
40924   SEEK_END      2
40925 @end smallexample
40926
40927 @node Limits
40928 @unnumberedsubsubsec Limits
40929 @cindex limits, in file-i/o protocol
40930
40931 All values are given in decimal representation.
40932
40933 @smallexample
40934   INT_MIN       -2147483648
40935   INT_MAX        2147483647
40936   UINT_MAX       4294967295
40937   LONG_MIN      -9223372036854775808
40938   LONG_MAX       9223372036854775807
40939   ULONG_MAX      18446744073709551615
40940 @end smallexample
40941
40942 @node File-I/O Examples
40943 @subsection File-I/O Examples
40944 @cindex file-i/o examples
40945
40946 Example sequence of a write call, file descriptor 3, buffer is at target
40947 address 0x1234, 6 bytes should be written:
40948
40949 @smallexample
40950 <- @code{Fwrite,3,1234,6}
40951 @emph{request memory read from target}
40952 -> @code{m1234,6}
40953 <- XXXXXX
40954 @emph{return "6 bytes written"}
40955 -> @code{F6}
40956 @end smallexample
40957
40958 Example sequence of a read call, file descriptor 3, buffer is at target
40959 address 0x1234, 6 bytes should be read:
40960
40961 @smallexample
40962 <- @code{Fread,3,1234,6}
40963 @emph{request memory write to target}
40964 -> @code{X1234,6:XXXXXX}
40965 @emph{return "6 bytes read"}
40966 -> @code{F6}
40967 @end smallexample
40968
40969 Example sequence of a read call, call fails on the host due to invalid
40970 file descriptor (@code{EBADF}):
40971
40972 @smallexample
40973 <- @code{Fread,3,1234,6}
40974 -> @code{F-1,9}
40975 @end smallexample
40976
40977 Example sequence of a read call, user presses @kbd{Ctrl-c} before syscall on
40978 host is called:
40979
40980 @smallexample
40981 <- @code{Fread,3,1234,6}
40982 -> @code{F-1,4,C}
40983 <- @code{T02}
40984 @end smallexample
40985
40986 Example sequence of a read call, user presses @kbd{Ctrl-c} after syscall on
40987 host is called:
40988
40989 @smallexample
40990 <- @code{Fread,3,1234,6}
40991 -> @code{X1234,6:XXXXXX}
40992 <- @code{T02}
40993 @end smallexample
40994
40995 @node Library List Format
40996 @section Library List Format
40997 @cindex library list format, remote protocol
40998
40999 On some platforms, a dynamic loader (e.g.@: @file{ld.so}) runs in the
41000 same process as your application to manage libraries.  In this case,
41001 @value{GDBN} can use the loader's symbol table and normal memory
41002 operations to maintain a list of shared libraries.  On other
41003 platforms, the operating system manages loaded libraries.
41004 @value{GDBN} can not retrieve the list of currently loaded libraries
41005 through memory operations, so it uses the @samp{qXfer:libraries:read}
41006 packet (@pxref{qXfer library list read}) instead.  The remote stub
41007 queries the target's operating system and reports which libraries
41008 are loaded.
41009
41010 The @samp{qXfer:libraries:read} packet returns an XML document which
41011 lists loaded libraries and their offsets.  Each library has an
41012 associated name and one or more segment or section base addresses,
41013 which report where the library was loaded in memory.
41014
41015 For the common case of libraries that are fully linked binaries, the
41016 library should have a list of segments.  If the target supports
41017 dynamic linking of a relocatable object file, its library XML element
41018 should instead include a list of allocated sections.  The segment or
41019 section bases are start addresses, not relocation offsets; they do not
41020 depend on the library's link-time base addresses.
41021
41022 @value{GDBN} must be linked with the Expat library to support XML
41023 library lists.  @xref{Expat}.
41024
41025 A simple memory map, with one loaded library relocated by a single
41026 offset, looks like this:
41027
41028 @smallexample
41029 <library-list>
41030   <library name="/lib/libc.so.6">
41031     <segment address="0x10000000"/>
41032   </library>
41033 </library-list>
41034 @end smallexample
41035
41036 Another simple memory map, with one loaded library with three
41037 allocated sections (.text, .data, .bss), looks like this:
41038
41039 @smallexample
41040 <library-list>
41041   <library name="sharedlib.o">
41042     <section address="0x10000000"/>
41043     <section address="0x20000000"/>
41044     <section address="0x30000000"/>
41045   </library>
41046 </library-list>
41047 @end smallexample
41048
41049 The format of a library list is described by this DTD:
41050
41051 @smallexample
41052 <!-- library-list: Root element with versioning -->
41053 <!ELEMENT library-list  (library)*>
41054 <!ATTLIST library-list  version CDATA   #FIXED  "1.0">
41055 <!ELEMENT library       (segment*, section*)>
41056 <!ATTLIST library       name    CDATA   #REQUIRED>
41057 <!ELEMENT segment       EMPTY>
41058 <!ATTLIST segment       address CDATA   #REQUIRED>
41059 <!ELEMENT section       EMPTY>
41060 <!ATTLIST section       address CDATA   #REQUIRED>
41061 @end smallexample
41062
41063 In addition, segments and section descriptors cannot be mixed within a
41064 single library element, and you must supply at least one segment or
41065 section for each library.
41066
41067 @node Library List Format for SVR4 Targets
41068 @section Library List Format for SVR4 Targets
41069 @cindex library list format, remote protocol
41070
41071 On SVR4 platforms @value{GDBN} can use the symbol table of a dynamic loader
41072 (e.g.@: @file{ld.so}) and normal memory operations to maintain a list of
41073 shared libraries.  Still a special library list provided by this packet is
41074 more efficient for the @value{GDBN} remote protocol.
41075
41076 The @samp{qXfer:libraries-svr4:read} packet returns an XML document which lists
41077 loaded libraries and their SVR4 linker parameters.  For each library on SVR4
41078 target, the following parameters are reported:
41079
41080 @itemize @minus
41081 @item
41082 @code{name}, the absolute file name from the @code{l_name} field of
41083 @code{struct link_map}.
41084 @item
41085 @code{lm} with address of @code{struct link_map} used for TLS
41086 (Thread Local Storage) access.
41087 @item
41088 @code{l_addr}, the displacement as read from the field @code{l_addr} of
41089 @code{struct link_map}.  For prelinked libraries this is not an absolute
41090 memory address.  It is a displacement of absolute memory address against
41091 address the file was prelinked to during the library load.
41092 @item
41093 @code{l_ld}, which is memory address of the @code{PT_DYNAMIC} segment
41094 @end itemize
41095
41096 Additionally the single @code{main-lm} attribute specifies address of
41097 @code{struct link_map} used for the main executable.  This parameter is used
41098 for TLS access and its presence is optional.
41099
41100 @value{GDBN} must be linked with the Expat library to support XML
41101 SVR4 library lists.  @xref{Expat}.
41102
41103 A simple memory map, with two loaded libraries (which do not use prelink),
41104 looks like this:
41105
41106 @smallexample
41107 <library-list-svr4 version="1.0" main-lm="0xe4f8f8">
41108   <library name="/lib/ld-linux.so.2" lm="0xe4f51c" l_addr="0xe2d000"
41109            l_ld="0xe4eefc"/>
41110   <library name="/lib/libc.so.6" lm="0xe4fbe8" l_addr="0x154000"
41111            l_ld="0x152350"/>
41112 </library-list-svr>
41113 @end smallexample
41114
41115 The format of an SVR4 library list is described by this DTD:
41116
41117 @smallexample
41118 <!-- library-list-svr4: Root element with versioning -->
41119 <!ELEMENT library-list-svr4  (library)*>
41120 <!ATTLIST library-list-svr4  version CDATA   #FIXED  "1.0">
41121 <!ATTLIST library-list-svr4  main-lm CDATA   #IMPLIED>
41122 <!ELEMENT library            EMPTY>
41123 <!ATTLIST library            name    CDATA   #REQUIRED>
41124 <!ATTLIST library            lm      CDATA   #REQUIRED>
41125 <!ATTLIST library            l_addr  CDATA   #REQUIRED>
41126 <!ATTLIST library            l_ld    CDATA   #REQUIRED>
41127 @end smallexample
41128
41129 @node Memory Map Format
41130 @section Memory Map Format
41131 @cindex memory map format
41132
41133 To be able to write into flash memory, @value{GDBN} needs to obtain a
41134 memory map from the target.  This section describes the format of the
41135 memory map.
41136
41137 The memory map is obtained using the @samp{qXfer:memory-map:read}
41138 (@pxref{qXfer memory map read}) packet and is an XML document that
41139 lists memory regions.
41140
41141 @value{GDBN} must be linked with the Expat library to support XML
41142 memory maps.  @xref{Expat}.
41143
41144 The top-level structure of the document is shown below:
41145
41146 @smallexample
41147 <?xml version="1.0"?>
41148 <!DOCTYPE memory-map
41149           PUBLIC "+//IDN gnu.org//DTD GDB Memory Map V1.0//EN"
41150                  "http://sourceware.org/gdb/gdb-memory-map.dtd">
41151 <memory-map>
41152     region...
41153 </memory-map>
41154 @end smallexample
41155
41156 Each region can be either:
41157
41158 @itemize
41159
41160 @item
41161 A region of RAM starting at @var{addr} and extending for @var{length}
41162 bytes from there:
41163
41164 @smallexample
41165 <memory type="ram" start="@var{addr}" length="@var{length}"/>
41166 @end smallexample
41167
41168
41169 @item
41170 A region of read-only memory:
41171
41172 @smallexample
41173 <memory type="rom" start="@var{addr}" length="@var{length}"/>
41174 @end smallexample
41175
41176
41177 @item
41178 A region of flash memory, with erasure blocks @var{blocksize}
41179 bytes in length:
41180
41181 @smallexample
41182 <memory type="flash" start="@var{addr}" length="@var{length}">
41183   <property name="blocksize">@var{blocksize}</property>
41184 </memory>
41185 @end smallexample
41186
41187 @end itemize
41188
41189 Regions must not overlap.  @value{GDBN} assumes that areas of memory not covered
41190 by the memory map are RAM, and uses the ordinary @samp{M} and @samp{X}
41191 packets to write to addresses in such ranges.
41192
41193 The formal DTD for memory map format is given below:
41194
41195 @smallexample
41196 <!-- ................................................... -->
41197 <!-- Memory Map XML DTD ................................ -->
41198 <!-- File: memory-map.dtd .............................. -->
41199 <!-- .................................... .............. -->
41200 <!-- memory-map.dtd -->
41201 <!-- memory-map: Root element with versioning -->
41202 <!ELEMENT memory-map (memory)*>
41203 <!ATTLIST memory-map    version CDATA   #FIXED  "1.0.0">
41204 <!ELEMENT memory (property)*>
41205 <!-- memory: Specifies a memory region,
41206              and its type, or device. -->
41207 <!ATTLIST memory        type    (ram|rom|flash) #REQUIRED
41208                         start   CDATA   #REQUIRED
41209                         length  CDATA   #REQUIRED>
41210 <!-- property: Generic attribute tag -->
41211 <!ELEMENT property (#PCDATA | property)*>
41212 <!ATTLIST property      name    (blocksize) #REQUIRED>
41213 @end smallexample
41214
41215 @node Thread List Format
41216 @section Thread List Format
41217 @cindex thread list format
41218
41219 To efficiently update the list of threads and their attributes,
41220 @value{GDBN} issues the @samp{qXfer:threads:read} packet
41221 (@pxref{qXfer threads read}) and obtains the XML document with
41222 the following structure:
41223
41224 @smallexample
41225 <?xml version="1.0"?>
41226 <threads>
41227     <thread id="id" core="0" name="name">
41228     ... description ...
41229     </thread>
41230 </threads>
41231 @end smallexample
41232
41233 Each @samp{thread} element must have the @samp{id} attribute that
41234 identifies the thread (@pxref{thread-id syntax}).  The
41235 @samp{core} attribute, if present, specifies which processor core
41236 the thread was last executing on.  The @samp{name} attribute, if
41237 present, specifies the human-readable name of the thread.  The content
41238 of the of @samp{thread} element is interpreted as human-readable
41239 auxiliary information.  The @samp{handle} attribute, if present,
41240 is a hex encoded representation of the thread handle.
41241
41242
41243 @node Traceframe Info Format
41244 @section Traceframe Info Format
41245 @cindex traceframe info format
41246
41247 To be able to know which objects in the inferior can be examined when
41248 inspecting a tracepoint hit, @value{GDBN} needs to obtain the list of
41249 memory ranges, registers and trace state variables that have been
41250 collected in a traceframe.
41251
41252 This list is obtained using the @samp{qXfer:traceframe-info:read}
41253 (@pxref{qXfer traceframe info read}) packet and is an XML document.
41254
41255 @value{GDBN} must be linked with the Expat library to support XML
41256 traceframe info discovery.  @xref{Expat}.
41257
41258 The top-level structure of the document is shown below:
41259
41260 @smallexample
41261 <?xml version="1.0"?>
41262 <!DOCTYPE traceframe-info
41263           PUBLIC "+//IDN gnu.org//DTD GDB Memory Map V1.0//EN"
41264                  "http://sourceware.org/gdb/gdb-traceframe-info.dtd">
41265 <traceframe-info>
41266    block...
41267 </traceframe-info>
41268 @end smallexample
41269
41270 Each traceframe block can be either:
41271
41272 @itemize
41273
41274 @item
41275 A region of collected memory starting at @var{addr} and extending for
41276 @var{length} bytes from there:
41277
41278 @smallexample
41279 <memory start="@var{addr}" length="@var{length}"/>
41280 @end smallexample
41281
41282 @item
41283 A block indicating trace state variable numbered @var{number} has been
41284 collected:
41285
41286 @smallexample
41287 <tvar id="@var{number}"/>
41288 @end smallexample
41289
41290 @end itemize
41291
41292 The formal DTD for the traceframe info format is given below:
41293
41294 @smallexample
41295 <!ELEMENT traceframe-info  (memory | tvar)* >
41296 <!ATTLIST traceframe-info  version CDATA   #FIXED  "1.0">
41297
41298 <!ELEMENT memory        EMPTY>
41299 <!ATTLIST memory        start   CDATA   #REQUIRED
41300                         length  CDATA   #REQUIRED>
41301 <!ELEMENT tvar>
41302 <!ATTLIST tvar          id      CDATA   #REQUIRED>
41303 @end smallexample
41304
41305 @node Branch Trace Format
41306 @section Branch Trace Format
41307 @cindex branch trace format
41308
41309 In order to display the branch trace of an inferior thread,
41310 @value{GDBN} needs to obtain the list of branches.  This list is
41311 represented as list of sequential code blocks that are connected via
41312 branches.  The code in each block has been executed sequentially.
41313
41314 This list is obtained using the @samp{qXfer:btrace:read}
41315 (@pxref{qXfer btrace read}) packet and is an XML document.
41316
41317 @value{GDBN} must be linked with the Expat library to support XML
41318 traceframe info discovery.  @xref{Expat}.
41319
41320 The top-level structure of the document is shown below:
41321
41322 @smallexample
41323 <?xml version="1.0"?>
41324 <!DOCTYPE btrace
41325           PUBLIC "+//IDN gnu.org//DTD GDB Branch Trace V1.0//EN"
41326                  "http://sourceware.org/gdb/gdb-btrace.dtd">
41327 <btrace>
41328    block...
41329 </btrace>
41330 @end smallexample
41331
41332 @itemize
41333
41334 @item
41335 A block of sequentially executed instructions starting at @var{begin}
41336 and ending at @var{end}:
41337
41338 @smallexample
41339 <block begin="@var{begin}" end="@var{end}"/>
41340 @end smallexample
41341
41342 @end itemize
41343
41344 The formal DTD for the branch trace format is given below:
41345
41346 @smallexample
41347 <!ELEMENT btrace  (block* | pt) >
41348 <!ATTLIST btrace  version CDATA   #FIXED "1.0">
41349
41350 <!ELEMENT block        EMPTY>
41351 <!ATTLIST block        begin  CDATA   #REQUIRED
41352                        end    CDATA   #REQUIRED>
41353
41354 <!ELEMENT pt (pt-config?, raw?)>
41355
41356 <!ELEMENT pt-config (cpu?)>
41357
41358 <!ELEMENT cpu EMPTY>
41359 <!ATTLIST cpu vendor   CDATA #REQUIRED
41360               family   CDATA #REQUIRED
41361               model    CDATA #REQUIRED
41362               stepping CDATA #REQUIRED>
41363
41364 <!ELEMENT raw (#PCDATA)>
41365 @end smallexample
41366
41367 @node Branch Trace Configuration Format
41368 @section Branch Trace Configuration Format
41369 @cindex branch trace configuration format
41370
41371 For each inferior thread, @value{GDBN} can obtain the branch trace
41372 configuration using the @samp{qXfer:btrace-conf:read}
41373 (@pxref{qXfer btrace-conf read}) packet.
41374
41375 The configuration describes the branch trace format and configuration
41376 settings for that format.  The following information is described:
41377
41378 @table @code
41379 @item bts
41380 This thread uses the @dfn{Branch Trace Store} (@acronym{BTS}) format.
41381 @table @code
41382 @item size
41383 The size of the @acronym{BTS} ring buffer in bytes.
41384 @end table
41385 @item pt
41386 This thread uses the @dfn{Intel Processor Trace} (@acronym{Intel
41387 PT}) format.
41388 @table @code
41389 @item size
41390 The size of the @acronym{Intel PT} ring buffer in bytes.
41391 @end table
41392 @end table
41393
41394 @value{GDBN} must be linked with the Expat library to support XML
41395 branch trace configuration discovery.  @xref{Expat}.
41396
41397 The formal DTD for the branch trace configuration format is given below:
41398
41399 @smallexample
41400 <!ELEMENT btrace-conf   (bts?, pt?)>
41401 <!ATTLIST btrace-conf   version CDATA   #FIXED "1.0">
41402
41403 <!ELEMENT bts   EMPTY>
41404 <!ATTLIST bts   size    CDATA   #IMPLIED>
41405
41406 <!ELEMENT pt    EMPTY>
41407 <!ATTLIST pt    size    CDATA   #IMPLIED>
41408 @end smallexample
41409
41410 @include agentexpr.texi
41411
41412 @node Target Descriptions
41413 @appendix Target Descriptions
41414 @cindex target descriptions
41415
41416 One of the challenges of using @value{GDBN} to debug embedded systems
41417 is that there are so many minor variants of each processor
41418 architecture in use.  It is common practice for vendors to start with
41419 a standard processor core --- ARM, PowerPC, or @acronym{MIPS}, for example ---
41420 and then make changes to adapt it to a particular market niche.  Some
41421 architectures have hundreds of variants, available from dozens of
41422 vendors.  This leads to a number of problems:
41423
41424 @itemize @bullet
41425 @item
41426 With so many different customized processors, it is difficult for
41427 the @value{GDBN} maintainers to keep up with the changes.
41428 @item
41429 Since individual variants may have short lifetimes or limited
41430 audiences, it may not be worthwhile to carry information about every
41431 variant in the @value{GDBN} source tree.
41432 @item
41433 When @value{GDBN} does support the architecture of the embedded system
41434 at hand, the task of finding the correct architecture name to give the
41435 @command{set architecture} command can be error-prone.
41436 @end itemize
41437
41438 To address these problems, the @value{GDBN} remote protocol allows a
41439 target system to not only identify itself to @value{GDBN}, but to
41440 actually describe its own features.  This lets @value{GDBN} support
41441 processor variants it has never seen before --- to the extent that the
41442 descriptions are accurate, and that @value{GDBN} understands them.
41443
41444 @value{GDBN} must be linked with the Expat library to support XML
41445 target descriptions.  @xref{Expat}.
41446
41447 @menu
41448 * Retrieving Descriptions::         How descriptions are fetched from a target.
41449 * Target Description Format::       The contents of a target description.
41450 * Predefined Target Types::         Standard types available for target
41451                                     descriptions.
41452 * Enum Target Types::               How to define enum target types.
41453 * Standard Target Features::        Features @value{GDBN} knows about.
41454 @end menu
41455
41456 @node Retrieving Descriptions
41457 @section Retrieving Descriptions
41458
41459 Target descriptions can be read from the target automatically, or
41460 specified by the user manually.  The default behavior is to read the
41461 description from the target.  @value{GDBN} retrieves it via the remote
41462 protocol using @samp{qXfer} requests (@pxref{General Query Packets,
41463 qXfer}).  The @var{annex} in the @samp{qXfer} packet will be
41464 @samp{target.xml}.  The contents of the @samp{target.xml} annex are an
41465 XML document, of the form described in @ref{Target Description
41466 Format}.
41467
41468 Alternatively, you can specify a file to read for the target description.
41469 If a file is set, the target will not be queried.  The commands to
41470 specify a file are:
41471
41472 @table @code
41473 @cindex set tdesc filename
41474 @item set tdesc filename @var{path}
41475 Read the target description from @var{path}.
41476
41477 @cindex unset tdesc filename
41478 @item unset tdesc filename
41479 Do not read the XML target description from a file.  @value{GDBN}
41480 will use the description supplied by the current target.
41481
41482 @cindex show tdesc filename
41483 @item show tdesc filename
41484 Show the filename to read for a target description, if any.
41485 @end table
41486
41487
41488 @node Target Description Format
41489 @section Target Description Format
41490 @cindex target descriptions, XML format
41491
41492 A target description annex is an @uref{http://www.w3.org/XML/, XML}
41493 document which complies with the Document Type Definition provided in
41494 the @value{GDBN} sources in @file{gdb/features/gdb-target.dtd}.  This
41495 means you can use generally available tools like @command{xmllint} to
41496 check that your feature descriptions are well-formed and valid.
41497 However, to help people unfamiliar with XML write descriptions for
41498 their targets, we also describe the grammar here.
41499
41500 Target descriptions can identify the architecture of the remote target
41501 and (for some architectures) provide information about custom register
41502 sets.  They can also identify the OS ABI of the remote target.
41503 @value{GDBN} can use this information to autoconfigure for your
41504 target, or to warn you if you connect to an unsupported target.
41505
41506 Here is a simple target description:
41507
41508 @smallexample
41509 <target version="1.0">
41510   <architecture>i386:x86-64</architecture>
41511 </target>
41512 @end smallexample
41513
41514 @noindent
41515 This minimal description only says that the target uses
41516 the x86-64 architecture.
41517
41518 A target description has the following overall form, with [ ] marking
41519 optional elements and @dots{} marking repeatable elements.  The elements
41520 are explained further below.
41521
41522 @smallexample
41523 <?xml version="1.0"?>
41524 <!DOCTYPE target SYSTEM "gdb-target.dtd">
41525 <target version="1.0">
41526   @r{[}@var{architecture}@r{]}
41527   @r{[}@var{osabi}@r{]}
41528   @r{[}@var{compatible}@r{]}
41529   @r{[}@var{feature}@dots{}@r{]}
41530 </target>
41531 @end smallexample
41532
41533 @noindent
41534 The description is generally insensitive to whitespace and line
41535 breaks, under the usual common-sense rules.  The XML version
41536 declaration and document type declaration can generally be omitted
41537 (@value{GDBN} does not require them), but specifying them may be
41538 useful for XML validation tools.  The @samp{version} attribute for
41539 @samp{<target>} may also be omitted, but we recommend
41540 including it; if future versions of @value{GDBN} use an incompatible
41541 revision of @file{gdb-target.dtd}, they will detect and report
41542 the version mismatch.
41543
41544 @subsection Inclusion
41545 @cindex target descriptions, inclusion
41546 @cindex XInclude
41547 @ifnotinfo
41548 @cindex <xi:include>
41549 @end ifnotinfo
41550
41551 It can sometimes be valuable to split a target description up into
41552 several different annexes, either for organizational purposes, or to
41553 share files between different possible target descriptions.  You can
41554 divide a description into multiple files by replacing any element of
41555 the target description with an inclusion directive of the form:
41556
41557 @smallexample
41558 <xi:include href="@var{document}"/>
41559 @end smallexample
41560
41561 @noindent
41562 When @value{GDBN} encounters an element of this form, it will retrieve
41563 the named XML @var{document}, and replace the inclusion directive with
41564 the contents of that document.  If the current description was read
41565 using @samp{qXfer}, then so will be the included document;
41566 @var{document} will be interpreted as the name of an annex.  If the
41567 current description was read from a file, @value{GDBN} will look for
41568 @var{document} as a file in the same directory where it found the
41569 original description.
41570
41571 @subsection Architecture
41572 @cindex <architecture>
41573
41574 An @samp{<architecture>} element has this form:
41575
41576 @smallexample
41577   <architecture>@var{arch}</architecture>
41578 @end smallexample
41579
41580 @var{arch} is one of the architectures from the set accepted by
41581 @code{set architecture} (@pxref{Targets, ,Specifying a Debugging Target}).
41582
41583 @subsection OS ABI
41584 @cindex @code{<osabi>}
41585
41586 This optional field was introduced in @value{GDBN} version 7.0.
41587 Previous versions of @value{GDBN} ignore it.
41588
41589 An @samp{<osabi>} element has this form:
41590
41591 @smallexample
41592   <osabi>@var{abi-name}</osabi>
41593 @end smallexample
41594
41595 @var{abi-name} is an OS ABI name from the same selection accepted by
41596 @w{@code{set osabi}} (@pxref{ABI, ,Configuring the Current ABI}).
41597
41598 @subsection Compatible Architecture
41599 @cindex @code{<compatible>}
41600
41601 This optional field was introduced in @value{GDBN} version 7.0.
41602 Previous versions of @value{GDBN} ignore it.
41603
41604 A @samp{<compatible>} element has this form:
41605
41606 @smallexample
41607   <compatible>@var{arch}</compatible>
41608 @end smallexample
41609
41610 @var{arch} is one of the architectures from the set accepted by
41611 @code{set architecture} (@pxref{Targets, ,Specifying a Debugging Target}).
41612
41613 A @samp{<compatible>} element is used to specify that the target
41614 is able to run binaries in some other than the main target architecture
41615 given by the @samp{<architecture>} element.  For example, on the
41616 Cell Broadband Engine, the main architecture is @code{powerpc:common}
41617 or @code{powerpc:common64}, but the system is able to run binaries
41618 in the @code{spu} architecture as well.  The way to describe this
41619 capability with @samp{<compatible>} is as follows:
41620
41621 @smallexample
41622   <architecture>powerpc:common</architecture>
41623   <compatible>spu</compatible>
41624 @end smallexample
41625
41626 @subsection Features
41627 @cindex <feature>
41628
41629 Each @samp{<feature>} describes some logical portion of the target
41630 system.  Features are currently used to describe available CPU
41631 registers and the types of their contents.  A @samp{<feature>} element
41632 has this form:
41633
41634 @smallexample
41635 <feature name="@var{name}">
41636   @r{[}@var{type}@dots{}@r{]}
41637   @var{reg}@dots{}
41638 </feature>
41639 @end smallexample
41640
41641 @noindent
41642 Each feature's name should be unique within the description.  The name
41643 of a feature does not matter unless @value{GDBN} has some special
41644 knowledge of the contents of that feature; if it does, the feature
41645 should have its standard name.  @xref{Standard Target Features}.
41646
41647 @subsection Types
41648
41649 Any register's value is a collection of bits which @value{GDBN} must
41650 interpret.  The default interpretation is a two's complement integer,
41651 but other types can be requested by name in the register description.
41652 Some predefined types are provided by @value{GDBN} (@pxref{Predefined
41653 Target Types}), and the description can define additional composite
41654 and enum types.
41655
41656 Each type element must have an @samp{id} attribute, which gives
41657 a unique (within the containing @samp{<feature>}) name to the type.
41658 Types must be defined before they are used.
41659
41660 @cindex <vector>
41661 Some targets offer vector registers, which can be treated as arrays
41662 of scalar elements.  These types are written as @samp{<vector>} elements,
41663 specifying the array element type, @var{type}, and the number of elements,
41664 @var{count}:
41665
41666 @smallexample
41667 <vector id="@var{id}" type="@var{type}" count="@var{count}"/>
41668 @end smallexample
41669
41670 @cindex <union>
41671 If a register's value is usefully viewed in multiple ways, define it
41672 with a union type containing the useful representations.  The
41673 @samp{<union>} element contains one or more @samp{<field>} elements,
41674 each of which has a @var{name} and a @var{type}:
41675
41676 @smallexample
41677 <union id="@var{id}">
41678   <field name="@var{name}" type="@var{type}"/>
41679   @dots{}
41680 </union>
41681 @end smallexample
41682
41683 @cindex <struct>
41684 @cindex <flags>
41685 If a register's value is composed from several separate values, define
41686 it with either a structure type or a flags type.
41687 A flags type may only contain bitfields.
41688 A structure type may either contain only bitfields or contain no bitfields.
41689 If the value contains only bitfields, its total size in bytes must be
41690 specified.
41691
41692 Non-bitfield values have a @var{name} and @var{type}.
41693
41694 @smallexample
41695 <struct id="@var{id}">
41696   <field name="@var{name}" type="@var{type}"/>
41697   @dots{}
41698 </struct>
41699 @end smallexample
41700
41701 Both @var{name} and @var{type} values are required.
41702 No implicit padding is added.
41703
41704 Bitfield values have a @var{name}, @var{start}, @var{end} and @var{type}.
41705
41706 @smallexample
41707 <struct id="@var{id}" size="@var{size}">
41708   <field name="@var{name}" start="@var{start}" end="@var{end}" type="@var{type}"/>
41709   @dots{}
41710 </struct>
41711 @end smallexample
41712
41713 @smallexample
41714 <flags id="@var{id}" size="@var{size}">
41715   <field name="@var{name}" start="@var{start}" end="@var{end}" type="@var{type}"/>
41716   @dots{}
41717 </flags>
41718 @end smallexample
41719
41720 The @var{name} value is required.
41721 Bitfield values may be named with the empty string, @samp{""},
41722 in which case the field is ``filler'' and its value is not printed.
41723 Not all bits need to be specified, so ``filler'' fields are optional.
41724
41725 The @var{start} and @var{end} values are required, and @var{type}
41726 is optional.
41727 The field's @var{start} must be less than or equal to its @var{end},
41728 and zero represents the least significant bit.
41729
41730 The default value of @var{type} is @code{bool} for single bit fields,
41731 and an unsigned integer otherwise.
41732
41733 Which to choose?  Structures or flags?
41734
41735 Registers defined with @samp{flags} have these advantages over
41736 defining them with @samp{struct}:
41737
41738 @itemize @bullet
41739 @item
41740 Arithmetic may be performed on them as if they were integers.
41741 @item
41742 They are printed in a more readable fashion.
41743 @end itemize
41744
41745 Registers defined with @samp{struct} have one advantage over
41746 defining them with @samp{flags}:
41747
41748 @itemize @bullet
41749 @item
41750 One can fetch individual fields like in @samp{C}.
41751
41752 @smallexample
41753 (gdb) print $my_struct_reg.field3
41754 $1 = 42
41755 @end smallexample
41756
41757 @end itemize
41758
41759 @subsection Registers
41760 @cindex <reg>
41761
41762 Each register is represented as an element with this form:
41763
41764 @smallexample
41765 <reg name="@var{name}"
41766      bitsize="@var{size}"
41767      @r{[}regnum="@var{num}"@r{]}
41768      @r{[}save-restore="@var{save-restore}"@r{]}
41769      @r{[}type="@var{type}"@r{]}
41770      @r{[}group="@var{group}"@r{]}/>
41771 @end smallexample
41772
41773 @noindent
41774 The components are as follows:
41775
41776 @table @var
41777
41778 @item name
41779 The register's name; it must be unique within the target description.
41780
41781 @item bitsize
41782 The register's size, in bits.
41783
41784 @item regnum
41785 The register's number.  If omitted, a register's number is one greater
41786 than that of the previous register (either in the current feature or in
41787 a preceding feature); the first register in the target description
41788 defaults to zero.  This register number is used to read or write
41789 the register; e.g.@: it is used in the remote @code{p} and @code{P}
41790 packets, and registers appear in the @code{g} and @code{G} packets
41791 in order of increasing register number.
41792
41793 @item save-restore
41794 Whether the register should be preserved across inferior function
41795 calls; this must be either @code{yes} or @code{no}.  The default is
41796 @code{yes}, which is appropriate for most registers except for
41797 some system control registers; this is not related to the target's
41798 ABI.
41799
41800 @item type
41801 The type of the register.  It may be a predefined type, a type
41802 defined in the current feature, or one of the special types @code{int}
41803 and @code{float}.  @code{int} is an integer type of the correct size
41804 for @var{bitsize}, and @code{float} is a floating point type (in the
41805 architecture's normal floating point format) of the correct size for
41806 @var{bitsize}.  The default is @code{int}.
41807
41808 @item group
41809 The register group to which this register belongs.  It can be one of the
41810 standard register groups @code{general}, @code{float}, @code{vector} or an
41811 arbitrary string.  Group names should be limited to alphanumeric characters.
41812 If a group name is made up of multiple words the words may be separated by
41813 hyphens; e.g.@: @code{special-group} or @code{ultra-special-group}.  If no
41814 @var{group} is specified, @value{GDBN} will not display the register in
41815 @code{info registers}.
41816
41817 @end table
41818
41819 @node Predefined Target Types
41820 @section Predefined Target Types
41821 @cindex target descriptions, predefined types
41822
41823 Type definitions in the self-description can build up composite types
41824 from basic building blocks, but can not define fundamental types.  Instead,
41825 standard identifiers are provided by @value{GDBN} for the fundamental
41826 types.  The currently supported types are:
41827
41828 @table @code
41829
41830 @item bool
41831 Boolean type, occupying a single bit.
41832
41833 @item int8
41834 @itemx int16
41835 @itemx int32
41836 @itemx int64
41837 @itemx int128
41838 Signed integer types holding the specified number of bits.
41839
41840 @item uint8
41841 @itemx uint16
41842 @itemx uint32
41843 @itemx uint64
41844 @itemx uint128
41845 Unsigned integer types holding the specified number of bits.
41846
41847 @item code_ptr
41848 @itemx data_ptr
41849 Pointers to unspecified code and data.  The program counter and
41850 any dedicated return address register may be marked as code
41851 pointers; printing a code pointer converts it into a symbolic
41852 address.  The stack pointer and any dedicated address registers
41853 may be marked as data pointers.
41854
41855 @item ieee_single
41856 Single precision IEEE floating point.
41857
41858 @item ieee_double
41859 Double precision IEEE floating point.
41860
41861 @item arm_fpa_ext
41862 The 12-byte extended precision format used by ARM FPA registers.
41863
41864 @item i387_ext
41865 The 10-byte extended precision format used by x87 registers.
41866
41867 @item i386_eflags
41868 32bit @sc{eflags} register used by x86.
41869
41870 @item i386_mxcsr
41871 32bit @sc{mxcsr} register used by x86.
41872
41873 @end table
41874
41875 @node Enum Target Types
41876 @section Enum Target Types
41877 @cindex target descriptions, enum types
41878
41879 Enum target types are useful in @samp{struct} and @samp{flags}
41880 register descriptions.  @xref{Target Description Format}.
41881
41882 Enum types have a name, size and a list of name/value pairs.
41883
41884 @smallexample
41885 <enum id="@var{id}" size="@var{size}">
41886   <evalue name="@var{name}" value="@var{value}"/>
41887   @dots{}
41888 </enum>
41889 @end smallexample
41890
41891 Enums must be defined before they are used.
41892
41893 @smallexample
41894 <enum id="levels_type" size="4">
41895   <evalue name="low" value="0"/>
41896   <evalue name="high" value="1"/>
41897 </enum>
41898 <flags id="flags_type" size="4">
41899   <field name="X" start="0"/>
41900   <field name="LEVEL" start="1" end="1" type="levels_type"/>
41901 </flags>
41902 <reg name="flags" bitsize="32" type="flags_type"/>
41903 @end smallexample
41904
41905 Given that description, a value of 3 for the @samp{flags} register
41906 would be printed as:
41907
41908 @smallexample
41909 (gdb) info register flags
41910 flags 0x3 [ X LEVEL=high ]
41911 @end smallexample
41912
41913 @node Standard Target Features
41914 @section Standard Target Features
41915 @cindex target descriptions, standard features
41916
41917 A target description must contain either no registers or all the
41918 target's registers.  If the description contains no registers, then
41919 @value{GDBN} will assume a default register layout, selected based on
41920 the architecture.  If the description contains any registers, the
41921 default layout will not be used; the standard registers must be
41922 described in the target description, in such a way that @value{GDBN}
41923 can recognize them.
41924
41925 This is accomplished by giving specific names to feature elements
41926 which contain standard registers.  @value{GDBN} will look for features
41927 with those names and verify that they contain the expected registers;
41928 if any known feature is missing required registers, or if any required
41929 feature is missing, @value{GDBN} will reject the target
41930 description.  You can add additional registers to any of the
41931 standard features --- @value{GDBN} will display them just as if
41932 they were added to an unrecognized feature.
41933
41934 This section lists the known features and their expected contents.
41935 Sample XML documents for these features are included in the
41936 @value{GDBN} source tree, in the directory @file{gdb/features}.
41937
41938 Names recognized by @value{GDBN} should include the name of the
41939 company or organization which selected the name, and the overall
41940 architecture to which the feature applies; so e.g.@: the feature
41941 containing ARM core registers is named @samp{org.gnu.gdb.arm.core}.
41942
41943 The names of registers are not case sensitive for the purpose
41944 of recognizing standard features, but @value{GDBN} will only display
41945 registers using the capitalization used in the description.
41946
41947 @menu
41948 * AArch64 Features::
41949 * ARC Features::
41950 * ARM Features::
41951 * i386 Features::
41952 * MicroBlaze Features::
41953 * MIPS Features::
41954 * M68K Features::
41955 * NDS32 Features::
41956 * Nios II Features::
41957 * OpenRISC 1000 Features::
41958 * PowerPC Features::
41959 * S/390 and System z Features::
41960 * Sparc Features::
41961 * TIC6x Features::
41962 @end menu
41963
41964
41965 @node AArch64 Features
41966 @subsection AArch64 Features
41967 @cindex target descriptions, AArch64 features
41968
41969 The @samp{org.gnu.gdb.aarch64.core} feature is required for AArch64
41970 targets.  It should contain registers @samp{x0} through @samp{x30},
41971 @samp{sp}, @samp{pc}, and @samp{cpsr}.
41972
41973 The @samp{org.gnu.gdb.aarch64.fpu} feature is optional.  If present,
41974 it should contain registers @samp{v0} through @samp{v31}, @samp{fpsr},
41975 and @samp{fpcr}.
41976
41977 @node ARC Features
41978 @subsection ARC Features
41979 @cindex target descriptions, ARC Features
41980
41981 ARC processors are highly configurable, so even core registers and their number
41982 are not completely predetermined.  In addition flags and PC registers which are
41983 important to @value{GDBN} are not ``core'' registers in ARC.  It is required
41984 that one of the core registers features is present.
41985 @samp{org.gnu.gdb.arc.aux-minimal} feature is mandatory.
41986
41987 The @samp{org.gnu.gdb.arc.core.v2} feature is required for ARC EM and ARC HS
41988 targets with a normal register file.  It should contain registers @samp{r0}
41989 through @samp{r25}, @samp{gp}, @samp{fp}, @samp{sp}, @samp{r30}, @samp{blink},
41990 @samp{lp_count} and @samp{pcl}.  This feature may contain register @samp{ilink}
41991 and any of extension core registers @samp{r32} through @samp{r59/acch}.
41992 @samp{ilink} and extension core registers are not available to read/write, when
41993 debugging GNU/Linux applications, thus @samp{ilink} is made optional.
41994
41995 The @samp{org.gnu.gdb.arc.core-reduced.v2} feature is required for ARC EM and
41996 ARC HS targets with a reduced register file.  It should contain registers
41997 @samp{r0} through @samp{r3}, @samp{r10} through @samp{r15}, @samp{gp},
41998 @samp{fp}, @samp{sp}, @samp{r30}, @samp{blink}, @samp{lp_count} and @samp{pcl}.
41999 This feature may contain register @samp{ilink} and any of extension core
42000 registers @samp{r32} through @samp{r59/acch}.
42001
42002 The @samp{org.gnu.gdb.arc.core.arcompact} feature is required for ARCompact
42003 targets with a normal register file.  It should contain registers @samp{r0}
42004 through @samp{r25}, @samp{gp}, @samp{fp}, @samp{sp}, @samp{r30}, @samp{blink},
42005 @samp{lp_count} and @samp{pcl}.  This feature may contain registers
42006 @samp{ilink1}, @samp{ilink2} and any of extension core registers @samp{r32}
42007 through @samp{r59/acch}.  @samp{ilink1} and @samp{ilink2} and extension core
42008 registers are not available when debugging GNU/Linux applications.  The only
42009 difference with @samp{org.gnu.gdb.arc.core.v2} feature is in the names of
42010 @samp{ilink1} and @samp{ilink2} registers and that @samp{r30} is mandatory in
42011 ARC v2, but @samp{ilink2} is optional on ARCompact.
42012
42013 The @samp{org.gnu.gdb.arc.aux-minimal} feature is required for all ARC
42014 targets.  It should contain registers @samp{pc} and @samp{status32}.
42015
42016 @node ARM Features
42017 @subsection ARM Features
42018 @cindex target descriptions, ARM features
42019
42020 The @samp{org.gnu.gdb.arm.core} feature is required for non-M-profile
42021 ARM targets.
42022 It should contain registers @samp{r0} through @samp{r13}, @samp{sp},
42023 @samp{lr}, @samp{pc}, and @samp{cpsr}.
42024
42025 For M-profile targets (e.g. Cortex-M3), the @samp{org.gnu.gdb.arm.core}
42026 feature is replaced by @samp{org.gnu.gdb.arm.m-profile}.  It should contain
42027 registers @samp{r0} through @samp{r13}, @samp{sp}, @samp{lr}, @samp{pc},
42028 and @samp{xpsr}.
42029
42030 The @samp{org.gnu.gdb.arm.fpa} feature is optional.  If present, it
42031 should contain registers @samp{f0} through @samp{f7} and @samp{fps}.
42032
42033 The @samp{org.gnu.gdb.xscale.iwmmxt} feature is optional.  If present,
42034 it should contain at least registers @samp{wR0} through @samp{wR15} and
42035 @samp{wCGR0} through @samp{wCGR3}.  The @samp{wCID}, @samp{wCon},
42036 @samp{wCSSF}, and @samp{wCASF} registers are optional.
42037
42038 The @samp{org.gnu.gdb.arm.vfp} feature is optional.  If present, it
42039 should contain at least registers @samp{d0} through @samp{d15}.  If
42040 they are present, @samp{d16} through @samp{d31} should also be included.
42041 @value{GDBN} will synthesize the single-precision registers from
42042 halves of the double-precision registers.
42043
42044 The @samp{org.gnu.gdb.arm.neon} feature is optional.  It does not
42045 need to contain registers; it instructs @value{GDBN} to display the
42046 VFP double-precision registers as vectors and to synthesize the
42047 quad-precision registers from pairs of double-precision registers.
42048 If this feature is present, @samp{org.gnu.gdb.arm.vfp} must also
42049 be present and include 32 double-precision registers.
42050
42051 @node i386 Features
42052 @subsection i386 Features
42053 @cindex target descriptions, i386 features
42054
42055 The @samp{org.gnu.gdb.i386.core} feature is required for i386/amd64
42056 targets.  It should describe the following registers:
42057
42058 @itemize @minus
42059 @item
42060 @samp{eax} through @samp{edi} plus @samp{eip} for i386
42061 @item
42062 @samp{rax} through @samp{r15} plus @samp{rip} for amd64
42063 @item
42064 @samp{eflags}, @samp{cs}, @samp{ss}, @samp{ds}, @samp{es},
42065 @samp{fs}, @samp{gs}
42066 @item 
42067 @samp{st0} through @samp{st7}
42068 @item 
42069 @samp{fctrl}, @samp{fstat}, @samp{ftag}, @samp{fiseg}, @samp{fioff},
42070 @samp{foseg}, @samp{fooff} and @samp{fop}
42071 @end itemize
42072
42073 The register sets may be different, depending on the target.
42074
42075 The @samp{org.gnu.gdb.i386.sse} feature is optional.  It should
42076 describe registers:
42077
42078 @itemize @minus
42079 @item
42080 @samp{xmm0} through @samp{xmm7} for i386
42081 @item
42082 @samp{xmm0} through @samp{xmm15} for amd64
42083 @item 
42084 @samp{mxcsr}
42085 @end itemize
42086
42087 The @samp{org.gnu.gdb.i386.avx} feature is optional and requires the
42088 @samp{org.gnu.gdb.i386.sse} feature.  It should
42089 describe the upper 128 bits of @sc{ymm} registers:
42090
42091 @itemize @minus
42092 @item
42093 @samp{ymm0h} through @samp{ymm7h} for i386
42094 @item
42095 @samp{ymm0h} through @samp{ymm15h} for amd64
42096 @end itemize
42097
42098 The @samp{org.gnu.gdb.i386.mpx} is an optional feature representing Intel
42099 Memory Protection Extension (MPX).  It should describe the following registers:
42100
42101 @itemize @minus
42102 @item
42103 @samp{bnd0raw} through @samp{bnd3raw} for i386 and amd64.
42104 @item
42105 @samp{bndcfgu} and @samp{bndstatus} for i386 and amd64.
42106 @end itemize
42107
42108 The @samp{org.gnu.gdb.i386.linux} feature is optional.  It should
42109 describe a single register, @samp{orig_eax}.
42110
42111 The @samp{org.gnu.gdb.i386.segments} feature is optional.  It should
42112 describe two system registers: @samp{fs_base} and @samp{gs_base}.
42113
42114 The @samp{org.gnu.gdb.i386.avx512} feature is optional and requires the
42115 @samp{org.gnu.gdb.i386.avx} feature.  It should
42116 describe additional @sc{xmm} registers:
42117
42118 @itemize @minus
42119 @item
42120 @samp{xmm16h} through @samp{xmm31h}, only valid for amd64.
42121 @end itemize
42122
42123 It should describe the upper 128 bits of additional @sc{ymm} registers:
42124
42125 @itemize @minus
42126 @item
42127 @samp{ymm16h} through @samp{ymm31h}, only valid for amd64.
42128 @end itemize
42129
42130 It should
42131 describe the upper 256 bits of @sc{zmm} registers:
42132
42133 @itemize @minus
42134 @item
42135 @samp{zmm0h} through @samp{zmm7h} for i386.
42136 @item
42137 @samp{zmm0h} through @samp{zmm15h} for amd64.
42138 @end itemize
42139
42140 It should
42141 describe the additional @sc{zmm} registers:
42142
42143 @itemize @minus
42144 @item
42145 @samp{zmm16h} through @samp{zmm31h}, only valid for amd64.
42146 @end itemize
42147
42148 The @samp{org.gnu.gdb.i386.pkeys} feature is optional.  It should
42149 describe a single register, @samp{pkru}.  It is a 32-bit register
42150 valid for i386 and amd64.
42151
42152 @node MicroBlaze Features
42153 @subsection MicroBlaze Features
42154 @cindex target descriptions, MicroBlaze features
42155
42156 The @samp{org.gnu.gdb.microblaze.core} feature is required for MicroBlaze
42157 targets.  It should contain registers @samp{r0} through @samp{r31},
42158 @samp{rpc}, @samp{rmsr}, @samp{rear}, @samp{resr}, @samp{rfsr}, @samp{rbtr},
42159 @samp{rpvr}, @samp{rpvr1} through @samp{rpvr11}, @samp{redr}, @samp{rpid},
42160 @samp{rzpr}, @samp{rtlbx}, @samp{rtlbsx}, @samp{rtlblo}, and @samp{rtlbhi}.
42161
42162 The @samp{org.gnu.gdb.microblaze.stack-protect} feature is optional.
42163 If present, it should contain registers @samp{rshr} and @samp{rslr}
42164
42165 @node MIPS Features
42166 @subsection @acronym{MIPS} Features
42167 @cindex target descriptions, @acronym{MIPS} features
42168
42169 The @samp{org.gnu.gdb.mips.cpu} feature is required for @acronym{MIPS} targets.
42170 It should contain registers @samp{r0} through @samp{r31}, @samp{lo},
42171 @samp{hi}, and @samp{pc}.  They may be 32-bit or 64-bit depending
42172 on the target.
42173
42174 The @samp{org.gnu.gdb.mips.cp0} feature is also required.  It should
42175 contain at least the @samp{status}, @samp{badvaddr}, and @samp{cause}
42176 registers.  They may be 32-bit or 64-bit depending on the target.
42177
42178 The @samp{org.gnu.gdb.mips.fpu} feature is currently required, though
42179 it may be optional in a future version of @value{GDBN}.  It should
42180 contain registers @samp{f0} through @samp{f31}, @samp{fcsr}, and
42181 @samp{fir}.  They may be 32-bit or 64-bit depending on the target.
42182
42183 The @samp{org.gnu.gdb.mips.dsp} feature is optional.  It should
42184 contain registers @samp{hi1} through @samp{hi3}, @samp{lo1} through
42185 @samp{lo3}, and @samp{dspctl}.  The @samp{dspctl} register should
42186 be 32-bit and the rest may be 32-bit or 64-bit depending on the target.
42187
42188 The @samp{org.gnu.gdb.mips.linux} feature is optional.  It should
42189 contain a single register, @samp{restart}, which is used by the
42190 Linux kernel to control restartable syscalls.
42191
42192 @node M68K Features
42193 @subsection M68K Features
42194 @cindex target descriptions, M68K features
42195
42196 @table @code
42197 @item @samp{org.gnu.gdb.m68k.core}
42198 @itemx @samp{org.gnu.gdb.coldfire.core}
42199 @itemx @samp{org.gnu.gdb.fido.core}
42200 One of those features must be always present. 
42201 The feature that is present determines which flavor of m68k is
42202 used.  The feature that is present should contain registers
42203 @samp{d0} through @samp{d7}, @samp{a0} through @samp{a5}, @samp{fp},
42204 @samp{sp}, @samp{ps} and @samp{pc}.
42205
42206 @item @samp{org.gnu.gdb.coldfire.fp}
42207 This feature is optional.  If present, it should contain registers
42208 @samp{fp0} through @samp{fp7}, @samp{fpcontrol}, @samp{fpstatus} and
42209 @samp{fpiaddr}.
42210 @end table
42211
42212 @node NDS32 Features
42213 @subsection NDS32 Features
42214 @cindex target descriptions, NDS32 features
42215
42216 The @samp{org.gnu.gdb.nds32.core} feature is required for NDS32
42217 targets.  It should contain at least registers @samp{r0} through
42218 @samp{r10}, @samp{r15}, @samp{fp}, @samp{gp}, @samp{lp}, @samp{sp},
42219 and @samp{pc}.
42220
42221 The @samp{org.gnu.gdb.nds32.fpu} feature is optional.  If present,
42222 it should contain 64-bit double-precision floating-point registers
42223 @samp{fd0} through @emph{fdN}, which should be @samp{fd3}, @samp{fd7},
42224 @samp{fd15}, or @samp{fd31} based on the FPU configuration implemented.
42225
42226 @emph{Note:} The first sixteen 64-bit double-precision floating-point
42227 registers are overlapped with the thirty-two 32-bit single-precision
42228 floating-point registers.  The 32-bit single-precision registers, if
42229 not being listed explicitly, will be synthesized from halves of the
42230 overlapping 64-bit double-precision registers.  Listing 32-bit
42231 single-precision registers explicitly is deprecated, and the
42232 support to it could be totally removed some day.
42233
42234 @node Nios II Features
42235 @subsection Nios II Features
42236 @cindex target descriptions, Nios II features
42237
42238 The @samp{org.gnu.gdb.nios2.cpu} feature is required for Nios II
42239 targets.  It should contain the 32 core registers (@samp{zero},
42240 @samp{at}, @samp{r2} through @samp{r23}, @samp{et} through @samp{ra}),
42241 @samp{pc}, and the 16 control registers (@samp{status} through
42242 @samp{mpuacc}).
42243
42244 @node OpenRISC 1000 Features
42245 @subsection Openrisc 1000 Features
42246 @cindex target descriptions, OpenRISC 1000 features
42247
42248 The @samp{org.gnu.gdb.or1k.group0} feature is required for OpenRISC 1000
42249 targets.  It should contain the 32 general purpose registers (@samp{r0}
42250 through @samp{r31}), @samp{ppc}, @samp{npc} and @samp{sr}.
42251
42252 @node PowerPC Features
42253 @subsection PowerPC Features
42254 @cindex target descriptions, PowerPC features
42255
42256 The @samp{org.gnu.gdb.power.core} feature is required for PowerPC
42257 targets.  It should contain registers @samp{r0} through @samp{r31},
42258 @samp{pc}, @samp{msr}, @samp{cr}, @samp{lr}, @samp{ctr}, and
42259 @samp{xer}.  They may be 32-bit or 64-bit depending on the target.
42260
42261 The @samp{org.gnu.gdb.power.fpu} feature is optional.  It should
42262 contain registers @samp{f0} through @samp{f31} and @samp{fpscr}.
42263
42264 The @samp{org.gnu.gdb.power.altivec} feature is optional.  It should
42265 contain registers @samp{vr0} through @samp{vr31}, @samp{vscr},
42266 and @samp{vrsave}.
42267
42268 The @samp{org.gnu.gdb.power.vsx} feature is optional.  It should
42269 contain registers @samp{vs0h} through @samp{vs31h}.  @value{GDBN}
42270 will combine these registers with the floating point registers
42271 (@samp{f0} through @samp{f31}) and the altivec registers (@samp{vr0}
42272 through @samp{vr31}) to present the 128-bit wide registers @samp{vs0}
42273 through @samp{vs63}, the set of vector registers for POWER7.
42274
42275 The @samp{org.gnu.gdb.power.spe} feature is optional.  It should
42276 contain registers @samp{ev0h} through @samp{ev31h}, @samp{acc}, and
42277 @samp{spefscr}.  SPE targets should provide 32-bit registers in
42278 @samp{org.gnu.gdb.power.core} and provide the upper halves in
42279 @samp{ev0h} through @samp{ev31h}.  @value{GDBN} will combine
42280 these to present registers @samp{ev0} through @samp{ev31} to the
42281 user.
42282
42283 @node S/390 and System z Features
42284 @subsection S/390 and System z Features
42285 @cindex target descriptions, S/390 features
42286 @cindex target descriptions, System z features
42287
42288 The @samp{org.gnu.gdb.s390.core} feature is required for S/390 and
42289 System z targets.  It should contain the PSW and the 16 general
42290 registers.  In particular, System z targets should provide the 64-bit
42291 registers @samp{pswm}, @samp{pswa}, and @samp{r0} through @samp{r15}.
42292 S/390 targets should provide the 32-bit versions of these registers.
42293 A System z target that runs in 31-bit addressing mode should provide
42294 32-bit versions of @samp{pswm} and @samp{pswa}, as well as the general
42295 register's upper halves @samp{r0h} through @samp{r15h}, and their
42296 lower halves @samp{r0l} through @samp{r15l}.
42297
42298 The @samp{org.gnu.gdb.s390.fpr} feature is required.  It should
42299 contain the 64-bit registers @samp{f0} through @samp{f15}, and
42300 @samp{fpc}.
42301
42302 The @samp{org.gnu.gdb.s390.acr} feature is required.  It should
42303 contain the 32-bit registers @samp{acr0} through @samp{acr15}.
42304
42305 The @samp{org.gnu.gdb.s390.linux} feature is optional.  It should
42306 contain the register @samp{orig_r2}, which is 64-bit wide on System z
42307 targets and 32-bit otherwise.  In addition, the feature may contain
42308 the @samp{last_break} register, whose width depends on the addressing
42309 mode, as well as the @samp{system_call} register, which is always
42310 32-bit wide.
42311
42312 The @samp{org.gnu.gdb.s390.tdb} feature is optional.  It should
42313 contain the 64-bit registers @samp{tdb0}, @samp{tac}, @samp{tct},
42314 @samp{atia}, and @samp{tr0} through @samp{tr15}.
42315
42316 The @samp{org.gnu.gdb.s390.vx} feature is optional.  It should contain
42317 64-bit wide registers @samp{v0l} through @samp{v15l}, which will be
42318 combined by @value{GDBN} with the floating point registers @samp{f0}
42319 through @samp{f15} to present the 128-bit wide vector registers
42320 @samp{v0} through @samp{v15}.  In addition, this feature should
42321 contain the 128-bit wide vector registers @samp{v16} through
42322 @samp{v31}.
42323
42324 The @samp{org.gnu.gdb.s390.gs} feature is optional.  It should contain
42325 the 64-bit wide guarded-storage-control registers @samp{gsd},
42326 @samp{gssm}, and @samp{gsepla}.
42327
42328 The @samp{org.gnu.gdb.s390.gsbc} feature is optional.  It should contain
42329 the 64-bit wide guarded-storage broadcast control registers
42330 @samp{bc_gsd}, @samp{bc_gssm}, and @samp{bc_gsepla}.
42331
42332 @node Sparc Features
42333 @subsection Sparc Features
42334 @cindex target descriptions, sparc32 features
42335 @cindex target descriptions, sparc64 features
42336 The @samp{org.gnu.gdb.sparc.cpu} feature is required for sparc32/sparc64
42337 targets.  It should describe the following registers:
42338
42339 @itemize @minus
42340 @item
42341 @samp{g0} through @samp{g7}
42342 @item
42343 @samp{o0} through @samp{o7}
42344 @item
42345 @samp{l0} through @samp{l7}
42346 @item
42347 @samp{i0} through @samp{i7}
42348 @end itemize
42349
42350 They may be 32-bit or 64-bit depending on the target.
42351
42352 Also the @samp{org.gnu.gdb.sparc.fpu} feature is required for sparc32/sparc64
42353 targets.  It should describe the following registers:
42354
42355 @itemize @minus
42356 @item
42357 @samp{f0} through @samp{f31}
42358 @item
42359 @samp{f32} through @samp{f62} for sparc64
42360 @end itemize
42361
42362 The @samp{org.gnu.gdb.sparc.cp0} feature is required for sparc32/sparc64
42363 targets.  It should describe the following registers:
42364
42365 @itemize @minus
42366 @item
42367 @samp{y}, @samp{psr}, @samp{wim}, @samp{tbr}, @samp{pc}, @samp{npc},
42368 @samp{fsr}, and @samp{csr} for sparc32
42369 @item
42370 @samp{pc}, @samp{npc}, @samp{state}, @samp{fsr}, @samp{fprs}, and @samp{y}
42371 for sparc64
42372 @end itemize
42373
42374 @node TIC6x Features
42375 @subsection TMS320C6x Features
42376 @cindex target descriptions, TIC6x features
42377 @cindex target descriptions, TMS320C6x features
42378 The @samp{org.gnu.gdb.tic6x.core} feature is required for TMS320C6x
42379 targets.  It should contain registers @samp{A0} through @samp{A15},
42380 registers @samp{B0} through @samp{B15}, @samp{CSR} and @samp{PC}.
42381
42382 The @samp{org.gnu.gdb.tic6x.gp} feature is optional.  It should
42383 contain registers @samp{A16} through @samp{A31} and @samp{B16}
42384 through @samp{B31}.
42385
42386 The @samp{org.gnu.gdb.tic6x.c6xp} feature is optional.  It should
42387 contain registers @samp{TSR}, @samp{ILC} and @samp{RILC}.
42388
42389 @node Operating System Information
42390 @appendix Operating System Information
42391 @cindex operating system information
42392
42393 @menu
42394 * Process list::
42395 @end menu
42396
42397 Users of @value{GDBN} often wish to obtain information about the state of
42398 the operating system running on the target---for example the list of
42399 processes, or the list of open files.  This section describes the
42400 mechanism that makes it possible.  This mechanism is similar to the 
42401 target features mechanism (@pxref{Target Descriptions}), but focuses
42402 on a different aspect of target.
42403
42404 Operating system information is retrived from the target via the
42405 remote protocol, using @samp{qXfer} requests (@pxref{qXfer osdata
42406 read}).  The object name in the request should be @samp{osdata}, and
42407 the @var{annex} identifies the data to be fetched.
42408
42409 @node Process list
42410 @appendixsection Process list
42411 @cindex operating system information, process list
42412
42413 When requesting the process list, the @var{annex} field in the
42414 @samp{qXfer} request should be @samp{processes}.  The returned data is
42415 an XML document.  The formal syntax of this document is defined in
42416 @file{gdb/features/osdata.dtd}.
42417
42418 An example document is:
42419
42420 @smallexample
42421 <?xml version="1.0"?>
42422 <!DOCTYPE target SYSTEM "osdata.dtd">
42423 <osdata type="processes">
42424   <item>
42425     <column name="pid">1</column>
42426     <column name="user">root</column>
42427     <column name="command">/sbin/init</column>
42428     <column name="cores">1,2,3</column>
42429   </item>
42430 </osdata>
42431 @end smallexample
42432
42433 Each item should include a column whose name is @samp{pid}.  The value
42434 of that column should identify the process on the target.  The
42435 @samp{user} and @samp{command} columns are optional, and will be
42436 displayed by @value{GDBN}.  The @samp{cores} column, if present,
42437 should contain a comma-separated list of cores that this process
42438 is running on.  Target may provide additional columns,
42439 which @value{GDBN} currently ignores.
42440
42441 @node Trace File Format
42442 @appendix Trace File Format
42443 @cindex trace file format
42444
42445 The trace file comes in three parts: a header, a textual description
42446 section, and a trace frame section with binary data.
42447
42448 The header has the form @code{\x7fTRACE0\n}.  The first byte is
42449 @code{0x7f} so as to indicate that the file contains binary data,
42450 while the @code{0} is a version number that may have different values
42451 in the future.
42452
42453 The description section consists of multiple lines of @sc{ascii} text
42454 separated by newline characters (@code{0xa}).  The lines may include a
42455 variety of optional descriptive or context-setting information, such
42456 as tracepoint definitions or register set size.  @value{GDBN} will
42457 ignore any line that it does not recognize.  An empty line marks the end
42458 of this section.
42459
42460 @table @code
42461 @item R @var{size}
42462 Specifies the size of a register block in bytes.  This is equal to the
42463 size of a @code{g} packet payload in the remote protocol.  @var{size}
42464 is an ascii decimal number.  There should be only one such line in
42465 a single trace file.
42466
42467 @item status @var{status}
42468 Trace status.  @var{status} has the same format as a @code{qTStatus}
42469 remote packet reply.  There should be only one such line in a single trace
42470 file.
42471
42472 @item tp @var{payload}
42473 Tracepoint definition.  The @var{payload} has the same format as
42474 @code{qTfP}/@code{qTsP} remote packet reply payload.  A single tracepoint
42475 may take multiple lines of definition, corresponding to the multiple
42476 reply packets.
42477
42478 @item tsv @var{payload}
42479 Trace state variable definition.  The @var{payload} has the same format as
42480 @code{qTfV}/@code{qTsV} remote packet reply payload.  A single variable
42481 may take multiple lines of definition, corresponding to the multiple
42482 reply packets.
42483
42484 @item tdesc @var{payload}
42485 Target description in XML format.  The @var{payload} is a single line of
42486 the XML file.  All such lines should be concatenated together to get
42487 the original XML file.  This file is in the same format as @code{qXfer}
42488 @code{features} payload, and corresponds to the main @code{target.xml}
42489 file.  Includes are not allowed.
42490
42491 @end table
42492
42493 The trace frame section consists of a number of consecutive frames.
42494 Each frame begins with a two-byte tracepoint number, followed by a
42495 four-byte size giving the amount of data in the frame.  The data in
42496 the frame consists of a number of blocks, each introduced by a
42497 character indicating its type (at least register, memory, and trace
42498 state variable).  The data in this section is raw binary, not a
42499 hexadecimal or other encoding; its endianness matches the target's
42500 endianness.
42501
42502 @c FIXME bi-arch may require endianness/arch info in description section
42503
42504 @table @code
42505 @item R @var{bytes}
42506 Register block.  The number and ordering of bytes matches that of a
42507 @code{g} packet in the remote protocol.  Note that these are the
42508 actual bytes, in target order, not a hexadecimal encoding.
42509
42510 @item M @var{address} @var{length} @var{bytes}...
42511 Memory block.  This is a contiguous block of memory, at the 8-byte
42512 address @var{address}, with a 2-byte length @var{length}, followed by
42513 @var{length} bytes.
42514
42515 @item V @var{number} @var{value}
42516 Trace state variable block.  This records the 8-byte signed value
42517 @var{value} of trace state variable numbered @var{number}.
42518
42519 @end table
42520
42521 Future enhancements of the trace file format may include additional types
42522 of blocks.
42523
42524 @node Index Section Format
42525 @appendix @code{.gdb_index} section format
42526 @cindex .gdb_index section format
42527 @cindex index section format
42528
42529 This section documents the index section that is created by @code{save
42530 gdb-index} (@pxref{Index Files}).  The index section is
42531 DWARF-specific; some knowledge of DWARF is assumed in this
42532 description.
42533
42534 The mapped index file format is designed to be directly
42535 @code{mmap}able on any architecture.  In most cases, a datum is
42536 represented using a little-endian 32-bit integer value, called an
42537 @code{offset_type}.  Big endian machines must byte-swap the values
42538 before using them.  Exceptions to this rule are noted.  The data is
42539 laid out such that alignment is always respected.
42540
42541 A mapped index consists of several areas, laid out in order.
42542
42543 @enumerate
42544 @item
42545 The file header.  This is a sequence of values, of @code{offset_type}
42546 unless otherwise noted:
42547
42548 @enumerate
42549 @item
42550 The version number, currently 8.  Versions 1, 2 and 3 are obsolete.
42551 Version 4 uses a different hashing function from versions 5 and 6.
42552 Version 6 includes symbols for inlined functions, whereas versions 4
42553 and 5 do not.  Version 7 adds attributes to the CU indices in the
42554 symbol table.  Version 8 specifies that symbols from DWARF type units
42555 (@samp{DW_TAG_type_unit}) refer to the type unit's symbol table and not the
42556 compilation unit (@samp{DW_TAG_comp_unit}) using the type.
42557
42558 @value{GDBN} will only read version 4, 5, or 6 indices
42559 by specifying @code{set use-deprecated-index-sections on}.
42560 GDB has a workaround for potentially broken version 7 indices so it is
42561 currently not flagged as deprecated.
42562
42563 @item
42564 The offset, from the start of the file, of the CU list.
42565
42566 @item
42567 The offset, from the start of the file, of the types CU list.  Note
42568 that this area can be empty, in which case this offset will be equal
42569 to the next offset.
42570
42571 @item
42572 The offset, from the start of the file, of the address area.
42573
42574 @item
42575 The offset, from the start of the file, of the symbol table.
42576
42577 @item
42578 The offset, from the start of the file, of the constant pool.
42579 @end enumerate
42580
42581 @item
42582 The CU list.  This is a sequence of pairs of 64-bit little-endian
42583 values, sorted by the CU offset.  The first element in each pair is
42584 the offset of a CU in the @code{.debug_info} section.  The second
42585 element in each pair is the length of that CU.  References to a CU
42586 elsewhere in the map are done using a CU index, which is just the
42587 0-based index into this table.  Note that if there are type CUs, then
42588 conceptually CUs and type CUs form a single list for the purposes of
42589 CU indices.
42590
42591 @item
42592 The types CU list.  This is a sequence of triplets of 64-bit
42593 little-endian values.  In a triplet, the first value is the CU offset,
42594 the second value is the type offset in the CU, and the third value is
42595 the type signature.  The types CU list is not sorted.
42596
42597 @item
42598 The address area.  The address area consists of a sequence of address
42599 entries.  Each address entry has three elements:
42600
42601 @enumerate
42602 @item
42603 The low address.  This is a 64-bit little-endian value.
42604
42605 @item
42606 The high address.  This is a 64-bit little-endian value.  Like
42607 @code{DW_AT_high_pc}, the value is one byte beyond the end.
42608
42609 @item
42610 The CU index.  This is an @code{offset_type} value.
42611 @end enumerate
42612
42613 @item
42614 The symbol table.  This is an open-addressed hash table.  The size of
42615 the hash table is always a power of 2.
42616
42617 Each slot in the hash table consists of a pair of @code{offset_type}
42618 values.  The first value is the offset of the symbol's name in the
42619 constant pool.  The second value is the offset of the CU vector in the
42620 constant pool.
42621
42622 If both values are 0, then this slot in the hash table is empty.  This
42623 is ok because while 0 is a valid constant pool index, it cannot be a
42624 valid index for both a string and a CU vector.
42625
42626 The hash value for a table entry is computed by applying an
42627 iterative hash function to the symbol's name.  Starting with an
42628 initial value of @code{r = 0}, each (unsigned) character @samp{c} in
42629 the string is incorporated into the hash using the formula depending on the
42630 index version:
42631
42632 @table @asis
42633 @item Version 4
42634 The formula is @code{r = r * 67 + c - 113}.
42635
42636 @item Versions 5 to 7
42637 The formula is @code{r = r * 67 + tolower (c) - 113}.
42638 @end table
42639
42640 The terminating @samp{\0} is not incorporated into the hash.
42641
42642 The step size used in the hash table is computed via
42643 @code{((hash * 17) & (size - 1)) | 1}, where @samp{hash} is the hash
42644 value, and @samp{size} is the size of the hash table.  The step size
42645 is used to find the next candidate slot when handling a hash
42646 collision.
42647
42648 The names of C@t{++} symbols in the hash table are canonicalized.  We
42649 don't currently have a simple description of the canonicalization
42650 algorithm; if you intend to create new index sections, you must read
42651 the code.
42652
42653 @item
42654 The constant pool.  This is simply a bunch of bytes.  It is organized
42655 so that alignment is correct: CU vectors are stored first, followed by
42656 strings.
42657
42658 A CU vector in the constant pool is a sequence of @code{offset_type}
42659 values.  The first value is the number of CU indices in the vector.
42660 Each subsequent value is the index and symbol attributes of a CU in
42661 the CU list.  This element in the hash table is used to indicate which
42662 CUs define the symbol and how the symbol is used.
42663 See below for the format of each CU index+attributes entry.
42664
42665 A string in the constant pool is zero-terminated.
42666 @end enumerate
42667
42668 Attributes were added to CU index values in @code{.gdb_index} version 7.
42669 If a symbol has multiple uses within a CU then there is one
42670 CU index+attributes value for each use.
42671
42672 The format of each CU index+attributes entry is as follows
42673 (bit 0 = LSB):
42674
42675 @table @asis
42676
42677 @item Bits 0-23
42678 This is the index of the CU in the CU list.
42679 @item Bits 24-27
42680 These bits are reserved for future purposes and must be zero.
42681 @item Bits 28-30
42682 The kind of the symbol in the CU.
42683
42684 @table @asis
42685 @item 0
42686 This value is reserved and should not be used.
42687 By reserving zero the full @code{offset_type} value is backwards compatible
42688 with previous versions of the index.
42689 @item 1
42690 The symbol is a type.
42691 @item 2
42692 The symbol is a variable or an enum value.
42693 @item 3
42694 The symbol is a function.
42695 @item 4
42696 Any other kind of symbol.
42697 @item 5,6,7
42698 These values are reserved.
42699 @end table
42700
42701 @item Bit 31
42702 This bit is zero if the value is global and one if it is static.
42703
42704 The determination of whether a symbol is global or static is complicated.
42705 The authorative reference is the file @file{dwarf2read.c} in
42706 @value{GDBN} sources.
42707
42708 @end table
42709
42710 This pseudo-code describes the computation of a symbol's kind and
42711 global/static attributes in the index.
42712
42713 @smallexample
42714 is_external = get_attribute (die, DW_AT_external);
42715 language = get_attribute (cu_die, DW_AT_language);
42716 switch (die->tag)
42717   @{
42718   case DW_TAG_typedef:
42719   case DW_TAG_base_type:
42720   case DW_TAG_subrange_type:
42721     kind = TYPE;
42722     is_static = 1;
42723     break;
42724   case DW_TAG_enumerator:
42725     kind = VARIABLE;
42726     is_static = language != CPLUS;
42727     break;
42728   case DW_TAG_subprogram:
42729     kind = FUNCTION;
42730     is_static = ! (is_external || language == ADA);
42731     break;
42732   case DW_TAG_constant:
42733     kind = VARIABLE;
42734     is_static = ! is_external;
42735     break;
42736   case DW_TAG_variable:
42737     kind = VARIABLE;
42738     is_static = ! is_external;
42739     break;
42740   case DW_TAG_namespace:
42741     kind = TYPE;
42742     is_static = 0;
42743     break;
42744   case DW_TAG_class_type:
42745   case DW_TAG_interface_type:
42746   case DW_TAG_structure_type:
42747   case DW_TAG_union_type:
42748   case DW_TAG_enumeration_type:
42749     kind = TYPE;
42750     is_static = language != CPLUS;
42751     break;
42752   default:
42753     assert (0);
42754   @}
42755 @end smallexample
42756
42757 @node Man Pages
42758 @appendix Manual pages
42759 @cindex Man pages
42760
42761 @menu
42762 * gdb man::                     The GNU Debugger man page
42763 * gdbserver man::               Remote Server for the GNU Debugger man page
42764 * gcore man::                   Generate a core file of a running program
42765 * gdbinit man::                 gdbinit scripts
42766 * gdb-add-index man::           Add index files to speed up GDB
42767 @end menu
42768
42769 @node gdb man
42770 @heading gdb man
42771
42772 @c man title gdb The GNU Debugger
42773
42774 @c man begin SYNOPSIS gdb
42775 gdb [@option{-help}] [@option{-nh}] [@option{-nx}] [@option{-q}]
42776 [@option{-batch}] [@option{-cd=}@var{dir}] [@option{-f}]
42777 [@option{-b}@w{ }@var{bps}]
42778     [@option{-tty=}@var{dev}] [@option{-s} @var{symfile}]
42779 [@option{-e}@w{ }@var{prog}] [@option{-se}@w{ }@var{prog}]
42780 [@option{-c}@w{ }@var{core}] [@option{-p}@w{ }@var{procID}]
42781     [@option{-x}@w{ }@var{cmds}] [@option{-d}@w{ }@var{dir}]
42782 [@var{prog}|@var{prog} @var{procID}|@var{prog} @var{core}]
42783 @c man end
42784
42785 @c man begin DESCRIPTION gdb
42786 The purpose of a debugger such as @value{GDBN} is to allow you to see what is
42787 going on ``inside'' another program while it executes -- or what another
42788 program was doing at the moment it crashed.
42789
42790 @value{GDBN} can do four main kinds of things (plus other things in support of
42791 these) to help you catch bugs in the act:
42792
42793 @itemize @bullet
42794 @item
42795 Start your program, specifying anything that might affect its behavior.
42796
42797 @item
42798 Make your program stop on specified conditions.
42799
42800 @item
42801 Examine what has happened, when your program has stopped.
42802
42803 @item
42804 Change things in your program, so you can experiment with correcting the
42805 effects of one bug and go on to learn about another.
42806 @end itemize
42807
42808 You can use @value{GDBN} to debug programs written in C, C@t{++}, Fortran and
42809 Modula-2.
42810
42811 @value{GDBN} is invoked with the shell command @code{gdb}.  Once started, it reads
42812 commands from the terminal until you tell it to exit with the @value{GDBN}
42813 command @code{quit}.  You can get online help from @value{GDBN} itself
42814 by using the command @code{help}.
42815
42816 You can run @code{gdb} with no arguments or options; but the most
42817 usual way to start @value{GDBN} is with one argument or two, specifying an
42818 executable program as the argument:
42819
42820 @smallexample
42821 gdb program
42822 @end smallexample
42823
42824 You can also start with both an executable program and a core file specified:
42825
42826 @smallexample
42827 gdb program core
42828 @end smallexample
42829
42830 You can, instead, specify a process ID as a second argument, if you want
42831 to debug a running process:
42832
42833 @smallexample
42834 gdb program 1234
42835 gdb -p 1234
42836 @end smallexample
42837
42838 @noindent
42839 would attach @value{GDBN} to process @code{1234} (unless you also have a file
42840 named @file{1234}; @value{GDBN} does check for a core file first).
42841 With option @option{-p} you can omit the @var{program} filename.
42842
42843 Here are some of the most frequently needed @value{GDBN} commands:
42844
42845 @c pod2man highlights the right hand side of the @item lines.
42846 @table @env
42847 @item break [@var{file}:]@var{function}
42848 Set a breakpoint at @var{function} (in @var{file}).
42849
42850 @item run [@var{arglist}]
42851 Start your program (with @var{arglist}, if specified).
42852
42853 @item bt
42854 Backtrace: display the program stack.
42855
42856 @item print @var{expr}
42857 Display the value of an expression.
42858
42859 @item c
42860 Continue running your program (after stopping, e.g. at a breakpoint).
42861
42862 @item next
42863 Execute next program line (after stopping); step @emph{over} any
42864 function calls in the line.
42865
42866 @item edit [@var{file}:]@var{function}
42867 look at the program line where it is presently stopped.
42868
42869 @item list [@var{file}:]@var{function}
42870 type the text of the program in the vicinity of where it is presently stopped.
42871
42872 @item step
42873 Execute next program line (after stopping); step @emph{into} any
42874 function calls in the line.
42875
42876 @item help [@var{name}]
42877 Show information about @value{GDBN} command @var{name}, or general information
42878 about using @value{GDBN}.
42879
42880 @item quit
42881 Exit from @value{GDBN}.
42882 @end table
42883
42884 @ifset man
42885 For full details on @value{GDBN},
42886 see @cite{Using GDB: A Guide to the GNU Source-Level Debugger},
42887 by Richard M. Stallman and Roland H. Pesch.  The same text is available online
42888 as the @code{gdb} entry in the @code{info} program.
42889 @end ifset
42890 @c man end
42891
42892 @c man begin OPTIONS gdb
42893 Any arguments other than options specify an executable
42894 file and core file (or process ID); that is, the first argument
42895 encountered with no
42896 associated option flag is equivalent to a @option{-se} option, and the second,
42897 if any, is equivalent to a @option{-c} option if it's the name of a file.
42898 Many options have
42899 both long and short forms; both are shown here.  The long forms are also
42900 recognized if you truncate them, so long as enough of the option is
42901 present to be unambiguous.  (If you prefer, you can flag option
42902 arguments with @option{+} rather than @option{-}, though we illustrate the
42903 more usual convention.)
42904
42905 All the options and command line arguments you give are processed
42906 in sequential order.  The order makes a difference when the @option{-x}
42907 option is used.
42908
42909 @table @env
42910 @item -help
42911 @itemx -h
42912 List all options, with brief explanations.
42913
42914 @item -symbols=@var{file}
42915 @itemx -s @var{file}
42916 Read symbol table from file @var{file}.
42917
42918 @item -write
42919 Enable writing into executable and core files.
42920
42921 @item -exec=@var{file}
42922 @itemx -e @var{file}
42923 Use file @var{file} as the executable file to execute when
42924 appropriate, and for examining pure data in conjunction with a core
42925 dump.
42926
42927 @item -se=@var{file}
42928 Read symbol table from file @var{file} and use it as the executable
42929 file.
42930
42931 @item -core=@var{file}
42932 @itemx -c @var{file}
42933 Use file @var{file} as a core dump to examine.
42934
42935 @item -command=@var{file}
42936 @itemx -x @var{file}
42937 Execute @value{GDBN} commands from file @var{file}.
42938
42939 @item -ex @var{command}
42940 Execute given @value{GDBN} @var{command}.
42941
42942 @item -directory=@var{directory}
42943 @itemx -d @var{directory}
42944 Add @var{directory} to the path to search for source files.
42945
42946 @item -nh
42947 Do not execute commands from @file{~/.gdbinit}.
42948
42949 @item -nx
42950 @itemx -n
42951 Do not execute commands from any @file{.gdbinit} initialization files.
42952
42953 @item -quiet
42954 @itemx -q
42955 ``Quiet''.  Do not print the introductory and copyright messages.  These
42956 messages are also suppressed in batch mode.
42957
42958 @item -batch
42959 Run in batch mode.  Exit with status @code{0} after processing all the command
42960 files specified with @option{-x} (and @file{.gdbinit}, if not inhibited).
42961 Exit with nonzero status if an error occurs in executing the @value{GDBN}
42962 commands in the command files.
42963
42964 Batch mode may be useful for running @value{GDBN} as a filter, for example to
42965 download and run a program on another computer; in order to make this
42966 more useful, the message
42967
42968 @smallexample
42969 Program exited normally.
42970 @end smallexample
42971
42972 @noindent
42973 (which is ordinarily issued whenever a program running under @value{GDBN} control
42974 terminates) is not issued when running in batch mode.
42975
42976 @item -cd=@var{directory}
42977 Run @value{GDBN} using @var{directory} as its working directory,
42978 instead of the current directory.
42979
42980 @item -fullname
42981 @itemx -f
42982 Emacs sets this option when it runs @value{GDBN} as a subprocess.  It tells
42983 @value{GDBN} to output the full file name and line number in a standard,
42984 recognizable fashion each time a stack frame is displayed (which
42985 includes each time the program stops).  This recognizable format looks
42986 like two @samp{\032} characters, followed by the file name, line number
42987 and character position separated by colons, and a newline.  The
42988 Emacs-to-@value{GDBN} interface program uses the two @samp{\032}
42989 characters as a signal to display the source code for the frame.
42990
42991 @item -b @var{bps}
42992 Set the line speed (baud rate or bits per second) of any serial
42993 interface used by @value{GDBN} for remote debugging.
42994
42995 @item -tty=@var{device}
42996 Run using @var{device} for your program's standard input and output.
42997 @end table
42998 @c man end
42999
43000 @c man begin SEEALSO gdb
43001 @ifset man
43002 The full documentation for @value{GDBN} is maintained as a Texinfo manual.
43003 If the @code{info} and @code{gdb} programs and @value{GDBN}'s Texinfo
43004 documentation are properly installed at your site, the command
43005
43006 @smallexample
43007 info gdb
43008 @end smallexample
43009
43010 @noindent
43011 should give you access to the complete manual.
43012
43013 @cite{Using GDB: A Guide to the GNU Source-Level Debugger},
43014 Richard M. Stallman and Roland H. Pesch, July 1991.
43015 @end ifset
43016 @c man end
43017
43018 @node gdbserver man
43019 @heading gdbserver man
43020
43021 @c man title gdbserver Remote Server for the GNU Debugger
43022 @format
43023 @c man begin SYNOPSIS gdbserver
43024 gdbserver @var{comm} @var{prog} [@var{args}@dots{}]
43025
43026 gdbserver --attach @var{comm} @var{pid}
43027
43028 gdbserver --multi @var{comm}
43029 @c man end
43030 @end format
43031
43032 @c man begin DESCRIPTION gdbserver
43033 @command{gdbserver} is a program that allows you to run @value{GDBN} on a different machine
43034 than the one which is running the program being debugged.
43035
43036 @ifclear man
43037 @subheading Usage (server (target) side)
43038 @end ifclear
43039 @ifset man
43040 Usage (server (target) side):
43041 @end ifset
43042
43043 First, you need to have a copy of the program you want to debug put onto
43044 the target system.  The program can be stripped to save space if needed, as
43045 @command{gdbserver} doesn't care about symbols.  All symbol handling is taken care of by
43046 the @value{GDBN} running on the host system.
43047
43048 To use the server, you log on to the target system, and run the @command{gdbserver}
43049 program.  You must tell it (a) how to communicate with @value{GDBN}, (b) the name of
43050 your program, and (c) its arguments.  The general syntax is:
43051
43052 @smallexample
43053 target> gdbserver @var{comm} @var{program} [@var{args} ...]
43054 @end smallexample
43055
43056 For example, using a serial port, you might say:
43057
43058 @smallexample
43059 @ifset man
43060 @c @file would wrap it as F</dev/com1>.
43061 target> gdbserver /dev/com1 emacs foo.txt
43062 @end ifset
43063 @ifclear man
43064 target> gdbserver @file{/dev/com1} emacs foo.txt
43065 @end ifclear
43066 @end smallexample
43067
43068 This tells @command{gdbserver} to debug emacs with an argument of foo.txt, and
43069 to communicate with @value{GDBN} via @file{/dev/com1}.  @command{gdbserver} now
43070 waits patiently for the host @value{GDBN} to communicate with it.
43071
43072 To use a TCP connection, you could say:
43073
43074 @smallexample
43075 target> gdbserver host:2345 emacs foo.txt
43076 @end smallexample
43077
43078 This says pretty much the same thing as the last example, except that we are
43079 going to communicate with the @code{host} @value{GDBN} via TCP.  The @code{host:2345} argument means
43080 that we are expecting to see a TCP connection from @code{host} to local TCP port
43081 2345.  (Currently, the @code{host} part is ignored.)  You can choose any number you
43082 want for the port number as long as it does not conflict with any existing TCP
43083 ports on the target system.  This same port number must be used in the host
43084 @value{GDBN}s @code{target remote} command, which will be described shortly.  Note that if
43085 you chose a port number that conflicts with another service, @command{gdbserver} will
43086 print an error message and exit.
43087
43088 @command{gdbserver} can also attach to running programs.
43089 This is accomplished via the @option{--attach} argument.  The syntax is:
43090
43091 @smallexample
43092 target> gdbserver --attach @var{comm} @var{pid}
43093 @end smallexample
43094
43095 @var{pid} is the process ID of a currently running process.  It isn't
43096 necessary to point @command{gdbserver} at a binary for the running process.
43097
43098 To start @code{gdbserver} without supplying an initial command to run
43099 or process ID to attach, use the @option{--multi} command line option.
43100 In such case you should connect using @kbd{target extended-remote} to start
43101 the program you want to debug.
43102
43103 @smallexample
43104 target> gdbserver --multi @var{comm}
43105 @end smallexample
43106
43107 @ifclear man
43108 @subheading Usage (host side)
43109 @end ifclear
43110 @ifset man
43111 Usage (host side):
43112 @end ifset
43113
43114 You need an unstripped copy of the target program on your host system, since
43115 @value{GDBN} needs to examine it's symbol tables and such.  Start up @value{GDBN} as you normally
43116 would, with the target program as the first argument.  (You may need to use the
43117 @option{--baud} option if the serial line is running at anything except 9600 baud.)
43118 That is @code{gdb TARGET-PROG}, or @code{gdb --baud BAUD TARGET-PROG}.  After that, the only
43119 new command you need to know about is @code{target remote}
43120 (or @code{target extended-remote}).  Its argument is either
43121 a device name (usually a serial device, like @file{/dev/ttyb}), or a @code{HOST:PORT}
43122 descriptor.  For example:
43123
43124 @smallexample
43125 @ifset man
43126 @c @file would wrap it as F</dev/ttyb>.
43127 (gdb) target remote /dev/ttyb
43128 @end ifset
43129 @ifclear man
43130 (gdb) target remote @file{/dev/ttyb}
43131 @end ifclear
43132 @end smallexample
43133
43134 @noindent
43135 communicates with the server via serial line @file{/dev/ttyb}, and:
43136
43137 @smallexample
43138 (gdb) target remote the-target:2345
43139 @end smallexample
43140
43141 @noindent
43142 communicates via a TCP connection to port 2345 on host `the-target', where
43143 you previously started up @command{gdbserver} with the same port number.  Note that for
43144 TCP connections, you must start up @command{gdbserver} prior to using the `target remote'
43145 command, otherwise you may get an error that looks something like
43146 `Connection refused'.
43147
43148 @command{gdbserver} can also debug multiple inferiors at once,
43149 described in
43150 @ifset man
43151 the @value{GDBN} manual in node @code{Inferiors and Programs}
43152 -- shell command @code{info -f gdb -n 'Inferiors and Programs'}.
43153 @end ifset
43154 @ifclear man
43155 @ref{Inferiors and Programs}.
43156 @end ifclear
43157 In such case use the @code{extended-remote} @value{GDBN} command variant:
43158
43159 @smallexample
43160 (gdb) target extended-remote the-target:2345
43161 @end smallexample
43162
43163 The @command{gdbserver} option @option{--multi} may or may not be used in such
43164 case.
43165 @c man end
43166
43167 @c man begin OPTIONS gdbserver
43168 There are three different modes for invoking @command{gdbserver}:
43169
43170 @itemize @bullet
43171
43172 @item
43173 Debug a specific program specified by its program name:
43174
43175 @smallexample
43176 gdbserver @var{comm} @var{prog} [@var{args}@dots{}]
43177 @end smallexample
43178
43179 The @var{comm} parameter specifies how should the server communicate
43180 with @value{GDBN}; it is either a device name (to use a serial line),
43181 a TCP port number (@code{:1234}), or @code{-} or @code{stdio} to use
43182 stdin/stdout of @code{gdbserver}.  Specify the name of the program to
43183 debug in @var{prog}.  Any remaining arguments will be passed to the
43184 program verbatim.  When the program exits, @value{GDBN} will close the
43185 connection, and @code{gdbserver} will exit.
43186
43187 @item
43188 Debug a specific program by specifying the process ID of a running
43189 program:
43190
43191 @smallexample
43192 gdbserver --attach @var{comm} @var{pid}
43193 @end smallexample
43194
43195 The @var{comm} parameter is as described above.  Supply the process ID
43196 of a running program in @var{pid}; @value{GDBN} will do everything
43197 else.  Like with the previous mode, when the process @var{pid} exits,
43198 @value{GDBN} will close the connection, and @code{gdbserver} will exit.
43199
43200 @item
43201 Multi-process mode -- debug more than one program/process:
43202
43203 @smallexample
43204 gdbserver --multi @var{comm}
43205 @end smallexample
43206
43207 In this mode, @value{GDBN} can instruct @command{gdbserver} which
43208 command(s) to run.  Unlike the other 2 modes, @value{GDBN} will not
43209 close the connection when a process being debugged exits, so you can
43210 debug several processes in the same session.
43211 @end itemize
43212
43213 In each of the modes you may specify these options:
43214
43215 @table @env
43216
43217 @item --help
43218 List all options, with brief explanations.
43219
43220 @item --version
43221 This option causes @command{gdbserver} to print its version number and exit.
43222
43223 @item --attach
43224 @command{gdbserver} will attach to a running program.  The syntax is:
43225
43226 @smallexample
43227 target> gdbserver --attach @var{comm} @var{pid}
43228 @end smallexample
43229
43230 @var{pid} is the process ID of a currently running process.  It isn't
43231 necessary to point @command{gdbserver} at a binary for the running process.
43232
43233 @item --multi
43234 To start @code{gdbserver} without supplying an initial command to run
43235 or process ID to attach, use this command line option.
43236 Then you can connect using @kbd{target extended-remote} and start
43237 the program you want to debug.  The syntax is:
43238
43239 @smallexample
43240 target> gdbserver --multi @var{comm}
43241 @end smallexample
43242
43243 @item --debug
43244 Instruct @code{gdbserver} to display extra status information about the debugging
43245 process.
43246 This option is intended for @code{gdbserver} development and for bug reports to
43247 the developers.
43248
43249 @item --remote-debug
43250 Instruct @code{gdbserver} to display remote protocol debug output.
43251 This option is intended for @code{gdbserver} development and for bug reports to
43252 the developers.
43253
43254 @item --debug-format=option1@r{[},option2,...@r{]}
43255 Instruct @code{gdbserver} to include extra information in each line
43256 of debugging output.
43257 @xref{Other Command-Line Arguments for gdbserver}.
43258
43259 @item --wrapper
43260 Specify a wrapper to launch programs
43261 for debugging.  The option should be followed by the name of the
43262 wrapper, then any command-line arguments to pass to the wrapper, then
43263 @kbd{--} indicating the end of the wrapper arguments.
43264
43265 @item --once
43266 By default, @command{gdbserver} keeps the listening TCP port open, so that
43267 additional connections are possible.  However, if you start @code{gdbserver}
43268 with the @option{--once} option, it will stop listening for any further
43269 connection attempts after connecting to the first @value{GDBN} session.
43270
43271 @c --disable-packet is not documented for users.
43272
43273 @c --disable-randomization and --no-disable-randomization are superseded by
43274 @c QDisableRandomization.
43275
43276 @end table
43277 @c man end
43278
43279 @c man begin SEEALSO gdbserver
43280 @ifset man
43281 The full documentation for @value{GDBN} is maintained as a Texinfo manual.
43282 If the @code{info} and @code{gdb} programs and @value{GDBN}'s Texinfo
43283 documentation are properly installed at your site, the command
43284
43285 @smallexample
43286 info gdb
43287 @end smallexample
43288
43289 should give you access to the complete manual.
43290
43291 @cite{Using GDB: A Guide to the GNU Source-Level Debugger},
43292 Richard M. Stallman and Roland H. Pesch, July 1991.
43293 @end ifset
43294 @c man end
43295
43296 @node gcore man
43297 @heading gcore
43298
43299 @c man title gcore Generate a core file of a running program
43300
43301 @format
43302 @c man begin SYNOPSIS gcore
43303 gcore [-a] [-o @var{filename}] @var{pid}
43304 @c man end
43305 @end format
43306
43307 @c man begin DESCRIPTION gcore
43308 Generate a core dump of a running program with process ID @var{pid}.
43309 Produced file is equivalent to a kernel produced core file as if the process
43310 crashed (and if @kbd{ulimit -c} were used to set up an appropriate core dump
43311 limit).  Unlike after a crash, after @command{gcore} the program remains
43312 running without any change.
43313 @c man end
43314
43315 @c man begin OPTIONS gcore
43316 @table @env
43317 @item -a
43318 Dump all memory mappings.  The actual effect of this option depends on
43319 the Operating System.  On @sc{gnu}/Linux, it will disable
43320 @code{use-coredump-filter} (@pxref{set use-coredump-filter}) and
43321 enable @code{dump-excluded-mappings} (@pxref{set
43322 dump-excluded-mappings}).
43323
43324 @item -o @var{filename}
43325 The optional argument
43326 @var{filename} specifies the file name where to put the core dump.
43327 If not specified, the file name defaults to @file{core.@var{pid}},
43328 where @var{pid} is the running program process ID.
43329 @end table
43330 @c man end
43331
43332 @c man begin SEEALSO gcore
43333 @ifset man
43334 The full documentation for @value{GDBN} is maintained as a Texinfo manual.
43335 If the @code{info} and @code{gdb} programs and @value{GDBN}'s Texinfo
43336 documentation are properly installed at your site, the command
43337
43338 @smallexample
43339 info gdb
43340 @end smallexample
43341
43342 @noindent
43343 should give you access to the complete manual.
43344
43345 @cite{Using GDB: A Guide to the GNU Source-Level Debugger},
43346 Richard M. Stallman and Roland H. Pesch, July 1991.
43347 @end ifset
43348 @c man end
43349
43350 @node gdbinit man
43351 @heading gdbinit
43352
43353 @c man title gdbinit GDB initialization scripts
43354
43355 @format
43356 @c man begin SYNOPSIS gdbinit
43357 @ifset SYSTEM_GDBINIT
43358 @value{SYSTEM_GDBINIT}
43359 @end ifset
43360
43361 ~/.gdbinit
43362
43363 ./.gdbinit
43364 @c man end
43365 @end format
43366
43367 @c man begin DESCRIPTION gdbinit
43368 These files contain @value{GDBN} commands to automatically execute during
43369 @value{GDBN} startup.  The lines of contents are canned sequences of commands,
43370 described in
43371 @ifset man
43372 the @value{GDBN} manual in node @code{Sequences}
43373 -- shell command @code{info -f gdb -n Sequences}.
43374 @end ifset
43375 @ifclear man
43376 @ref{Sequences}.
43377 @end ifclear
43378
43379 Please read more in
43380 @ifset man
43381 the @value{GDBN} manual in node @code{Startup}
43382 -- shell command @code{info -f gdb -n Startup}.
43383 @end ifset
43384 @ifclear man
43385 @ref{Startup}.
43386 @end ifclear
43387
43388 @table @env
43389 @ifset SYSTEM_GDBINIT
43390 @item @value{SYSTEM_GDBINIT}
43391 @end ifset
43392 @ifclear SYSTEM_GDBINIT
43393 @item (not enabled with @code{--with-system-gdbinit} during compilation)
43394 @end ifclear
43395 System-wide initialization file.  It is executed unless user specified
43396 @value{GDBN} option @code{-nx} or @code{-n}.
43397 See more in
43398 @ifset man
43399 the @value{GDBN} manual in node @code{System-wide configuration}
43400 -- shell command @code{info -f gdb -n 'System-wide configuration'}.
43401 @end ifset
43402 @ifclear man
43403 @ref{System-wide configuration}.
43404 @end ifclear
43405
43406 @item ~/.gdbinit
43407 User initialization file.  It is executed unless user specified
43408 @value{GDBN} options @code{-nx}, @code{-n} or @code{-nh}.
43409
43410 @item ./.gdbinit
43411 Initialization file for current directory.  It may need to be enabled with
43412 @value{GDBN} security command @code{set auto-load local-gdbinit}.
43413 See more in
43414 @ifset man
43415 the @value{GDBN} manual in node @code{Init File in the Current Directory}
43416 -- shell command @code{info -f gdb -n 'Init File in the Current Directory'}.
43417 @end ifset
43418 @ifclear man
43419 @ref{Init File in the Current Directory}.
43420 @end ifclear
43421 @end table
43422 @c man end
43423
43424 @c man begin SEEALSO gdbinit
43425 @ifset man
43426 gdb(1), @code{info -f gdb -n Startup}
43427
43428 The full documentation for @value{GDBN} is maintained as a Texinfo manual.
43429 If the @code{info} and @code{gdb} programs and @value{GDBN}'s Texinfo
43430 documentation are properly installed at your site, the command
43431
43432 @smallexample
43433 info gdb
43434 @end smallexample
43435
43436 should give you access to the complete manual.
43437
43438 @cite{Using GDB: A Guide to the GNU Source-Level Debugger},
43439 Richard M. Stallman and Roland H. Pesch, July 1991.
43440 @end ifset
43441 @c man end
43442
43443 @node gdb-add-index man
43444 @pindex gdb-add-index
43445 @anchor{gdb-add-index}
43446 @heading gdb-add-index
43447
43448 @c man title gdb-add-index Add index files to speed up GDB
43449
43450 @c man begin SYNOPSIS gdb-add-index
43451 gdb-add-index @var{filename}
43452 @c man end
43453
43454 @c man begin DESCRIPTION gdb-add-index
43455 When @value{GDBN} finds a symbol file, it scans the symbols in the
43456 file in order to construct an internal symbol table.  This lets most
43457 @value{GDBN} operations work quickly--at the cost of a delay early on.
43458 For large programs, this delay can be quite lengthy, so @value{GDBN}
43459 provides a way to build an index, which speeds up startup.
43460
43461 To determine whether a file contains such an index, use the command
43462 @kbd{readelf -S filename}: the index is stored in a section named
43463 @code{.gdb_index}.  The index file can only be produced on systems
43464 which use ELF binaries and DWARF debug information (i.e., sections
43465 named @code{.debug_*}).
43466
43467 @command{gdb-add-index} uses @value{GDBN} and @command{objdump} found
43468 in the @env{PATH} environment variable.  If you want to use different
43469 versions of these programs, you can specify them through the
43470 @env{GDB} and @env{OBJDUMP} environment variables.
43471
43472 See more in
43473 @ifset man
43474 the @value{GDBN} manual in node @code{Index Files}
43475 -- shell command @kbd{info -f gdb -n "Index Files"}.
43476 @end ifset
43477 @ifclear man
43478 @ref{Index Files}.
43479 @end ifclear
43480 @c man end
43481
43482 @c man begin SEEALSO gdb-add-index
43483 @ifset man
43484 The full documentation for @value{GDBN} is maintained as a Texinfo manual.
43485 If the @code{info} and @code{gdb} programs and @value{GDBN}'s Texinfo
43486 documentation are properly installed at your site, the command
43487
43488 @smallexample
43489 info gdb
43490 @end smallexample
43491
43492 should give you access to the complete manual.
43493
43494 @cite{Using GDB: A Guide to the GNU Source-Level Debugger},
43495 Richard M. Stallman and Roland H. Pesch, July 1991.
43496 @end ifset
43497 @c man end
43498
43499 @include gpl.texi
43500
43501 @node GNU Free Documentation License
43502 @appendix GNU Free Documentation License
43503 @include fdl.texi
43504
43505 @node Concept Index
43506 @unnumbered Concept Index
43507
43508 @printindex cp
43509
43510 @node Command and Variable Index
43511 @unnumbered Command, Variable, and Function Index
43512
43513 @printindex fn
43514
43515 @tex
43516 % I think something like @@colophon should be in texinfo.  In the
43517 % meantime:
43518 \long\def\colophon{\hbox to0pt{}\vfill
43519 \centerline{The body of this manual is set in}
43520 \centerline{\fontname\tenrm,}
43521 \centerline{with headings in {\bf\fontname\tenbf}}
43522 \centerline{and examples in {\tt\fontname\tentt}.}
43523 \centerline{{\it\fontname\tenit\/},}
43524 \centerline{{\bf\fontname\tenbf}, and}
43525 \centerline{{\sl\fontname\tensl\/}}
43526 \centerline{are used for emphasis.}\vfill}
43527 \page\colophon
43528 % Blame: doc@@cygnus.com, 1991.
43529 @end tex
43530
43531 @bye