d53903c0fd986ff9aff706135c911d7465b7e4d4
[external/binutils.git] / gdb / doc / gdb.texinfo
1 \input texinfo      @c -*-texinfo-*-
2 @c Copyright 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1998,
3 @c 1999, 2000, 2001
4 @c Free Software Foundation, Inc.
5 @c
6 @c %**start of header
7 @c makeinfo ignores cmds prev to setfilename, so its arg cannot make use
8 @c of @set vars.  However, you can override filename with makeinfo -o.
9 @setfilename gdb.info
10 @c
11 @include gdb-cfg.texi
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 @syncodeindex ky cp
24
25 @c readline appendices use @vindex, @findex and @ftable,
26 @c annotate.texi and gdbmi use @findex.
27 @syncodeindex vr cp
28 @syncodeindex fn cp
29
30 @c !!set GDB manual's edition---not the same as GDB version!
31 @set EDITION Ninth
32
33 @c !!set GDB manual's revision date
34 @set DATE April 2001
35
36 @c THIS MANUAL REQUIRES TEXINFO 3.12 OR LATER.
37
38 @c This is a dir.info fragment to support semi-automated addition of
39 @c manuals to an info tree.
40 @dircategory Programming & development tools.
41 @direntry
42 * Gdb: (gdb).                     The @sc{gnu} debugger.
43 @end direntry
44
45 @ifinfo
46 This file documents the @sc{gnu} debugger @value{GDBN}.
47
48
49 This is the @value{EDITION} Edition, @value{DATE},
50 of @cite{Debugging with @value{GDBN}: the @sc{gnu} Source-Level Debugger}
51 for @value{GDBN} Version @value{GDBVN}.
52
53 Copyright (C) 1988,1989,1990,1991,1992,1993,1994,1995,1996,1998,1999,2000,2001
54    Free Software Foundation, Inc.
55
56 Permission is granted to copy, distribute and/or modify this document
57 under the terms of the GNU Free Documentation License, Version 1.1 or
58 any later version published by the Free Software Foundation; with the
59 Invariant Sections being ``A Sample GDB Session'' and ``Free
60 Software'', with the Front-Cover texts being ``A GNU Manual,'' and
61 with the Back-Cover Texts as in (a) below.
62
63 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
64 this GNU Manual, like GNU software.  Copies published by the Free
65 Software Foundation raise funds for GNU development.''
66 @end ifinfo
67
68 @titlepage
69 @title Debugging with @value{GDBN}
70 @subtitle The @sc{gnu} Source-Level Debugger
71 @sp 1
72 @subtitle @value{EDITION} Edition, for @value{GDBN} version @value{GDBVN}
73 @subtitle @value{DATE}
74 @author Richard Stallman, Roland Pesch, Stan Shebs, et al.
75 @page
76 @tex
77 {\parskip=0pt
78 \hfill (Send bugs and comments on @value{GDBN} to bug-gdb\@gnu.org.)\par
79 \hfill {\it Debugging with @value{GDBN}}\par
80 \hfill \TeX{}info \texinfoversion\par
81 }
82 @end tex
83
84 @vskip 0pt plus 1filll
85 Copyright @copyright{} 1988,1989,1990,1991,1992,1993,1994,1995,1996,1998,1999,2000,2001
86    Free Software Foundation, Inc.
87 @sp 2
88 Published by the Free Software Foundation @*
89 59 Temple Place - Suite 330, @*
90 Boston, MA 02111-1307 USA @*
91 ISBN 1-882114-77-9 @*
92
93 Permission is granted to copy, distribute and/or modify this document
94 under the terms of the GNU Free Documentation License, Version 1.1 or
95 any later version published by the Free Software Foundation; with the
96 Invariant Sections being ``A Sample GDB Session'' and ``Free
97 Software'', with the Front-Cover texts being ``A GNU Manual,'' and
98 with the Back-Cover Texts as in (a) below.
99
100 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
101 this GNU Manual, like GNU software.  Copies published by the Free
102 Software Foundation raise funds for GNU development.''
103 @end titlepage
104 @page
105
106 @ifinfo
107 @node Top, Summary, (dir), (dir)
108
109 @top Debugging with @value{GDBN}
110
111 This file describes @value{GDBN}, the @sc{gnu} symbolic debugger.
112
113 This is the @value{EDITION} Edition, @value{DATE}, for @value{GDBN} Version
114 @value{GDBVN}.
115
116 Copyright (C) 1988-2001 Free Software Foundation, Inc.
117
118 @menu
119 * Summary::                     Summary of @value{GDBN}
120 * Sample Session::              A sample @value{GDBN} session
121
122 * Invocation::                  Getting in and out of @value{GDBN}
123 * Commands::                    @value{GDBN} commands
124 * Running::                     Running programs under @value{GDBN}
125 * Stopping::                    Stopping and continuing
126 * Stack::                       Examining the stack
127 * Source::                      Examining source files
128 * Data::                        Examining data
129 * Tracepoints::                 Debugging remote targets non-intrusively
130
131 * Languages::                   Using @value{GDBN} with different languages
132
133 * Symbols::                     Examining the symbol table
134 * Altering::                    Altering execution
135 * GDB Files::                   @value{GDBN} files
136 * Targets::                     Specifying a debugging target
137 * Configurations::              Configuration-specific information
138 * Controlling GDB::             Controlling @value{GDBN}
139 * Sequences::                   Canned sequences of commands
140 * Emacs::                       Using @value{GDBN} under @sc{gnu} Emacs
141 * Annotations::                 @value{GDBN}'s annotation interface.
142 * GDB/MI::                      @value{GDBN}'s Machine Interface.
143
144 * GDB Bugs::                    Reporting bugs in @value{GDBN}
145 * Formatting Documentation::    How to format and print @value{GDBN} documentation
146
147 * Command Line Editing::        Command Line Editing
148 * Using History Interactively:: Using History Interactively
149 * Installing GDB::              Installing GDB
150 * Index::                       Index
151 @end menu
152
153 @end ifinfo
154
155 @c the replication sucks, but this avoids a texinfo 3.12 lameness
156
157 @ifhtml
158 @node Top
159
160 @top Debugging with @value{GDBN}
161
162 This file describes @value{GDBN}, the @sc{gnu} symbolic debugger.
163
164 This is the @value{EDITION} Edition, @value{DATE}, for @value{GDBN} Version
165 @value{GDBVN}.
166
167 Copyright (C) 1988-2000 Free Software Foundation, Inc.
168
169 @menu
170 * Summary::                     Summary of @value{GDBN}
171 * Sample Session::              A sample @value{GDBN} session
172
173 * Invocation::                  Getting in and out of @value{GDBN}
174 * Commands::                    @value{GDBN} commands
175 * Running::                     Running programs under @value{GDBN}
176 * Stopping::                    Stopping and continuing
177 * Stack::                       Examining the stack
178 * Source::                      Examining source files
179 * Data::                        Examining data
180
181 * Languages::                   Using @value{GDBN} with different languages
182
183 * Symbols::                     Examining the symbol table
184 * Altering::                    Altering execution
185 * GDB Files::                   @value{GDBN} files
186 * Targets::                     Specifying a debugging target
187 * Configurations::              Configuration-specific information
188 * Controlling GDB::             Controlling @value{GDBN}
189 * Sequences::                   Canned sequences of commands
190 * Emacs::                       Using @value{GDBN} under @sc{gnu} Emacs
191 * Annotations::                 @value{GDBN}'s annotation interface.
192
193 * GDB Bugs::                    Reporting bugs in @value{GDBN}
194 * Formatting Documentation::    How to format and print @value{GDBN} documentation
195
196 * Command Line Editing::        Command Line Editing
197 * Using History Interactively:: Using History Interactively
198 * Installing GDB::              Installing GDB
199 * Index::                       Index
200 @end menu
201
202 @end ifhtml
203
204 @c TeX can handle the contents at the start but makeinfo 3.12 can not
205 @iftex
206 @contents
207 @end iftex
208
209 @node Summary
210 @unnumbered Summary of @value{GDBN}
211
212 The purpose of a debugger such as @value{GDBN} is to allow you to see what is
213 going on ``inside'' another program while it executes---or what another
214 program was doing at the moment it crashed.
215
216 @value{GDBN} can do four main kinds of things (plus other things in support of
217 these) to help you catch bugs in the act:
218
219 @itemize @bullet
220 @item
221 Start your program, specifying anything that might affect its behavior.
222
223 @item
224 Make your program stop on specified conditions.
225
226 @item
227 Examine what has happened, when your program has stopped.
228
229 @item
230 Change things in your program, so you can experiment with correcting the
231 effects of one bug and go on to learn about another.
232 @end itemize
233
234 You can use @value{GDBN} to debug programs written in C and C++.
235 For more information, see @ref{Support,,Supported languages}.
236 For more information, see @ref{C,,C and C++}.
237
238 @cindex Chill
239 @cindex Modula-2
240 Support for Modula-2 and Chill is partial.  For information on Modula-2,
241 see @ref{Modula-2,,Modula-2}.  For information on Chill, see @ref{Chill}.
242
243 @cindex Pascal
244 Debugging Pascal programs which use sets, subranges, file variables, or
245 nested functions does not currently work.  @value{GDBN} does not support
246 entering expressions, printing values, or similar features using Pascal
247 syntax.
248
249 @cindex Fortran
250 @value{GDBN} can be used to debug programs written in Fortran, although
251 it may be necessary to refer to some variables with a trailing
252 underscore.
253
254 @menu
255 * Free Software::               Freely redistributable software
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 Contributors
276 @unnumberedsec Contributors to @value{GDBN}
277
278 Richard Stallman was the original author of @value{GDBN}, and of many
279 other @sc{gnu} programs.  Many others have contributed to its
280 development.  This section attempts to credit major contributors.  One
281 of the virtues of free software is that everyone is free to contribute
282 to it; with regret, we cannot actually acknowledge everyone here.  The
283 file @file{ChangeLog} in the @value{GDBN} distribution approximates a
284 blow-by-blow account.
285
286 Changes much prior to version 2.0 are lost in the mists of time.
287
288 @quotation
289 @emph{Plea:} Additions to this section are particularly welcome.  If you
290 or your friends (or enemies, to be evenhanded) have been unfairly
291 omitted from this list, we would like to add your names!
292 @end quotation
293
294 So that they may not regard their many labors as thankless, we
295 particularly thank those who shepherded @value{GDBN} through major
296 releases:
297 Andrew Cagney (releases 5.0 and 5.1);
298 Jim Blandy (release 4.18);
299 Jason Molenda (release 4.17);
300 Stan Shebs (release 4.14);
301 Fred Fish (releases 4.16, 4.15, 4.13, 4.12, 4.11, 4.10, and 4.9);
302 Stu Grossman and John Gilmore (releases 4.8, 4.7, 4.6, 4.5, and 4.4);
303 John Gilmore (releases 4.3, 4.2, 4.1, 4.0, and 3.9);
304 Jim Kingdon (releases 3.5, 3.4, and 3.3);
305 and Randy Smith (releases 3.2, 3.1, and 3.0).
306
307 Richard Stallman, assisted at various times by Peter TerMaat, Chris
308 Hanson, and Richard Mlynarik, handled releases through 2.8.
309
310 Michael Tiemann is the author of most of the @sc{gnu} C@t{++} support
311 in @value{GDBN}, with significant additional contributions from Per
312 Bothner and Daniel Berlin.  James Clark wrote the @sc{gnu} C@t{++}
313 demangler.  Early work on C@t{++} was by Peter TerMaat (who also did
314 much general update work leading to release 3.0).
315
316 @value{GDBN} uses the BFD subroutine library to examine multiple
317 object-file formats; BFD was a joint project of David V.
318 Henkel-Wallace, Rich Pixley, Steve Chamberlain, and John Gilmore.
319
320 David Johnson wrote the original COFF support; Pace Willison did
321 the original support for encapsulated COFF.
322
323 Brent Benson of Harris Computer Systems contributed DWARF2 support.
324
325 Adam de Boor and Bradley Davis contributed the ISI Optimum V support.
326 Per Bothner, Noboyuki Hikichi, and Alessandro Forin contributed MIPS
327 support.
328 Jean-Daniel Fekete contributed Sun 386i support.
329 Chris Hanson improved the HP9000 support.
330 Noboyuki Hikichi and Tomoyuki Hasei contributed Sony/News OS 3 support.
331 David Johnson contributed Encore Umax support.
332 Jyrki Kuoppala contributed Altos 3068 support.
333 Jeff Law contributed HP PA and SOM support.
334 Keith Packard contributed NS32K support.
335 Doug Rabson contributed Acorn Risc Machine support.
336 Bob Rusk contributed Harris Nighthawk CX-UX support.
337 Chris Smith contributed Convex support (and Fortran debugging).
338 Jonathan Stone contributed Pyramid support.
339 Michael Tiemann contributed SPARC support.
340 Tim Tucker contributed support for the Gould NP1 and Gould Powernode.
341 Pace Willison contributed Intel 386 support.
342 Jay Vosburgh contributed Symmetry support.
343
344 Andreas Schwab contributed M68K Linux support.
345
346 Rich Schaefer and Peter Schauer helped with support of SunOS shared
347 libraries.
348
349 Jay Fenlason and Roland McGrath ensured that @value{GDBN} and GAS agree
350 about several machine instruction sets.
351
352 Patrick Duval, Ted Goldstein, Vikram Koka and Glenn Engel helped develop
353 remote debugging.  Intel Corporation, Wind River Systems, AMD, and ARM
354 contributed remote debugging modules for the i960, VxWorks, A29K UDI,
355 and RDI targets, respectively.
356
357 Brian Fox is the author of the readline libraries providing
358 command-line editing and command history.
359
360 Andrew Beers of SUNY Buffalo wrote the language-switching code, the
361 Modula-2 support, and contributed the Languages chapter of this manual.
362
363 Fred Fish wrote most of the support for Unix System Vr4.
364 He also enhanced the command-completion support to cover C@t{++} overloaded
365 symbols.
366
367 Hitachi America, Ltd. sponsored the support for H8/300, H8/500, and
368 Super-H processors.
369
370 NEC sponsored the support for the v850, Vr4xxx, and Vr5xxx processors.
371
372 Mitsubishi sponsored the support for D10V, D30V, and M32R/D processors.
373
374 Toshiba sponsored the support for the TX39 Mips processor.
375
376 Matsushita sponsored the support for the MN10200 and MN10300 processors.
377
378 Fujitsu sponsored the support for SPARClite and FR30 processors.
379
380 Kung Hsu, Jeff Law, and Rick Sladkey added support for hardware
381 watchpoints.
382
383 Michael Snyder added support for tracepoints.
384
385 Stu Grossman wrote gdbserver.
386
387 Jim Kingdon, Peter Schauer, Ian Taylor, and Stu Grossman made
388 nearly innumerable bug fixes and cleanups throughout @value{GDBN}.
389
390 The following people at the Hewlett-Packard Company contributed
391 support for the PA-RISC 2.0 architecture, HP-UX 10.20, 10.30, and 11.0
392 (narrow mode), HP's implementation of kernel threads, HP's aC@t{++}
393 compiler, and the terminal user interface: Ben Krepp, Richard Title,
394 John Bishop, Susan Macchia, Kathy Mann, Satish Pai, India Paul, Steve
395 Rehrauer, and Elena Zannoni.  Kim Haase provided HP-specific
396 information in this manual.
397
398 DJ Delorie ported @value{GDBN} to MS-DOS, for the DJGPP project.
399 Robert Hoehne made significant contributions to the DJGPP port.
400
401 Cygnus Solutions has sponsored @value{GDBN} maintenance and much of its
402 development since 1991.  Cygnus engineers who have worked on @value{GDBN}
403 fulltime include Mark Alexander, Jim Blandy, Per Bothner, Kevin
404 Buettner, Edith Epstein, Chris Faylor, Fred Fish, Martin Hunt, Jim
405 Ingham, John Gilmore, Stu Grossman, Kung Hsu, Jim Kingdon, John Metzler,
406 Fernando Nasser, Geoffrey Noer, Dawn Perchik, Rich Pixley, Zdenek
407 Radouch, Keith Seitz, Stan Shebs, David Taylor, and Elena Zannoni.  In
408 addition, Dave Brolley, Ian Carmichael, Steve Chamberlain, Nick Clifton,
409 JT Conklin, Stan Cox, DJ Delorie, Ulrich Drepper, Frank Eigler, Doug
410 Evans, Sean Fagan, David Henkel-Wallace, Richard Henderson, Jeff
411 Holcomb, Jeff Law, Jim Lemke, Tom Lord, Bob Manson, Michael Meissner,
412 Jason Merrill, Catherine Moore, Drew Moseley, Ken Raeburn, Gavin
413 Romig-Koch, Rob Savoye, Jamie Smith, Mike Stump, Ian Taylor, Angela
414 Thomas, Michael Tiemann, Tom Tromey, Ron Unrau, Jim Wilson, and David
415 Zuhn have made contributions both large and small.
416
417
418 @node Sample Session
419 @chapter A Sample @value{GDBN} Session
420
421 You can use this manual at your leisure to read all about @value{GDBN}.
422 However, a handful of commands are enough to get started using the
423 debugger.  This chapter illustrates those commands.
424
425 @iftex
426 In this sample session, we emphasize user input like this: @b{input},
427 to make it easier to pick out from the surrounding output.
428 @end iftex
429
430 @c FIXME: this example may not be appropriate for some configs, where
431 @c FIXME...primary interest is in remote use.
432
433 One of the preliminary versions of @sc{gnu} @code{m4} (a generic macro
434 processor) exhibits the following bug: sometimes, when we change its
435 quote strings from the default, the commands used to capture one macro
436 definition within another stop working.  In the following short @code{m4}
437 session, we define a macro @code{foo} which expands to @code{0000}; we
438 then use the @code{m4} built-in @code{defn} to define @code{bar} as the
439 same thing.  However, when we change the open quote string to
440 @code{<QUOTE>} and the close quote string to @code{<UNQUOTE>}, the same
441 procedure fails to define a new synonym @code{baz}:
442
443 @smallexample
444 $ @b{cd gnu/m4}
445 $ @b{./m4}
446 @b{define(foo,0000)}
447
448 @b{foo}
449 0000
450 @b{define(bar,defn(`foo'))}
451
452 @b{bar}
453 0000
454 @b{changequote(<QUOTE>,<UNQUOTE>)}
455
456 @b{define(baz,defn(<QUOTE>foo<UNQUOTE>))}
457 @b{baz}
458 @b{C-d}
459 m4: End of input: 0: fatal error: EOF in string
460 @end smallexample
461
462 @noindent
463 Let us use @value{GDBN} to try to see what is going on.
464
465 @smallexample
466 $ @b{@value{GDBP} m4}
467 @c FIXME: this falsifies the exact text played out, to permit smallbook
468 @c FIXME... format to come out better.
469 @value{GDBN} is free software and you are welcome to distribute copies
470  of it under certain conditions; type "show copying" to see
471  the conditions.
472 There is absolutely no warranty for @value{GDBN}; type "show warranty"
473  for details.
474
475 @value{GDBN} @value{GDBVN}, Copyright 1999 Free Software Foundation, Inc...
476 (@value{GDBP})
477 @end smallexample
478
479 @noindent
480 @value{GDBN} reads only enough symbol data to know where to find the
481 rest when needed; as a result, the first prompt comes up very quickly.
482 We now tell @value{GDBN} to use a narrower display width than usual, so
483 that examples fit in this manual.
484
485 @smallexample
486 (@value{GDBP}) @b{set width 70}
487 @end smallexample
488
489 @noindent
490 We need to see how the @code{m4} built-in @code{changequote} works.
491 Having looked at the source, we know the relevant subroutine is
492 @code{m4_changequote}, so we set a breakpoint there with the @value{GDBN}
493 @code{break} command.
494
495 @smallexample
496 (@value{GDBP}) @b{break m4_changequote}
497 Breakpoint 1 at 0x62f4: file builtin.c, line 879.
498 @end smallexample
499
500 @noindent
501 Using the @code{run} command, we start @code{m4} running under @value{GDBN}
502 control; as long as control does not reach the @code{m4_changequote}
503 subroutine, the program runs as usual:
504
505 @smallexample
506 (@value{GDBP}) @b{run}
507 Starting program: /work/Editorial/gdb/gnu/m4/m4
508 @b{define(foo,0000)}
509
510 @b{foo}
511 0000
512 @end smallexample
513
514 @noindent
515 To trigger the breakpoint, we call @code{changequote}.  @value{GDBN}
516 suspends execution of @code{m4}, displaying information about the
517 context where it stops.
518
519 @smallexample
520 @b{changequote(<QUOTE>,<UNQUOTE>)}
521
522 Breakpoint 1, m4_changequote (argc=3, argv=0x33c70)
523     at builtin.c:879
524 879         if (bad_argc(TOKEN_DATA_TEXT(argv[0]),argc,1,3))
525 @end smallexample
526
527 @noindent
528 Now we use the command @code{n} (@code{next}) to advance execution to
529 the next line of the current function.
530
531 @smallexample
532 (@value{GDBP}) @b{n}
533 882         set_quotes((argc >= 2) ? TOKEN_DATA_TEXT(argv[1])\
534  : nil,
535 @end smallexample
536
537 @noindent
538 @code{set_quotes} looks like a promising subroutine.  We can go into it
539 by using the command @code{s} (@code{step}) instead of @code{next}.
540 @code{step} goes to the next line to be executed in @emph{any}
541 subroutine, so it steps into @code{set_quotes}.
542
543 @smallexample
544 (@value{GDBP}) @b{s}
545 set_quotes (lq=0x34c78 "<QUOTE>", rq=0x34c88 "<UNQUOTE>")
546     at input.c:530
547 530         if (lquote != def_lquote)
548 @end smallexample
549
550 @noindent
551 The display that shows the subroutine where @code{m4} is now
552 suspended (and its arguments) is called a stack frame display.  It
553 shows a summary of the stack.  We can use the @code{backtrace}
554 command (which can also be spelled @code{bt}), to see where we are
555 in the stack as a whole: the @code{backtrace} command displays a
556 stack frame for each active subroutine.
557
558 @smallexample
559 (@value{GDBP}) @b{bt}
560 #0  set_quotes (lq=0x34c78 "<QUOTE>", rq=0x34c88 "<UNQUOTE>")
561     at input.c:530
562 #1  0x6344 in m4_changequote (argc=3, argv=0x33c70)
563     at builtin.c:882
564 #2  0x8174 in expand_macro (sym=0x33320) at macro.c:242
565 #3  0x7a88 in expand_token (obs=0x0, t=209696, td=0xf7fffa30)
566     at macro.c:71
567 #4  0x79dc in expand_input () at macro.c:40
568 #5  0x2930 in main (argc=0, argv=0xf7fffb20) at m4.c:195
569 @end smallexample
570
571 @noindent
572 We step through a few more lines to see what happens.  The first two
573 times, we can use @samp{s}; the next two times we use @code{n} to avoid
574 falling into the @code{xstrdup} subroutine.
575
576 @smallexample
577 (@value{GDBP}) @b{s}
578 0x3b5c  532         if (rquote != def_rquote)
579 (@value{GDBP}) @b{s}
580 0x3b80  535         lquote = (lq == nil || *lq == '\0') ?  \
581 def_lquote : xstrdup(lq);
582 (@value{GDBP}) @b{n}
583 536         rquote = (rq == nil || *rq == '\0') ? def_rquote\
584  : xstrdup(rq);
585 (@value{GDBP}) @b{n}
586 538         len_lquote = strlen(rquote);
587 @end smallexample
588
589 @noindent
590 The last line displayed looks a little odd; we can examine the variables
591 @code{lquote} and @code{rquote} to see if they are in fact the new left
592 and right quotes we specified.  We use the command @code{p}
593 (@code{print}) to see their values.
594
595 @smallexample
596 (@value{GDBP}) @b{p lquote}
597 $1 = 0x35d40 "<QUOTE>"
598 (@value{GDBP}) @b{p rquote}
599 $2 = 0x35d50 "<UNQUOTE>"
600 @end smallexample
601
602 @noindent
603 @code{lquote} and @code{rquote} are indeed the new left and right quotes.
604 To look at some context, we can display ten lines of source
605 surrounding the current line with the @code{l} (@code{list}) command.
606
607 @smallexample
608 (@value{GDBP}) @b{l}
609 533             xfree(rquote);
610 534
611 535         lquote = (lq == nil || *lq == '\0') ? def_lquote\
612  : xstrdup (lq);
613 536         rquote = (rq == nil || *rq == '\0') ? def_rquote\
614  : xstrdup (rq);
615 537
616 538         len_lquote = strlen(rquote);
617 539         len_rquote = strlen(lquote);
618 540     @}
619 541
620 542     void
621 @end smallexample
622
623 @noindent
624 Let us step past the two lines that set @code{len_lquote} and
625 @code{len_rquote}, and then examine the values of those variables.
626
627 @smallexample
628 (@value{GDBP}) @b{n}
629 539         len_rquote = strlen(lquote);
630 (@value{GDBP}) @b{n}
631 540     @}
632 (@value{GDBP}) @b{p len_lquote}
633 $3 = 9
634 (@value{GDBP}) @b{p len_rquote}
635 $4 = 7
636 @end smallexample
637
638 @noindent
639 That certainly looks wrong, assuming @code{len_lquote} and
640 @code{len_rquote} are meant to be the lengths of @code{lquote} and
641 @code{rquote} respectively.  We can set them to better values using
642 the @code{p} command, since it can print the value of
643 any expression---and that expression can include subroutine calls and
644 assignments.
645
646 @smallexample
647 (@value{GDBP}) @b{p len_lquote=strlen(lquote)}
648 $5 = 7
649 (@value{GDBP}) @b{p len_rquote=strlen(rquote)}
650 $6 = 9
651 @end smallexample
652
653 @noindent
654 Is that enough to fix the problem of using the new quotes with the
655 @code{m4} built-in @code{defn}?  We can allow @code{m4} to continue
656 executing with the @code{c} (@code{continue}) command, and then try the
657 example that caused trouble initially:
658
659 @smallexample
660 (@value{GDBP}) @b{c}
661 Continuing.
662
663 @b{define(baz,defn(<QUOTE>foo<UNQUOTE>))}
664
665 baz
666 0000
667 @end smallexample
668
669 @noindent
670 Success!  The new quotes now work just as well as the default ones.  The
671 problem seems to have been just the two typos defining the wrong
672 lengths.  We allow @code{m4} exit by giving it an EOF as input:
673
674 @smallexample
675 @b{C-d}
676 Program exited normally.
677 @end smallexample
678
679 @noindent
680 The message @samp{Program exited normally.} is from @value{GDBN}; it
681 indicates @code{m4} has finished executing.  We can end our @value{GDBN}
682 session with the @value{GDBN} @code{quit} command.
683
684 @smallexample
685 (@value{GDBP}) @b{quit}
686 @end smallexample
687
688 @node Invocation
689 @chapter Getting In and Out of @value{GDBN}
690
691 This chapter discusses how to start @value{GDBN}, and how to get out of it.
692 The essentials are:
693 @itemize @bullet
694 @item
695 type @samp{@value{GDBP}} to start @value{GDBN}.
696 @item
697 type @kbd{quit} or @kbd{C-d} to exit.
698 @end itemize
699
700 @menu
701 * Invoking GDB::                How to start @value{GDBN}
702 * Quitting GDB::                How to quit @value{GDBN}
703 * Shell Commands::              How to use shell commands inside @value{GDBN}
704 @end menu
705
706 @node Invoking GDB
707 @section Invoking @value{GDBN}
708
709 Invoke @value{GDBN} by running the program @code{@value{GDBP}}.  Once started,
710 @value{GDBN} reads commands from the terminal until you tell it to exit.
711
712 You can also run @code{@value{GDBP}} with a variety of arguments and options,
713 to specify more of your debugging environment at the outset.
714
715 The command-line options described here are designed
716 to cover a variety of situations; in some environments, some of these
717 options may effectively be unavailable.
718
719 The most usual way to start @value{GDBN} is with one argument,
720 specifying an executable program:
721
722 @example
723 @value{GDBP} @var{program}
724 @end example
725
726 @noindent
727 You can also start with both an executable program and a core file
728 specified:
729
730 @example
731 @value{GDBP} @var{program} @var{core}
732 @end example
733
734 You can, instead, specify a process ID as a second argument, if you want
735 to debug a running process:
736
737 @example
738 @value{GDBP} @var{program} 1234
739 @end example
740
741 @noindent
742 would attach @value{GDBN} to process @code{1234} (unless you also have a file
743 named @file{1234}; @value{GDBN} does check for a core file first).
744
745 Taking advantage of the second command-line argument requires a fairly
746 complete operating system; when you use @value{GDBN} as a remote
747 debugger attached to a bare board, there may not be any notion of
748 ``process'', and there is often no way to get a core dump.  @value{GDBN}
749 will warn you if it is unable to attach or to read core dumps.
750
751 You can run @code{@value{GDBP}} without printing the front material, which describes
752 @value{GDBN}'s non-warranty, by specifying @code{-silent}:
753
754 @smallexample
755 @value{GDBP} -silent
756 @end smallexample
757
758 @noindent
759 You can further control how @value{GDBN} starts up by using command-line
760 options.  @value{GDBN} itself can remind you of the options available.
761
762 @noindent
763 Type
764
765 @example
766 @value{GDBP} -help
767 @end example
768
769 @noindent
770 to display all available options and briefly describe their use
771 (@samp{@value{GDBP} -h} is a shorter equivalent).
772
773 All options and command line arguments you give are processed
774 in sequential order.  The order makes a difference when the
775 @samp{-x} option is used.
776
777
778 @menu
779 * File Options::                Choosing files
780 * Mode Options::                Choosing modes
781 @end menu
782
783 @node File Options
784 @subsection Choosing files
785
786 When @value{GDBN} starts, it reads any arguments other than options as
787 specifying an executable file and core file (or process ID).  This is
788 the same as if the arguments were specified by the @samp{-se} and
789 @samp{-c} options respectively.  (@value{GDBN} reads the first argument
790 that does not have an associated option flag as equivalent to the
791 @samp{-se} option followed by that argument; and the second argument
792 that does not have an associated option flag, if any, as equivalent to
793 the @samp{-c} option followed by that argument.)
794
795 If @value{GDBN} has not been configured to included core file support,
796 such as for most embedded targets, then it will complain about a second
797 argument and ignore it.
798
799 Many options have both long and short forms; both are shown in the
800 following list.  @value{GDBN} also recognizes the long forms if you truncate
801 them, so long as enough of the option is present to be unambiguous.
802 (If you prefer, you can flag option arguments with @samp{--} rather
803 than @samp{-}, though we illustrate the more usual convention.)
804
805 @c NOTE: the @cindex entries here use double dashes ON PURPOSE.  This
806 @c way, both those who look for -foo and --foo in the index, will find
807 @c it.
808
809 @table @code
810 @item -symbols @var{file}
811 @itemx -s @var{file}
812 @cindex @code{--symbols}
813 @cindex @code{-s}
814 Read symbol table from file @var{file}.
815
816 @item -exec @var{file}
817 @itemx -e @var{file}
818 @cindex @code{--exec}
819 @cindex @code{-e}
820 Use file @var{file} as the executable file to execute when appropriate,
821 and for examining pure data in conjunction with a core dump.
822
823 @item -se @var{file}
824 @cindex @code{--se}
825 Read symbol table from file @var{file} and use it as the executable
826 file.
827
828 @item -core @var{file}
829 @itemx -c @var{file}
830 @cindex @code{--core}
831 @cindex @code{-c}
832 Use file @var{file} as a core dump to examine.
833
834 @item -c @var{number}
835 Connect to process ID @var{number}, as with the @code{attach} command
836 (unless there is a file in core-dump format named @var{number}, in which
837 case @samp{-c} specifies that file as a core dump to read).
838
839 @item -command @var{file}
840 @itemx -x @var{file}
841 @cindex @code{--command}
842 @cindex @code{-x}
843 Execute @value{GDBN} commands from file @var{file}.  @xref{Command
844 Files,, Command files}.
845
846 @item -directory @var{directory}
847 @itemx -d @var{directory}
848 @cindex @code{--directory}
849 @cindex @code{-d}
850 Add @var{directory} to the path to search for source files.
851
852 @item -m
853 @itemx -mapped
854 @cindex @code{--mapped}
855 @cindex @code{-m}
856 @emph{Warning: this option depends on operating system facilities that are not
857 supported on all systems.}@*
858 If memory-mapped files are available on your system through the @code{mmap}
859 system call, you can use this option
860 to have @value{GDBN} write the symbols from your
861 program into a reusable file in the current directory.  If the program you are debugging is
862 called @file{/tmp/fred}, the mapped symbol file is @file{/tmp/fred.syms}.
863 Future @value{GDBN} debugging sessions notice the presence of this file,
864 and can quickly map in symbol information from it, rather than reading
865 the symbol table from the executable program.
866
867 The @file{.syms} file is specific to the host machine where @value{GDBN}
868 is run.  It holds an exact image of the internal @value{GDBN} symbol
869 table.  It cannot be shared across multiple host platforms.
870
871 @item -r
872 @itemx -readnow
873 @cindex @code{--readnow}
874 @cindex @code{-r}
875 Read each symbol file's entire symbol table immediately, rather than
876 the default, which is to read it incrementally as it is needed.
877 This makes startup slower, but makes future operations faster.
878
879 @end table
880
881 You typically combine the @code{-mapped} and @code{-readnow} options in
882 order to build a @file{.syms} file that contains complete symbol
883 information.  (@xref{Files,,Commands to specify files}, for information
884 on @file{.syms} files.)  A simple @value{GDBN} invocation to do nothing
885 but build a @file{.syms} file for future use is:
886
887 @example
888 gdb -batch -nx -mapped -readnow programname
889 @end example
890
891 @node Mode Options
892 @subsection Choosing modes
893
894 You can run @value{GDBN} in various alternative modes---for example, in
895 batch mode or quiet mode.
896
897 @table @code
898 @item -nx
899 @itemx -n
900 @cindex @code{--nx}
901 @cindex @code{-n}
902 Do not execute commands found in any initialization files (normally
903 called @file{.gdbinit}, or @file{gdb.ini} on PCs).  Normally,
904 @value{GDBN} executes the commands in these files after all the command
905 options and arguments have been processed.  @xref{Command Files,,Command
906 files}.
907
908 @item -quiet
909 @itemx -silent
910 @itemx -q
911 @cindex @code{--quiet}
912 @cindex @code{--silent}
913 @cindex @code{-q}
914 ``Quiet''.  Do not print the introductory and copyright messages.  These
915 messages are also suppressed in batch mode.
916
917 @item -batch
918 @cindex @code{--batch}
919 Run in batch mode.  Exit with status @code{0} after processing all the
920 command files specified with @samp{-x} (and all commands from
921 initialization files, if not inhibited with @samp{-n}).  Exit with
922 nonzero status if an error occurs in executing the @value{GDBN} commands
923 in the command files.
924
925 Batch mode may be useful for running @value{GDBN} as a filter, for
926 example to download and run a program on another computer; in order to
927 make this more useful, the message
928
929 @example
930 Program exited normally.
931 @end example
932
933 @noindent
934 (which is ordinarily issued whenever a program running under
935 @value{GDBN} control terminates) is not issued when running in batch
936 mode.
937
938 @item -nowindows
939 @itemx -nw
940 @cindex @code{--nowindows}
941 @cindex @code{-nw}
942 ``No windows''.  If @value{GDBN} comes with a graphical user interface
943 (GUI) built in, then this option tells @value{GDBN} to only use the command-line
944 interface.  If no GUI is available, this option has no effect.
945
946 @item -windows
947 @itemx -w
948 @cindex @code{--windows}
949 @cindex @code{-w}
950 If @value{GDBN} includes a GUI, then this option requires it to be
951 used if possible.
952
953 @item -cd @var{directory}
954 @cindex @code{--cd}
955 Run @value{GDBN} using @var{directory} as its working directory,
956 instead of the current directory.
957
958 @item -fullname
959 @itemx -f
960 @cindex @code{--fullname}
961 @cindex @code{-f}
962 @sc{gnu} Emacs sets this option when it runs @value{GDBN} as a
963 subprocess.  It tells @value{GDBN} to output the full file name and line
964 number in a standard, recognizable fashion each time a stack frame is
965 displayed (which includes each time your program stops).  This
966 recognizable format looks like two @samp{\032} characters, followed by
967 the file name, line number and character position separated by colons,
968 and a newline.  The Emacs-to-@value{GDBN} interface program uses the two
969 @samp{\032} characters as a signal to display the source code for the
970 frame.
971
972 @item -epoch
973 @cindex @code{--epoch}
974 The Epoch Emacs-@value{GDBN} interface sets this option when it runs
975 @value{GDBN} as a subprocess.  It tells @value{GDBN} to modify its print
976 routines so as to allow Epoch to display values of expressions in a
977 separate window.
978
979 @item -annotate @var{level}
980 @cindex @code{--annotate}
981 This option sets the @dfn{annotation level} inside @value{GDBN}.  Its
982 effect is identical to using @samp{set annotate @var{level}}
983 (@pxref{Annotations}).
984 Annotation level controls how much information does @value{GDBN} print
985 together with its prompt, values of expressions, source lines, and other
986 types of output.  Level 0 is the normal, level 1 is for use when
987 @value{GDBN} is run as a subprocess of @sc{gnu} Emacs, level 2 is the
988 maximum annotation suitable for programs that control @value{GDBN}.
989
990 @item -async
991 @cindex @code{--async}
992 Use the asynchronous event loop for the command-line interface.
993 @value{GDBN} processes all events, such as user keyboard input, via a
994 special event loop.  This allows @value{GDBN} to accept and process user
995 commands in parallel with the debugged process being
996 run@footnote{@value{GDBN} built with @sc{djgpp} tools for
997 MS-DOS/MS-Windows supports this mode of operation, but the event loop is
998 suspended when the debuggee runs.}, so you don't need to wait for
999 control to return to @value{GDBN} before you type the next command.
1000 (@emph{Note:} as of version 5.1, the target side of the asynchronous
1001 operation is not yet in place, so @samp{-async} does not work fully
1002 yet.)
1003 @c FIXME: when the target side of the event loop is done, the above NOTE
1004 @c should be removed.
1005
1006 When the standard input is connected to a terminal device, @value{GDBN}
1007 uses the asynchronous event loop by default, unless disabled by the
1008 @samp{-noasync} option.
1009
1010 @item -noasync
1011 @cindex @code{--noasync}
1012 Disable the asynchronous event loop for the command-line interface.
1013
1014 @item -baud @var{bps}
1015 @itemx -b @var{bps}
1016 @cindex @code{--baud}
1017 @cindex @code{-b}
1018 Set the line speed (baud rate or bits per second) of any serial
1019 interface used by @value{GDBN} for remote debugging.
1020
1021 @item -tty @var{device}
1022 @itemx -t @var{device}
1023 @cindex @code{--tty}
1024 @cindex @code{-t}
1025 Run using @var{device} for your program's standard input and output.
1026 @c FIXME: kingdon thinks there is more to -tty.  Investigate.
1027
1028 @c resolve the situation of these eventually
1029 @c @item -tui
1030 @c @cindex @code{--tui}
1031 @c Use a Terminal User Interface.  For information, use your Web browser to
1032 @c read the file @file{TUI.html}, which is usually installed in the
1033 @c directory @code{/opt/langtools/wdb/doc} on HP-UX systems.  Do not use
1034 @c this option if you run @value{GDBN} from Emacs (see @pxref{Emacs, ,Using
1035 @c @value{GDBN} under @sc{gnu} Emacs}).
1036
1037 @c @item -xdb
1038 @c @cindex @code{--xdb}
1039 @c Run in XDB compatibility mode, allowing the use of certain XDB commands.
1040 @c For information, see the file @file{xdb_trans.html}, which is usually
1041 @c installed in the directory @code{/opt/langtools/wdb/doc} on HP-UX
1042 @c systems.
1043
1044 @item -interpreter @var{interp}
1045 @cindex @code{--interpreter}
1046 Use the interpreter @var{interp} for interface with the controlling
1047 program or device.  This option is meant to be set by programs which
1048 communicate with @value{GDBN} using it as a back end.  For example,
1049 @samp{--interpreter=mi} causes @value{GDBN} to use the @dfn{gdbmi
1050 interface} (@pxref{GDB/MI, , The @sc{gdb/mi} Interface}).
1051
1052 @item -write
1053 @cindex @code{--write}
1054 Open the executable and core files for both reading and writing.  This
1055 is equivalent to the @samp{set write on} command inside @value{GDBN}
1056 (@pxref{Patching}).
1057
1058 @item -statistics
1059 @cindex @code{--statistics}
1060 This option causes @value{GDBN} to print statistics about time and
1061 memory usage after it completes each command and returns to the prompt.
1062
1063 @item -version
1064 @cindex @code{--version}
1065 This option causes @value{GDBN} to print its version number and
1066 no-warranty blurb, and exit.
1067
1068 @end table
1069
1070 @node Quitting GDB
1071 @section Quitting @value{GDBN}
1072 @cindex exiting @value{GDBN}
1073 @cindex leaving @value{GDBN}
1074
1075 @table @code
1076 @kindex quit @r{[}@var{expression}@r{]}
1077 @kindex q @r{(@code{quit})}
1078 @item quit @r{[}@var{expression}@r{]}
1079 @itemx q
1080 To exit @value{GDBN}, use the @code{quit} command (abbreviated
1081 @code{q}), or type an end-of-file character (usually @kbd{C-d}).  If you
1082 do not supply @var{expression}, @value{GDBN} will terminate normally;
1083 otherwise it will terminate using the result of @var{expression} as the
1084 error code.
1085 @end table
1086
1087 @cindex interrupt
1088 An interrupt (often @kbd{C-c}) does not exit from @value{GDBN}, but rather
1089 terminates the action of any @value{GDBN} command that is in progress and
1090 returns to @value{GDBN} command level.  It is safe to type the interrupt
1091 character at any time because @value{GDBN} does not allow it to take effect
1092 until a time when it is safe.
1093
1094 If you have been using @value{GDBN} to control an attached process or
1095 device, you can release it with the @code{detach} command
1096 (@pxref{Attach, ,Debugging an already-running process}).
1097
1098 @node Shell Commands
1099 @section Shell commands
1100
1101 If you need to execute occasional shell commands during your
1102 debugging session, there is no need to leave or suspend @value{GDBN}; you can
1103 just use the @code{shell} command.
1104
1105 @table @code
1106 @kindex shell
1107 @cindex shell escape
1108 @item shell @var{command string}
1109 Invoke a standard shell to execute @var{command string}.
1110 If it exists, the environment variable @code{SHELL} determines which
1111 shell to run.  Otherwise @value{GDBN} uses the default shell
1112 (@file{/bin/sh} on Unix systems, @file{COMMAND.COM} on MS-DOS, etc.).
1113 @end table
1114
1115 The utility @code{make} is often needed in development environments.
1116 You do not have to use the @code{shell} command for this purpose in
1117 @value{GDBN}:
1118
1119 @table @code
1120 @kindex make
1121 @cindex calling make
1122 @item make @var{make-args}
1123 Execute the @code{make} program with the specified
1124 arguments.  This is equivalent to @samp{shell make @var{make-args}}.
1125 @end table
1126
1127 @node Commands
1128 @chapter @value{GDBN} Commands
1129
1130 You can abbreviate a @value{GDBN} command to the first few letters of the command
1131 name, if that abbreviation is unambiguous; and you can repeat certain
1132 @value{GDBN} commands by typing just @key{RET}.  You can also use the @key{TAB}
1133 key to get @value{GDBN} to fill out the rest of a word in a command (or to
1134 show you the alternatives available, if there is more than one possibility).
1135
1136 @menu
1137 * Command Syntax::              How to give commands to @value{GDBN}
1138 * Completion::                  Command completion
1139 * Help::                        How to ask @value{GDBN} for help
1140 @end menu
1141
1142 @node Command Syntax
1143 @section Command syntax
1144
1145 A @value{GDBN} command is a single line of input.  There is no limit on
1146 how long it can be.  It starts with a command name, which is followed by
1147 arguments whose meaning depends on the command name.  For example, the
1148 command @code{step} accepts an argument which is the number of times to
1149 step, as in @samp{step 5}.  You can also use the @code{step} command
1150 with no arguments.  Some commands do not allow any arguments.
1151
1152 @cindex abbreviation
1153 @value{GDBN} command names may always be truncated if that abbreviation is
1154 unambiguous.  Other possible command abbreviations are listed in the
1155 documentation for individual commands.  In some cases, even ambiguous
1156 abbreviations are allowed; for example, @code{s} is specially defined as
1157 equivalent to @code{step} even though there are other commands whose
1158 names start with @code{s}.  You can test abbreviations by using them as
1159 arguments to the @code{help} command.
1160
1161 @cindex repeating commands
1162 @kindex RET @r{(repeat last command)}
1163 A blank line as input to @value{GDBN} (typing just @key{RET}) means to
1164 repeat the previous command.  Certain commands (for example, @code{run})
1165 will not repeat this way; these are commands whose unintentional
1166 repetition might cause trouble and which you are unlikely to want to
1167 repeat.
1168
1169 The @code{list} and @code{x} commands, when you repeat them with
1170 @key{RET}, construct new arguments rather than repeating
1171 exactly as typed.  This permits easy scanning of source or memory.
1172
1173 @value{GDBN} can also use @key{RET} in another way: to partition lengthy
1174 output, in a way similar to the common utility @code{more}
1175 (@pxref{Screen Size,,Screen size}).  Since it is easy to press one
1176 @key{RET} too many in this situation, @value{GDBN} disables command
1177 repetition after any command that generates this sort of display.
1178
1179 @kindex # @r{(a comment)}
1180 @cindex comment
1181 Any text from a @kbd{#} to the end of the line is a comment; it does
1182 nothing.  This is useful mainly in command files (@pxref{Command
1183 Files,,Command files}).
1184
1185 @node Completion
1186 @section Command completion
1187
1188 @cindex completion
1189 @cindex word completion
1190 @value{GDBN} can fill in the rest of a word in a command for you, if there is
1191 only one possibility; it can also show you what the valid possibilities
1192 are for the next word in a command, at any time.  This works for @value{GDBN}
1193 commands, @value{GDBN} subcommands, and the names of symbols in your program.
1194
1195 Press the @key{TAB} key whenever you want @value{GDBN} to fill out the rest
1196 of a word.  If there is only one possibility, @value{GDBN} fills in the
1197 word, and waits for you to finish the command (or press @key{RET} to
1198 enter it).  For example, if you type
1199
1200 @c FIXME "@key" does not distinguish its argument sufficiently to permit
1201 @c complete accuracy in these examples; space introduced for clarity.
1202 @c If texinfo enhancements make it unnecessary, it would be nice to
1203 @c replace " @key" by "@key" in the following...
1204 @example
1205 (@value{GDBP}) info bre @key{TAB}
1206 @end example
1207
1208 @noindent
1209 @value{GDBN} fills in the rest of the word @samp{breakpoints}, since that is
1210 the only @code{info} subcommand beginning with @samp{bre}:
1211
1212 @example
1213 (@value{GDBP}) info breakpoints
1214 @end example
1215
1216 @noindent
1217 You can either press @key{RET} at this point, to run the @code{info
1218 breakpoints} command, or backspace and enter something else, if
1219 @samp{breakpoints} does not look like the command you expected.  (If you
1220 were sure you wanted @code{info breakpoints} in the first place, you
1221 might as well just type @key{RET} immediately after @samp{info bre},
1222 to exploit command abbreviations rather than command completion).
1223
1224 If there is more than one possibility for the next word when you press
1225 @key{TAB}, @value{GDBN} sounds a bell.  You can either supply more
1226 characters and try again, or just press @key{TAB} a second time;
1227 @value{GDBN} displays all the possible completions for that word.  For
1228 example, you might want to set a breakpoint on a subroutine whose name
1229 begins with @samp{make_}, but when you type @kbd{b make_@key{TAB}} @value{GDBN}
1230 just sounds the bell.  Typing @key{TAB} again displays all the
1231 function names in your program that begin with those characters, for
1232 example:
1233
1234 @example
1235 (@value{GDBP}) b make_ @key{TAB}
1236 @exdent @value{GDBN} sounds bell; press @key{TAB} again, to see:
1237 make_a_section_from_file     make_environ
1238 make_abs_section             make_function_type
1239 make_blockvector             make_pointer_type
1240 make_cleanup                 make_reference_type
1241 make_command                 make_symbol_completion_list
1242 (@value{GDBP}) b make_
1243 @end example
1244
1245 @noindent
1246 After displaying the available possibilities, @value{GDBN} copies your
1247 partial input (@samp{b make_} in the example) so you can finish the
1248 command.
1249
1250 If you just want to see the list of alternatives in the first place, you
1251 can press @kbd{M-?} rather than pressing @key{TAB} twice.  @kbd{M-?}
1252 means @kbd{@key{META} ?}.  You can type this either by holding down a
1253 key designated as the @key{META} shift on your keyboard (if there is
1254 one) while typing @kbd{?}, or as @key{ESC} followed by @kbd{?}.
1255
1256 @cindex quotes in commands
1257 @cindex completion of quoted strings
1258 Sometimes the string you need, while logically a ``word'', may contain
1259 parentheses or other characters that @value{GDBN} normally excludes from
1260 its notion of a word.  To permit word completion to work in this
1261 situation, you may enclose words in @code{'} (single quote marks) in
1262 @value{GDBN} commands.
1263
1264 The most likely situation where you might need this is in typing the
1265 name of a C@t{++} function.  This is because C@t{++} allows function
1266 overloading (multiple definitions of the same function, distinguished
1267 by argument type).  For example, when you want to set a breakpoint you
1268 may need to distinguish whether you mean the version of @code{name}
1269 that takes an @code{int} parameter, @code{name(int)}, or the version
1270 that takes a @code{float} parameter, @code{name(float)}.  To use the
1271 word-completion facilities in this situation, type a single quote
1272 @code{'} at the beginning of the function name.  This alerts
1273 @value{GDBN} that it may need to consider more information than usual
1274 when you press @key{TAB} or @kbd{M-?} to request word completion:
1275
1276 @example
1277 (@value{GDBP}) b 'bubble( @kbd{M-?}
1278 bubble(double,double)    bubble(int,int)
1279 (@value{GDBP}) b 'bubble(
1280 @end example
1281
1282 In some cases, @value{GDBN} can tell that completing a name requires using
1283 quotes.  When this happens, @value{GDBN} inserts the quote for you (while
1284 completing as much as it can) if you do not type the quote in the first
1285 place:
1286
1287 @example
1288 (@value{GDBP}) b bub @key{TAB}
1289 @exdent @value{GDBN} alters your input line to the following, and rings a bell:
1290 (@value{GDBP}) b 'bubble(
1291 @end example
1292
1293 @noindent
1294 In general, @value{GDBN} can tell that a quote is needed (and inserts it) if
1295 you have not yet started typing the argument list when you ask for
1296 completion on an overloaded symbol.
1297
1298 For more information about overloaded functions, see @ref{C plus plus
1299 expressions, ,C@t{++} expressions}.  You can use the command @code{set
1300 overload-resolution off} to disable overload resolution;
1301 see @ref{Debugging C plus plus, ,@value{GDBN} features for C@t{++}}.
1302
1303
1304 @node Help
1305 @section Getting help
1306 @cindex online documentation
1307 @kindex help
1308
1309 You can always ask @value{GDBN} itself for information on its commands,
1310 using the command @code{help}.
1311
1312 @table @code
1313 @kindex h @r{(@code{help})}
1314 @item help
1315 @itemx h
1316 You can use @code{help} (abbreviated @code{h}) with no arguments to
1317 display a short list of named classes of commands:
1318
1319 @smallexample
1320 (@value{GDBP}) help
1321 List of classes of commands:
1322
1323 aliases -- Aliases of other commands
1324 breakpoints -- Making program stop at certain points
1325 data -- Examining data
1326 files -- Specifying and examining files
1327 internals -- Maintenance commands
1328 obscure -- Obscure features
1329 running -- Running the program
1330 stack -- Examining the stack
1331 status -- Status inquiries
1332 support -- Support facilities
1333 tracepoints -- Tracing of program execution without@*
1334                stopping the program
1335 user-defined -- User-defined commands
1336
1337 Type "help" followed by a class name for a list of
1338 commands in that class.
1339 Type "help" followed by command name for full
1340 documentation.
1341 Command name abbreviations are allowed if unambiguous.
1342 (@value{GDBP})
1343 @end smallexample
1344 @c the above line break eliminates huge line overfull...
1345
1346 @item help @var{class}
1347 Using one of the general help classes as an argument, you can get a
1348 list of the individual commands in that class.  For example, here is the
1349 help display for the class @code{status}:
1350
1351 @smallexample
1352 (@value{GDBP}) help status
1353 Status inquiries.
1354
1355 List of commands:
1356
1357 @c Line break in "show" line falsifies real output, but needed
1358 @c to fit in smallbook page size.
1359 info -- Generic command for showing things
1360  about the program being debugged
1361 show -- Generic command for showing things
1362  about the debugger
1363
1364 Type "help" followed by command name for full
1365 documentation.
1366 Command name abbreviations are allowed if unambiguous.
1367 (@value{GDBP})
1368 @end smallexample
1369
1370 @item help @var{command}
1371 With a command name as @code{help} argument, @value{GDBN} displays a
1372 short paragraph on how to use that command.
1373
1374 @kindex apropos
1375 @item apropos @var{args}
1376 The @code{apropos @var{args}} command searches through all of the @value{GDBN}
1377 commands, and their documentation, for the regular expression specified in
1378 @var{args}. It prints out all matches found. For example:
1379
1380 @smallexample
1381 apropos reload
1382 @end smallexample
1383
1384 @noindent
1385 results in:
1386
1387 @smallexample
1388 @c @group
1389 set symbol-reloading -- Set dynamic symbol table reloading
1390                                  multiple times in one run
1391 show symbol-reloading -- Show dynamic symbol table reloading
1392                                  multiple times in one run
1393 @c @end group
1394 @end smallexample
1395
1396 @kindex complete
1397 @item complete @var{args}
1398 The @code{complete @var{args}} command lists all the possible completions
1399 for the beginning of a command.  Use @var{args} to specify the beginning of the
1400 command you want completed.  For example:
1401
1402 @smallexample
1403 complete i
1404 @end smallexample
1405
1406 @noindent results in:
1407
1408 @smallexample
1409 @group
1410 if
1411 ignore
1412 info
1413 inspect
1414 @end group
1415 @end smallexample
1416
1417 @noindent This is intended for use by @sc{gnu} Emacs.
1418 @end table
1419
1420 In addition to @code{help}, you can use the @value{GDBN} commands @code{info}
1421 and @code{show} to inquire about the state of your program, or the state
1422 of @value{GDBN} itself.  Each command supports many topics of inquiry; this
1423 manual introduces each of them in the appropriate context.  The listings
1424 under @code{info} and under @code{show} in the Index point to
1425 all the sub-commands.  @xref{Index}.
1426
1427 @c @group
1428 @table @code
1429 @kindex info
1430 @kindex i @r{(@code{info})}
1431 @item info
1432 This command (abbreviated @code{i}) is for describing the state of your
1433 program.  For example, you can list the arguments given to your program
1434 with @code{info args}, list the registers currently in use with @code{info
1435 registers}, or list the breakpoints you have set with @code{info breakpoints}.
1436 You can get a complete list of the @code{info} sub-commands with
1437 @w{@code{help info}}.
1438
1439 @kindex set
1440 @item set
1441 You can assign the result of an expression to an environment variable with
1442 @code{set}.  For example, you can set the @value{GDBN} prompt to a $-sign with
1443 @code{set prompt $}.
1444
1445 @kindex show
1446 @item show
1447 In contrast to @code{info}, @code{show} is for describing the state of
1448 @value{GDBN} itself.
1449 You can change most of the things you can @code{show}, by using the
1450 related command @code{set}; for example, you can control what number
1451 system is used for displays with @code{set radix}, or simply inquire
1452 which is currently in use with @code{show radix}.
1453
1454 @kindex info set
1455 To display all the settable parameters and their current
1456 values, you can use @code{show} with no arguments; you may also use
1457 @code{info set}.  Both commands produce the same display.
1458 @c FIXME: "info set" violates the rule that "info" is for state of
1459 @c FIXME...program.  Ck w/ GNU: "info set" to be called something else,
1460 @c FIXME...or change desc of rule---eg "state of prog and debugging session"?
1461 @end table
1462 @c @end group
1463
1464 Here are three miscellaneous @code{show} subcommands, all of which are
1465 exceptional in lacking corresponding @code{set} commands:
1466
1467 @table @code
1468 @kindex show version
1469 @cindex version number
1470 @item show version
1471 Show what version of @value{GDBN} is running.  You should include this
1472 information in @value{GDBN} bug-reports.  If multiple versions of
1473 @value{GDBN} are in use at your site, you may need to determine which
1474 version of @value{GDBN} you are running; as @value{GDBN} evolves, new
1475 commands are introduced, and old ones may wither away.  Also, many
1476 system vendors ship variant versions of @value{GDBN}, and there are
1477 variant versions of @value{GDBN} in @sc{gnu}/Linux distributions as well.
1478 The version number is the same as the one announced when you start
1479 @value{GDBN}.
1480
1481 @kindex show copying
1482 @item show copying
1483 Display information about permission for copying @value{GDBN}.
1484
1485 @kindex show warranty
1486 @item show warranty
1487 Display the @sc{gnu} ``NO WARRANTY'' statement, or a warranty,
1488 if your version of @value{GDBN} comes with one.
1489
1490 @end table
1491
1492 @node Running
1493 @chapter Running Programs Under @value{GDBN}
1494
1495 When you run a program under @value{GDBN}, you must first generate
1496 debugging information when you compile it.
1497
1498 You may start @value{GDBN} with its arguments, if any, in an environment
1499 of your choice.  If you are doing native debugging, you may redirect
1500 your program's input and output, debug an already running process, or
1501 kill a child process.
1502
1503 @menu
1504 * Compilation::                 Compiling for debugging
1505 * Starting::                    Starting your program
1506 * Arguments::                   Your program's arguments
1507 * Environment::                 Your program's environment
1508
1509 * Working Directory::           Your program's working directory
1510 * Input/Output::                Your program's input and output
1511 * Attach::                      Debugging an already-running process
1512 * Kill Process::                Killing the child process
1513
1514 * Threads::                     Debugging programs with multiple threads
1515 * Processes::                   Debugging programs with multiple processes
1516 @end menu
1517
1518 @node Compilation
1519 @section Compiling for debugging
1520
1521 In order to debug a program effectively, you need to generate
1522 debugging information when you compile it.  This debugging information
1523 is stored in the object file; it describes the data type of each
1524 variable or function and the correspondence between source line numbers
1525 and addresses in the executable code.
1526
1527 To request debugging information, specify the @samp{-g} option when you run
1528 the compiler.
1529
1530 Many C compilers are unable to handle the @samp{-g} and @samp{-O}
1531 options together.  Using those compilers, you cannot generate optimized
1532 executables containing debugging information.
1533
1534 @value{NGCC}, the @sc{gnu} C compiler, supports @samp{-g} with or
1535 without @samp{-O}, making it possible to debug optimized code.  We
1536 recommend that you @emph{always} use @samp{-g} whenever you compile a
1537 program.  You may think your program is correct, but there is no sense
1538 in pushing your luck.
1539
1540 @cindex optimized code, debugging
1541 @cindex debugging optimized code
1542 When you debug a program compiled with @samp{-g -O}, remember that the
1543 optimizer is rearranging your code; the debugger shows you what is
1544 really there.  Do not be too surprised when the execution path does not
1545 exactly match your source file!  An extreme example: if you define a
1546 variable, but never use it, @value{GDBN} never sees that
1547 variable---because the compiler optimizes it out of existence.
1548
1549 Some things do not work as well with @samp{-g -O} as with just
1550 @samp{-g}, particularly on machines with instruction scheduling.  If in
1551 doubt, recompile with @samp{-g} alone, and if this fixes the problem,
1552 please report it to us as a bug (including a test case!).
1553
1554 Older versions of the @sc{gnu} C compiler permitted a variant option
1555 @w{@samp{-gg}} for debugging information.  @value{GDBN} no longer supports this
1556 format; if your @sc{gnu} C compiler has this option, do not use it.
1557
1558 @need 2000
1559 @node Starting
1560 @section Starting your program
1561 @cindex starting
1562 @cindex running
1563
1564 @table @code
1565 @kindex run
1566 @kindex r @r{(@code{run})}
1567 @item run
1568 @itemx r
1569 Use the @code{run} command to start your program under @value{GDBN}.
1570 You must first specify the program name (except on VxWorks) with an
1571 argument to @value{GDBN} (@pxref{Invocation, ,Getting In and Out of
1572 @value{GDBN}}), or by using the @code{file} or @code{exec-file} command
1573 (@pxref{Files, ,Commands to specify files}).
1574
1575 @end table
1576
1577 If you are running your program in an execution environment that
1578 supports processes, @code{run} creates an inferior process and makes
1579 that process run your program.  (In environments without processes,
1580 @code{run} jumps to the start of your program.)
1581
1582 The execution of a program is affected by certain information it
1583 receives from its superior.  @value{GDBN} provides ways to specify this
1584 information, which you must do @emph{before} starting your program.  (You
1585 can change it after starting your program, but such changes only affect
1586 your program the next time you start it.)  This information may be
1587 divided into four categories:
1588
1589 @table @asis
1590 @item The @emph{arguments.}
1591 Specify the arguments to give your program as the arguments of the
1592 @code{run} command.  If a shell is available on your target, the shell
1593 is used to pass the arguments, so that you may use normal conventions
1594 (such as wildcard expansion or variable substitution) in describing
1595 the arguments.
1596 In Unix systems, you can control which shell is used with the
1597 @code{SHELL} environment variable.
1598 @xref{Arguments, ,Your program's arguments}.
1599
1600 @item The @emph{environment.}
1601 Your program normally inherits its environment from @value{GDBN}, but you can
1602 use the @value{GDBN} commands @code{set environment} and @code{unset
1603 environment} to change parts of the environment that affect
1604 your program.  @xref{Environment, ,Your program's environment}.
1605
1606 @item The @emph{working directory.}
1607 Your program inherits its working directory from @value{GDBN}.  You can set
1608 the @value{GDBN} working directory with the @code{cd} command in @value{GDBN}.
1609 @xref{Working Directory, ,Your program's working directory}.
1610
1611 @item The @emph{standard input and output.}
1612 Your program normally uses the same device for standard input and
1613 standard output as @value{GDBN} is using.  You can redirect input and output
1614 in the @code{run} command line, or you can use the @code{tty} command to
1615 set a different device for your program.
1616 @xref{Input/Output, ,Your program's input and output}.
1617
1618 @cindex pipes
1619 @emph{Warning:} While input and output redirection work, you cannot use
1620 pipes to pass the output of the program you are debugging to another
1621 program; if you attempt this, @value{GDBN} is likely to wind up debugging the
1622 wrong program.
1623 @end table
1624
1625 When you issue the @code{run} command, your program begins to execute
1626 immediately.  @xref{Stopping, ,Stopping and continuing}, for discussion
1627 of how to arrange for your program to stop.  Once your program has
1628 stopped, you may call functions in your program, using the @code{print}
1629 or @code{call} commands.  @xref{Data, ,Examining Data}.
1630
1631 If the modification time of your symbol file has changed since the last
1632 time @value{GDBN} read its symbols, @value{GDBN} discards its symbol
1633 table, and reads it again.  When it does this, @value{GDBN} tries to retain
1634 your current breakpoints.
1635
1636 @node Arguments
1637 @section Your program's arguments
1638
1639 @cindex arguments (to your program)
1640 The arguments to your program can be specified by the arguments of the
1641 @code{run} command.
1642 They are passed to a shell, which expands wildcard characters and
1643 performs redirection of I/O, and thence to your program.  Your
1644 @code{SHELL} environment variable (if it exists) specifies what shell
1645 @value{GDBN} uses.  If you do not define @code{SHELL}, @value{GDBN} uses
1646 the default shell (@file{/bin/sh} on Unix).
1647
1648 On non-Unix systems, the program is usually invoked directly by
1649 @value{GDBN}, which emulates I/O redirection via the appropriate system
1650 calls, and the wildcard characters are expanded by the startup code of
1651 the program, not by the shell.
1652
1653 @code{run} with no arguments uses the same arguments used by the previous
1654 @code{run}, or those set by the @code{set args} command.
1655
1656 @table @code
1657 @kindex set args
1658 @item set args
1659 Specify the arguments to be used the next time your program is run.  If
1660 @code{set args} has no arguments, @code{run} executes your program
1661 with no arguments.  Once you have run your program with arguments,
1662 using @code{set args} before the next @code{run} is the only way to run
1663 it again without arguments.
1664
1665 @kindex show args
1666 @item show args
1667 Show the arguments to give your program when it is started.
1668 @end table
1669
1670 @node Environment
1671 @section Your program's environment
1672
1673 @cindex environment (of your program)
1674 The @dfn{environment} consists of a set of environment variables and
1675 their values.  Environment variables conventionally record such things as
1676 your user name, your home directory, your terminal type, and your search
1677 path for programs to run.  Usually you set up environment variables with
1678 the shell and they are inherited by all the other programs you run.  When
1679 debugging, it can be useful to try running your program with a modified
1680 environment without having to start @value{GDBN} over again.
1681
1682 @table @code
1683 @kindex path
1684 @item path @var{directory}
1685 Add @var{directory} to the front of the @code{PATH} environment variable
1686 (the search path for executables) that will be passed to your program.
1687 The value of @code{PATH} used by @value{GDBN} does not change.
1688 You may specify several directory names, separated by whitespace or by a
1689 system-dependent separator character (@samp{:} on Unix, @samp{;} on
1690 MS-DOS and MS-Windows).  If @var{directory} is already in the path, it
1691 is moved to the front, so it is searched sooner.
1692
1693 You can use the string @samp{$cwd} to refer to whatever is the current
1694 working directory at the time @value{GDBN} searches the path.  If you
1695 use @samp{.} instead, it refers to the directory where you executed the
1696 @code{path} command.  @value{GDBN} replaces @samp{.} in the
1697 @var{directory} argument (with the current path) before adding
1698 @var{directory} to the search path.
1699 @c 'path' is explicitly nonrepeatable, but RMS points out it is silly to
1700 @c document that, since repeating it would be a no-op.
1701
1702 @kindex show paths
1703 @item show paths
1704 Display the list of search paths for executables (the @code{PATH}
1705 environment variable).
1706
1707 @kindex show environment
1708 @item show environment @r{[}@var{varname}@r{]}
1709 Print the value of environment variable @var{varname} to be given to
1710 your program when it starts.  If you do not supply @var{varname},
1711 print the names and values of all environment variables to be given to
1712 your program.  You can abbreviate @code{environment} as @code{env}.
1713
1714 @kindex set environment
1715 @item set environment @var{varname} @r{[}=@var{value}@r{]}
1716 Set environment variable @var{varname} to @var{value}.  The value
1717 changes for your program only, not for @value{GDBN} itself.  @var{value} may
1718 be any string; the values of environment variables are just strings, and
1719 any interpretation is supplied by your program itself.  The @var{value}
1720 parameter is optional; if it is eliminated, the variable is set to a
1721 null value.
1722 @c "any string" here does not include leading, trailing
1723 @c blanks. Gnu asks: does anyone care?
1724
1725 For example, this command:
1726
1727 @example
1728 set env USER = foo
1729 @end example
1730
1731 @noindent
1732 tells the debugged program, when subsequently run, that its user is named
1733 @samp{foo}.  (The spaces around @samp{=} are used for clarity here; they
1734 are not actually required.)
1735
1736 @kindex unset environment
1737 @item unset environment @var{varname}
1738 Remove variable @var{varname} from the environment to be passed to your
1739 program.  This is different from @samp{set env @var{varname} =};
1740 @code{unset environment} removes the variable from the environment,
1741 rather than assigning it an empty value.
1742 @end table
1743
1744 @emph{Warning:} On Unix systems, @value{GDBN} runs your program using
1745 the shell indicated
1746 by your @code{SHELL} environment variable if it exists (or
1747 @code{/bin/sh} if not).  If your @code{SHELL} variable names a shell
1748 that runs an initialization file---such as @file{.cshrc} for C-shell, or
1749 @file{.bashrc} for BASH---any variables you set in that file affect
1750 your program.  You may wish to move setting of environment variables to
1751 files that are only run when you sign on, such as @file{.login} or
1752 @file{.profile}.
1753
1754 @node Working Directory
1755 @section Your program's working directory
1756
1757 @cindex working directory (of your program)
1758 Each time you start your program with @code{run}, it inherits its
1759 working directory from the current working directory of @value{GDBN}.
1760 The @value{GDBN} working directory is initially whatever it inherited
1761 from its parent process (typically the shell), but you can specify a new
1762 working directory in @value{GDBN} with the @code{cd} command.
1763
1764 The @value{GDBN} working directory also serves as a default for the commands
1765 that specify files for @value{GDBN} to operate on.  @xref{Files, ,Commands to
1766 specify files}.
1767
1768 @table @code
1769 @kindex cd
1770 @item cd @var{directory}
1771 Set the @value{GDBN} working directory to @var{directory}.
1772
1773 @kindex pwd
1774 @item pwd
1775 Print the @value{GDBN} working directory.
1776 @end table
1777
1778 @node Input/Output
1779 @section Your program's input and output
1780
1781 @cindex redirection
1782 @cindex i/o
1783 @cindex terminal
1784 By default, the program you run under @value{GDBN} does input and output to
1785 the same terminal that @value{GDBN} uses.  @value{GDBN} switches the terminal
1786 to its own terminal modes to interact with you, but it records the terminal
1787 modes your program was using and switches back to them when you continue
1788 running your program.
1789
1790 @table @code
1791 @kindex info terminal
1792 @item info terminal
1793 Displays information recorded by @value{GDBN} about the terminal modes your
1794 program is using.
1795 @end table
1796
1797 You can redirect your program's input and/or output using shell
1798 redirection with the @code{run} command.  For example,
1799
1800 @example
1801 run > outfile
1802 @end example
1803
1804 @noindent
1805 starts your program, diverting its output to the file @file{outfile}.
1806
1807 @kindex tty
1808 @cindex controlling terminal
1809 Another way to specify where your program should do input and output is
1810 with the @code{tty} command.  This command accepts a file name as
1811 argument, and causes this file to be the default for future @code{run}
1812 commands.  It also resets the controlling terminal for the child
1813 process, for future @code{run} commands.  For example,
1814
1815 @example
1816 tty /dev/ttyb
1817 @end example
1818
1819 @noindent
1820 directs that processes started with subsequent @code{run} commands
1821 default to do input and output on the terminal @file{/dev/ttyb} and have
1822 that as their controlling terminal.
1823
1824 An explicit redirection in @code{run} overrides the @code{tty} command's
1825 effect on the input/output device, but not its effect on the controlling
1826 terminal.
1827
1828 When you use the @code{tty} command or redirect input in the @code{run}
1829 command, only the input @emph{for your program} is affected.  The input
1830 for @value{GDBN} still comes from your terminal.
1831
1832 @node Attach
1833 @section Debugging an already-running process
1834 @kindex attach
1835 @cindex attach
1836
1837 @table @code
1838 @item attach @var{process-id}
1839 This command attaches to a running process---one that was started
1840 outside @value{GDBN}.  (@code{info files} shows your active
1841 targets.)  The command takes as argument a process ID.  The usual way to
1842 find out the process-id of a Unix process is with the @code{ps} utility,
1843 or with the @samp{jobs -l} shell command.
1844
1845 @code{attach} does not repeat if you press @key{RET} a second time after
1846 executing the command.
1847 @end table
1848
1849 To use @code{attach}, your program must be running in an environment
1850 which supports processes; for example, @code{attach} does not work for
1851 programs on bare-board targets that lack an operating system.  You must
1852 also have permission to send the process a signal.
1853
1854 When you use @code{attach}, the debugger finds the program running in
1855 the process first by looking in the current working directory, then (if
1856 the program is not found) by using the source file search path
1857 (@pxref{Source Path, ,Specifying source directories}).  You can also use
1858 the @code{file} command to load the program.  @xref{Files, ,Commands to
1859 Specify Files}.
1860
1861 The first thing @value{GDBN} does after arranging to debug the specified
1862 process is to stop it.  You can examine and modify an attached process
1863 with all the @value{GDBN} commands that are ordinarily available when
1864 you start processes with @code{run}.  You can insert breakpoints; you
1865 can step and continue; you can modify storage.  If you would rather the
1866 process continue running, you may use the @code{continue} command after
1867 attaching @value{GDBN} to the process.
1868
1869 @table @code
1870 @kindex detach
1871 @item detach
1872 When you have finished debugging the attached process, you can use the
1873 @code{detach} command to release it from @value{GDBN} control.  Detaching
1874 the process continues its execution.  After the @code{detach} command,
1875 that process and @value{GDBN} become completely independent once more, and you
1876 are ready to @code{attach} another process or start one with @code{run}.
1877 @code{detach} does not repeat if you press @key{RET} again after
1878 executing the command.
1879 @end table
1880
1881 If you exit @value{GDBN} or use the @code{run} command while you have an
1882 attached process, you kill that process.  By default, @value{GDBN} asks
1883 for confirmation if you try to do either of these things; you can
1884 control whether or not you need to confirm by using the @code{set
1885 confirm} command (@pxref{Messages/Warnings, ,Optional warnings and
1886 messages}).
1887
1888 @node Kill Process
1889 @section Killing the child process
1890
1891 @table @code
1892 @kindex kill
1893 @item kill
1894 Kill the child process in which your program is running under @value{GDBN}.
1895 @end table
1896
1897 This command is useful if you wish to debug a core dump instead of a
1898 running process.  @value{GDBN} ignores any core dump file while your program
1899 is running.
1900
1901 On some operating systems, a program cannot be executed outside @value{GDBN}
1902 while you have breakpoints set on it inside @value{GDBN}.  You can use the
1903 @code{kill} command in this situation to permit running your program
1904 outside the debugger.
1905
1906 The @code{kill} command is also useful if you wish to recompile and
1907 relink your program, since on many systems it is impossible to modify an
1908 executable file while it is running in a process.  In this case, when you
1909 next type @code{run}, @value{GDBN} notices that the file has changed, and
1910 reads the symbol table again (while trying to preserve your current
1911 breakpoint settings).
1912
1913 @node Threads
1914 @section Debugging programs with multiple threads
1915
1916 @cindex threads of execution
1917 @cindex multiple threads
1918 @cindex switching threads
1919 In some operating systems, such as HP-UX and Solaris, a single program
1920 may have more than one @dfn{thread} of execution.  The precise semantics
1921 of threads differ from one operating system to another, but in general
1922 the threads of a single program are akin to multiple processes---except
1923 that they share one address space (that is, they can all examine and
1924 modify the same variables).  On the other hand, each thread has its own
1925 registers and execution stack, and perhaps private memory.
1926
1927 @value{GDBN} provides these facilities for debugging multi-thread
1928 programs:
1929
1930 @itemize @bullet
1931 @item automatic notification of new threads
1932 @item @samp{thread @var{threadno}}, a command to switch among threads
1933 @item @samp{info threads}, a command to inquire about existing threads
1934 @item @samp{thread apply [@var{threadno}] [@var{all}] @var{args}},
1935 a command to apply a command to a list of threads
1936 @item thread-specific breakpoints
1937 @end itemize
1938
1939 @quotation
1940 @emph{Warning:} These facilities are not yet available on every
1941 @value{GDBN} configuration where the operating system supports threads.
1942 If your @value{GDBN} does not support threads, these commands have no
1943 effect.  For example, a system without thread support shows no output
1944 from @samp{info threads}, and always rejects the @code{thread} command,
1945 like this:
1946
1947 @smallexample
1948 (@value{GDBP}) info threads
1949 (@value{GDBP}) thread 1
1950 Thread ID 1 not known.  Use the "info threads" command to
1951 see the IDs of currently known threads.
1952 @end smallexample
1953 @c FIXME to implementors: how hard would it be to say "sorry, this GDB
1954 @c                        doesn't support threads"?
1955 @end quotation
1956
1957 @cindex focus of debugging
1958 @cindex current thread
1959 The @value{GDBN} thread debugging facility allows you to observe all
1960 threads while your program runs---but whenever @value{GDBN} takes
1961 control, one thread in particular is always the focus of debugging.
1962 This thread is called the @dfn{current thread}.  Debugging commands show
1963 program information from the perspective of the current thread.
1964
1965 @cindex @code{New} @var{systag} message
1966 @cindex thread identifier (system)
1967 @c FIXME-implementors!! It would be more helpful if the [New...] message
1968 @c included GDB's numeric thread handle, so you could just go to that
1969 @c thread without first checking `info threads'.
1970 Whenever @value{GDBN} detects a new thread in your program, it displays
1971 the target system's identification for the thread with a message in the
1972 form @samp{[New @var{systag}]}.  @var{systag} is a thread identifier
1973 whose form varies depending on the particular system.  For example, on
1974 LynxOS, you might see
1975
1976 @example
1977 [New process 35 thread 27]
1978 @end example
1979
1980 @noindent
1981 when @value{GDBN} notices a new thread.  In contrast, on an SGI system,
1982 the @var{systag} is simply something like @samp{process 368}, with no
1983 further qualifier.
1984
1985 @c FIXME!! (1) Does the [New...] message appear even for the very first
1986 @c         thread of a program, or does it only appear for the
1987 @c         second---i.e., when it becomes obvious we have a multithread
1988 @c         program?
1989 @c         (2) *Is* there necessarily a first thread always?  Or do some
1990 @c         multithread systems permit starting a program with multiple
1991 @c         threads ab initio?
1992
1993 @cindex thread number
1994 @cindex thread identifier (GDB)
1995 For debugging purposes, @value{GDBN} associates its own thread
1996 number---always a single integer---with each thread in your program.
1997
1998 @table @code
1999 @kindex info threads
2000 @item info threads
2001 Display a summary of all threads currently in your
2002 program.  @value{GDBN} displays for each thread (in this order):
2003
2004 @enumerate
2005 @item the thread number assigned by @value{GDBN}
2006
2007 @item the target system's thread identifier (@var{systag})
2008
2009 @item the current stack frame summary for that thread
2010 @end enumerate
2011
2012 @noindent
2013 An asterisk @samp{*} to the left of the @value{GDBN} thread number
2014 indicates the current thread.
2015
2016 For example,
2017 @end table
2018 @c end table here to get a little more width for example
2019
2020 @smallexample
2021 (@value{GDBP}) info threads
2022   3 process 35 thread 27  0x34e5 in sigpause ()
2023   2 process 35 thread 23  0x34e5 in sigpause ()
2024 * 1 process 35 thread 13  main (argc=1, argv=0x7ffffff8)
2025     at threadtest.c:68
2026 @end smallexample
2027
2028 On HP-UX systems:
2029
2030 @cindex thread number
2031 @cindex thread identifier (GDB)
2032 For debugging purposes, @value{GDBN} associates its own thread
2033 number---a small integer assigned in thread-creation order---with each
2034 thread in your program.
2035
2036 @cindex @code{New} @var{systag} message, on HP-UX
2037 @cindex thread identifier (system), on HP-UX
2038 @c FIXME-implementors!! It would be more helpful if the [New...] message
2039 @c included GDB's numeric thread handle, so you could just go to that
2040 @c thread without first checking `info threads'.
2041 Whenever @value{GDBN} detects a new thread in your program, it displays
2042 both @value{GDBN}'s thread number and the target system's identification for the thread with a message in the
2043 form @samp{[New @var{systag}]}.  @var{systag} is a thread identifier
2044 whose form varies depending on the particular system.  For example, on
2045 HP-UX, you see
2046
2047 @example
2048 [New thread 2 (system thread 26594)]
2049 @end example
2050
2051 @noindent
2052 when @value{GDBN} notices a new thread.
2053
2054 @table @code
2055 @kindex info threads
2056 @item info threads
2057 Display a summary of all threads currently in your
2058 program.  @value{GDBN} displays for each thread (in this order):
2059
2060 @enumerate
2061 @item the thread number assigned by @value{GDBN}
2062
2063 @item the target system's thread identifier (@var{systag})
2064
2065 @item the current stack frame summary for that thread
2066 @end enumerate
2067
2068 @noindent
2069 An asterisk @samp{*} to the left of the @value{GDBN} thread number
2070 indicates the current thread.
2071
2072 For example,
2073 @end table
2074 @c end table here to get a little more width for example
2075
2076 @example
2077 (@value{GDBP}) info threads
2078     * 3 system thread 26607  worker (wptr=0x7b09c318 "@@") \@*
2079                                at quicksort.c:137
2080       2 system thread 26606  0x7b0030d8 in __ksleep () \@*
2081                                from /usr/lib/libc.2
2082       1 system thread 27905  0x7b003498 in _brk () \@*
2083                                from /usr/lib/libc.2
2084 @end example
2085
2086 @table @code
2087 @kindex thread @var{threadno}
2088 @item thread @var{threadno}
2089 Make thread number @var{threadno} the current thread.  The command
2090 argument @var{threadno} is the internal @value{GDBN} thread number, as
2091 shown in the first field of the @samp{info threads} display.
2092 @value{GDBN} responds by displaying the system identifier of the thread
2093 you selected, and its current stack frame summary:
2094
2095 @smallexample
2096 @c FIXME!! This example made up; find a @value{GDBN} w/threads and get real one
2097 (@value{GDBP}) thread 2
2098 [Switching to process 35 thread 23]
2099 0x34e5 in sigpause ()
2100 @end smallexample
2101
2102 @noindent
2103 As with the @samp{[New @dots{}]} message, the form of the text after
2104 @samp{Switching to} depends on your system's conventions for identifying
2105 threads.
2106
2107 @kindex thread apply
2108 @item thread apply [@var{threadno}] [@var{all}]  @var{args}
2109 The @code{thread apply} command allows you to apply a command to one or
2110 more threads.  Specify the numbers of the threads that you want affected
2111 with the command argument @var{threadno}.  @var{threadno} is the internal
2112 @value{GDBN} thread number, as shown in the first field of the @samp{info
2113 threads} display.  To apply a command to all threads, use
2114 @code{thread apply all} @var{args}.
2115 @end table
2116
2117 @cindex automatic thread selection
2118 @cindex switching threads automatically
2119 @cindex threads, automatic switching
2120 Whenever @value{GDBN} stops your program, due to a breakpoint or a
2121 signal, it automatically selects the thread where that breakpoint or
2122 signal happened.  @value{GDBN} alerts you to the context switch with a
2123 message of the form @samp{[Switching to @var{systag}]} to identify the
2124 thread.
2125
2126 @xref{Thread Stops,,Stopping and starting multi-thread programs}, for
2127 more information about how @value{GDBN} behaves when you stop and start
2128 programs with multiple threads.
2129
2130 @xref{Set Watchpoints,,Setting watchpoints}, for information about
2131 watchpoints in programs with multiple threads.
2132
2133 @node Processes
2134 @section Debugging programs with multiple processes
2135
2136 @cindex fork, debugging programs which call
2137 @cindex multiple processes
2138 @cindex processes, multiple
2139 On most systems, @value{GDBN} has no special support for debugging
2140 programs which create additional processes using the @code{fork}
2141 function.  When a program forks, @value{GDBN} will continue to debug the
2142 parent process and the child process will run unimpeded.  If you have
2143 set a breakpoint in any code which the child then executes, the child
2144 will get a @code{SIGTRAP} signal which (unless it catches the signal)
2145 will cause it to terminate.
2146
2147 However, if you want to debug the child process there is a workaround
2148 which isn't too painful.  Put a call to @code{sleep} in the code which
2149 the child process executes after the fork.  It may be useful to sleep
2150 only if a certain environment variable is set, or a certain file exists,
2151 so that the delay need not occur when you don't want to run @value{GDBN}
2152 on the child.  While the child is sleeping, use the @code{ps} program to
2153 get its process ID.  Then tell @value{GDBN} (a new invocation of
2154 @value{GDBN} if you are also debugging the parent process) to attach to
2155 the child process (@pxref{Attach}).  From that point on you can debug
2156 the child process just like any other process which you attached to.
2157
2158 On HP-UX (11.x and later only?), @value{GDBN} provides support for
2159 debugging programs that create additional processes using the
2160 @code{fork} or @code{vfork} function.
2161
2162 By default, when a program forks, @value{GDBN} will continue to debug
2163 the parent process and the child process will run unimpeded.
2164
2165 If you want to follow the child process instead of the parent process,
2166 use the command @w{@code{set follow-fork-mode}}.
2167
2168 @table @code
2169 @kindex set follow-fork-mode
2170 @item set follow-fork-mode @var{mode}
2171 Set the debugger response to a program call of @code{fork} or
2172 @code{vfork}.  A call to @code{fork} or @code{vfork} creates a new
2173 process.  The @var{mode} can be:
2174
2175 @table @code
2176 @item parent
2177 The original process is debugged after a fork.  The child process runs
2178 unimpeded.  This is the default.
2179
2180 @item child
2181 The new process is debugged after a fork.  The parent process runs
2182 unimpeded.
2183
2184 @item ask
2185 The debugger will ask for one of the above choices.
2186 @end table
2187
2188 @item show follow-fork-mode
2189 Display the current debugger response to a @code{fork} or @code{vfork} call.
2190 @end table
2191
2192 If you ask to debug a child process and a @code{vfork} is followed by an
2193 @code{exec}, @value{GDBN} executes the new target up to the first
2194 breakpoint in the new target.  If you have a breakpoint set on
2195 @code{main} in your original program, the breakpoint will also be set on
2196 the child process's @code{main}.
2197
2198 When a child process is spawned by @code{vfork}, you cannot debug the
2199 child or parent until an @code{exec} call completes.
2200
2201 If you issue a @code{run} command to @value{GDBN} after an @code{exec}
2202 call executes, the new target restarts.  To restart the parent process,
2203 use the @code{file} command with the parent executable name as its
2204 argument.
2205
2206 You can use the @code{catch} command to make @value{GDBN} stop whenever
2207 a @code{fork}, @code{vfork}, or @code{exec} call is made.  @xref{Set
2208 Catchpoints, ,Setting catchpoints}.
2209
2210 @node Stopping
2211 @chapter Stopping and Continuing
2212
2213 The principal purposes of using a debugger are so that you can stop your
2214 program before it terminates; or so that, if your program runs into
2215 trouble, you can investigate and find out why.
2216
2217 Inside @value{GDBN}, your program may stop for any of several reasons,
2218 such as a signal, a breakpoint, or reaching a new line after a
2219 @value{GDBN} command such as @code{step}.  You may then examine and
2220 change variables, set new breakpoints or remove old ones, and then
2221 continue execution.  Usually, the messages shown by @value{GDBN} provide
2222 ample explanation of the status of your program---but you can also
2223 explicitly request this information at any time.
2224
2225 @table @code
2226 @kindex info program
2227 @item info program
2228 Display information about the status of your program: whether it is
2229 running or not, what process it is, and why it stopped.
2230 @end table
2231
2232 @menu
2233 * Breakpoints::                 Breakpoints, watchpoints, and catchpoints
2234 * Continuing and Stepping::     Resuming execution
2235 * Signals::                     Signals
2236 * Thread Stops::                Stopping and starting multi-thread programs
2237 @end menu
2238
2239 @node Breakpoints
2240 @section Breakpoints, watchpoints, and catchpoints
2241
2242 @cindex breakpoints
2243 A @dfn{breakpoint} makes your program stop whenever a certain point in
2244 the program is reached.  For each breakpoint, you can add conditions to
2245 control in finer detail whether your program stops.  You can set
2246 breakpoints with the @code{break} command and its variants (@pxref{Set
2247 Breaks, ,Setting breakpoints}), to specify the place where your program
2248 should stop by line number, function name or exact address in the
2249 program.
2250
2251 In HP-UX, SunOS 4.x, SVR4, and Alpha OSF/1 configurations, you can set
2252 breakpoints in shared libraries before the executable is run.  There is
2253 a minor limitation on HP-UX systems: you must wait until the executable
2254 is run in order to set breakpoints in shared library routines that are
2255 not called directly by the program (for example, routines that are
2256 arguments in a @code{pthread_create} call).
2257
2258 @cindex watchpoints
2259 @cindex memory tracing
2260 @cindex breakpoint on memory address
2261 @cindex breakpoint on variable modification
2262 A @dfn{watchpoint} is a special breakpoint that stops your program
2263 when the value of an expression changes.  You must use a different
2264 command to set watchpoints (@pxref{Set Watchpoints, ,Setting
2265 watchpoints}), but aside from that, you can manage a watchpoint like
2266 any other breakpoint: you enable, disable, and delete both breakpoints
2267 and watchpoints using the same commands.
2268
2269 You can arrange to have values from your program displayed automatically
2270 whenever @value{GDBN} stops at a breakpoint.  @xref{Auto Display,,
2271 Automatic display}.
2272
2273 @cindex catchpoints
2274 @cindex breakpoint on events
2275 A @dfn{catchpoint} is another special breakpoint that stops your program
2276 when a certain kind of event occurs, such as the throwing of a C@t{++}
2277 exception or the loading of a library.  As with watchpoints, you use a
2278 different command to set a catchpoint (@pxref{Set Catchpoints, ,Setting
2279 catchpoints}), but aside from that, you can manage a catchpoint like any
2280 other breakpoint.  (To stop when your program receives a signal, use the
2281 @code{handle} command; see @ref{Signals, ,Signals}.)
2282
2283 @cindex breakpoint numbers
2284 @cindex numbers for breakpoints
2285 @value{GDBN} assigns a number to each breakpoint, watchpoint, or
2286 catchpoint when you create it; these numbers are successive integers
2287 starting with one.  In many of the commands for controlling various
2288 features of breakpoints you use the breakpoint number to say which
2289 breakpoint you want to change.  Each breakpoint may be @dfn{enabled} or
2290 @dfn{disabled}; if disabled, it has no effect on your program until you
2291 enable it again.
2292
2293 @cindex breakpoint ranges
2294 @cindex ranges of breakpoints
2295 Some @value{GDBN} commands accept a range of breakpoints on which to
2296 operate.  A breakpoint range is either a single breakpoint number, like
2297 @samp{5}, or two such numbers, in increasing order, separated by a
2298 hyphen, like @samp{5-7}.  When a breakpoint range is given to a command,
2299 all breakpoint in that range are operated on.
2300
2301 @menu
2302 * Set Breaks::                  Setting breakpoints
2303 * Set Watchpoints::             Setting watchpoints
2304 * Set Catchpoints::             Setting catchpoints
2305 * Delete Breaks::               Deleting breakpoints
2306 * Disabling::                   Disabling breakpoints
2307 * Conditions::                  Break conditions
2308 * Break Commands::              Breakpoint command lists
2309 * Breakpoint Menus::            Breakpoint menus
2310 * Error in Breakpoints::        ``Cannot insert breakpoints''
2311 @end menu
2312
2313 @node Set Breaks
2314 @subsection Setting breakpoints
2315
2316 @c FIXME LMB what does GDB do if no code on line of breakpt?
2317 @c       consider in particular declaration with/without initialization.
2318 @c
2319 @c FIXME 2 is there stuff on this already? break at fun start, already init?
2320
2321 @kindex break
2322 @kindex b @r{(@code{break})}
2323 @vindex $bpnum@r{, convenience variable}
2324 @cindex latest breakpoint
2325 Breakpoints are set with the @code{break} command (abbreviated
2326 @code{b}).  The debugger convenience variable @samp{$bpnum} records the
2327 number of the breakpoint you've set most recently; see @ref{Convenience
2328 Vars,, Convenience variables}, for a discussion of what you can do with
2329 convenience variables.
2330
2331 You have several ways to say where the breakpoint should go.
2332
2333 @table @code
2334 @item break @var{function}
2335 Set a breakpoint at entry to function @var{function}.
2336 When using source languages that permit overloading of symbols, such as
2337 C@t{++}, @var{function} may refer to more than one possible place to break.
2338 @xref{Breakpoint Menus,,Breakpoint menus}, for a discussion of that situation.
2339
2340 @item break +@var{offset}
2341 @itemx break -@var{offset}
2342 Set a breakpoint some number of lines forward or back from the position
2343 at which execution stopped in the currently selected @dfn{stack frame}.
2344 (@xref{Frames, ,Frames}, for a description of stack frames.)
2345
2346 @item break @var{linenum}
2347 Set a breakpoint at line @var{linenum} in the current source file.
2348 The current source file is the last file whose source text was printed.
2349 The breakpoint will stop your program just before it executes any of the
2350 code on that line.
2351
2352 @item break @var{filename}:@var{linenum}
2353 Set a breakpoint at line @var{linenum} in source file @var{filename}.
2354
2355 @item break @var{filename}:@var{function}
2356 Set a breakpoint at entry to function @var{function} found in file
2357 @var{filename}.  Specifying a file name as well as a function name is
2358 superfluous except when multiple files contain similarly named
2359 functions.
2360
2361 @item break *@var{address}
2362 Set a breakpoint at address @var{address}.  You can use this to set
2363 breakpoints in parts of your program which do not have debugging
2364 information or source files.
2365
2366 @item break
2367 When called without any arguments, @code{break} sets a breakpoint at
2368 the next instruction to be executed in the selected stack frame
2369 (@pxref{Stack, ,Examining the Stack}).  In any selected frame but the
2370 innermost, this makes your program stop as soon as control
2371 returns to that frame.  This is similar to the effect of a
2372 @code{finish} command in the frame inside the selected frame---except
2373 that @code{finish} does not leave an active breakpoint.  If you use
2374 @code{break} without an argument in the innermost frame, @value{GDBN} stops
2375 the next time it reaches the current location; this may be useful
2376 inside loops.
2377
2378 @value{GDBN} normally ignores breakpoints when it resumes execution, until at
2379 least one instruction has been executed.  If it did not do this, you
2380 would be unable to proceed past a breakpoint without first disabling the
2381 breakpoint.  This rule applies whether or not the breakpoint already
2382 existed when your program stopped.
2383
2384 @item break @dots{} if @var{cond}
2385 Set a breakpoint with condition @var{cond}; evaluate the expression
2386 @var{cond} each time the breakpoint is reached, and stop only if the
2387 value is nonzero---that is, if @var{cond} evaluates as true.
2388 @samp{@dots{}} stands for one of the possible arguments described
2389 above (or no argument) specifying where to break.  @xref{Conditions,
2390 ,Break conditions}, for more information on breakpoint conditions.
2391
2392 @kindex tbreak
2393 @item tbreak @var{args}
2394 Set a breakpoint enabled only for one stop.  @var{args} are the
2395 same as for the @code{break} command, and the breakpoint is set in the same
2396 way, but the breakpoint is automatically deleted after the first time your
2397 program stops there.  @xref{Disabling, ,Disabling breakpoints}.
2398
2399 @kindex hbreak
2400 @item hbreak @var{args}
2401 Set a hardware-assisted breakpoint.  @var{args} are the same as for the
2402 @code{break} command and the breakpoint is set in the same way, but the
2403 breakpoint requires hardware support and some target hardware may not
2404 have this support.  The main purpose of this is EPROM/ROM code
2405 debugging, so you can set a breakpoint at an instruction without
2406 changing the instruction.  This can be used with the new trap-generation
2407 provided by SPARClite DSU and some x86-based targets.  These targets
2408 will generate traps when a program accesses some data or instruction
2409 address that is assigned to the debug registers.  However the hardware
2410 breakpoint registers can take a limited number of breakpoints.  For
2411 example, on the DSU, only two data breakpoints can be set at a time, and
2412 @value{GDBN} will reject this command if more than two are used.  Delete
2413 or disable unused hardware breakpoints before setting new ones
2414 (@pxref{Disabling, ,Disabling}).  @xref{Conditions, ,Break conditions}.
2415
2416 @kindex thbreak
2417 @item thbreak @var{args}
2418 Set a hardware-assisted breakpoint enabled only for one stop.  @var{args}
2419 are the same as for the @code{hbreak} command and the breakpoint is set in
2420 the same way.  However, like the @code{tbreak} command,
2421 the breakpoint is automatically deleted after the
2422 first time your program stops there.  Also, like the @code{hbreak}
2423 command, the breakpoint requires hardware support and some target hardware
2424 may not have this support.  @xref{Disabling, ,Disabling breakpoints}.
2425 See also @ref{Conditions, ,Break conditions}.
2426
2427 @kindex rbreak
2428 @cindex regular expression
2429 @item rbreak @var{regex}
2430 Set breakpoints on all functions matching the regular expression
2431 @var{regex}.  This command sets an unconditional breakpoint on all
2432 matches, printing a list of all breakpoints it set.  Once these
2433 breakpoints are set, they are treated just like the breakpoints set with
2434 the @code{break} command.  You can delete them, disable them, or make
2435 them conditional the same way as any other breakpoint.
2436
2437 The syntax of the regular expression is the standard one used with tools
2438 like @file{grep}.  Note that this is different from the syntax used by
2439 shells, so for instance @code{foo*} matches all functions that include
2440 an @code{fo} followed by zero or more @code{o}s.  There is an implicit
2441 @code{.*} leading and trailing the regular expression you supply, so to
2442 match only functions that begin with @code{foo}, use @code{^foo}.
2443
2444 When debugging C@t{++} programs, @code{rbreak} is useful for setting
2445 breakpoints on overloaded functions that are not members of any special
2446 classes.
2447
2448 @kindex info breakpoints
2449 @cindex @code{$_} and @code{info breakpoints}
2450 @item info breakpoints @r{[}@var{n}@r{]}
2451 @itemx info break @r{[}@var{n}@r{]}
2452 @itemx info watchpoints @r{[}@var{n}@r{]}
2453 Print a table of all breakpoints, watchpoints, and catchpoints set and
2454 not deleted, with the following columns for each breakpoint:
2455
2456 @table @emph
2457 @item Breakpoint Numbers
2458 @item Type
2459 Breakpoint, watchpoint, or catchpoint.
2460 @item Disposition
2461 Whether the breakpoint is marked to be disabled or deleted when hit.
2462 @item Enabled or Disabled
2463 Enabled breakpoints are marked with @samp{y}.  @samp{n} marks breakpoints
2464 that are not enabled.
2465 @item Address
2466 Where the breakpoint is in your program, as a memory address.
2467 @item What
2468 Where the breakpoint is in the source for your program, as a file and
2469 line number.
2470 @end table
2471
2472 @noindent
2473 If a breakpoint is conditional, @code{info break} shows the condition on
2474 the line following the affected breakpoint; breakpoint commands, if any,
2475 are listed after that.
2476
2477 @noindent
2478 @code{info break} with a breakpoint
2479 number @var{n} as argument lists only that breakpoint.  The
2480 convenience variable @code{$_} and the default examining-address for
2481 the @code{x} command are set to the address of the last breakpoint
2482 listed (@pxref{Memory, ,Examining memory}).
2483
2484 @noindent
2485 @code{info break} displays a count of the number of times the breakpoint
2486 has been hit.  This is especially useful in conjunction with the
2487 @code{ignore} command.  You can ignore a large number of breakpoint
2488 hits, look at the breakpoint info to see how many times the breakpoint
2489 was hit, and then run again, ignoring one less than that number.  This
2490 will get you quickly to the last hit of that breakpoint.
2491 @end table
2492
2493 @value{GDBN} allows you to set any number of breakpoints at the same place in
2494 your program.  There is nothing silly or meaningless about this.  When
2495 the breakpoints are conditional, this is even useful
2496 (@pxref{Conditions, ,Break conditions}).
2497
2498 @cindex negative breakpoint numbers
2499 @cindex internal @value{GDBN} breakpoints
2500 @value{GDBN} itself sometimes sets breakpoints in your program for special
2501 purposes, such as proper handling of @code{longjmp} (in C programs).
2502 These internal breakpoints are assigned negative numbers, starting with
2503 @code{-1}; @samp{info breakpoints} does not display them.
2504
2505 You can see these breakpoints with the @value{GDBN} maintenance command
2506 @samp{maint info breakpoints}.
2507
2508 @table @code
2509 @kindex maint info breakpoints
2510 @item maint info breakpoints
2511 Using the same format as @samp{info breakpoints}, display both the
2512 breakpoints you've set explicitly, and those @value{GDBN} is using for
2513 internal purposes.  Internal breakpoints are shown with negative
2514 breakpoint numbers.  The type column identifies what kind of breakpoint
2515 is shown:
2516
2517 @table @code
2518 @item breakpoint
2519 Normal, explicitly set breakpoint.
2520
2521 @item watchpoint
2522 Normal, explicitly set watchpoint.
2523
2524 @item longjmp
2525 Internal breakpoint, used to handle correctly stepping through
2526 @code{longjmp} calls.
2527
2528 @item longjmp resume
2529 Internal breakpoint at the target of a @code{longjmp}.
2530
2531 @item until
2532 Temporary internal breakpoint used by the @value{GDBN} @code{until} command.
2533
2534 @item finish
2535 Temporary internal breakpoint used by the @value{GDBN} @code{finish} command.
2536
2537 @item shlib events
2538 Shared library events.
2539
2540 @end table
2541
2542 @end table
2543
2544
2545 @node Set Watchpoints
2546 @subsection Setting watchpoints
2547
2548 @cindex setting watchpoints
2549 @cindex software watchpoints
2550 @cindex hardware watchpoints
2551 You can use a watchpoint to stop execution whenever the value of an
2552 expression changes, without having to predict a particular place where
2553 this may happen.
2554
2555 Depending on your system, watchpoints may be implemented in software or
2556 hardware.  @value{GDBN} does software watchpointing by single-stepping your
2557 program and testing the variable's value each time, which is hundreds of
2558 times slower than normal execution.  (But this may still be worth it, to
2559 catch errors where you have no clue what part of your program is the
2560 culprit.)
2561
2562 On some systems, such as HP-UX, Linux and some other x86-based targets,
2563 @value{GDBN} includes support for
2564 hardware watchpoints, which do not slow down the running of your
2565 program.
2566
2567 @table @code
2568 @kindex watch
2569 @item watch @var{expr}
2570 Set a watchpoint for an expression.  @value{GDBN} will break when @var{expr}
2571 is written into by the program and its value changes.
2572
2573 @kindex rwatch
2574 @item rwatch @var{expr}
2575 Set a watchpoint that will break when watch @var{expr} is read by the program.
2576
2577 @kindex awatch
2578 @item awatch @var{expr}
2579 Set a watchpoint that will break when @var{expr} is either read or written into
2580 by the program.
2581
2582 @kindex info watchpoints
2583 @item info watchpoints
2584 This command prints a list of watchpoints, breakpoints, and catchpoints;
2585 it is the same as @code{info break}.
2586 @end table
2587
2588 @value{GDBN} sets a @dfn{hardware watchpoint} if possible.  Hardware
2589 watchpoints execute very quickly, and the debugger reports a change in
2590 value at the exact instruction where the change occurs.  If @value{GDBN}
2591 cannot set a hardware watchpoint, it sets a software watchpoint, which
2592 executes more slowly and reports the change in value at the next
2593 statement, not the instruction, after the change occurs.
2594
2595 When you issue the @code{watch} command, @value{GDBN} reports
2596
2597 @example
2598 Hardware watchpoint @var{num}: @var{expr}
2599 @end example
2600
2601 @noindent
2602 if it was able to set a hardware watchpoint.
2603
2604 Currently, the @code{awatch} and @code{rwatch} commands can only set
2605 hardware watchpoints, because accesses to data that don't change the
2606 value of the watched expression cannot be detected without examining
2607 every instruction as it is being executed, and @value{GDBN} does not do
2608 that currently.  If @value{GDBN} finds that it is unable to set a
2609 hardware breakpoint with the @code{awatch} or @code{rwatch} command, it
2610 will print a message like this:
2611
2612 @smallexample
2613 Expression cannot be implemented with read/access watchpoint.
2614 @end smallexample
2615
2616 Sometimes, @value{GDBN} cannot set a hardware watchpoint because the
2617 data type of the watched expression is wider than what a hardware
2618 watchpoint on the target machine can handle.  For example, some systems
2619 can only watch regions that are up to 4 bytes wide; on such systems you
2620 cannot set hardware watchpoints for an expression that yields a
2621 double-precision floating-point number (which is typically 8 bytes
2622 wide).  As a work-around, it might be possible to break the large region
2623 into a series of smaller ones and watch them with separate watchpoints.
2624
2625 If you set too many hardware watchpoints, @value{GDBN} might be unable
2626 to insert all of them when you resume the execution of your program.
2627 Since the precise number of active watchpoints is unknown until such
2628 time as the program is about to be resumed, @value{GDBN} might not be
2629 able to warn you about this when you set the watchpoints, and the
2630 warning will be printed only when the program is resumed:
2631
2632 @smallexample
2633 Hardware watchpoint @var{num}: Could not insert watchpoint
2634 @end smallexample
2635
2636 @noindent
2637 If this happens, delete or disable some of the watchpoints.
2638
2639 The SPARClite DSU will generate traps when a program accesses some data
2640 or instruction address that is assigned to the debug registers.  For the
2641 data addresses, DSU facilitates the @code{watch} command.  However the
2642 hardware breakpoint registers can only take two data watchpoints, and
2643 both watchpoints must be the same kind.  For example, you can set two
2644 watchpoints with @code{watch} commands, two with @code{rwatch} commands,
2645 @strong{or} two with @code{awatch} commands, but you cannot set one
2646 watchpoint with one command and the other with a different command.
2647 @value{GDBN} will reject the command if you try to mix watchpoints.
2648 Delete or disable unused watchpoint commands before setting new ones.
2649
2650 If you call a function interactively using @code{print} or @code{call},
2651 any watchpoints you have set will be inactive until @value{GDBN} reaches another
2652 kind of breakpoint or the call completes.
2653
2654 @value{GDBN} automatically deletes watchpoints that watch local
2655 (automatic) variables, or expressions that involve such variables, when
2656 they go out of scope, that is, when the execution leaves the block in
2657 which these variables were defined.  In particular, when the program
2658 being debugged terminates, @emph{all} local variables go out of scope,
2659 and so only watchpoints that watch global variables remain set.  If you
2660 rerun the program, you will need to set all such watchpoints again.  One
2661 way of doing that would be to set a code breakpoint at the entry to the
2662 @code{main} function and when it breaks, set all the watchpoints.
2663
2664 @quotation
2665 @cindex watchpoints and threads
2666 @cindex threads and watchpoints
2667 @emph{Warning:} In multi-thread programs, watchpoints have only limited
2668 usefulness.  With the current watchpoint implementation, @value{GDBN}
2669 can only watch the value of an expression @emph{in a single thread}.  If
2670 you are confident that the expression can only change due to the current
2671 thread's activity (and if you are also confident that no other thread
2672 can become current), then you can use watchpoints as usual.  However,
2673 @value{GDBN} may not notice when a non-current thread's activity changes
2674 the expression.
2675
2676 @c FIXME: this is almost identical to the previous paragraph.
2677 @emph{HP-UX Warning:} In multi-thread programs, software watchpoints
2678 have only limited usefulness.  If @value{GDBN} creates a software
2679 watchpoint, it can only watch the value of an expression @emph{in a
2680 single thread}.  If you are confident that the expression can only
2681 change due to the current thread's activity (and if you are also
2682 confident that no other thread can become current), then you can use
2683 software watchpoints as usual.  However, @value{GDBN} may not notice
2684 when a non-current thread's activity changes the expression.  (Hardware
2685 watchpoints, in contrast, watch an expression in all threads.)
2686 @end quotation
2687
2688 @node Set Catchpoints
2689 @subsection Setting catchpoints
2690 @cindex catchpoints, setting
2691 @cindex exception handlers
2692 @cindex event handling
2693
2694 You can use @dfn{catchpoints} to cause the debugger to stop for certain
2695 kinds of program events, such as C@t{++} exceptions or the loading of a
2696 shared library.  Use the @code{catch} command to set a catchpoint.
2697
2698 @table @code
2699 @kindex catch
2700 @item catch @var{event}
2701 Stop when @var{event} occurs.  @var{event} can be any of the following:
2702 @table @code
2703 @item throw
2704 @kindex catch throw
2705 The throwing of a C@t{++} exception.
2706
2707 @item catch
2708 @kindex catch catch
2709 The catching of a C@t{++} exception.
2710
2711 @item exec
2712 @kindex catch exec
2713 A call to @code{exec}.  This is currently only available for HP-UX.
2714
2715 @item fork
2716 @kindex catch fork
2717 A call to @code{fork}.  This is currently only available for HP-UX.
2718
2719 @item vfork
2720 @kindex catch vfork
2721 A call to @code{vfork}.  This is currently only available for HP-UX.
2722
2723 @item load
2724 @itemx load @var{libname}
2725 @kindex catch load
2726 The dynamic loading of any shared library, or the loading of the library
2727 @var{libname}.  This is currently only available for HP-UX.
2728
2729 @item unload
2730 @itemx unload @var{libname}
2731 @kindex catch unload
2732 The unloading of any dynamically loaded shared library, or the unloading
2733 of the library @var{libname}.  This is currently only available for HP-UX.
2734 @end table
2735
2736 @item tcatch @var{event}
2737 Set a catchpoint that is enabled only for one stop.  The catchpoint is
2738 automatically deleted after the first time the event is caught.
2739
2740 @end table
2741
2742 Use the @code{info break} command to list the current catchpoints.
2743
2744 There are currently some limitations to C@t{++} exception handling
2745 (@code{catch throw} and @code{catch catch}) in @value{GDBN}:
2746
2747 @itemize @bullet
2748 @item
2749 If you call a function interactively, @value{GDBN} normally returns
2750 control to you when the function has finished executing.  If the call
2751 raises an exception, however, the call may bypass the mechanism that
2752 returns control to you and cause your program either to abort or to
2753 simply continue running until it hits a breakpoint, catches a signal
2754 that @value{GDBN} is listening for, or exits.  This is the case even if
2755 you set a catchpoint for the exception; catchpoints on exceptions are
2756 disabled within interactive calls.
2757
2758 @item
2759 You cannot raise an exception interactively.
2760
2761 @item
2762 You cannot install an exception handler interactively.
2763 @end itemize
2764
2765 @cindex raise exceptions
2766 Sometimes @code{catch} is not the best way to debug exception handling:
2767 if you need to know exactly where an exception is raised, it is better to
2768 stop @emph{before} the exception handler is called, since that way you
2769 can see the stack before any unwinding takes place.  If you set a
2770 breakpoint in an exception handler instead, it may not be easy to find
2771 out where the exception was raised.
2772
2773 To stop just before an exception handler is called, you need some
2774 knowledge of the implementation.  In the case of @sc{gnu} C@t{++}, exceptions are
2775 raised by calling a library function named @code{__raise_exception}
2776 which has the following ANSI C interface:
2777
2778 @example
2779     /* @var{addr} is where the exception identifier is stored.
2780        @var{id} is the exception identifier.  */
2781     void __raise_exception (void **addr, void *id);
2782 @end example
2783
2784 @noindent
2785 To make the debugger catch all exceptions before any stack
2786 unwinding takes place, set a breakpoint on @code{__raise_exception}
2787 (@pxref{Breakpoints, ,Breakpoints; watchpoints; and exceptions}).
2788
2789 With a conditional breakpoint (@pxref{Conditions, ,Break conditions})
2790 that depends on the value of @var{id}, you can stop your program when
2791 a specific exception is raised.  You can use multiple conditional
2792 breakpoints to stop your program when any of a number of exceptions are
2793 raised.
2794
2795
2796 @node Delete Breaks
2797 @subsection Deleting breakpoints
2798
2799 @cindex clearing breakpoints, watchpoints, catchpoints
2800 @cindex deleting breakpoints, watchpoints, catchpoints
2801 It is often necessary to eliminate a breakpoint, watchpoint, or
2802 catchpoint once it has done its job and you no longer want your program
2803 to stop there.  This is called @dfn{deleting} the breakpoint.  A
2804 breakpoint that has been deleted no longer exists; it is forgotten.
2805
2806 With the @code{clear} command you can delete breakpoints according to
2807 where they are in your program.  With the @code{delete} command you can
2808 delete individual breakpoints, watchpoints, or catchpoints by specifying
2809 their breakpoint numbers.
2810
2811 It is not necessary to delete a breakpoint to proceed past it.  @value{GDBN}
2812 automatically ignores breakpoints on the first instruction to be executed
2813 when you continue execution without changing the execution address.
2814
2815 @table @code
2816 @kindex clear
2817 @item clear
2818 Delete any breakpoints at the next instruction to be executed in the
2819 selected stack frame (@pxref{Selection, ,Selecting a frame}).  When
2820 the innermost frame is selected, this is a good way to delete a
2821 breakpoint where your program just stopped.
2822
2823 @item clear @var{function}
2824 @itemx clear @var{filename}:@var{function}
2825 Delete any breakpoints set at entry to the function @var{function}.
2826
2827 @item clear @var{linenum}
2828 @itemx clear @var{filename}:@var{linenum}
2829 Delete any breakpoints set at or within the code of the specified line.
2830
2831 @cindex delete breakpoints
2832 @kindex delete
2833 @kindex d @r{(@code{delete})}
2834 @item delete @r{[}breakpoints@r{]} @r{[}@var{range}@dots{}@r{]}
2835 Delete the breakpoints, watchpoints, or catchpoints of the breakpoint
2836 ranges specified as arguments.  If no argument is specified, delete all
2837 breakpoints (@value{GDBN} asks confirmation, unless you have @code{set
2838 confirm off}).  You can abbreviate this command as @code{d}.
2839 @end table
2840
2841 @node Disabling
2842 @subsection Disabling breakpoints
2843
2844 @kindex disable breakpoints
2845 @kindex enable breakpoints
2846 Rather than deleting a breakpoint, watchpoint, or catchpoint, you might
2847 prefer to @dfn{disable} it.  This makes the breakpoint inoperative as if
2848 it had been deleted, but remembers the information on the breakpoint so
2849 that you can @dfn{enable} it again later.
2850
2851 You disable and enable breakpoints, watchpoints, and catchpoints with
2852 the @code{enable} and @code{disable} commands, optionally specifying one
2853 or more breakpoint numbers as arguments.  Use @code{info break} or
2854 @code{info watch} to print a list of breakpoints, watchpoints, and
2855 catchpoints if you do not know which numbers to use.
2856
2857 A breakpoint, watchpoint, or catchpoint can have any of four different
2858 states of enablement:
2859
2860 @itemize @bullet
2861 @item
2862 Enabled.  The breakpoint stops your program.  A breakpoint set
2863 with the @code{break} command starts out in this state.
2864 @item
2865 Disabled.  The breakpoint has no effect on your program.
2866 @item
2867 Enabled once.  The breakpoint stops your program, but then becomes
2868 disabled.
2869 @item
2870 Enabled for deletion.  The breakpoint stops your program, but
2871 immediately after it does so it is deleted permanently.  A breakpoint
2872 set with the @code{tbreak} command starts out in this state.
2873 @end itemize
2874
2875 You can use the following commands to enable or disable breakpoints,
2876 watchpoints, and catchpoints:
2877
2878 @table @code
2879 @kindex disable breakpoints
2880 @kindex disable
2881 @kindex dis @r{(@code{disable})}
2882 @item disable @r{[}breakpoints@r{]} @r{[}@var{range}@dots{}@r{]}
2883 Disable the specified breakpoints---or all breakpoints, if none are
2884 listed.  A disabled breakpoint has no effect but is not forgotten.  All
2885 options such as ignore-counts, conditions and commands are remembered in
2886 case the breakpoint is enabled again later.  You may abbreviate
2887 @code{disable} as @code{dis}.
2888
2889 @kindex enable breakpoints
2890 @kindex enable
2891 @item enable @r{[}breakpoints@r{]} @r{[}@var{range}@dots{}@r{]}
2892 Enable the specified breakpoints (or all defined breakpoints).  They
2893 become effective once again in stopping your program.
2894
2895 @item enable @r{[}breakpoints@r{]} once @var{range}@dots{}
2896 Enable the specified breakpoints temporarily.  @value{GDBN} disables any
2897 of these breakpoints immediately after stopping your program.
2898
2899 @item enable @r{[}breakpoints@r{]} delete @var{range}@dots{}
2900 Enable the specified breakpoints to work once, then die.  @value{GDBN}
2901 deletes any of these breakpoints as soon as your program stops there.
2902 @end table
2903
2904 @c FIXME: I think the following ``Except for [...] @code{tbreak}'' is
2905 @c confusing: tbreak is also initially enabled.
2906 Except for a breakpoint set with @code{tbreak} (@pxref{Set Breaks,
2907 ,Setting breakpoints}), breakpoints that you set are initially enabled;
2908 subsequently, they become disabled or enabled only when you use one of
2909 the commands above.  (The command @code{until} can set and delete a
2910 breakpoint of its own, but it does not change the state of your other
2911 breakpoints; see @ref{Continuing and Stepping, ,Continuing and
2912 stepping}.)
2913
2914 @node Conditions
2915 @subsection Break conditions
2916 @cindex conditional breakpoints
2917 @cindex breakpoint conditions
2918
2919 @c FIXME what is scope of break condition expr?  Context where wanted?
2920 @c      in particular for a watchpoint?
2921 The simplest sort of breakpoint breaks every time your program reaches a
2922 specified place.  You can also specify a @dfn{condition} for a
2923 breakpoint.  A condition is just a Boolean expression in your
2924 programming language (@pxref{Expressions, ,Expressions}).  A breakpoint with
2925 a condition evaluates the expression each time your program reaches it,
2926 and your program stops only if the condition is @emph{true}.
2927
2928 This is the converse of using assertions for program validation; in that
2929 situation, you want to stop when the assertion is violated---that is,
2930 when the condition is false.  In C, if you want to test an assertion expressed
2931 by the condition @var{assert}, you should set the condition
2932 @samp{! @var{assert}} on the appropriate breakpoint.
2933
2934 Conditions are also accepted for watchpoints; you may not need them,
2935 since a watchpoint is inspecting the value of an expression anyhow---but
2936 it might be simpler, say, to just set a watchpoint on a variable name,
2937 and specify a condition that tests whether the new value is an interesting
2938 one.
2939
2940 Break conditions can have side effects, and may even call functions in
2941 your program.  This can be useful, for example, to activate functions
2942 that log program progress, or to use your own print functions to
2943 format special data structures. The effects are completely predictable
2944 unless there is another enabled breakpoint at the same address.  (In
2945 that case, @value{GDBN} might see the other breakpoint first and stop your
2946 program without checking the condition of this one.)  Note that
2947 breakpoint commands are usually more convenient and flexible than break
2948 conditions for the
2949 purpose of performing side effects when a breakpoint is reached
2950 (@pxref{Break Commands, ,Breakpoint command lists}).
2951
2952 Break conditions can be specified when a breakpoint is set, by using
2953 @samp{if} in the arguments to the @code{break} command.  @xref{Set
2954 Breaks, ,Setting breakpoints}.  They can also be changed at any time
2955 with the @code{condition} command.
2956
2957 You can also use the @code{if} keyword with the @code{watch} command.
2958 The @code{catch} command does not recognize the @code{if} keyword;
2959 @code{condition} is the only way to impose a further condition on a
2960 catchpoint.
2961
2962 @table @code
2963 @kindex condition
2964 @item condition @var{bnum} @var{expression}
2965 Specify @var{expression} as the break condition for breakpoint,
2966 watchpoint, or catchpoint number @var{bnum}.  After you set a condition,
2967 breakpoint @var{bnum} stops your program only if the value of
2968 @var{expression} is true (nonzero, in C).  When you use
2969 @code{condition}, @value{GDBN} checks @var{expression} immediately for
2970 syntactic correctness, and to determine whether symbols in it have
2971 referents in the context of your breakpoint.  If @var{expression} uses
2972 symbols not referenced in the context of the breakpoint, @value{GDBN}
2973 prints an error message:
2974
2975 @example
2976 No symbol "foo" in current context.
2977 @end example
2978
2979 @noindent
2980 @value{GDBN} does
2981 not actually evaluate @var{expression} at the time the @code{condition}
2982 command (or a command that sets a breakpoint with a condition, like
2983 @code{break if @dots{}}) is given, however.  @xref{Expressions, ,Expressions}.
2984
2985 @item condition @var{bnum}
2986 Remove the condition from breakpoint number @var{bnum}.  It becomes
2987 an ordinary unconditional breakpoint.
2988 @end table
2989
2990 @cindex ignore count (of breakpoint)
2991 A special case of a breakpoint condition is to stop only when the
2992 breakpoint has been reached a certain number of times.  This is so
2993 useful that there is a special way to do it, using the @dfn{ignore
2994 count} of the breakpoint.  Every breakpoint has an ignore count, which
2995 is an integer.  Most of the time, the ignore count is zero, and
2996 therefore has no effect.  But if your program reaches a breakpoint whose
2997 ignore count is positive, then instead of stopping, it just decrements
2998 the ignore count by one and continues.  As a result, if the ignore count
2999 value is @var{n}, the breakpoint does not stop the next @var{n} times
3000 your program reaches it.
3001
3002 @table @code
3003 @kindex ignore
3004 @item ignore @var{bnum} @var{count}
3005 Set the ignore count of breakpoint number @var{bnum} to @var{count}.
3006 The next @var{count} times the breakpoint is reached, your program's
3007 execution does not stop; other than to decrement the ignore count, @value{GDBN}
3008 takes no action.
3009
3010 To make the breakpoint stop the next time it is reached, specify
3011 a count of zero.
3012
3013 When you use @code{continue} to resume execution of your program from a
3014 breakpoint, you can specify an ignore count directly as an argument to
3015 @code{continue}, rather than using @code{ignore}.  @xref{Continuing and
3016 Stepping,,Continuing and stepping}.
3017
3018 If a breakpoint has a positive ignore count and a condition, the
3019 condition is not checked.  Once the ignore count reaches zero,
3020 @value{GDBN} resumes checking the condition.
3021
3022 You could achieve the effect of the ignore count with a condition such
3023 as @w{@samp{$foo-- <= 0}} using a debugger convenience variable that
3024 is decremented each time.  @xref{Convenience Vars, ,Convenience
3025 variables}.
3026 @end table
3027
3028 Ignore counts apply to breakpoints, watchpoints, and catchpoints.
3029
3030
3031 @node Break Commands
3032 @subsection Breakpoint command lists
3033
3034 @cindex breakpoint commands
3035 You can give any breakpoint (or watchpoint or catchpoint) a series of
3036 commands to execute when your program stops due to that breakpoint.  For
3037 example, you might want to print the values of certain expressions, or
3038 enable other breakpoints.
3039
3040 @table @code
3041 @kindex commands
3042 @kindex end
3043 @item commands @r{[}@var{bnum}@r{]}
3044 @itemx @dots{} @var{command-list} @dots{}
3045 @itemx end
3046 Specify a list of commands for breakpoint number @var{bnum}.  The commands
3047 themselves appear on the following lines.  Type a line containing just
3048 @code{end} to terminate the commands.
3049
3050 To remove all commands from a breakpoint, type @code{commands} and
3051 follow it immediately with @code{end}; that is, give no commands.
3052
3053 With no @var{bnum} argument, @code{commands} refers to the last
3054 breakpoint, watchpoint, or catchpoint set (not to the breakpoint most
3055 recently encountered).
3056 @end table
3057
3058 Pressing @key{RET} as a means of repeating the last @value{GDBN} command is
3059 disabled within a @var{command-list}.
3060
3061 You can use breakpoint commands to start your program up again.  Simply
3062 use the @code{continue} command, or @code{step}, or any other command
3063 that resumes execution.
3064
3065 Any other commands in the command list, after a command that resumes
3066 execution, are ignored.  This is because any time you resume execution
3067 (even with a simple @code{next} or @code{step}), you may encounter
3068 another breakpoint---which could have its own command list, leading to
3069 ambiguities about which list to execute.
3070
3071 @kindex silent
3072 If the first command you specify in a command list is @code{silent}, the
3073 usual message about stopping at a breakpoint is not printed.  This may
3074 be desirable for breakpoints that are to print a specific message and
3075 then continue.  If none of the remaining commands print anything, you
3076 see no sign that the breakpoint was reached.  @code{silent} is
3077 meaningful only at the beginning of a breakpoint command list.
3078
3079 The commands @code{echo}, @code{output}, and @code{printf} allow you to
3080 print precisely controlled output, and are often useful in silent
3081 breakpoints.  @xref{Output, ,Commands for controlled output}.
3082
3083 For example, here is how you could use breakpoint commands to print the
3084 value of @code{x} at entry to @code{foo} whenever @code{x} is positive.
3085
3086 @example
3087 break foo if x>0
3088 commands
3089 silent
3090 printf "x is %d\n",x
3091 cont
3092 end
3093 @end example
3094
3095 One application for breakpoint commands is to compensate for one bug so
3096 you can test for another.  Put a breakpoint just after the erroneous line
3097 of code, give it a condition to detect the case in which something
3098 erroneous has been done, and give it commands to assign correct values
3099 to any variables that need them.  End with the @code{continue} command
3100 so that your program does not stop, and start with the @code{silent}
3101 command so that no output is produced.  Here is an example:
3102
3103 @example
3104 break 403
3105 commands
3106 silent
3107 set x = y + 4
3108 cont
3109 end
3110 @end example
3111
3112 @node Breakpoint Menus
3113 @subsection Breakpoint menus
3114 @cindex overloading
3115 @cindex symbol overloading
3116
3117 Some programming languages (notably C@t{++}) permit a single function name
3118 to be defined several times, for application in different contexts.
3119 This is called @dfn{overloading}.  When a function name is overloaded,
3120 @samp{break @var{function}} is not enough to tell @value{GDBN} where you want
3121 a breakpoint.  If you realize this is a problem, you can use
3122 something like @samp{break @var{function}(@var{types})} to specify which
3123 particular version of the function you want.  Otherwise, @value{GDBN} offers
3124 you a menu of numbered choices for different possible breakpoints, and
3125 waits for your selection with the prompt @samp{>}.  The first two
3126 options are always @samp{[0] cancel} and @samp{[1] all}.  Typing @kbd{1}
3127 sets a breakpoint at each definition of @var{function}, and typing
3128 @kbd{0} aborts the @code{break} command without setting any new
3129 breakpoints.
3130
3131 For example, the following session excerpt shows an attempt to set a
3132 breakpoint at the overloaded symbol @code{String::after}.
3133 We choose three particular definitions of that function name:
3134
3135 @c FIXME! This is likely to change to show arg type lists, at least
3136 @smallexample
3137 @group
3138 (@value{GDBP}) b String::after
3139 [0] cancel
3140 [1] all
3141 [2] file:String.cc; line number:867
3142 [3] file:String.cc; line number:860
3143 [4] file:String.cc; line number:875
3144 [5] file:String.cc; line number:853
3145 [6] file:String.cc; line number:846
3146 [7] file:String.cc; line number:735
3147 > 2 4 6
3148 Breakpoint 1 at 0xb26c: file String.cc, line 867.
3149 Breakpoint 2 at 0xb344: file String.cc, line 875.
3150 Breakpoint 3 at 0xafcc: file String.cc, line 846.
3151 Multiple breakpoints were set.
3152 Use the "delete" command to delete unwanted
3153  breakpoints.
3154 (@value{GDBP})
3155 @end group
3156 @end smallexample
3157
3158 @c  @ifclear BARETARGET
3159 @node Error in Breakpoints
3160 @subsection ``Cannot insert breakpoints''
3161 @c
3162 @c  FIXME!! 14/6/95  Is there a real example of this?  Let's use it.
3163 @c
3164 Under some operating systems, breakpoints cannot be used in a program if
3165 any other process is running that program.  In this situation,
3166 attempting to run or continue a program with a breakpoint causes
3167 @value{GDBN} to print an error message:
3168
3169 @example
3170 Cannot insert breakpoints.
3171 The same program may be running in another process.
3172 @end example
3173
3174 When this happens, you have three ways to proceed:
3175
3176 @enumerate
3177 @item
3178 Remove or disable the breakpoints, then continue.
3179
3180 @item
3181 Suspend @value{GDBN}, and copy the file containing your program to a new
3182 name.  Resume @value{GDBN} and use the @code{exec-file} command to specify
3183 that @value{GDBN} should run your program under that name.
3184 Then start your program again.
3185
3186 @item
3187 Relink your program so that the text segment is nonsharable, using the
3188 linker option @samp{-N}.  The operating system limitation may not apply
3189 to nonsharable executables.
3190 @end enumerate
3191 @c  @end ifclear
3192
3193 A similar message can be printed if you request too many active
3194 hardware-assisted breakpoints and watchpoints:
3195
3196 @c FIXME: the precise wording of this message may change; the relevant
3197 @c source change is not committed yet (Sep 3, 1999).
3198 @smallexample
3199 Stopped; cannot insert breakpoints.
3200 You may have requested too many hardware breakpoints and watchpoints.
3201 @end smallexample
3202
3203 @noindent
3204 This message is printed when you attempt to resume the program, since
3205 only then @value{GDBN} knows exactly how many hardware breakpoints and
3206 watchpoints it needs to insert.
3207
3208 When this message is printed, you need to disable or remove some of the
3209 hardware-assisted breakpoints and watchpoints, and then continue.
3210
3211
3212 @node Continuing and Stepping
3213 @section Continuing and stepping
3214
3215 @cindex stepping
3216 @cindex continuing
3217 @cindex resuming execution
3218 @dfn{Continuing} means resuming program execution until your program
3219 completes normally.  In contrast, @dfn{stepping} means executing just
3220 one more ``step'' of your program, where ``step'' may mean either one
3221 line of source code, or one machine instruction (depending on what
3222 particular command you use).  Either when continuing or when stepping,
3223 your program may stop even sooner, due to a breakpoint or a signal.  (If
3224 it stops due to a signal, you may want to use @code{handle}, or use
3225 @samp{signal 0} to resume execution.  @xref{Signals, ,Signals}.)
3226
3227 @table @code
3228 @kindex continue
3229 @kindex c @r{(@code{continue})}
3230 @kindex fg @r{(resume foreground execution)}
3231 @item continue @r{[}@var{ignore-count}@r{]}
3232 @itemx c @r{[}@var{ignore-count}@r{]}
3233 @itemx fg @r{[}@var{ignore-count}@r{]}
3234 Resume program execution, at the address where your program last stopped;
3235 any breakpoints set at that address are bypassed.  The optional argument
3236 @var{ignore-count} allows you to specify a further number of times to
3237 ignore a breakpoint at this location; its effect is like that of
3238 @code{ignore} (@pxref{Conditions, ,Break conditions}).
3239
3240 The argument @var{ignore-count} is meaningful only when your program
3241 stopped due to a breakpoint.  At other times, the argument to
3242 @code{continue} is ignored.
3243
3244 The synonyms @code{c} and @code{fg} (for @dfn{foreground}, as the
3245 debugged program is deemed to be the foreground program) are provided
3246 purely for convenience, and have exactly the same behavior as
3247 @code{continue}.
3248 @end table
3249
3250 To resume execution at a different place, you can use @code{return}
3251 (@pxref{Returning, ,Returning from a function}) to go back to the
3252 calling function; or @code{jump} (@pxref{Jumping, ,Continuing at a
3253 different address}) to go to an arbitrary location in your program.
3254
3255 A typical technique for using stepping is to set a breakpoint
3256 (@pxref{Breakpoints, ,Breakpoints; watchpoints; and catchpoints}) at the
3257 beginning of the function or the section of your program where a problem
3258 is believed to lie, run your program until it stops at that breakpoint,
3259 and then step through the suspect area, examining the variables that are
3260 interesting, until you see the problem happen.
3261
3262 @table @code
3263 @kindex step
3264 @kindex s @r{(@code{step})}
3265 @item step
3266 Continue running your program until control reaches a different source
3267 line, then stop it and return control to @value{GDBN}.  This command is
3268 abbreviated @code{s}.
3269
3270 @quotation
3271 @c "without debugging information" is imprecise; actually "without line
3272 @c numbers in the debugging information".  (gcc -g1 has debugging info but
3273 @c not line numbers).  But it seems complex to try to make that
3274 @c distinction here.
3275 @emph{Warning:} If you use the @code{step} command while control is
3276 within a function that was compiled without debugging information,
3277 execution proceeds until control reaches a function that does have
3278 debugging information.  Likewise, it will not step into a function which
3279 is compiled without debugging information.  To step through functions
3280 without debugging information, use the @code{stepi} command, described
3281 below.
3282 @end quotation
3283
3284 The @code{step} command only stops at the first instruction of a source
3285 line.  This prevents the multiple stops that could otherwise occur in
3286 @code{switch} statements, @code{for} loops, etc.  @code{step} continues
3287 to stop if a function that has debugging information is called within
3288 the line.  In other words, @code{step} @emph{steps inside} any functions
3289 called within the line.
3290
3291 Also, the @code{step} command only enters a function if there is line
3292 number information for the function.  Otherwise it acts like the
3293 @code{next} command.  This avoids problems when using @code{cc -gl}
3294 on MIPS machines.  Previously, @code{step} entered subroutines if there
3295 was any debugging information about the routine.
3296
3297 @item step @var{count}
3298 Continue running as in @code{step}, but do so @var{count} times.  If a
3299 breakpoint is reached, or a signal not related to stepping occurs before
3300 @var{count} steps, stepping stops right away.
3301
3302 @kindex next
3303 @kindex n @r{(@code{next})}
3304 @item next @r{[}@var{count}@r{]}
3305 Continue to the next source line in the current (innermost) stack frame.
3306 This is similar to @code{step}, but function calls that appear within
3307 the line of code are executed without stopping.  Execution stops when
3308 control reaches a different line of code at the original stack level
3309 that was executing when you gave the @code{next} command.  This command
3310 is abbreviated @code{n}.
3311
3312 An argument @var{count} is a repeat count, as for @code{step}.
3313
3314
3315 @c  FIX ME!!  Do we delete this, or is there a way it fits in with
3316 @c  the following paragraph?   ---  Vctoria
3317 @c
3318 @c  @code{next} within a function that lacks debugging information acts like
3319 @c  @code{step}, but any function calls appearing within the code of the
3320 @c  function are executed without stopping.
3321
3322 The @code{next} command only stops at the first instruction of a
3323 source line.  This prevents multiple stops that could otherwise occur in
3324 @code{switch} statements, @code{for} loops, etc.
3325
3326 @kindex set step-mode
3327 @item set step-mode
3328 @cindex functions without line info, and stepping
3329 @cindex stepping into functions with no line info
3330 @itemx set step-mode on
3331 The @code{set step-mode on} command causes the @code{step} command to
3332 stop at the first instruction of a function which contains no debug line
3333 information rather than stepping over it.
3334
3335 This is useful in cases where you may be interested in inspecting the
3336 machine instructions of a function which has no symbolic info and do not
3337 want @value{GDBN} to automatically skip over this function.
3338
3339 @item set step-mode off
3340 Causes the @code{step} command to step over any functions which contains no
3341 debug information.  This is the default.
3342
3343 @kindex finish
3344 @item finish
3345 Continue running until just after function in the selected stack frame
3346 returns.  Print the returned value (if any).
3347
3348 Contrast this with the @code{return} command (@pxref{Returning,
3349 ,Returning from a function}).
3350
3351 @kindex until
3352 @kindex u @r{(@code{until})}
3353 @item until
3354 @itemx u
3355 Continue running until a source line past the current line, in the
3356 current stack frame, is reached.  This command is used to avoid single
3357 stepping through a loop more than once.  It is like the @code{next}
3358 command, except that when @code{until} encounters a jump, it
3359 automatically continues execution until the program counter is greater
3360 than the address of the jump.
3361
3362 This means that when you reach the end of a loop after single stepping
3363 though it, @code{until} makes your program continue execution until it
3364 exits the loop.  In contrast, a @code{next} command at the end of a loop
3365 simply steps back to the beginning of the loop, which forces you to step
3366 through the next iteration.
3367
3368 @code{until} always stops your program if it attempts to exit the current
3369 stack frame.
3370
3371 @code{until} may produce somewhat counterintuitive results if the order
3372 of machine code does not match the order of the source lines.  For
3373 example, in the following excerpt from a debugging session, the @code{f}
3374 (@code{frame}) command shows that execution is stopped at line
3375 @code{206}; yet when we use @code{until}, we get to line @code{195}:
3376
3377 @example
3378 (@value{GDBP}) f
3379 #0  main (argc=4, argv=0xf7fffae8) at m4.c:206
3380 206                 expand_input();
3381 (@value{GDBP}) until
3382 195             for ( ; argc > 0; NEXTARG) @{
3383 @end example
3384
3385 This happened because, for execution efficiency, the compiler had
3386 generated code for the loop closure test at the end, rather than the
3387 start, of the loop---even though the test in a C @code{for}-loop is
3388 written before the body of the loop.  The @code{until} command appeared
3389 to step back to the beginning of the loop when it advanced to this
3390 expression; however, it has not really gone to an earlier
3391 statement---not in terms of the actual machine code.
3392
3393 @code{until} with no argument works by means of single
3394 instruction stepping, and hence is slower than @code{until} with an
3395 argument.
3396
3397 @item until @var{location}
3398 @itemx u @var{location}
3399 Continue running your program until either the specified location is
3400 reached, or the current stack frame returns.  @var{location} is any of
3401 the forms of argument acceptable to @code{break} (@pxref{Set Breaks,
3402 ,Setting breakpoints}).  This form of the command uses breakpoints,
3403 and hence is quicker than @code{until} without an argument.
3404
3405 @kindex stepi
3406 @kindex si @r{(@code{stepi})}
3407 @item stepi
3408 @itemx stepi @var{arg}
3409 @itemx si
3410 Execute one machine instruction, then stop and return to the debugger.
3411
3412 It is often useful to do @samp{display/i $pc} when stepping by machine
3413 instructions.  This makes @value{GDBN} automatically display the next
3414 instruction to be executed, each time your program stops.  @xref{Auto
3415 Display,, Automatic display}.
3416
3417 An argument is a repeat count, as in @code{step}.
3418
3419 @need 750
3420 @kindex nexti
3421 @kindex ni @r{(@code{nexti})}
3422 @item nexti
3423 @itemx nexti @var{arg}
3424 @itemx ni
3425 Execute one machine instruction, but if it is a function call,
3426 proceed until the function returns.
3427
3428 An argument is a repeat count, as in @code{next}.
3429 @end table
3430
3431 @node Signals
3432 @section Signals
3433 @cindex signals
3434
3435 A signal is an asynchronous event that can happen in a program.  The
3436 operating system defines the possible kinds of signals, and gives each
3437 kind a name and a number.  For example, in Unix @code{SIGINT} is the
3438 signal a program gets when you type an interrupt character (often @kbd{C-c});
3439 @code{SIGSEGV} is the signal a program gets from referencing a place in
3440 memory far away from all the areas in use; @code{SIGALRM} occurs when
3441 the alarm clock timer goes off (which happens only if your program has
3442 requested an alarm).
3443
3444 @cindex fatal signals
3445 Some signals, including @code{SIGALRM}, are a normal part of the
3446 functioning of your program.  Others, such as @code{SIGSEGV}, indicate
3447 errors; these signals are @dfn{fatal} (they kill your program immediately) if the
3448 program has not specified in advance some other way to handle the signal.
3449 @code{SIGINT} does not indicate an error in your program, but it is normally
3450 fatal so it can carry out the purpose of the interrupt: to kill the program.
3451
3452 @value{GDBN} has the ability to detect any occurrence of a signal in your
3453 program.  You can tell @value{GDBN} in advance what to do for each kind of
3454 signal.
3455
3456 @cindex handling signals
3457 Normally, @value{GDBN} is set up to let the non-erroneous signals like
3458 @code{SIGALRM} be silently passed to your program
3459 (so as not to interfere with their role in the program's functioning)
3460 but to stop your program immediately whenever an error signal happens.
3461 You can change these settings with the @code{handle} command.
3462
3463 @table @code
3464 @kindex info signals
3465 @item info signals
3466 @itemx info handle
3467 Print a table of all the kinds of signals and how @value{GDBN} has been told to
3468 handle each one.  You can use this to see the signal numbers of all
3469 the defined types of signals.
3470
3471 @code{info handle} is an alias for @code{info signals}.
3472
3473 @kindex handle
3474 @item handle @var{signal} @var{keywords}@dots{}
3475 Change the way @value{GDBN} handles signal @var{signal}.  @var{signal}
3476 can be the number of a signal or its name (with or without the
3477 @samp{SIG} at the beginning); a list of signal numbers of the form
3478 @samp{@var{low}-@var{high}}; or the word @samp{all}, meaning all the
3479 known signals.  The @var{keywords} say what change to make.
3480 @end table
3481
3482 @c @group
3483 The keywords allowed by the @code{handle} command can be abbreviated.
3484 Their full names are:
3485
3486 @table @code
3487 @item nostop
3488 @value{GDBN} should not stop your program when this signal happens.  It may
3489 still print a message telling you that the signal has come in.
3490
3491 @item stop
3492 @value{GDBN} should stop your program when this signal happens.  This implies
3493 the @code{print} keyword as well.
3494
3495 @item print
3496 @value{GDBN} should print a message when this signal happens.
3497
3498 @item noprint
3499 @value{GDBN} should not mention the occurrence of the signal at all.  This
3500 implies the @code{nostop} keyword as well.
3501
3502 @item pass
3503 @itemx noignore
3504 @value{GDBN} should allow your program to see this signal; your program
3505 can handle the signal, or else it may terminate if the signal is fatal
3506 and not handled.  @code{pass} and @code{noignore} are synonyms.
3507
3508 @item nopass
3509 @itemx ignore
3510 @value{GDBN} should not allow your program to see this signal.
3511 @code{nopass} and @code{ignore} are synonyms.
3512 @end table
3513 @c @end group
3514
3515 When a signal stops your program, the signal is not visible to the
3516 program until you
3517 continue.  Your program sees the signal then, if @code{pass} is in
3518 effect for the signal in question @emph{at that time}.  In other words,
3519 after @value{GDBN} reports a signal, you can use the @code{handle}
3520 command with @code{pass} or @code{nopass} to control whether your
3521 program sees that signal when you continue.
3522
3523 The default is set to @code{nostop}, @code{noprint}, @code{pass} for
3524 non-erroneous signals such as @code{SIGALRM}, @code{SIGWINCH} and
3525 @code{SIGCHLD}, and to @code{stop}, @code{print}, @code{pass} for the
3526 erroneous signals.
3527
3528 You can also use the @code{signal} command to prevent your program from
3529 seeing a signal, or cause it to see a signal it normally would not see,
3530 or to give it any signal at any time.  For example, if your program stopped
3531 due to some sort of memory reference error, you might store correct
3532 values into the erroneous variables and continue, hoping to see more
3533 execution; but your program would probably terminate immediately as
3534 a result of the fatal signal once it saw the signal.  To prevent this,
3535 you can continue with @samp{signal 0}.  @xref{Signaling, ,Giving your
3536 program a signal}.
3537
3538 @node Thread Stops
3539 @section Stopping and starting multi-thread programs
3540
3541 When your program has multiple threads (@pxref{Threads,, Debugging
3542 programs with multiple threads}), you can choose whether to set
3543 breakpoints on all threads, or on a particular thread.
3544
3545 @table @code
3546 @cindex breakpoints and threads
3547 @cindex thread breakpoints
3548 @kindex break @dots{} thread @var{threadno}
3549 @item break @var{linespec} thread @var{threadno}
3550 @itemx break @var{linespec} thread @var{threadno} if @dots{}
3551 @var{linespec} specifies source lines; there are several ways of
3552 writing them, but the effect is always to specify some source line.
3553
3554 Use the qualifier @samp{thread @var{threadno}} with a breakpoint command
3555 to specify that you only want @value{GDBN} to stop the program when a
3556 particular thread reaches this breakpoint.  @var{threadno} is one of the
3557 numeric thread identifiers assigned by @value{GDBN}, shown in the first
3558 column of the @samp{info threads} display.
3559
3560 If you do not specify @samp{thread @var{threadno}} when you set a
3561 breakpoint, the breakpoint applies to @emph{all} threads of your
3562 program.
3563
3564 You can use the @code{thread} qualifier on conditional breakpoints as
3565 well; in this case, place @samp{thread @var{threadno}} before the
3566 breakpoint condition, like this:
3567
3568 @smallexample
3569 (@value{GDBP}) break frik.c:13 thread 28 if bartab > lim
3570 @end smallexample
3571
3572 @end table
3573
3574 @cindex stopped threads
3575 @cindex threads, stopped
3576 Whenever your program stops under @value{GDBN} for any reason,
3577 @emph{all} threads of execution stop, not just the current thread.  This
3578 allows you to examine the overall state of the program, including
3579 switching between threads, without worrying that things may change
3580 underfoot.
3581
3582 @cindex continuing threads
3583 @cindex threads, continuing
3584 Conversely, whenever you restart the program, @emph{all} threads start
3585 executing.  @emph{This is true even when single-stepping} with commands
3586 like @code{step} or @code{next}.
3587
3588 In particular, @value{GDBN} cannot single-step all threads in lockstep.
3589 Since thread scheduling is up to your debugging target's operating
3590 system (not controlled by @value{GDBN}), other threads may
3591 execute more than one statement while the current thread completes a
3592 single step.  Moreover, in general other threads stop in the middle of a
3593 statement, rather than at a clean statement boundary, when the program
3594 stops.
3595
3596 You might even find your program stopped in another thread after
3597 continuing or even single-stepping.  This happens whenever some other
3598 thread runs into a breakpoint, a signal, or an exception before the
3599 first thread completes whatever you requested.
3600
3601 On some OSes, you can lock the OS scheduler and thus allow only a single
3602 thread to run.
3603
3604 @table @code
3605 @item set scheduler-locking @var{mode}
3606 Set the scheduler locking mode.  If it is @code{off}, then there is no
3607 locking and any thread may run at any time.  If @code{on}, then only the
3608 current thread may run when the inferior is resumed.  The @code{step}
3609 mode optimizes for single-stepping.  It stops other threads from
3610 ``seizing the prompt'' by preempting the current thread while you are
3611 stepping.  Other threads will only rarely (or never) get a chance to run
3612 when you step.  They are more likely to run when you @samp{next} over a
3613 function call, and they are completely free to run when you use commands
3614 like @samp{continue}, @samp{until}, or @samp{finish}.  However, unless another
3615 thread hits a breakpoint during its timeslice, they will never steal the
3616 @value{GDBN} prompt away from the thread that you are debugging.
3617
3618 @item show scheduler-locking
3619 Display the current scheduler locking mode.
3620 @end table
3621
3622
3623 @node Stack
3624 @chapter Examining the Stack
3625
3626 When your program has stopped, the first thing you need to know is where it
3627 stopped and how it got there.
3628
3629 @cindex call stack
3630 Each time your program performs a function call, information about the call
3631 is generated.
3632 That information includes the location of the call in your program,
3633 the arguments of the call,
3634 and the local variables of the function being called.
3635 The information is saved in a block of data called a @dfn{stack frame}.
3636 The stack frames are allocated in a region of memory called the @dfn{call
3637 stack}.
3638
3639 When your program stops, the @value{GDBN} commands for examining the
3640 stack allow you to see all of this information.
3641
3642 @cindex selected frame
3643 One of the stack frames is @dfn{selected} by @value{GDBN} and many
3644 @value{GDBN} commands refer implicitly to the selected frame.  In
3645 particular, whenever you ask @value{GDBN} for the value of a variable in
3646 your program, the value is found in the selected frame.  There are
3647 special @value{GDBN} commands to select whichever frame you are
3648 interested in. @xref{Selection, ,Selecting a frame}.
3649
3650 When your program stops, @value{GDBN} automatically selects the
3651 currently executing frame and describes it briefly, similar to the
3652 @code{frame} command (@pxref{Frame Info, ,Information about a frame}).
3653
3654 @menu
3655 * Frames::                      Stack frames
3656 * Backtrace::                   Backtraces
3657 * Selection::                   Selecting a frame
3658 * Frame Info::                  Information on a frame
3659
3660 @end menu
3661
3662 @node Frames
3663 @section Stack frames
3664
3665 @cindex frame, definition
3666 @cindex stack frame
3667 The call stack is divided up into contiguous pieces called @dfn{stack
3668 frames}, or @dfn{frames} for short; each frame is the data associated
3669 with one call to one function.  The frame contains the arguments given
3670 to the function, the function's local variables, and the address at
3671 which the function is executing.
3672
3673 @cindex initial frame
3674 @cindex outermost frame
3675 @cindex innermost frame
3676 When your program is started, the stack has only one frame, that of the
3677 function @code{main}.  This is called the @dfn{initial} frame or the
3678 @dfn{outermost} frame.  Each time a function is called, a new frame is
3679 made.  Each time a function returns, the frame for that function invocation
3680 is eliminated.  If a function is recursive, there can be many frames for
3681 the same function.  The frame for the function in which execution is
3682 actually occurring is called the @dfn{innermost} frame.  This is the most
3683 recently created of all the stack frames that still exist.
3684
3685 @cindex frame pointer
3686 Inside your program, stack frames are identified by their addresses.  A
3687 stack frame consists of many bytes, each of which has its own address; each
3688 kind of computer has a convention for choosing one byte whose
3689 address serves as the address of the frame.  Usually this address is kept
3690 in a register called the @dfn{frame pointer register} while execution is
3691 going on in that frame.
3692
3693 @cindex frame number
3694 @value{GDBN} assigns numbers to all existing stack frames, starting with
3695 zero for the innermost frame, one for the frame that called it,
3696 and so on upward.  These numbers do not really exist in your program;
3697 they are assigned by @value{GDBN} to give you a way of designating stack
3698 frames in @value{GDBN} commands.
3699
3700 @c The -fomit-frame-pointer below perennially causes hbox overflow
3701 @c underflow problems.
3702 @cindex frameless execution
3703 Some compilers provide a way to compile functions so that they operate
3704 without stack frames.  (For example, the @value{GCC} option
3705 @example
3706 @samp{-fomit-frame-pointer}
3707 @end example
3708 generates functions without a frame.)
3709 This is occasionally done with heavily used library functions to save
3710 the frame setup time.  @value{GDBN} has limited facilities for dealing
3711 with these function invocations.  If the innermost function invocation
3712 has no stack frame, @value{GDBN} nevertheless regards it as though
3713 it had a separate frame, which is numbered zero as usual, allowing
3714 correct tracing of the function call chain.  However, @value{GDBN} has
3715 no provision for frameless functions elsewhere in the stack.
3716
3717 @table @code
3718 @kindex frame@r{, command}
3719 @cindex current stack frame
3720 @item frame @var{args}
3721 The @code{frame} command allows you to move from one stack frame to another,
3722 and to print the stack frame you select.  @var{args} may be either the
3723 address of the frame or the stack frame number.  Without an argument,
3724 @code{frame} prints the current stack frame.
3725
3726 @kindex select-frame
3727 @cindex selecting frame silently
3728 @item select-frame
3729 The @code{select-frame} command allows you to move from one stack frame
3730 to another without printing the frame.  This is the silent version of
3731 @code{frame}.
3732 @end table
3733
3734 @node Backtrace
3735 @section Backtraces
3736
3737 @cindex backtraces
3738 @cindex tracebacks
3739 @cindex stack traces
3740 A backtrace is a summary of how your program got where it is.  It shows one
3741 line per frame, for many frames, starting with the currently executing
3742 frame (frame zero), followed by its caller (frame one), and on up the
3743 stack.
3744
3745 @table @code
3746 @kindex backtrace
3747 @kindex bt @r{(@code{backtrace})}
3748 @item backtrace
3749 @itemx bt
3750 Print a backtrace of the entire stack: one line per frame for all
3751 frames in the stack.
3752
3753 You can stop the backtrace at any time by typing the system interrupt
3754 character, normally @kbd{C-c}.
3755
3756 @item backtrace @var{n}
3757 @itemx bt @var{n}
3758 Similar, but print only the innermost @var{n} frames.
3759
3760 @item backtrace -@var{n}
3761 @itemx bt -@var{n}
3762 Similar, but print only the outermost @var{n} frames.
3763 @end table
3764
3765 @kindex where
3766 @kindex info stack
3767 @kindex info s @r{(@code{info stack})}
3768 The names @code{where} and @code{info stack} (abbreviated @code{info s})
3769 are additional aliases for @code{backtrace}.
3770
3771 Each line in the backtrace shows the frame number and the function name.
3772 The program counter value is also shown---unless you use @code{set
3773 print address off}.  The backtrace also shows the source file name and
3774 line number, as well as the arguments to the function.  The program
3775 counter value is omitted if it is at the beginning of the code for that
3776 line number.
3777
3778 Here is an example of a backtrace.  It was made with the command
3779 @samp{bt 3}, so it shows the innermost three frames.
3780
3781 @smallexample
3782 @group
3783 #0  m4_traceon (obs=0x24eb0, argc=1, argv=0x2b8c8)
3784     at builtin.c:993
3785 #1  0x6e38 in expand_macro (sym=0x2b600) at macro.c:242
3786 #2  0x6840 in expand_token (obs=0x0, t=177664, td=0xf7fffb08)
3787     at macro.c:71
3788 (More stack frames follow...)
3789 @end group
3790 @end smallexample
3791
3792 @noindent
3793 The display for frame zero does not begin with a program counter
3794 value, indicating that your program has stopped at the beginning of the
3795 code for line @code{993} of @code{builtin.c}.
3796
3797 @node Selection
3798 @section Selecting a frame
3799
3800 Most commands for examining the stack and other data in your program work on
3801 whichever stack frame is selected at the moment.  Here are the commands for
3802 selecting a stack frame; all of them finish by printing a brief description
3803 of the stack frame just selected.
3804
3805 @table @code
3806 @kindex frame@r{, selecting}
3807 @kindex f @r{(@code{frame})}
3808 @item frame @var{n}
3809 @itemx f @var{n}
3810 Select frame number @var{n}.  Recall that frame zero is the innermost
3811 (currently executing) frame, frame one is the frame that called the
3812 innermost one, and so on.  The highest-numbered frame is the one for
3813 @code{main}.
3814
3815 @item frame @var{addr}
3816 @itemx f @var{addr}
3817 Select the frame at address @var{addr}.  This is useful mainly if the
3818 chaining of stack frames has been damaged by a bug, making it
3819 impossible for @value{GDBN} to assign numbers properly to all frames.  In
3820 addition, this can be useful when your program has multiple stacks and
3821 switches between them.
3822
3823 On the SPARC architecture, @code{frame} needs two addresses to
3824 select an arbitrary frame: a frame pointer and a stack pointer.
3825
3826 On the MIPS and Alpha architecture, it needs two addresses: a stack
3827 pointer and a program counter.
3828
3829 On the 29k architecture, it needs three addresses: a register stack
3830 pointer, a program counter, and a memory stack pointer.
3831 @c note to future updaters: this is conditioned on a flag
3832 @c SETUP_ARBITRARY_FRAME in the tm-*.h files.  The above is up to date
3833 @c as of 27 Jan 1994.
3834
3835 @kindex up
3836 @item up @var{n}
3837 Move @var{n} frames up the stack.  For positive numbers @var{n}, this
3838 advances toward the outermost frame, to higher frame numbers, to frames
3839 that have existed longer.  @var{n} defaults to one.
3840
3841 @kindex down
3842 @kindex do @r{(@code{down})}
3843 @item down @var{n}
3844 Move @var{n} frames down the stack.  For positive numbers @var{n}, this
3845 advances toward the innermost frame, to lower frame numbers, to frames
3846 that were created more recently.  @var{n} defaults to one.  You may
3847 abbreviate @code{down} as @code{do}.
3848 @end table
3849
3850 All of these commands end by printing two lines of output describing the
3851 frame.  The first line shows the frame number, the function name, the
3852 arguments, and the source file and line number of execution in that
3853 frame.  The second line shows the text of that source line.
3854
3855 @need 1000
3856 For example:
3857
3858 @smallexample
3859 @group
3860 (@value{GDBP}) up
3861 #1  0x22f0 in main (argc=1, argv=0xf7fffbf4, env=0xf7fffbfc)
3862     at env.c:10
3863 10              read_input_file (argv[i]);
3864 @end group
3865 @end smallexample
3866
3867 After such a printout, the @code{list} command with no arguments
3868 prints ten lines centered on the point of execution in the frame.
3869 @xref{List, ,Printing source lines}.
3870
3871 @table @code
3872 @kindex down-silently
3873 @kindex up-silently
3874 @item up-silently @var{n}
3875 @itemx down-silently @var{n}
3876 These two commands are variants of @code{up} and @code{down},
3877 respectively; they differ in that they do their work silently, without
3878 causing display of the new frame.  They are intended primarily for use
3879 in @value{GDBN} command scripts, where the output might be unnecessary and
3880 distracting.
3881 @end table
3882
3883 @node Frame Info
3884 @section Information about a frame
3885
3886 There are several other commands to print information about the selected
3887 stack frame.
3888
3889 @table @code
3890 @item frame
3891 @itemx f
3892 When used without any argument, this command does not change which
3893 frame is selected, but prints a brief description of the currently
3894 selected stack frame.  It can be abbreviated @code{f}.  With an
3895 argument, this command is used to select a stack frame.
3896 @xref{Selection, ,Selecting a frame}.
3897
3898 @kindex info frame
3899 @kindex info f @r{(@code{info frame})}
3900 @item info frame
3901 @itemx info f
3902 This command prints a verbose description of the selected stack frame,
3903 including:
3904
3905 @itemize @bullet
3906 @item
3907 the address of the frame
3908 @item
3909 the address of the next frame down (called by this frame)
3910 @item
3911 the address of the next frame up (caller of this frame)
3912 @item
3913 the language in which the source code corresponding to this frame is written
3914 @item
3915 the address of the frame's arguments
3916 @item
3917 the address of the frame's local variables
3918 @item
3919 the program counter saved in it (the address of execution in the caller frame)
3920 @item
3921 which registers were saved in the frame
3922 @end itemize
3923
3924 @noindent The verbose description is useful when
3925 something has gone wrong that has made the stack format fail to fit
3926 the usual conventions.
3927
3928 @item info frame @var{addr}
3929 @itemx info f @var{addr}
3930 Print a verbose description of the frame at address @var{addr}, without
3931 selecting that frame.  The selected frame remains unchanged by this
3932 command.  This requires the same kind of address (more than one for some
3933 architectures) that you specify in the @code{frame} command.
3934 @xref{Selection, ,Selecting a frame}.
3935
3936 @kindex info args
3937 @item info args
3938 Print the arguments of the selected frame, each on a separate line.
3939
3940 @item info locals
3941 @kindex info locals
3942 Print the local variables of the selected frame, each on a separate
3943 line.  These are all variables (declared either static or automatic)
3944 accessible at the point of execution of the selected frame.
3945
3946 @kindex info catch
3947 @cindex catch exceptions, list active handlers
3948 @cindex exception handlers, how to list
3949 @item info catch
3950 Print a list of all the exception handlers that are active in the
3951 current stack frame at the current point of execution.  To see other
3952 exception handlers, visit the associated frame (using the @code{up},
3953 @code{down}, or @code{frame} commands); then type @code{info catch}.
3954 @xref{Set Catchpoints, , Setting catchpoints}.
3955
3956 @end table
3957
3958
3959 @node Source
3960 @chapter Examining Source Files
3961
3962 @value{GDBN} can print parts of your program's source, since the debugging
3963 information recorded in the program tells @value{GDBN} what source files were
3964 used to build it.  When your program stops, @value{GDBN} spontaneously prints
3965 the line where it stopped.  Likewise, when you select a stack frame
3966 (@pxref{Selection, ,Selecting a frame}), @value{GDBN} prints the line where
3967 execution in that frame has stopped.  You can print other portions of
3968 source files by explicit command.
3969
3970 If you use @value{GDBN} through its @sc{gnu} Emacs interface, you may
3971 prefer to use Emacs facilities to view source; see @ref{Emacs, ,Using
3972 @value{GDBN} under @sc{gnu} Emacs}.
3973
3974 @menu
3975 * List::                        Printing source lines
3976 * Search::                      Searching source files
3977 * Source Path::                 Specifying source directories
3978 * Machine Code::                Source and machine code
3979 @end menu
3980
3981 @node List
3982 @section Printing source lines
3983
3984 @kindex list
3985 @kindex l @r{(@code{list})}
3986 To print lines from a source file, use the @code{list} command
3987 (abbreviated @code{l}).  By default, ten lines are printed.
3988 There are several ways to specify what part of the file you want to print.
3989
3990 Here are the forms of the @code{list} command most commonly used:
3991
3992 @table @code
3993 @item list @var{linenum}
3994 Print lines centered around line number @var{linenum} in the
3995 current source file.
3996
3997 @item list @var{function}
3998 Print lines centered around the beginning of function
3999 @var{function}.
4000
4001 @item list
4002 Print more lines.  If the last lines printed were printed with a
4003 @code{list} command, this prints lines following the last lines
4004 printed; however, if the last line printed was a solitary line printed
4005 as part of displaying a stack frame (@pxref{Stack, ,Examining the
4006 Stack}), this prints lines centered around that line.
4007
4008 @item list -
4009 Print lines just before the lines last printed.
4010 @end table
4011
4012 By default, @value{GDBN} prints ten source lines with any of these forms of
4013 the @code{list} command.  You can change this using @code{set listsize}:
4014
4015 @table @code
4016 @kindex set listsize
4017 @item set listsize @var{count}
4018 Make the @code{list} command display @var{count} source lines (unless
4019 the @code{list} argument explicitly specifies some other number).
4020
4021 @kindex show listsize
4022 @item show listsize
4023 Display the number of lines that @code{list} prints.
4024 @end table
4025
4026 Repeating a @code{list} command with @key{RET} discards the argument,
4027 so it is equivalent to typing just @code{list}.  This is more useful
4028 than listing the same lines again.  An exception is made for an
4029 argument of @samp{-}; that argument is preserved in repetition so that
4030 each repetition moves up in the source file.
4031
4032 @cindex linespec
4033 In general, the @code{list} command expects you to supply zero, one or two
4034 @dfn{linespecs}.  Linespecs specify source lines; there are several ways
4035 of writing them, but the effect is always to specify some source line.
4036 Here is a complete description of the possible arguments for @code{list}:
4037
4038 @table @code
4039 @item list @var{linespec}
4040 Print lines centered around the line specified by @var{linespec}.
4041
4042 @item list @var{first},@var{last}
4043 Print lines from @var{first} to @var{last}.  Both arguments are
4044 linespecs.
4045
4046 @item list ,@var{last}
4047 Print lines ending with @var{last}.
4048
4049 @item list @var{first},
4050 Print lines starting with @var{first}.
4051
4052 @item list +
4053 Print lines just after the lines last printed.
4054
4055 @item list -
4056 Print lines just before the lines last printed.
4057
4058 @item list
4059 As described in the preceding table.
4060 @end table
4061
4062 Here are the ways of specifying a single source line---all the
4063 kinds of linespec.
4064
4065 @table @code
4066 @item @var{number}
4067 Specifies line @var{number} of the current source file.
4068 When a @code{list} command has two linespecs, this refers to
4069 the same source file as the first linespec.
4070
4071 @item +@var{offset}
4072 Specifies the line @var{offset} lines after the last line printed.
4073 When used as the second linespec in a @code{list} command that has
4074 two, this specifies the line @var{offset} lines down from the
4075 first linespec.
4076
4077 @item -@var{offset}
4078 Specifies the line @var{offset} lines before the last line printed.
4079
4080 @item @var{filename}:@var{number}
4081 Specifies line @var{number} in the source file @var{filename}.
4082
4083 @item @var{function}
4084 Specifies the line that begins the body of the function @var{function}.
4085 For example: in C, this is the line with the open brace.
4086
4087 @item @var{filename}:@var{function}
4088 Specifies the line of the open-brace that begins the body of the
4089 function @var{function} in the file @var{filename}.  You only need the
4090 file name with a function name to avoid ambiguity when there are
4091 identically named functions in different source files.
4092
4093 @item *@var{address}
4094 Specifies the line containing the program address @var{address}.
4095 @var{address} may be any expression.
4096 @end table
4097
4098 @node Search
4099 @section Searching source files
4100 @cindex searching
4101 @kindex reverse-search
4102
4103 There are two commands for searching through the current source file for a
4104 regular expression.
4105
4106 @table @code
4107 @kindex search
4108 @kindex forward-search
4109 @item forward-search @var{regexp}
4110 @itemx search @var{regexp}
4111 The command @samp{forward-search @var{regexp}} checks each line,
4112 starting with the one following the last line listed, for a match for
4113 @var{regexp}.  It lists the line that is found.  You can use the
4114 synonym @samp{search @var{regexp}} or abbreviate the command name as
4115 @code{fo}.
4116
4117 @item reverse-search @var{regexp}
4118 The command @samp{reverse-search @var{regexp}} checks each line, starting
4119 with the one before the last line listed and going backward, for a match
4120 for @var{regexp}.  It lists the line that is found.  You can abbreviate
4121 this command as @code{rev}.
4122 @end table
4123
4124 @node Source Path
4125 @section Specifying source directories
4126
4127 @cindex source path
4128 @cindex directories for source files
4129 Executable programs sometimes do not record the directories of the source
4130 files from which they were compiled, just the names.  Even when they do,
4131 the directories could be moved between the compilation and your debugging
4132 session.  @value{GDBN} has a list of directories to search for source files;
4133 this is called the @dfn{source path}.  Each time @value{GDBN} wants a source file,
4134 it tries all the directories in the list, in the order they are present
4135 in the list, until it finds a file with the desired name.  Note that
4136 the executable search path is @emph{not} used for this purpose.  Neither is
4137 the current working directory, unless it happens to be in the source
4138 path.
4139
4140 If @value{GDBN} cannot find a source file in the source path, and the
4141 object program records a directory, @value{GDBN} tries that directory
4142 too.  If the source path is empty, and there is no record of the
4143 compilation directory, @value{GDBN} looks in the current directory as a
4144 last resort.
4145
4146 Whenever you reset or rearrange the source path, @value{GDBN} clears out
4147 any information it has cached about where source files are found and where
4148 each line is in the file.
4149
4150 @kindex directory
4151 @kindex dir
4152 When you start @value{GDBN}, its source path includes only @samp{cdir}
4153 and @samp{cwd}, in that order.
4154 To add other directories, use the @code{directory} command.
4155
4156 @table @code
4157 @item directory @var{dirname} @dots{}
4158 @item dir @var{dirname} @dots{}
4159 Add directory @var{dirname} to the front of the source path.  Several
4160 directory names may be given to this command, separated by @samp{:}
4161 (@samp{;} on MS-DOS and MS-Windows, where @samp{:} usually appears as
4162 part of absolute file names) or
4163 whitespace.  You may specify a directory that is already in the source
4164 path; this moves it forward, so @value{GDBN} searches it sooner.
4165
4166 @kindex cdir
4167 @kindex cwd
4168 @vindex $cdir@r{, convenience variable}
4169 @vindex $cwdr@r{, convenience variable}
4170 @cindex compilation directory
4171 @cindex current directory
4172 @cindex working directory
4173 @cindex directory, current
4174 @cindex directory, compilation
4175 You can use the string @samp{$cdir} to refer to the compilation
4176 directory (if one is recorded), and @samp{$cwd} to refer to the current
4177 working directory.  @samp{$cwd} is not the same as @samp{.}---the former
4178 tracks the current working directory as it changes during your @value{GDBN}
4179 session, while the latter is immediately expanded to the current
4180 directory at the time you add an entry to the source path.
4181
4182 @item directory
4183 Reset the source path to empty again.  This requires confirmation.
4184
4185 @c RET-repeat for @code{directory} is explicitly disabled, but since
4186 @c repeating it would be a no-op we do not say that.  (thanks to RMS)
4187
4188 @item show directories
4189 @kindex show directories
4190 Print the source path: show which directories it contains.
4191 @end table
4192
4193 If your source path is cluttered with directories that are no longer of
4194 interest, @value{GDBN} may sometimes cause confusion by finding the wrong
4195 versions of source.  You can correct the situation as follows:
4196
4197 @enumerate
4198 @item
4199 Use @code{directory} with no argument to reset the source path to empty.
4200
4201 @item
4202 Use @code{directory} with suitable arguments to reinstall the
4203 directories you want in the source path.  You can add all the
4204 directories in one command.
4205 @end enumerate
4206
4207 @node Machine Code
4208 @section Source and machine code
4209
4210 You can use the command @code{info line} to map source lines to program
4211 addresses (and vice versa), and the command @code{disassemble} to display
4212 a range of addresses as machine instructions.  When run under @sc{gnu} Emacs
4213 mode, the @code{info line} command causes the arrow to point to the
4214 line specified.  Also, @code{info line} prints addresses in symbolic form as
4215 well as hex.
4216
4217 @table @code
4218 @kindex info line
4219 @item info line @var{linespec}
4220 Print the starting and ending addresses of the compiled code for
4221 source line @var{linespec}.  You can specify source lines in any of
4222 the ways understood by the @code{list} command (@pxref{List, ,Printing
4223 source lines}).
4224 @end table
4225
4226 For example, we can use @code{info line} to discover the location of
4227 the object code for the first line of function
4228 @code{m4_changequote}:
4229
4230 @c FIXME: I think this example should also show the addresses in
4231 @c symbolic form, as they usually would be displayed.
4232 @smallexample
4233 (@value{GDBP}) info line m4_changequote
4234 Line 895 of "builtin.c" starts at pc 0x634c and ends at 0x6350.
4235 @end smallexample
4236
4237 @noindent
4238 We can also inquire (using @code{*@var{addr}} as the form for
4239 @var{linespec}) what source line covers a particular address:
4240 @smallexample
4241 (@value{GDBP}) info line *0x63ff
4242 Line 926 of "builtin.c" starts at pc 0x63e4 and ends at 0x6404.
4243 @end smallexample
4244
4245 @cindex @code{$_} and @code{info line}
4246 @kindex x@r{(examine), and} info line
4247 After @code{info line}, the default address for the @code{x} command
4248 is changed to the starting address of the line, so that @samp{x/i} is
4249 sufficient to begin examining the machine code (@pxref{Memory,
4250 ,Examining memory}).  Also, this address is saved as the value of the
4251 convenience variable @code{$_} (@pxref{Convenience Vars, ,Convenience
4252 variables}).
4253
4254 @table @code
4255 @kindex disassemble
4256 @cindex assembly instructions
4257 @cindex instructions, assembly
4258 @cindex machine instructions
4259 @cindex listing machine instructions
4260 @item disassemble
4261 This specialized command dumps a range of memory as machine
4262 instructions.  The default memory range is the function surrounding the
4263 program counter of the selected frame.  A single argument to this
4264 command is a program counter value; @value{GDBN} dumps the function
4265 surrounding this value.  Two arguments specify a range of addresses
4266 (first inclusive, second exclusive) to dump.
4267 @end table
4268
4269 The following example shows the disassembly of a range of addresses of
4270 HP PA-RISC 2.0 code:
4271
4272 @smallexample
4273 (@value{GDBP}) disas 0x32c4 0x32e4
4274 Dump of assembler code from 0x32c4 to 0x32e4:
4275 0x32c4 <main+204>:      addil 0,dp
4276 0x32c8 <main+208>:      ldw 0x22c(sr0,r1),r26
4277 0x32cc <main+212>:      ldil 0x3000,r31
4278 0x32d0 <main+216>:      ble 0x3f8(sr4,r31)
4279 0x32d4 <main+220>:      ldo 0(r31),rp
4280 0x32d8 <main+224>:      addil -0x800,dp
4281 0x32dc <main+228>:      ldo 0x588(r1),r26
4282 0x32e0 <main+232>:      ldil 0x3000,r31
4283 End of assembler dump.
4284 @end smallexample
4285
4286 Some architectures have more than one commonly-used set of instruction
4287 mnemonics or other syntax.
4288
4289 @table @code
4290 @kindex set disassembly-flavor
4291 @cindex assembly instructions
4292 @cindex instructions, assembly
4293 @cindex machine instructions
4294 @cindex listing machine instructions
4295 @cindex Intel disassembly flavor
4296 @cindex AT&T disassembly flavor
4297 @item set disassembly-flavor @var{instruction-set}
4298 Select the instruction set to use when disassembling the
4299 program via the @code{disassemble} or @code{x/i} commands.
4300
4301 Currently this command is only defined for the Intel x86 family.  You
4302 can set @var{instruction-set} to either @code{intel} or @code{att}.
4303 The default is @code{att}, the AT&T flavor used by default by Unix
4304 assemblers for x86-based targets.
4305 @end table
4306
4307
4308 @node Data
4309 @chapter Examining Data
4310
4311 @cindex printing data
4312 @cindex examining data
4313 @kindex print
4314 @kindex inspect
4315 @c "inspect" is not quite a synonym if you are using Epoch, which we do not
4316 @c document because it is nonstandard...  Under Epoch it displays in a
4317 @c different window or something like that.
4318 The usual way to examine data in your program is with the @code{print}
4319 command (abbreviated @code{p}), or its synonym @code{inspect}.  It
4320 evaluates and prints the value of an expression of the language your
4321 program is written in (@pxref{Languages, ,Using @value{GDBN} with
4322 Different Languages}).
4323
4324 @table @code
4325 @item print @var{expr}
4326 @itemx print /@var{f} @var{expr}
4327 @var{expr} is an expression (in the source language).  By default the
4328 value of @var{expr} is printed in a format appropriate to its data type;
4329 you can choose a different format by specifying @samp{/@var{f}}, where
4330 @var{f} is a letter specifying the format; see @ref{Output Formats,,Output
4331 formats}.
4332
4333 @item print
4334 @itemx print /@var{f}
4335 If you omit @var{expr}, @value{GDBN} displays the last value again (from the
4336 @dfn{value history}; @pxref{Value History, ,Value history}).  This allows you to
4337 conveniently inspect the same value in an alternative format.
4338 @end table
4339
4340 A more low-level way of examining data is with the @code{x} command.
4341 It examines data in memory at a specified address and prints it in a
4342 specified format.  @xref{Memory, ,Examining memory}.
4343
4344 If you are interested in information about types, or about how the
4345 fields of a struct or a class are declared, use the @code{ptype @var{exp}}
4346 command rather than @code{print}.  @xref{Symbols, ,Examining the Symbol
4347 Table}.
4348
4349 @menu
4350 * Expressions::                 Expressions
4351 * Variables::                   Program variables
4352 * Arrays::                      Artificial arrays
4353 * Output Formats::              Output formats
4354 * Memory::                      Examining memory
4355 * Auto Display::                Automatic display
4356 * Print Settings::              Print settings
4357 * Value History::               Value history
4358 * Convenience Vars::            Convenience variables
4359 * Registers::                   Registers
4360 * Floating Point Hardware::     Floating point hardware
4361 * Memory Region Attributes::    Memory region attributes
4362 @end menu
4363
4364 @node Expressions
4365 @section Expressions
4366
4367 @cindex expressions
4368 @code{print} and many other @value{GDBN} commands accept an expression and
4369 compute its value.  Any kind of constant, variable or operator defined
4370 by the programming language you are using is valid in an expression in
4371 @value{GDBN}.  This includes conditional expressions, function calls, casts
4372 and string constants.  It unfortunately does not include symbols defined
4373 by preprocessor @code{#define} commands.
4374
4375 @value{GDBN} supports array constants in expressions input by
4376 the user.  The syntax is @{@var{element}, @var{element}@dots{}@}.  For example,
4377 you can use the command @code{print @{1, 2, 3@}} to build up an array in
4378 memory that is @code{malloc}ed in the target program.
4379
4380 Because C is so widespread, most of the expressions shown in examples in
4381 this manual are in C.  @xref{Languages, , Using @value{GDBN} with Different
4382 Languages}, for information on how to use expressions in other
4383 languages.
4384
4385 In this section, we discuss operators that you can use in @value{GDBN}
4386 expressions regardless of your programming language.
4387
4388 Casts are supported in all languages, not just in C, because it is so
4389 useful to cast a number into a pointer in order to examine a structure
4390 at that address in memory.
4391 @c FIXME: casts supported---Mod2 true?
4392
4393 @value{GDBN} supports these operators, in addition to those common
4394 to programming languages:
4395
4396 @table @code
4397 @item @@
4398 @samp{@@} is a binary operator for treating parts of memory as arrays.
4399 @xref{Arrays, ,Artificial arrays}, for more information.
4400
4401 @item ::
4402 @samp{::} allows you to specify a variable in terms of the file or
4403 function where it is defined.  @xref{Variables, ,Program variables}.
4404
4405 @cindex @{@var{type}@}
4406 @cindex type casting memory
4407 @cindex memory, viewing as typed object
4408 @cindex casts, to view memory
4409 @item @{@var{type}@} @var{addr}
4410 Refers to an object of type @var{type} stored at address @var{addr} in
4411 memory.  @var{addr} may be any expression whose value is an integer or
4412 pointer (but parentheses are required around binary operators, just as in
4413 a cast).  This construct is allowed regardless of what kind of data is
4414 normally supposed to reside at @var{addr}.
4415 @end table
4416
4417 @node Variables
4418 @section Program variables
4419
4420 The most common kind of expression to use is the name of a variable
4421 in your program.
4422
4423 Variables in expressions are understood in the selected stack frame
4424 (@pxref{Selection, ,Selecting a frame}); they must be either:
4425
4426 @itemize @bullet
4427 @item
4428 global (or file-static)
4429 @end itemize
4430
4431 @noindent or
4432
4433 @itemize @bullet
4434 @item
4435 visible according to the scope rules of the
4436 programming language from the point of execution in that frame
4437 @end itemize
4438
4439 @noindent This means that in the function
4440
4441 @example
4442 foo (a)
4443      int a;
4444 @{
4445   bar (a);
4446   @{
4447     int b = test ();
4448     bar (b);
4449   @}
4450 @}
4451 @end example
4452
4453 @noindent
4454 you can examine and use the variable @code{a} whenever your program is
4455 executing within the function @code{foo}, but you can only use or
4456 examine the variable @code{b} while your program is executing inside
4457 the block where @code{b} is declared.
4458
4459 @cindex variable name conflict
4460 There is an exception: you can refer to a variable or function whose
4461 scope is a single source file even if the current execution point is not
4462 in this file.  But it is possible to have more than one such variable or
4463 function with the same name (in different source files).  If that
4464 happens, referring to that name has unpredictable effects.  If you wish,
4465 you can specify a static variable in a particular function or file,
4466 using the colon-colon notation:
4467
4468 @cindex colon-colon, context for variables/functions
4469 @iftex
4470 @c info cannot cope with a :: index entry, but why deprive hard copy readers?
4471 @cindex @code{::}, context for variables/functions
4472 @end iftex
4473 @example
4474 @var{file}::@var{variable}
4475 @var{function}::@var{variable}
4476 @end example
4477
4478 @noindent
4479 Here @var{file} or @var{function} is the name of the context for the
4480 static @var{variable}.  In the case of file names, you can use quotes to
4481 make sure @value{GDBN} parses the file name as a single word---for example,
4482 to print a global value of @code{x} defined in @file{f2.c}:
4483
4484 @example
4485 (@value{GDBP}) p 'f2.c'::x
4486 @end example
4487
4488 @cindex C@t{++} scope resolution
4489 This use of @samp{::} is very rarely in conflict with the very similar
4490 use of the same notation in C@t{++}.  @value{GDBN} also supports use of the C@t{++}
4491 scope resolution operator in @value{GDBN} expressions.
4492 @c FIXME: Um, so what happens in one of those rare cases where it's in
4493 @c conflict??  --mew
4494
4495 @cindex wrong values
4496 @cindex variable values, wrong
4497 @quotation
4498 @emph{Warning:} Occasionally, a local variable may appear to have the
4499 wrong value at certain points in a function---just after entry to a new
4500 scope, and just before exit.
4501 @end quotation
4502 You may see this problem when you are stepping by machine instructions.
4503 This is because, on most machines, it takes more than one instruction to
4504 set up a stack frame (including local variable definitions); if you are
4505 stepping by machine instructions, variables may appear to have the wrong
4506 values until the stack frame is completely built.  On exit, it usually
4507 also takes more than one machine instruction to destroy a stack frame;
4508 after you begin stepping through that group of instructions, local
4509 variable definitions may be gone.
4510
4511 This may also happen when the compiler does significant optimizations.
4512 To be sure of always seeing accurate values, turn off all optimization
4513 when compiling.
4514
4515 @cindex ``No symbol "foo" in current context''
4516 Another possible effect of compiler optimizations is to optimize
4517 unused variables out of existence, or assign variables to registers (as
4518 opposed to memory addresses).  Depending on the support for such cases
4519 offered by the debug info format used by the compiler, @value{GDBN}
4520 might not be able to display values for such local variables.  If that
4521 happens, @value{GDBN} will print a message like this:
4522
4523 @example
4524 No symbol "foo" in current context.
4525 @end example
4526
4527 To solve such problems, either recompile without optimizations, or use a
4528 different debug info format, if the compiler supports several such
4529 formats.  For example, @value{NGCC}, the @sc{gnu} C/C@t{++} compiler usually
4530 supports the @samp{-gstabs} option.  @samp{-gstabs} produces debug info
4531 in a format that is superior to formats such as COFF.  You may be able
4532 to use DWARF2 (@samp{-gdwarf-2}), which is also an effective form for
4533 debug info.  See @ref{Debugging Options,,Options for Debugging Your
4534 Program or @sc{gnu} CC, gcc.info, Using @sc{gnu} CC}, for more
4535 information.
4536
4537
4538 @node Arrays
4539 @section Artificial arrays
4540
4541 @cindex artificial array
4542 @kindex @@@r{, referencing memory as an array}
4543 It is often useful to print out several successive objects of the
4544 same type in memory; a section of an array, or an array of
4545 dynamically determined size for which only a pointer exists in the
4546 program.
4547
4548 You can do this by referring to a contiguous span of memory as an
4549 @dfn{artificial array}, using the binary operator @samp{@@}.  The left
4550 operand of @samp{@@} should be the first element of the desired array
4551 and be an individual object.  The right operand should be the desired length
4552 of the array.  The result is an array value whose elements are all of
4553 the type of the left argument.  The first element is actually the left
4554 argument; the second element comes from bytes of memory immediately
4555 following those that hold the first element, and so on.  Here is an
4556 example.  If a program says
4557
4558 @example
4559 int *array = (int *) malloc (len * sizeof (int));
4560 @end example
4561
4562 @noindent
4563 you can print the contents of @code{array} with
4564
4565 @example
4566 p *array@@len
4567 @end example
4568
4569 The left operand of @samp{@@} must reside in memory.  Array values made
4570 with @samp{@@} in this way behave just like other arrays in terms of
4571 subscripting, and are coerced to pointers when used in expressions.
4572 Artificial arrays most often appear in expressions via the value history
4573 (@pxref{Value History, ,Value history}), after printing one out.
4574
4575 Another way to create an artificial array is to use a cast.
4576 This re-interprets a value as if it were an array.
4577 The value need not be in memory:
4578 @example
4579 (@value{GDBP}) p/x (short[2])0x12345678
4580 $1 = @{0x1234, 0x5678@}
4581 @end example
4582
4583 As a convenience, if you leave the array length out (as in
4584 @samp{(@var{type}[])@var{value}}) @value{GDBN} calculates the size to fill
4585 the value (as @samp{sizeof(@var{value})/sizeof(@var{type})}:
4586 @example
4587 (@value{GDBP}) p/x (short[])0x12345678
4588 $2 = @{0x1234, 0x5678@}
4589 @end example
4590
4591 Sometimes the artificial array mechanism is not quite enough; in
4592 moderately complex data structures, the elements of interest may not
4593 actually be adjacent---for example, if you are interested in the values
4594 of pointers in an array.  One useful work-around in this situation is
4595 to use a convenience variable (@pxref{Convenience Vars, ,Convenience
4596 variables}) as a counter in an expression that prints the first
4597 interesting value, and then repeat that expression via @key{RET}.  For
4598 instance, suppose you have an array @code{dtab} of pointers to
4599 structures, and you are interested in the values of a field @code{fv}
4600 in each structure.  Here is an example of what you might type:
4601
4602 @example
4603 set $i = 0
4604 p dtab[$i++]->fv
4605 @key{RET}
4606 @key{RET}
4607 @dots{}
4608 @end example
4609
4610 @node Output Formats
4611 @section Output formats
4612
4613 @cindex formatted output
4614 @cindex output formats
4615 By default, @value{GDBN} prints a value according to its data type.  Sometimes
4616 this is not what you want.  For example, you might want to print a number
4617 in hex, or a pointer in decimal.  Or you might want to view data in memory
4618 at a certain address as a character string or as an instruction.  To do
4619 these things, specify an @dfn{output format} when you print a value.
4620
4621 The simplest use of output formats is to say how to print a value
4622 already computed.  This is done by starting the arguments of the
4623 @code{print} command with a slash and a format letter.  The format
4624 letters supported are:
4625
4626 @table @code
4627 @item x
4628 Regard the bits of the value as an integer, and print the integer in
4629 hexadecimal.
4630
4631 @item d
4632 Print as integer in signed decimal.
4633
4634 @item u
4635 Print as integer in unsigned decimal.
4636
4637 @item o
4638 Print as integer in octal.
4639
4640 @item t
4641 Print as integer in binary.  The letter @samp{t} stands for ``two''.
4642 @footnote{@samp{b} cannot be used because these format letters are also
4643 used with the @code{x} command, where @samp{b} stands for ``byte'';
4644 see @ref{Memory,,Examining memory}.}
4645
4646 @item a
4647 @cindex unknown address, locating
4648 @cindex locate address
4649 Print as an address, both absolute in hexadecimal and as an offset from
4650 the nearest preceding symbol.  You can use this format used to discover
4651 where (in what function) an unknown address is located:
4652
4653 @example
4654 (@value{GDBP}) p/a 0x54320
4655 $3 = 0x54320 <_initialize_vx+396>
4656 @end example
4657
4658 @noindent
4659 The command @code{info symbol 0x54320} yields similar results.
4660 @xref{Symbols, info symbol}.
4661
4662 @item c
4663 Regard as an integer and print it as a character constant.
4664
4665 @item f
4666 Regard the bits of the value as a floating point number and print
4667 using typical floating point syntax.
4668 @end table
4669
4670 For example, to print the program counter in hex (@pxref{Registers}), type
4671
4672 @example
4673 p/x $pc
4674 @end example
4675
4676 @noindent
4677 Note that no space is required before the slash; this is because command
4678 names in @value{GDBN} cannot contain a slash.
4679
4680 To reprint the last value in the value history with a different format,
4681 you can use the @code{print} command with just a format and no
4682 expression.  For example, @samp{p/x} reprints the last value in hex.
4683
4684 @node Memory
4685 @section Examining memory
4686
4687 You can use the command @code{x} (for ``examine'') to examine memory in
4688 any of several formats, independently of your program's data types.
4689
4690 @cindex examining memory
4691 @table @code
4692 @kindex x @r{(examine memory)}
4693 @item x/@var{nfu} @var{addr}
4694 @itemx x @var{addr}
4695 @itemx x
4696 Use the @code{x} command to examine memory.
4697 @end table
4698
4699 @var{n}, @var{f}, and @var{u} are all optional parameters that specify how
4700 much memory to display and how to format it; @var{addr} is an
4701 expression giving the address where you want to start displaying memory.
4702 If you use defaults for @var{nfu}, you need not type the slash @samp{/}.
4703 Several commands set convenient defaults for @var{addr}.
4704
4705 @table @r
4706 @item @var{n}, the repeat count
4707 The repeat count is a decimal integer; the default is 1.  It specifies
4708 how much memory (counting by units @var{u}) to display.
4709 @c This really is **decimal**; unaffected by 'set radix' as of GDB
4710 @c 4.1.2.
4711
4712 @item @var{f}, the display format
4713 The display format is one of the formats used by @code{print},
4714 @samp{s} (null-terminated string), or @samp{i} (machine instruction).
4715 The default is @samp{x} (hexadecimal) initially.
4716 The default changes each time you use either @code{x} or @code{print}.
4717
4718 @item @var{u}, the unit size
4719 The unit size is any of
4720
4721 @table @code
4722 @item b
4723 Bytes.
4724 @item h
4725 Halfwords (two bytes).
4726 @item w
4727 Words (four bytes).  This is the initial default.
4728 @item g
4729 Giant words (eight bytes).
4730 @end table
4731
4732 Each time you specify a unit size with @code{x}, that size becomes the
4733 default unit the next time you use @code{x}.  (For the @samp{s} and
4734 @samp{i} formats, the unit size is ignored and is normally not written.)
4735
4736 @item @var{addr}, starting display address
4737 @var{addr} is the address where you want @value{GDBN} to begin displaying
4738 memory.  The expression need not have a pointer value (though it may);
4739 it is always interpreted as an integer address of a byte of memory.
4740 @xref{Expressions, ,Expressions}, for more information on expressions.  The default for
4741 @var{addr} is usually just after the last address examined---but several
4742 other commands also set the default address: @code{info breakpoints} (to
4743 the address of the last breakpoint listed), @code{info line} (to the
4744 starting address of a line), and @code{print} (if you use it to display
4745 a value from memory).
4746 @end table
4747
4748 For example, @samp{x/3uh 0x54320} is a request to display three halfwords
4749 (@code{h}) of memory, formatted as unsigned decimal integers (@samp{u}),
4750 starting at address @code{0x54320}.  @samp{x/4xw $sp} prints the four
4751 words (@samp{w}) of memory above the stack pointer (here, @samp{$sp};
4752 @pxref{Registers, ,Registers}) in hexadecimal (@samp{x}).
4753
4754 Since the letters indicating unit sizes are all distinct from the
4755 letters specifying output formats, you do not have to remember whether
4756 unit size or format comes first; either order works.  The output
4757 specifications @samp{4xw} and @samp{4wx} mean exactly the same thing.
4758 (However, the count @var{n} must come first; @samp{wx4} does not work.)
4759
4760 Even though the unit size @var{u} is ignored for the formats @samp{s}
4761 and @samp{i}, you might still want to use a count @var{n}; for example,
4762 @samp{3i} specifies that you want to see three machine instructions,
4763 including any operands.  The command @code{disassemble} gives an
4764 alternative way of inspecting machine instructions; see @ref{Machine
4765 Code,,Source and machine code}.
4766
4767 All the defaults for the arguments to @code{x} are designed to make it
4768 easy to continue scanning memory with minimal specifications each time
4769 you use @code{x}.  For example, after you have inspected three machine
4770 instructions with @samp{x/3i @var{addr}}, you can inspect the next seven
4771 with just @samp{x/7}.  If you use @key{RET} to repeat the @code{x} command,
4772 the repeat count @var{n} is used again; the other arguments default as
4773 for successive uses of @code{x}.
4774
4775 @cindex @code{$_}, @code{$__}, and value history
4776 The addresses and contents printed by the @code{x} command are not saved
4777 in the value history because there is often too much of them and they
4778 would get in the way.  Instead, @value{GDBN} makes these values available for
4779 subsequent use in expressions as values of the convenience variables
4780 @code{$_} and @code{$__}.  After an @code{x} command, the last address
4781 examined is available for use in expressions in the convenience variable
4782 @code{$_}.  The contents of that address, as examined, are available in
4783 the convenience variable @code{$__}.
4784
4785 If the @code{x} command has a repeat count, the address and contents saved
4786 are from the last memory unit printed; this is not the same as the last
4787 address printed if several units were printed on the last line of output.
4788
4789 @node Auto Display
4790 @section Automatic display
4791 @cindex automatic display
4792 @cindex display of expressions
4793
4794 If you find that you want to print the value of an expression frequently
4795 (to see how it changes), you might want to add it to the @dfn{automatic
4796 display list} so that @value{GDBN} prints its value each time your program stops.
4797 Each expression added to the list is given a number to identify it;
4798 to remove an expression from the list, you specify that number.
4799 The automatic display looks like this:
4800
4801 @example
4802 2: foo = 38
4803 3: bar[5] = (struct hack *) 0x3804
4804 @end example
4805
4806 @noindent
4807 This display shows item numbers, expressions and their current values.  As with
4808 displays you request manually using @code{x} or @code{print}, you can
4809 specify the output format you prefer; in fact, @code{display} decides
4810 whether to use @code{print} or @code{x} depending on how elaborate your
4811 format specification is---it uses @code{x} if you specify a unit size,
4812 or one of the two formats (@samp{i} and @samp{s}) that are only
4813 supported by @code{x}; otherwise it uses @code{print}.
4814
4815 @table @code
4816 @kindex display
4817 @item display @var{expr}
4818 Add the expression @var{expr} to the list of expressions to display
4819 each time your program stops.  @xref{Expressions, ,Expressions}.
4820
4821 @code{display} does not repeat if you press @key{RET} again after using it.
4822
4823 @item display/@var{fmt} @var{expr}
4824 For @var{fmt} specifying only a display format and not a size or
4825 count, add the expression @var{expr} to the auto-display list but
4826 arrange to display it each time in the specified format @var{fmt}.
4827 @xref{Output Formats,,Output formats}.
4828
4829 @item display/@var{fmt} @var{addr}
4830 For @var{fmt} @samp{i} or @samp{s}, or including a unit-size or a
4831 number of units, add the expression @var{addr} as a memory address to
4832 be examined each time your program stops.  Examining means in effect
4833 doing @samp{x/@var{fmt} @var{addr}}.  @xref{Memory, ,Examining memory}.
4834 @end table
4835
4836 For example, @samp{display/i $pc} can be helpful, to see the machine
4837 instruction about to be executed each time execution stops (@samp{$pc}
4838 is a common name for the program counter; @pxref{Registers, ,Registers}).
4839
4840 @table @code
4841 @kindex delete display
4842 @kindex undisplay
4843 @item undisplay @var{dnums}@dots{}
4844 @itemx delete display @var{dnums}@dots{}
4845 Remove item numbers @var{dnums} from the list of expressions to display.
4846
4847 @code{undisplay} does not repeat if you press @key{RET} after using it.
4848 (Otherwise you would just get the error @samp{No display number @dots{}}.)
4849
4850 @kindex disable display
4851 @item disable display @var{dnums}@dots{}
4852 Disable the display of item numbers @var{dnums}.  A disabled display
4853 item is not printed automatically, but is not forgotten.  It may be
4854 enabled again later.
4855
4856 @kindex enable display
4857 @item enable display @var{dnums}@dots{}
4858 Enable display of item numbers @var{dnums}.  It becomes effective once
4859 again in auto display of its expression, until you specify otherwise.
4860
4861 @item display
4862 Display the current values of the expressions on the list, just as is
4863 done when your program stops.
4864
4865 @kindex info display
4866 @item info display
4867 Print the list of expressions previously set up to display
4868 automatically, each one with its item number, but without showing the
4869 values.  This includes disabled expressions, which are marked as such.
4870 It also includes expressions which would not be displayed right now
4871 because they refer to automatic variables not currently available.
4872 @end table
4873
4874 If a display expression refers to local variables, then it does not make
4875 sense outside the lexical context for which it was set up.  Such an
4876 expression is disabled when execution enters a context where one of its
4877 variables is not defined.  For example, if you give the command
4878 @code{display last_char} while inside a function with an argument
4879 @code{last_char}, @value{GDBN} displays this argument while your program
4880 continues to stop inside that function.  When it stops elsewhere---where
4881 there is no variable @code{last_char}---the display is disabled
4882 automatically.  The next time your program stops where @code{last_char}
4883 is meaningful, you can enable the display expression once again.
4884
4885 @node Print Settings
4886 @section Print settings
4887
4888 @cindex format options
4889 @cindex print settings
4890 @value{GDBN} provides the following ways to control how arrays, structures,
4891 and symbols are printed.
4892
4893 @noindent
4894 These settings are useful for debugging programs in any language:
4895
4896 @table @code
4897 @kindex set print address
4898 @item set print address
4899 @itemx set print address on
4900 @value{GDBN} prints memory addresses showing the location of stack
4901 traces, structure values, pointer values, breakpoints, and so forth,
4902 even when it also displays the contents of those addresses.  The default
4903 is @code{on}.  For example, this is what a stack frame display looks like with
4904 @code{set print address on}:
4905
4906 @smallexample
4907 @group
4908 (@value{GDBP}) f
4909 #0  set_quotes (lq=0x34c78 "<<", rq=0x34c88 ">>")
4910     at input.c:530
4911 530         if (lquote != def_lquote)
4912 @end group
4913 @end smallexample
4914
4915 @item set print address off
4916 Do not print addresses when displaying their contents.  For example,
4917 this is the same stack frame displayed with @code{set print address off}:
4918
4919 @smallexample
4920 @group
4921 (@value{GDBP}) set print addr off
4922 (@value{GDBP}) f
4923 #0  set_quotes (lq="<<", rq=">>") at input.c:530
4924 530         if (lquote != def_lquote)
4925 @end group
4926 @end smallexample
4927
4928 You can use @samp{set print address off} to eliminate all machine
4929 dependent displays from the @value{GDBN} interface.  For example, with
4930 @code{print address off}, you should get the same text for backtraces on
4931 all machines---whether or not they involve pointer arguments.
4932
4933 @kindex show print address
4934 @item show print address
4935 Show whether or not addresses are to be printed.
4936 @end table
4937
4938 When @value{GDBN} prints a symbolic address, it normally prints the
4939 closest earlier symbol plus an offset.  If that symbol does not uniquely
4940 identify the address (for example, it is a name whose scope is a single
4941 source file), you may need to clarify.  One way to do this is with
4942 @code{info line}, for example @samp{info line *0x4537}.  Alternately,
4943 you can set @value{GDBN} to print the source file and line number when
4944 it prints a symbolic address:
4945
4946 @table @code
4947 @kindex set print symbol-filename
4948 @item set print symbol-filename on
4949 Tell @value{GDBN} to print the source file name and line number of a
4950 symbol in the symbolic form of an address.
4951
4952 @item set print symbol-filename off
4953 Do not print source file name and line number of a symbol.  This is the
4954 default.
4955
4956 @kindex show print symbol-filename
4957 @item show print symbol-filename
4958 Show whether or not @value{GDBN} will print the source file name and
4959 line number of a symbol in the symbolic form of an address.
4960 @end table
4961
4962 Another situation where it is helpful to show symbol filenames and line
4963 numbers is when disassembling code; @value{GDBN} shows you the line
4964 number and source file that corresponds to each instruction.
4965
4966 Also, you may wish to see the symbolic form only if the address being
4967 printed is reasonably close to the closest earlier symbol:
4968
4969 @table @code
4970 @kindex set print max-symbolic-offset
4971 @item set print max-symbolic-offset @var{max-offset}
4972 Tell @value{GDBN} to only display the symbolic form of an address if the
4973 offset between the closest earlier symbol and the address is less than
4974 @var{max-offset}.  The default is 0, which tells @value{GDBN}
4975 to always print the symbolic form of an address if any symbol precedes it.
4976
4977 @kindex show print max-symbolic-offset
4978 @item show print max-symbolic-offset
4979 Ask how large the maximum offset is that @value{GDBN} prints in a
4980 symbolic address.
4981 @end table
4982
4983 @cindex wild pointer, interpreting
4984 @cindex pointer, finding referent
4985 If you have a pointer and you are not sure where it points, try
4986 @samp{set print symbol-filename on}.  Then you can determine the name
4987 and source file location of the variable where it points, using
4988 @samp{p/a @var{pointer}}.  This interprets the address in symbolic form.
4989 For example, here @value{GDBN} shows that a variable @code{ptt} points
4990 at another variable @code{t}, defined in @file{hi2.c}:
4991
4992 @example
4993 (@value{GDBP}) set print symbol-filename on
4994 (@value{GDBP}) p/a ptt
4995 $4 = 0xe008 <t in hi2.c>
4996 @end example
4997
4998 @quotation
4999 @emph{Warning:} For pointers that point to a local variable, @samp{p/a}
5000 does not show the symbol name and filename of the referent, even with
5001 the appropriate @code{set print} options turned on.
5002 @end quotation
5003
5004 Other settings control how different kinds of objects are printed:
5005
5006 @table @code
5007 @kindex set print array
5008 @item set print array
5009 @itemx set print array on
5010 Pretty print arrays.  This format is more convenient to read,
5011 but uses more space.  The default is off.
5012
5013 @item set print array off
5014 Return to compressed format for arrays.
5015
5016 @kindex show print array
5017 @item show print array
5018 Show whether compressed or pretty format is selected for displaying
5019 arrays.
5020
5021 @kindex set print elements
5022 @item set print elements @var{number-of-elements}
5023 Set a limit on how many elements of an array @value{GDBN} will print.
5024 If @value{GDBN} is printing a large array, it stops printing after it has
5025 printed the number of elements set by the @code{set print elements} command.
5026 This limit also applies to the display of strings.
5027 When @value{GDBN} starts, this limit is set to 200.
5028 Setting  @var{number-of-elements} to zero means that the printing is unlimited.
5029
5030 @kindex show print elements
5031 @item show print elements
5032 Display the number of elements of a large array that @value{GDBN} will print.
5033 If the number is 0, then the printing is unlimited.
5034
5035 @kindex set print null-stop
5036 @item set print null-stop
5037 Cause @value{GDBN} to stop printing the characters of an array when the first
5038 @sc{null} is encountered.  This is useful when large arrays actually
5039 contain only short strings.
5040 The default is off.
5041
5042 @kindex set print pretty
5043 @item set print pretty on
5044 Cause @value{GDBN} to print structures in an indented format with one member
5045 per line, like this:
5046
5047 @smallexample
5048 @group
5049 $1 = @{
5050   next = 0x0,
5051   flags = @{
5052     sweet = 1,
5053     sour = 1
5054   @},
5055   meat = 0x54 "Pork"
5056 @}
5057 @end group
5058 @end smallexample
5059
5060 @item set print pretty off
5061 Cause @value{GDBN} to print structures in a compact format, like this:
5062
5063 @smallexample
5064 @group
5065 $1 = @{next = 0x0, flags = @{sweet = 1, sour = 1@}, \
5066 meat = 0x54 "Pork"@}
5067 @end group
5068 @end smallexample
5069
5070 @noindent
5071 This is the default format.
5072
5073 @kindex show print pretty
5074 @item show print pretty
5075 Show which format @value{GDBN} is using to print structures.
5076
5077 @kindex set print sevenbit-strings
5078 @item set print sevenbit-strings on
5079 Print using only seven-bit characters; if this option is set,
5080 @value{GDBN} displays any eight-bit characters (in strings or
5081 character values) using the notation @code{\}@var{nnn}.  This setting is
5082 best if you are working in English (@sc{ascii}) and you use the
5083 high-order bit of characters as a marker or ``meta'' bit.
5084
5085 @item set print sevenbit-strings off
5086 Print full eight-bit characters.  This allows the use of more
5087 international character sets, and is the default.
5088
5089 @kindex show print sevenbit-strings
5090 @item show print sevenbit-strings
5091 Show whether or not @value{GDBN} is printing only seven-bit characters.
5092
5093 @kindex set print union
5094 @item set print union on
5095 Tell @value{GDBN} to print unions which are contained in structures.  This
5096 is the default setting.
5097
5098 @item set print union off
5099 Tell @value{GDBN} not to print unions which are contained in structures.
5100
5101 @kindex show print union
5102 @item show print union
5103 Ask @value{GDBN} whether or not it will print unions which are contained in
5104 structures.
5105
5106 For example, given the declarations
5107
5108 @smallexample
5109 typedef enum @{Tree, Bug@} Species;
5110 typedef enum @{Big_tree, Acorn, Seedling@} Tree_forms;
5111 typedef enum @{Caterpillar, Cocoon, Butterfly@}
5112               Bug_forms;
5113
5114 struct thing @{
5115   Species it;
5116   union @{
5117     Tree_forms tree;
5118     Bug_forms bug;
5119   @} form;
5120 @};
5121
5122 struct thing foo = @{Tree, @{Acorn@}@};
5123 @end smallexample
5124
5125 @noindent
5126 with @code{set print union on} in effect @samp{p foo} would print
5127
5128 @smallexample
5129 $1 = @{it = Tree, form = @{tree = Acorn, bug = Cocoon@}@}
5130 @end smallexample
5131
5132 @noindent
5133 and with @code{set print union off} in effect it would print
5134
5135 @smallexample
5136 $1 = @{it = Tree, form = @{...@}@}
5137 @end smallexample
5138 @end table
5139
5140 @need 1000
5141 @noindent
5142 These settings are of interest when debugging C@t{++} programs:
5143
5144 @table @code
5145 @cindex demangling
5146 @kindex set print demangle
5147 @item set print demangle
5148 @itemx set print demangle on
5149 Print C@t{++} names in their source form rather than in the encoded
5150 (``mangled'') form passed to the assembler and linker for type-safe
5151 linkage.  The default is on.
5152
5153 @kindex show print demangle
5154 @item show print demangle
5155 Show whether C@t{++} names are printed in mangled or demangled form.
5156
5157 @kindex set print asm-demangle
5158 @item set print asm-demangle
5159 @itemx set print asm-demangle on
5160 Print C@t{++} names in their source form rather than their mangled form, even
5161 in assembler code printouts such as instruction disassemblies.
5162 The default is off.
5163
5164 @kindex show print asm-demangle
5165 @item show print asm-demangle
5166 Show whether C@t{++} names in assembly listings are printed in mangled
5167 or demangled form.
5168
5169 @kindex set demangle-style
5170 @cindex C@t{++} symbol decoding style
5171 @cindex symbol decoding style, C@t{++}
5172 @item set demangle-style @var{style}
5173 Choose among several encoding schemes used by different compilers to
5174 represent C@t{++} names.  The choices for @var{style} are currently:
5175
5176 @table @code
5177 @item auto
5178 Allow @value{GDBN} to choose a decoding style by inspecting your program.
5179
5180 @item gnu
5181 Decode based on the @sc{gnu} C@t{++} compiler (@code{g++}) encoding algorithm.
5182 This is the default.
5183
5184 @item hp
5185 Decode based on the HP ANSI C@t{++} (@code{aCC}) encoding algorithm.
5186
5187 @item lucid
5188 Decode based on the Lucid C@t{++} compiler (@code{lcc}) encoding algorithm.
5189
5190 @item arm
5191 Decode using the algorithm in the @cite{C@t{++} Annotated Reference Manual}.
5192 @strong{Warning:} this setting alone is not sufficient to allow
5193 debugging @code{cfront}-generated executables.  @value{GDBN} would
5194 require further enhancement to permit that.
5195
5196 @end table
5197 If you omit @var{style}, you will see a list of possible formats.
5198
5199 @kindex show demangle-style
5200 @item show demangle-style
5201 Display the encoding style currently in use for decoding C@t{++} symbols.
5202
5203 @kindex set print object
5204 @item set print object
5205 @itemx set print object on
5206 When displaying a pointer to an object, identify the @emph{actual}
5207 (derived) type of the object rather than the @emph{declared} type, using
5208 the virtual function table.
5209
5210 @item set print object off
5211 Display only the declared type of objects, without reference to the
5212 virtual function table.  This is the default setting.
5213
5214 @kindex show print object
5215 @item show print object
5216 Show whether actual, or declared, object types are displayed.
5217
5218 @kindex set print static-members
5219 @item set print static-members
5220 @itemx set print static-members on
5221 Print static members when displaying a C@t{++} object.  The default is on.
5222
5223 @item set print static-members off
5224 Do not print static members when displaying a C@t{++} object.
5225
5226 @kindex show print static-members
5227 @item show print static-members
5228 Show whether C@t{++} static members are printed, or not.
5229
5230 @c These don't work with HP ANSI C++ yet.
5231 @kindex set print vtbl
5232 @item set print vtbl
5233 @itemx set print vtbl on
5234 Pretty print C@t{++} virtual function tables.  The default is off.
5235 (The @code{vtbl} commands do not work on programs compiled with the HP
5236 ANSI C@t{++} compiler (@code{aCC}).)
5237
5238 @item set print vtbl off
5239 Do not pretty print C@t{++} virtual function tables.
5240
5241 @kindex show print vtbl
5242 @item show print vtbl
5243 Show whether C@t{++} virtual function tables are pretty printed, or not.
5244 @end table
5245
5246 @node Value History
5247 @section Value history
5248
5249 @cindex value history
5250 Values printed by the @code{print} command are saved in the @value{GDBN}
5251 @dfn{value history}.  This allows you to refer to them in other expressions.
5252 Values are kept until the symbol table is re-read or discarded
5253 (for example with the @code{file} or @code{symbol-file} commands).
5254 When the symbol table changes, the value history is discarded,
5255 since the values may contain pointers back to the types defined in the
5256 symbol table.
5257
5258 @cindex @code{$}
5259 @cindex @code{$$}
5260 @cindex history number
5261 The values printed are given @dfn{history numbers} by which you can
5262 refer to them.  These are successive integers starting with one.
5263 @code{print} shows you the history number assigned to a value by
5264 printing @samp{$@var{num} = } before the value; here @var{num} is the
5265 history number.
5266
5267 To refer to any previous value, use @samp{$} followed by the value's
5268 history number.  The way @code{print} labels its output is designed to
5269 remind you of this.  Just @code{$} refers to the most recent value in
5270 the history, and @code{$$} refers to the value before that.
5271 @code{$$@var{n}} refers to the @var{n}th value from the end; @code{$$2}
5272 is the value just prior to @code{$$}, @code{$$1} is equivalent to
5273 @code{$$}, and @code{$$0} is equivalent to @code{$}.
5274
5275 For example, suppose you have just printed a pointer to a structure and
5276 want to see the contents of the structure.  It suffices to type
5277
5278 @example
5279 p *$
5280 @end example
5281
5282 If you have a chain of structures where the component @code{next} points
5283 to the next one, you can print the contents of the next one with this:
5284
5285 @example
5286 p *$.next
5287 @end example
5288
5289 @noindent
5290 You can print successive links in the chain by repeating this
5291 command---which you can do by just typing @key{RET}.
5292
5293 Note that the history records values, not expressions.  If the value of
5294 @code{x} is 4 and you type these commands:
5295
5296 @example
5297 print x
5298 set x=5
5299 @end example
5300
5301 @noindent
5302 then the value recorded in the value history by the @code{print} command
5303 remains 4 even though the value of @code{x} has changed.
5304
5305 @table @code
5306 @kindex show values
5307 @item show values
5308 Print the last ten values in the value history, with their item numbers.
5309 This is like @samp{p@ $$9} repeated ten times, except that @code{show
5310 values} does not change the history.
5311
5312 @item show values @var{n}
5313 Print ten history values centered on history item number @var{n}.
5314
5315 @item show values +
5316 Print ten history values just after the values last printed.  If no more
5317 values are available, @code{show values +} produces no display.
5318 @end table
5319
5320 Pressing @key{RET} to repeat @code{show values @var{n}} has exactly the
5321 same effect as @samp{show values +}.
5322
5323 @node Convenience Vars
5324 @section Convenience variables
5325
5326 @cindex convenience variables
5327 @value{GDBN} provides @dfn{convenience variables} that you can use within
5328 @value{GDBN} to hold on to a value and refer to it later.  These variables
5329 exist entirely within @value{GDBN}; they are not part of your program, and
5330 setting a convenience variable has no direct effect on further execution
5331 of your program.  That is why you can use them freely.
5332
5333 Convenience variables are prefixed with @samp{$}.  Any name preceded by
5334 @samp{$} can be used for a convenience variable, unless it is one of
5335 the predefined machine-specific register names (@pxref{Registers, ,Registers}).
5336 (Value history references, in contrast, are @emph{numbers} preceded
5337 by @samp{$}.  @xref{Value History, ,Value history}.)
5338
5339 You can save a value in a convenience variable with an assignment
5340 expression, just as you would set a variable in your program.
5341 For example:
5342
5343 @example
5344 set $foo = *object_ptr
5345 @end example
5346
5347 @noindent
5348 would save in @code{$foo} the value contained in the object pointed to by
5349 @code{object_ptr}.
5350
5351 Using a convenience variable for the first time creates it, but its
5352 value is @code{void} until you assign a new value.  You can alter the
5353 value with another assignment at any time.
5354
5355 Convenience variables have no fixed types.  You can assign a convenience
5356 variable any type of value, including structures and arrays, even if
5357 that variable already has a value of a different type.  The convenience
5358 variable, when used as an expression, has the type of its current value.
5359
5360 @table @code
5361 @kindex show convenience
5362 @item show convenience
5363 Print a list of convenience variables used so far, and their values.
5364 Abbreviated @code{show conv}.
5365 @end table
5366
5367 One of the ways to use a convenience variable is as a counter to be
5368 incremented or a pointer to be advanced.  For example, to print
5369 a field from successive elements of an array of structures:
5370
5371 @example
5372 set $i = 0
5373 print bar[$i++]->contents
5374 @end example
5375
5376 @noindent
5377 Repeat that command by typing @key{RET}.
5378
5379 Some convenience variables are created automatically by @value{GDBN} and given
5380 values likely to be useful.
5381
5382 @table @code
5383 @vindex $_@r{, convenience variable}
5384 @item $_
5385 The variable @code{$_} is automatically set by the @code{x} command to
5386 the last address examined (@pxref{Memory, ,Examining memory}).  Other
5387 commands which provide a default address for @code{x} to examine also
5388 set @code{$_} to that address; these commands include @code{info line}
5389 and @code{info breakpoint}.  The type of @code{$_} is @code{void *}
5390 except when set by the @code{x} command, in which case it is a pointer
5391 to the type of @code{$__}.
5392
5393 @vindex $__@r{, convenience variable}
5394 @item $__
5395 The variable @code{$__} is automatically set by the @code{x} command
5396 to the value found in the last address examined.  Its type is chosen
5397 to match the format in which the data was printed.
5398
5399 @item $_exitcode
5400 @vindex $_exitcode@r{, convenience variable}
5401 The variable @code{$_exitcode} is automatically set to the exit code when
5402 the program being debugged terminates.
5403 @end table
5404
5405 On HP-UX systems, if you refer to a function or variable name that
5406 begins with a dollar sign, @value{GDBN} searches for a user or system
5407 name first, before it searches for a convenience variable.
5408
5409 @node Registers
5410 @section Registers
5411
5412 @cindex registers
5413 You can refer to machine register contents, in expressions, as variables
5414 with names starting with @samp{$}.  The names of registers are different
5415 for each machine; use @code{info registers} to see the names used on
5416 your machine.
5417
5418 @table @code
5419 @kindex info registers
5420 @item info registers
5421 Print the names and values of all registers except floating-point
5422 registers (in the selected stack frame).
5423
5424 @kindex info all-registers
5425 @cindex floating point registers
5426 @item info all-registers
5427 Print the names and values of all registers, including floating-point
5428 registers.
5429
5430 @item info registers @var{regname} @dots{}
5431 Print the @dfn{relativized} value of each specified register @var{regname}.
5432 As discussed in detail below, register values are normally relative to
5433 the selected stack frame.  @var{regname} may be any register name valid on
5434 the machine you are using, with or without the initial @samp{$}.
5435 @end table
5436
5437 @value{GDBN} has four ``standard'' register names that are available (in
5438 expressions) on most machines---whenever they do not conflict with an
5439 architecture's canonical mnemonics for registers.  The register names
5440 @code{$pc} and @code{$sp} are used for the program counter register and
5441 the stack pointer.  @code{$fp} is used for a register that contains a
5442 pointer to the current stack frame, and @code{$ps} is used for a
5443 register that contains the processor status.  For example,
5444 you could print the program counter in hex with
5445
5446 @example
5447 p/x $pc
5448 @end example
5449
5450 @noindent
5451 or print the instruction to be executed next with
5452
5453 @example
5454 x/i $pc
5455 @end example
5456
5457 @noindent
5458 or add four to the stack pointer@footnote{This is a way of removing
5459 one word from the stack, on machines where stacks grow downward in
5460 memory (most machines, nowadays).  This assumes that the innermost
5461 stack frame is selected; setting @code{$sp} is not allowed when other
5462 stack frames are selected.  To pop entire frames off the stack,
5463 regardless of machine architecture, use @code{return};
5464 see @ref{Returning, ,Returning from a function}.} with
5465
5466 @example
5467 set $sp += 4
5468 @end example
5469
5470 Whenever possible, these four standard register names are available on
5471 your machine even though the machine has different canonical mnemonics,
5472 so long as there is no conflict.  The @code{info registers} command
5473 shows the canonical names.  For example, on the SPARC, @code{info
5474 registers} displays the processor status register as @code{$psr} but you
5475 can also refer to it as @code{$ps}; and on x86-based machines @code{$ps}
5476 is an alias for the @sc{eflags} register.
5477
5478 @value{GDBN} always considers the contents of an ordinary register as an
5479 integer when the register is examined in this way.  Some machines have
5480 special registers which can hold nothing but floating point; these
5481 registers are considered to have floating point values.  There is no way
5482 to refer to the contents of an ordinary register as floating point value
5483 (although you can @emph{print} it as a floating point value with
5484 @samp{print/f $@var{regname}}).
5485
5486 Some registers have distinct ``raw'' and ``virtual'' data formats.  This
5487 means that the data format in which the register contents are saved by
5488 the operating system is not the same one that your program normally
5489 sees.  For example, the registers of the 68881 floating point
5490 coprocessor are always saved in ``extended'' (raw) format, but all C
5491 programs expect to work with ``double'' (virtual) format.  In such
5492 cases, @value{GDBN} normally works with the virtual format only (the format
5493 that makes sense for your program), but the @code{info registers} command
5494 prints the data in both formats.
5495
5496 Normally, register values are relative to the selected stack frame
5497 (@pxref{Selection, ,Selecting a frame}).  This means that you get the
5498 value that the register would contain if all stack frames farther in
5499 were exited and their saved registers restored.  In order to see the
5500 true contents of hardware registers, you must select the innermost
5501 frame (with @samp{frame 0}).
5502
5503 However, @value{GDBN} must deduce where registers are saved, from the machine
5504 code generated by your compiler.  If some registers are not saved, or if
5505 @value{GDBN} is unable to locate the saved registers, the selected stack
5506 frame makes no difference.
5507
5508 @node Floating Point Hardware
5509 @section Floating point hardware
5510 @cindex floating point
5511
5512 Depending on the configuration, @value{GDBN} may be able to give
5513 you more information about the status of the floating point hardware.
5514
5515 @table @code
5516 @kindex info float
5517 @item info float
5518 Display hardware-dependent information about the floating
5519 point unit.  The exact contents and layout vary depending on the
5520 floating point chip.  Currently, @samp{info float} is supported on
5521 the ARM and x86 machines.
5522 @end table
5523
5524 @node Memory Region Attributes
5525 @section Memory Region Attributes 
5526 @cindex memory region attributes
5527
5528 @dfn{Memory region attributes} allow you to describe special handling 
5529 required by regions of your target's memory.  @value{GDBN} uses attributes 
5530 to determine whether to allow certain types of memory accesses; whether to
5531 use specific width accesses; and whether to cache target memory.
5532
5533 Defined memory regions can be individually enabled and disabled.  When a
5534 memory region is disabled, @value{GDBN} uses the default attributes when
5535 accessing memory in that region.  Similarly, if no memory regions have
5536 been defined, @value{GDBN} uses the default attributes when accessing
5537 all memory.
5538
5539 When a memory region is defined, it is given a number to identify it; 
5540 to enable, disable, or remove a memory region, you specify that number.
5541
5542 @table @code
5543 @kindex mem
5544 @item mem @var{address1} @var{address1} @var{attributes}@dots{}
5545 Define memory region bounded by @var{address1} and @var{address2}
5546 with attributes @var{attributes}@dots{}.
5547
5548 @kindex delete mem
5549 @item delete mem @var{nums}@dots{}
5550 Remove memory region numbers @var{nums}.
5551
5552 @kindex disable mem
5553 @item disable mem @var{nums}@dots{}
5554 Disable memory region numbers @var{nums}.
5555 A disabled memory region is not forgotten.  
5556 It may be enabled again later.
5557
5558 @kindex enable mem
5559 @item enable mem @var{nums}@dots{}
5560 Enable memory region numbers @var{nums}.
5561
5562 @kindex info mem
5563 @item info mem
5564 Print a table of all defined memory regions, with the following columns
5565 for each region.
5566
5567 @table @emph
5568 @item Memory Region Number
5569 @item Enabled or Disabled.
5570 Enabled memory regions are marked with @samp{y}.  
5571 Disabled memory regions are marked with @samp{n}.
5572
5573 @item Lo Address
5574 The address defining the inclusive lower bound of the memory region.
5575
5576 @item Hi Address
5577 The address defining the exclusive upper bound of the memory region.
5578
5579 @item Attributes
5580 The list of attributes set for this memory region.
5581 @end table
5582 @end table
5583
5584
5585 @subsection Attributes
5586
5587 @subsubsection Memory Access Mode 
5588 The access mode attributes set whether @value{GDBN} may make read or
5589 write accesses to a memory region.
5590
5591 While these attributes prevent @value{GDBN} from performing invalid
5592 memory accesses, they do nothing to prevent the target system, I/O DMA,
5593 etc. from accessing memory.
5594
5595 @table @code
5596 @item ro
5597 Memory is read only.
5598 @item wo
5599 Memory is write only.
5600 @item rw
5601 Memory is read/write (default).
5602 @end table
5603
5604 @subsubsection Memory Access Size
5605 The acccess size attributes tells @value{GDBN} to use specific sized
5606 accesses in the memory region.  Often memory mapped device registers
5607 require specific sized accesses.  If no access size attribute is
5608 specified, @value{GDBN} may use accesses of any size.
5609
5610 @table @code
5611 @item 8
5612 Use 8 bit memory accesses.
5613 @item 16
5614 Use 16 bit memory accesses.
5615 @item 32
5616 Use 32 bit memory accesses.
5617 @item 64
5618 Use 64 bit memory accesses.
5619 @end table
5620
5621 @c @subsubsection Hardware/Software Breakpoints
5622 @c The hardware/software breakpoint attributes set whether @value{GDBN}
5623 @c will use hardware or software breakpoints for the internal breakpoints
5624 @c used by the step, next, finish, until, etc. commands.
5625 @c
5626 @c @table @code
5627 @c @item hwbreak
5628 @c Always use hardware breakpoints 
5629 @c @item swbreak (default)
5630 @c @end table
5631
5632 @subsubsection Data Cache
5633 The data cache attributes set whether @value{GDBN} will cache target
5634 memory.  While this generally improves performance by reducing debug
5635 protocol overhead, it can lead to incorrect results because @value{GDBN}
5636 does not know about volatile variables or memory mapped device
5637 registers.
5638
5639 @table @code
5640 @item cache
5641 Enable @value{GDBN} to cache target memory. 
5642 @item nocache (default)
5643 Disable @value{GDBN} from caching target memory.
5644 @end table
5645
5646 @c @subsubsection Memory Write Verification
5647 @c The memory write verification attributes set whether @value{GDBN} 
5648 @c will re-reads data after each write to verify the write was successful.
5649 @c
5650 @c @table @code
5651 @c @item verify
5652 @c @item noverify (default)
5653 @c @end table
5654
5655 @node Tracepoints
5656 @chapter Tracepoints
5657 @c This chapter is based on the documentation written by Michael
5658 @c Snyder, David Taylor, Jim Blandy, and Elena Zannoni.
5659
5660 @cindex tracepoints
5661 In some applications, it is not feasible for the debugger to interrupt
5662 the program's execution long enough for the developer to learn
5663 anything helpful about its behavior.  If the program's correctness
5664 depends on its real-time behavior, delays introduced by a debugger
5665 might cause the program to change its behavior drastically, or perhaps
5666 fail, even when the code itself is correct.  It is useful to be able
5667 to observe the program's behavior without interrupting it.
5668
5669 Using @value{GDBN}'s @code{trace} and @code{collect} commands, you can
5670 specify locations in the program, called @dfn{tracepoints}, and
5671 arbitrary expressions to evaluate when those tracepoints are reached.
5672 Later, using the @code{tfind} command, you can examine the values
5673 those expressions had when the program hit the tracepoints.  The
5674 expressions may also denote objects in memory---structures or arrays,
5675 for example---whose values @value{GDBN} should record; while visiting
5676 a particular tracepoint, you may inspect those objects as if they were
5677 in memory at that moment.  However, because @value{GDBN} records these
5678 values without interacting with you, it can do so quickly and
5679 unobtrusively, hopefully not disturbing the program's behavior.
5680
5681 The tracepoint facility is currently available only for remote
5682 targets.  @xref{Targets}.
5683
5684 This chapter describes the tracepoint commands and features.
5685
5686 @menu
5687 * Set Tracepoints::         
5688 * Analyze Collected Data::      
5689 * Tracepoint Variables::        
5690 @end menu
5691
5692 @node Set Tracepoints
5693 @section Commands to Set Tracepoints
5694
5695 Before running such a @dfn{trace experiment}, an arbitrary number of
5696 tracepoints can be set.  Like a breakpoint (@pxref{Set Breaks}), a
5697 tracepoint has a number assigned to it by @value{GDBN}.  Like with
5698 breakpoints, tracepoint numbers are successive integers starting from
5699 one.  Many of the commands associated with tracepoints take the
5700 tracepoint number as their argument, to identify which tracepoint to
5701 work on.
5702
5703 For each tracepoint, you can specify, in advance, some arbitrary set
5704 of data that you want the target to collect in the trace buffer when
5705 it hits that tracepoint.  The collected data can include registers,
5706 local variables, or global data.  Later, you can use @value{GDBN}
5707 commands to examine the values these data had at the time the
5708 tracepoint was hit.
5709
5710 This section describes commands to set tracepoints and associated
5711 conditions and actions.
5712
5713 @menu
5714 * Create and Delete Tracepoints::  
5715 * Enable and Disable Tracepoints::  
5716 * Tracepoint Passcounts::       
5717 * Tracepoint Actions::          
5718 * Listing Tracepoints::         
5719 * Starting and Stopping Trace Experiment::  
5720 @end menu
5721
5722 @node Create and Delete Tracepoints
5723 @subsection Create and Delete Tracepoints
5724
5725 @table @code
5726 @cindex set tracepoint
5727 @kindex trace
5728 @item trace
5729 The @code{trace} command is very similar to the @code{break} command.
5730 Its argument can be a source line, a function name, or an address in
5731 the target program.  @xref{Set Breaks}.  The @code{trace} command
5732 defines a tracepoint, which is a point in the target program where the
5733 debugger will briefly stop, collect some data, and then allow the
5734 program to continue.  Setting a tracepoint or changing its commands
5735 doesn't take effect until the next @code{tstart} command; thus, you
5736 cannot change the tracepoint attributes once a trace experiment is
5737 running.
5738
5739 Here are some examples of using the @code{trace} command:
5740
5741 @smallexample
5742 (@value{GDBP}) @b{trace foo.c:121}    // a source file and line number
5743
5744 (@value{GDBP}) @b{trace +2}           // 2 lines forward
5745
5746 (@value{GDBP}) @b{trace my_function}  // first source line of function
5747
5748 (@value{GDBP}) @b{trace *my_function} // EXACT start address of function
5749
5750 (@value{GDBP}) @b{trace *0x2117c4}    // an address
5751 @end smallexample
5752
5753 @noindent
5754 You can abbreviate @code{trace} as @code{tr}.
5755
5756 @vindex $tpnum
5757 @cindex last tracepoint number
5758 @cindex recent tracepoint number
5759 @cindex tracepoint number
5760 The convenience variable @code{$tpnum} records the tracepoint number
5761 of the most recently set tracepoint.
5762
5763 @kindex delete tracepoint
5764 @cindex tracepoint deletion
5765 @item delete tracepoint @r{[}@var{num}@r{]}
5766 Permanently delete one or more tracepoints.  With no argument, the
5767 default is to delete all tracepoints.
5768
5769 Examples:
5770
5771 @smallexample
5772 (@value{GDBP}) @b{delete trace 1 2 3} // remove three tracepoints
5773
5774 (@value{GDBP}) @b{delete trace}       // remove all tracepoints
5775 @end smallexample
5776
5777 @noindent
5778 You can abbreviate this command as @code{del tr}.
5779 @end table
5780
5781 @node Enable and Disable Tracepoints
5782 @subsection Enable and Disable Tracepoints
5783
5784 @table @code
5785 @kindex disable tracepoint
5786 @item disable tracepoint @r{[}@var{num}@r{]}
5787 Disable tracepoint @var{num}, or all tracepoints if no argument
5788 @var{num} is given.  A disabled tracepoint will have no effect during
5789 the next trace experiment, but it is not forgotten.  You can re-enable
5790 a disabled tracepoint using the @code{enable tracepoint} command.
5791
5792 @kindex enable tracepoint
5793 @item enable tracepoint @r{[}@var{num}@r{]}
5794 Enable tracepoint @var{num}, or all tracepoints.  The enabled
5795 tracepoints will become effective the next time a trace experiment is
5796 run.
5797 @end table
5798
5799 @node Tracepoint Passcounts
5800 @subsection Tracepoint Passcounts
5801
5802 @table @code
5803 @kindex passcount
5804 @cindex tracepoint pass count
5805 @item passcount @r{[}@var{n} @r{[}@var{num}@r{]]}
5806 Set the @dfn{passcount} of a tracepoint.  The passcount is a way to
5807 automatically stop a trace experiment.  If a tracepoint's passcount is
5808 @var{n}, then the trace experiment will be automatically stopped on
5809 the @var{n}'th time that tracepoint is hit.  If the tracepoint number
5810 @var{num} is not specified, the @code{passcount} command sets the
5811 passcount of the most recently defined tracepoint.  If no passcount is
5812 given, the trace experiment will run until stopped explicitly by the
5813 user.
5814
5815 Examples:
5816
5817 @smallexample
5818 (@value{GDBP}) @b{passcount 5 2} // Stop on the 5th execution of tracepoint 2
5819
5820 (@value{GDBP}) @b{passcount 12}  // Stop on the 12th execution of the
5821                                 // most recently defined tracepoint.
5822 (@value{GDBP}) @b{trace foo}
5823 (@value{GDBP}) @b{pass 3}
5824 (@value{GDBP}) @b{trace bar}
5825 (@value{GDBP}) @b{pass 2}
5826 (@value{GDBP}) @b{trace baz}
5827 (@value{GDBP}) @b{pass 1}        // Stop tracing when foo has been
5828                                  // executed 3 times OR when bar has
5829                                  // been executed 2 times
5830                                  // OR when baz has been executed 1 time.
5831 @end smallexample
5832 @end table
5833
5834 @node Tracepoint Actions
5835 @subsection Tracepoint Action Lists
5836
5837 @table @code
5838 @kindex actions
5839 @cindex tracepoint actions
5840 @item actions @r{[}@var{num}@r{]}
5841 This command will prompt for a list of actions to be taken when the
5842 tracepoint is hit.  If the tracepoint number @var{num} is not
5843 specified, this command sets the actions for the one that was most
5844 recently defined (so that you can define a tracepoint and then say
5845 @code{actions} without bothering about its number).  You specify the
5846 actions themselves on the following lines, one action at a time, and
5847 terminate the actions list with a line containing just @code{end}.  So
5848 far, the only defined actions are @code{collect} and
5849 @code{while-stepping}.
5850
5851 @cindex remove actions from a tracepoint
5852 To remove all actions from a tracepoint, type @samp{actions @var{num}}
5853 and follow it immediately with @samp{end}.
5854
5855 @smallexample
5856 (@value{GDBP}) @b{collect @var{data}} // collect some data
5857
5858 (@value{GDBP}) @b{while-stepping 5}   // single-step 5 times and collect data
5859
5860 (@value{GDBP}) @b{end}                // signals the end of actions.
5861 @end smallexample
5862
5863 In the following example, the action list begins with @code{collect}
5864 commands indicating the things to be collected when the tracepoint is
5865 hit.  Then, in order to single-step and collect additional data
5866 following the tracepoint, a @code{while-stepping} command is used,
5867 followed by the list of things to be collected while stepping.  The
5868 @code{while-stepping} command is terminated by its own separate
5869 @code{end} command.  Lastly, the action list is terminated by an
5870 @code{end} command.
5871
5872 @smallexample
5873 (@value{GDBP}) @b{trace foo}
5874 (@value{GDBP}) @b{actions}
5875 Enter actions for tracepoint 1, one per line:
5876 > collect bar,baz
5877 > collect $regs
5878 > while-stepping 12
5879   > collect $fp, $sp
5880   > end
5881 end
5882 @end smallexample
5883
5884 @kindex collect @r{(tracepoints)}
5885 @item collect @var{expr1}, @var{expr2}, @dots{}
5886 Collect values of the given expressions when the tracepoint is hit.
5887 This command accepts a comma-separated list of any valid expressions.
5888 In addition to global, static, or local variables, the following
5889 special arguments are supported:
5890
5891 @table @code
5892 @item $regs
5893 collect all registers
5894
5895 @item $args
5896 collect all function arguments
5897
5898 @item $locals
5899 collect all local variables.
5900 @end table
5901
5902 You can give several consecutive @code{collect} commands, each one
5903 with a single argument, or one @code{collect} command with several
5904 arguments separated by commas: the effect is the same.
5905
5906 The command @code{info scope} (@pxref{Symbols, info scope}) is
5907 particularly useful for figuring out what data to collect.
5908
5909 @kindex while-stepping @r{(tracepoints)}
5910 @item while-stepping @var{n}
5911 Perform @var{n} single-step traces after the tracepoint, collecting
5912 new data at each step.  The @code{while-stepping} command is
5913 followed by the list of what to collect while stepping (followed by
5914 its own @code{end} command):
5915
5916 @smallexample
5917 > while-stepping 12
5918   > collect $regs, myglobal
5919   > end
5920 >
5921 @end smallexample
5922
5923 @noindent
5924 You may abbreviate @code{while-stepping} as @code{ws} or
5925 @code{stepping}.
5926 @end table
5927
5928 @node Listing Tracepoints
5929 @subsection Listing Tracepoints
5930
5931 @table @code
5932 @kindex info tracepoints
5933 @cindex information about tracepoints
5934 @item info tracepoints @r{[}@var{num}@r{]}
5935 Display information the tracepoint @var{num}.  If you don't specify a
5936 tracepoint number displays information about all the tracepoints
5937 defined so far.  For each tracepoint, the following information is
5938 shown:
5939
5940 @itemize @bullet
5941 @item
5942 its number
5943 @item
5944 whether it is enabled or disabled
5945 @item
5946 its address
5947 @item
5948 its passcount as given by the @code{passcount @var{n}} command
5949 @item
5950 its step count as given by the @code{while-stepping @var{n}} command
5951 @item
5952 where in the source files is the tracepoint set
5953 @item
5954 its action list as given by the @code{actions} command
5955 @end itemize
5956
5957 @smallexample
5958 (@value{GDBP}) @b{info trace}
5959 Num Enb Address    PassC StepC What
5960 1   y   0x002117c4 0     0     <gdb_asm>
5961 2   y   0x0020dc64 0     0     in gdb_test at gdb_test.c:375
5962 3   y   0x0020b1f4 0     0     in collect_data at ../foo.c:1741
5963 (@value{GDBP})
5964 @end smallexample
5965
5966 @noindent
5967 This command can be abbreviated @code{info tp}.
5968 @end table
5969
5970 @node Starting and Stopping Trace Experiment
5971 @subsection Starting and Stopping Trace Experiment
5972
5973 @table @code
5974 @kindex tstart
5975 @cindex start a new trace experiment
5976 @cindex collected data discarded
5977 @item tstart
5978 This command takes no arguments.  It starts the trace experiment, and
5979 begins collecting data.  This has the side effect of discarding all
5980 the data collected in the trace buffer during the previous trace
5981 experiment.
5982
5983 @kindex tstop
5984 @cindex stop a running trace experiment
5985 @item tstop
5986 This command takes no arguments.  It ends the trace experiment, and
5987 stops collecting data.
5988
5989 @strong{Note:} a trace experiment and data collection may stop
5990 automatically if any tracepoint's passcount is reached
5991 (@pxref{Tracepoint Passcounts}), or if the trace buffer becomes full.
5992
5993 @kindex tstatus
5994 @cindex status of trace data collection
5995 @cindex trace experiment, status of
5996 @item tstatus
5997 This command displays the status of the current trace data
5998 collection.
5999 @end table
6000
6001 Here is an example of the commands we described so far:
6002
6003 @smallexample
6004 (@value{GDBP}) @b{trace gdb_c_test}
6005 (@value{GDBP}) @b{actions}
6006 Enter actions for tracepoint #1, one per line.
6007 > collect $regs,$locals,$args
6008 > while-stepping 11
6009   > collect $regs
6010   > end
6011 > end
6012 (@value{GDBP}) @b{tstart}
6013         [time passes @dots{}]
6014 (@value{GDBP}) @b{tstop}
6015 @end smallexample
6016
6017
6018 @node Analyze Collected Data
6019 @section Using the collected data
6020
6021 After the tracepoint experiment ends, you use @value{GDBN} commands
6022 for examining the trace data.  The basic idea is that each tracepoint
6023 collects a trace @dfn{snapshot} every time it is hit and another
6024 snapshot every time it single-steps.  All these snapshots are
6025 consecutively numbered from zero and go into a buffer, and you can
6026 examine them later.  The way you examine them is to @dfn{focus} on a
6027 specific trace snapshot.  When the remote stub is focused on a trace
6028 snapshot, it will respond to all @value{GDBN} requests for memory and
6029 registers by reading from the buffer which belongs to that snapshot,
6030 rather than from @emph{real} memory or registers of the program being
6031 debugged.  This means that @strong{all} @value{GDBN} commands
6032 (@code{print}, @code{info registers}, @code{backtrace}, etc.) will
6033 behave as if we were currently debugging the program state as it was
6034 when the tracepoint occurred.  Any requests for data that are not in
6035 the buffer will fail.
6036
6037 @menu
6038 * tfind::                       How to select a trace snapshot
6039 * tdump::                       How to display all data for a snapshot
6040 * save-tracepoints::            How to save tracepoints for a future run
6041 @end menu
6042
6043 @node tfind
6044 @subsection @code{tfind @var{n}}
6045
6046 @kindex tfind
6047 @cindex select trace snapshot
6048 @cindex find trace snapshot
6049 The basic command for selecting a trace snapshot from the buffer is
6050 @code{tfind @var{n}}, which finds trace snapshot number @var{n},
6051 counting from zero.  If no argument @var{n} is given, the next
6052 snapshot is selected.
6053
6054 Here are the various forms of using the @code{tfind} command.
6055
6056 @table @code
6057 @item tfind start
6058 Find the first snapshot in the buffer.  This is a synonym for
6059 @code{tfind 0} (since 0 is the number of the first snapshot).
6060
6061 @item tfind none
6062 Stop debugging trace snapshots, resume @emph{live} debugging.
6063
6064 @item tfind end
6065 Same as @samp{tfind none}.
6066
6067 @item tfind
6068 No argument means find the next trace snapshot.
6069
6070 @item tfind -
6071 Find the previous trace snapshot before the current one.  This permits
6072 retracing earlier steps.
6073
6074 @item tfind tracepoint @var{num}
6075 Find the next snapshot associated with tracepoint @var{num}.  Search
6076 proceeds forward from the last examined trace snapshot.  If no
6077 argument @var{num} is given, it means find the next snapshot collected
6078 for the same tracepoint as the current snapshot.
6079
6080 @item tfind pc @var{addr}
6081 Find the next snapshot associated with the value @var{addr} of the
6082 program counter.  Search proceeds forward from the last examined trace
6083 snapshot.  If no argument @var{addr} is given, it means find the next
6084 snapshot with the same value of PC as the current snapshot.
6085
6086 @item tfind outside @var{addr1}, @var{addr2}
6087 Find the next snapshot whose PC is outside the given range of
6088 addresses.
6089
6090 @item tfind range @var{addr1}, @var{addr2}
6091 Find the next snapshot whose PC is between @var{addr1} and
6092 @var{addr2}.  @c FIXME: Is the range inclusive or exclusive?
6093
6094 @item tfind line @r{[}@var{file}:@r{]}@var{n}
6095 Find the next snapshot associated with the source line @var{n}.  If
6096 the optional argument @var{file} is given, refer to line @var{n} in
6097 that source file.  Search proceeds forward from the last examined
6098 trace snapshot.  If no argument @var{n} is given, it means find the
6099 next line other than the one currently being examined; thus saying
6100 @code{tfind line} repeatedly can appear to have the same effect as
6101 stepping from line to line in a @emph{live} debugging session.
6102 @end table
6103
6104 The default arguments for the @code{tfind} commands are specifically
6105 designed to make it easy to scan through the trace buffer.  For
6106 instance, @code{tfind} with no argument selects the next trace
6107 snapshot, and @code{tfind -} with no argument selects the previous
6108 trace snapshot.  So, by giving one @code{tfind} command, and then
6109 simply hitting @key{RET} repeatedly you can examine all the trace
6110 snapshots in order.  Or, by saying @code{tfind -} and then hitting
6111 @key{RET} repeatedly you can examine the snapshots in reverse order.
6112 The @code{tfind line} command with no argument selects the snapshot
6113 for the next source line executed.  The @code{tfind pc} command with
6114 no argument selects the next snapshot with the same program counter
6115 (PC) as the current frame.  The @code{tfind tracepoint} command with
6116 no argument selects the next trace snapshot collected by the same
6117 tracepoint as the current one.
6118
6119 In addition to letting you scan through the trace buffer manually,
6120 these commands make it easy to construct @value{GDBN} scripts that
6121 scan through the trace buffer and print out whatever collected data
6122 you are interested in.  Thus, if we want to examine the PC, FP, and SP
6123 registers from each trace frame in the buffer, we can say this:
6124
6125 @smallexample
6126 (@value{GDBP}) @b{tfind start}
6127 (@value{GDBP}) @b{while ($trace_frame != -1)}
6128 > printf "Frame %d, PC = %08X, SP = %08X, FP = %08X\n", \
6129           $trace_frame, $pc, $sp, $fp
6130 > tfind
6131 > end
6132
6133 Frame 0, PC = 0020DC64, SP = 0030BF3C, FP = 0030BF44
6134 Frame 1, PC = 0020DC6C, SP = 0030BF38, FP = 0030BF44
6135 Frame 2, PC = 0020DC70, SP = 0030BF34, FP = 0030BF44
6136 Frame 3, PC = 0020DC74, SP = 0030BF30, FP = 0030BF44
6137 Frame 4, PC = 0020DC78, SP = 0030BF2C, FP = 0030BF44
6138 Frame 5, PC = 0020DC7C, SP = 0030BF28, FP = 0030BF44
6139 Frame 6, PC = 0020DC80, SP = 0030BF24, FP = 0030BF44
6140 Frame 7, PC = 0020DC84, SP = 0030BF20, FP = 0030BF44
6141 Frame 8, PC = 0020DC88, SP = 0030BF1C, FP = 0030BF44
6142 Frame 9, PC = 0020DC8E, SP = 0030BF18, FP = 0030BF44
6143 Frame 10, PC = 00203F6C, SP = 0030BE3C, FP = 0030BF14
6144 @end smallexample
6145
6146 Or, if we want to examine the variable @code{X} at each source line in
6147 the buffer:
6148
6149 @smallexample
6150 (@value{GDBP}) @b{tfind start}
6151 (@value{GDBP}) @b{while ($trace_frame != -1)}
6152 > printf "Frame %d, X == %d\n", $trace_frame, X
6153 > tfind line
6154 > end
6155
6156 Frame 0, X = 1
6157 Frame 7, X = 2
6158 Frame 13, X = 255
6159 @end smallexample
6160
6161 @node tdump
6162 @subsection @code{tdump}
6163 @kindex tdump
6164 @cindex dump all data collected at tracepoint
6165 @cindex tracepoint data, display
6166
6167 This command takes no arguments.  It prints all the data collected at
6168 the current trace snapshot.
6169
6170 @smallexample
6171 (@value{GDBP}) @b{trace 444}
6172 (@value{GDBP}) @b{actions}
6173 Enter actions for tracepoint #2, one per line:
6174 > collect $regs, $locals, $args, gdb_long_test
6175 > end
6176
6177 (@value{GDBP}) @b{tstart}
6178
6179 (@value{GDBP}) @b{tfind line 444}
6180 #0  gdb_test (p1=0x11, p2=0x22, p3=0x33, p4=0x44, p5=0x55, p6=0x66)
6181 at gdb_test.c:444
6182 444        printp( "%s: arguments = 0x%X 0x%X 0x%X 0x%X 0x%X 0x%X\n", )
6183
6184 (@value{GDBP}) @b{tdump}
6185 Data collected at tracepoint 2, trace frame 1:
6186 d0             0xc4aa0085       -995491707
6187 d1             0x18     24
6188 d2             0x80     128
6189 d3             0x33     51
6190 d4             0x71aea3d        119204413
6191 d5             0x22     34
6192 d6             0xe0     224
6193 d7             0x380035 3670069
6194 a0             0x19e24a 1696330
6195 a1             0x3000668        50333288
6196 a2             0x100    256
6197 a3             0x322000 3284992
6198 a4             0x3000698        50333336
6199 a5             0x1ad3cc 1758156
6200 fp             0x30bf3c 0x30bf3c
6201 sp             0x30bf34 0x30bf34
6202 ps             0x0      0
6203 pc             0x20b2c8 0x20b2c8
6204 fpcontrol      0x0      0
6205 fpstatus       0x0      0
6206 fpiaddr        0x0      0
6207 p = 0x20e5b4 "gdb-test"
6208 p1 = (void *) 0x11
6209 p2 = (void *) 0x22
6210 p3 = (void *) 0x33
6211 p4 = (void *) 0x44
6212 p5 = (void *) 0x55
6213 p6 = (void *) 0x66
6214 gdb_long_test = 17 '\021'
6215
6216 (@value{GDBP})
6217 @end smallexample
6218
6219 @node save-tracepoints
6220 @subsection @code{save-tracepoints @var{filename}}
6221 @kindex save-tracepoints
6222 @cindex save tracepoints for future sessions
6223
6224 This command saves all current tracepoint definitions together with
6225 their actions and passcounts, into a file @file{@var{filename}}
6226 suitable for use in a later debugging session.  To read the saved
6227 tracepoint definitions, use the @code{source} command (@pxref{Command
6228 Files}).
6229
6230 @node Tracepoint Variables
6231 @section Convenience Variables for Tracepoints
6232 @cindex tracepoint variables
6233 @cindex convenience variables for tracepoints
6234
6235 @table @code
6236 @vindex $trace_frame
6237 @item (int) $trace_frame
6238 The current trace snapshot (a.k.a.@: @dfn{frame}) number, or -1 if no
6239 snapshot is selected.
6240
6241 @vindex $tracepoint
6242 @item (int) $tracepoint
6243 The tracepoint for the current trace snapshot.
6244
6245 @vindex $trace_line
6246 @item (int) $trace_line
6247 The line number for the current trace snapshot.
6248
6249 @vindex $trace_file
6250 @item (char []) $trace_file
6251 The source file for the current trace snapshot.
6252
6253 @vindex $trace_func
6254 @item (char []) $trace_func
6255 The name of the function containing @code{$tracepoint}.
6256 @end table
6257
6258 Note: @code{$trace_file} is not suitable for use in @code{printf},
6259 use @code{output} instead.
6260
6261 Here's a simple example of using these convenience variables for
6262 stepping through all the trace snapshots and printing some of their
6263 data.
6264
6265 @smallexample
6266 (@value{GDBP}) @b{tfind start}
6267
6268 (@value{GDBP}) @b{while $trace_frame != -1}
6269 > output $trace_file
6270 > printf ", line %d (tracepoint #%d)\n", $trace_line, $tracepoint
6271 > tfind
6272 > end
6273 @end smallexample
6274
6275 @node Languages
6276 @chapter Using @value{GDBN} with Different Languages
6277 @cindex languages
6278
6279 Although programming languages generally have common aspects, they are
6280 rarely expressed in the same manner.  For instance, in ANSI C,
6281 dereferencing a pointer @code{p} is accomplished by @code{*p}, but in
6282 Modula-2, it is accomplished by @code{p^}.  Values can also be
6283 represented (and displayed) differently.  Hex numbers in C appear as
6284 @samp{0x1ae}, while in Modula-2 they appear as @samp{1AEH}.
6285
6286 @cindex working language
6287 Language-specific information is built into @value{GDBN} for some languages,
6288 allowing you to express operations like the above in your program's
6289 native language, and allowing @value{GDBN} to output values in a manner
6290 consistent with the syntax of your program's native language.  The
6291 language you use to build expressions is called the @dfn{working
6292 language}.
6293
6294 @menu
6295 * Setting::                     Switching between source languages
6296 * Show::                        Displaying the language
6297 * Checks::                      Type and range checks
6298 * Support::                     Supported languages
6299 @end menu
6300
6301 @node Setting
6302 @section Switching between source languages
6303
6304 There are two ways to control the working language---either have @value{GDBN}
6305 set it automatically, or select it manually yourself.  You can use the
6306 @code{set language} command for either purpose.  On startup, @value{GDBN}
6307 defaults to setting the language automatically.  The working language is
6308 used to determine how expressions you type are interpreted, how values
6309 are printed, etc.
6310
6311 In addition to the working language, every source file that
6312 @value{GDBN} knows about has its own working language.  For some object
6313 file formats, the compiler might indicate which language a particular
6314 source file is in.  However, most of the time @value{GDBN} infers the
6315 language from the name of the file.  The language of a source file
6316 controls whether C@t{++} names are demangled---this way @code{backtrace} can
6317 show each frame appropriately for its own language.  There is no way to
6318 set the language of a source file from within @value{GDBN}, but you can
6319 set the language associated with a filename extension.  @xref{Show, ,
6320 Displaying the language}.
6321
6322 This is most commonly a problem when you use a program, such
6323 as @code{cfront} or @code{f2c}, that generates C but is written in
6324 another language.  In that case, make the
6325 program use @code{#line} directives in its C output; that way
6326 @value{GDBN} will know the correct language of the source code of the original
6327 program, and will display that source code, not the generated C code.
6328
6329 @menu
6330 * Filenames::                   Filename extensions and languages.
6331 * Manually::                    Setting the working language manually
6332 * Automatically::               Having @value{GDBN} infer the source language
6333 @end menu
6334
6335 @node Filenames
6336 @subsection List of filename extensions and languages
6337
6338 If a source file name ends in one of the following extensions, then
6339 @value{GDBN} infers that its language is the one indicated.
6340
6341 @table @file
6342
6343 @item .c
6344 C source file
6345
6346 @item .C
6347 @itemx .cc
6348 @itemx .cp
6349 @itemx .cpp
6350 @itemx .cxx
6351 @itemx .c++
6352 C@t{++} source file
6353
6354 @item .f
6355 @itemx .F
6356 Fortran source file
6357
6358 @item .ch
6359 @itemx .c186
6360 @itemx .c286
6361 CHILL source file
6362
6363 @item .mod
6364 Modula-2 source file
6365
6366 @item .s
6367 @itemx .S
6368 Assembler source file.  This actually behaves almost like C, but
6369 @value{GDBN} does not skip over function prologues when stepping.
6370 @end table
6371
6372 In addition, you may set the language associated with a filename
6373 extension.  @xref{Show, , Displaying the language}.
6374
6375 @node Manually
6376 @subsection Setting the working language
6377
6378 If you allow @value{GDBN} to set the language automatically,
6379 expressions are interpreted the same way in your debugging session and
6380 your program.
6381
6382 @kindex set language
6383 If you wish, you may set the language manually.  To do this, issue the
6384 command @samp{set language @var{lang}}, where @var{lang} is the name of
6385 a language, such as
6386 @code{c} or @code{modula-2}.
6387 For a list of the supported languages, type @samp{set language}.
6388
6389 Setting the language manually prevents @value{GDBN} from updating the working
6390 language automatically.  This can lead to confusion if you try
6391 to debug a program when the working language is not the same as the
6392 source language, when an expression is acceptable to both
6393 languages---but means different things.  For instance, if the current
6394 source file were written in C, and @value{GDBN} was parsing Modula-2, a
6395 command such as:
6396
6397 @example
6398 print a = b + c
6399 @end example
6400
6401 @noindent
6402 might not have the effect you intended.  In C, this means to add
6403 @code{b} and @code{c} and place the result in @code{a}.  The result
6404 printed would be the value of @code{a}.  In Modula-2, this means to compare
6405 @code{a} to the result of @code{b+c}, yielding a @code{BOOLEAN} value.
6406
6407 @node Automatically
6408 @subsection Having @value{GDBN} infer the source language
6409
6410 To have @value{GDBN} set the working language automatically, use
6411 @samp{set language local} or @samp{set language auto}.  @value{GDBN}
6412 then infers the working language.  That is, when your program stops in a
6413 frame (usually by encountering a breakpoint), @value{GDBN} sets the
6414 working language to the language recorded for the function in that
6415 frame.  If the language for a frame is unknown (that is, if the function
6416 or block corresponding to the frame was defined in a source file that
6417 does not have a recognized extension), the current working language is
6418 not changed, and @value{GDBN} issues a warning.
6419
6420 This may not seem necessary for most programs, which are written
6421 entirely in one source language.  However, program modules and libraries
6422 written in one source language can be used by a main program written in
6423 a different source language.  Using @samp{set language auto} in this
6424 case frees you from having to set the working language manually.
6425
6426 @node Show
6427 @section Displaying the language
6428
6429 The following commands help you find out which language is the
6430 working language, and also what language source files were written in.
6431
6432 @kindex show language
6433 @kindex info frame@r{, show the source language}
6434 @kindex info source@r{, show the source language}
6435 @table @code
6436 @item show language
6437 Display the current working language.  This is the
6438 language you can use with commands such as @code{print} to
6439 build and compute expressions that may involve variables in your program.
6440
6441 @item info frame
6442 Display the source language for this frame.  This language becomes the
6443 working language if you use an identifier from this frame.
6444 @xref{Frame Info, ,Information about a frame}, to identify the other
6445 information listed here.
6446
6447 @item info source
6448 Display the source language of this source file.
6449 @xref{Symbols, ,Examining the Symbol Table}, to identify the other
6450 information listed here.
6451 @end table
6452
6453 In unusual circumstances, you may have source files with extensions
6454 not in the standard list.  You can then set the extension associated
6455 with a language explicitly:
6456
6457 @kindex set extension-language
6458 @kindex info extensions
6459 @table @code
6460 @item set extension-language @var{.ext} @var{language}
6461 Set source files with extension @var{.ext} to be assumed to be in
6462 the source language @var{language}.
6463
6464 @item info extensions
6465 List all the filename extensions and the associated languages.
6466 @end table
6467
6468 @node Checks
6469 @section Type and range checking
6470
6471 @quotation
6472 @emph{Warning:} In this release, the @value{GDBN} commands for type and range
6473 checking are included, but they do not yet have any effect.  This
6474 section documents the intended facilities.
6475 @end quotation
6476 @c FIXME remove warning when type/range code added
6477
6478 Some languages are designed to guard you against making seemingly common
6479 errors through a series of compile- and run-time checks.  These include
6480 checking the type of arguments to functions and operators, and making
6481 sure mathematical overflows are caught at run time.  Checks such as
6482 these help to ensure a program's correctness once it has been compiled
6483 by eliminating type mismatches, and providing active checks for range
6484 errors when your program is running.
6485
6486 @value{GDBN} can check for conditions like the above if you wish.
6487 Although @value{GDBN} does not check the statements in your program, it
6488 can check expressions entered directly into @value{GDBN} for evaluation via
6489 the @code{print} command, for example.  As with the working language,
6490 @value{GDBN} can also decide whether or not to check automatically based on
6491 your program's source language.  @xref{Support, ,Supported languages},
6492 for the default settings of supported languages.
6493
6494 @menu
6495 * Type Checking::               An overview of type checking
6496 * Range Checking::              An overview of range checking
6497 @end menu
6498
6499 @cindex type checking
6500 @cindex checks, type
6501 @node Type Checking
6502 @subsection An overview of type checking
6503
6504 Some languages, such as Modula-2, are strongly typed, meaning that the
6505 arguments to operators and functions have to be of the correct type,
6506 otherwise an error occurs.  These checks prevent type mismatch
6507 errors from ever causing any run-time problems.  For example,
6508
6509 @smallexample
6510 1 + 2 @result{} 3
6511 @exdent but
6512 @error{} 1 + 2.3
6513 @end smallexample
6514
6515 The second example fails because the @code{CARDINAL} 1 is not
6516 type-compatible with the @code{REAL} 2.3.
6517
6518 For the expressions you use in @value{GDBN} commands, you can tell the
6519 @value{GDBN} type checker to skip checking;
6520 to treat any mismatches as errors and abandon the expression;
6521 or to only issue warnings when type mismatches occur,
6522 but evaluate the expression anyway.  When you choose the last of
6523 these, @value{GDBN} evaluates expressions like the second example above, but
6524 also issues a warning.
6525
6526 Even if you turn type checking off, there may be other reasons
6527 related to type that prevent @value{GDBN} from evaluating an expression.
6528 For instance, @value{GDBN} does not know how to add an @code{int} and
6529 a @code{struct foo}.  These particular type errors have nothing to do
6530 with the language in use, and usually arise from expressions, such as
6531 the one described above, which make little sense to evaluate anyway.
6532
6533 Each language defines to what degree it is strict about type.  For
6534 instance, both Modula-2 and C require the arguments to arithmetical
6535 operators to be numbers.  In C, enumerated types and pointers can be
6536 represented as numbers, so that they are valid arguments to mathematical
6537 operators.  @xref{Support, ,Supported languages}, for further
6538 details on specific languages.
6539
6540 @value{GDBN} provides some additional commands for controlling the type checker:
6541
6542 @kindex set check@r{, type}
6543 @kindex set check type
6544 @kindex show check type
6545 @table @code
6546 @item set check type auto
6547 Set type checking on or off based on the current working language.
6548 @xref{Support, ,Supported languages}, for the default settings for
6549 each language.
6550
6551 @item set check type on
6552 @itemx set check type off
6553 Set type checking on or off, overriding the default setting for the
6554 current working language.  Issue a warning if the setting does not
6555 match the language default.  If any type mismatches occur in
6556 evaluating an expression while type checking is on, @value{GDBN} prints a
6557 message and aborts evaluation of the expression.
6558
6559 @item set check type warn
6560 Cause the type checker to issue warnings, but to always attempt to
6561 evaluate the expression.  Evaluating the expression may still
6562 be impossible for other reasons.  For example, @value{GDBN} cannot add
6563 numbers and structures.
6564
6565 @item show type
6566 Show the current setting of the type checker, and whether or not @value{GDBN}
6567 is setting it automatically.
6568 @end table
6569
6570 @cindex range checking
6571 @cindex checks, range
6572 @node Range Checking
6573 @subsection An overview of range checking
6574
6575 In some languages (such as Modula-2), it is an error to exceed the
6576 bounds of a type; this is enforced with run-time checks.  Such range
6577 checking is meant to ensure program correctness by making sure
6578 computations do not overflow, or indices on an array element access do
6579 not exceed the bounds of the array.
6580
6581 For expressions you use in @value{GDBN} commands, you can tell
6582 @value{GDBN} to treat range errors in one of three ways: ignore them,
6583 always treat them as errors and abandon the expression, or issue
6584 warnings but evaluate the expression anyway.
6585
6586 A range error can result from numerical overflow, from exceeding an
6587 array index bound, or when you type a constant that is not a member
6588 of any type.  Some languages, however, do not treat overflows as an
6589 error.  In many implementations of C, mathematical overflow causes the
6590 result to ``wrap around'' to lower values---for example, if @var{m} is
6591 the largest integer value, and @var{s} is the smallest, then
6592
6593 @example
6594 @var{m} + 1 @result{} @var{s}
6595 @end example
6596
6597 This, too, is specific to individual languages, and in some cases
6598 specific to individual compilers or machines.  @xref{Support, ,
6599 Supported languages}, for further details on specific languages.
6600
6601 @value{GDBN} provides some additional commands for controlling the range checker:
6602
6603 @kindex set check@r{, range}
6604 @kindex set check range
6605 @kindex show check range
6606 @table @code
6607 @item set check range auto
6608 Set range checking on or off based on the current working language.
6609 @xref{Support, ,Supported languages}, for the default settings for
6610 each language.
6611
6612 @item set check range on
6613 @itemx set check range off
6614 Set range checking on or off, overriding the default setting for the
6615 current working language.  A warning is issued if the setting does not
6616 match the language default.  If a range error occurs and range checking is on,
6617 then a message is printed and evaluation of the expression is aborted.
6618
6619 @item set check range warn
6620 Output messages when the @value{GDBN} range checker detects a range error,
6621 but attempt to evaluate the expression anyway.  Evaluating the
6622 expression may still be impossible for other reasons, such as accessing
6623 memory that the process does not own (a typical example from many Unix
6624 systems).
6625
6626 @item show range
6627 Show the current setting of the range checker, and whether or not it is
6628 being set automatically by @value{GDBN}.
6629 @end table
6630
6631 @node Support
6632 @section Supported languages
6633
6634 @value{GDBN} supports C, C@t{++}, Fortran, Java, Chill, assembly, and Modula-2.
6635 @c This is false ...
6636 Some @value{GDBN} features may be used in expressions regardless of the
6637 language you use: the @value{GDBN} @code{@@} and @code{::} operators,
6638 and the @samp{@{type@}addr} construct (@pxref{Expressions,
6639 ,Expressions}) can be used with the constructs of any supported
6640 language.
6641
6642 The following sections detail to what degree each source language is
6643 supported by @value{GDBN}.  These sections are not meant to be language
6644 tutorials or references, but serve only as a reference guide to what the
6645 @value{GDBN} expression parser accepts, and what input and output
6646 formats should look like for different languages.  There are many good
6647 books written on each of these languages; please look to these for a
6648 language reference or tutorial.
6649
6650 @menu
6651 * C::           C and C@t{++}
6652 * Modula-2::    Modula-2
6653 * Chill::        Chill
6654 @end menu
6655
6656 @node C
6657 @subsection C and C@t{++}
6658
6659 @cindex C and C@t{++}
6660 @cindex expressions in C or C@t{++}
6661
6662 Since C and C@t{++} are so closely related, many features of @value{GDBN} apply
6663 to both languages.  Whenever this is the case, we discuss those languages
6664 together.
6665
6666 @cindex C@t{++}
6667 @cindex @code{g++}, @sc{gnu} C@t{++} compiler
6668 @cindex @sc{gnu} C@t{++}
6669 The C@t{++} debugging facilities are jointly implemented by the C@t{++}
6670 compiler and @value{GDBN}.  Therefore, to debug your C@t{++} code
6671 effectively, you must compile your C@t{++} programs with a supported
6672 C@t{++} compiler, such as @sc{gnu} @code{g++}, or the HP ANSI C@t{++}
6673 compiler (@code{aCC}).
6674
6675 For best results when using @sc{gnu} C@t{++}, use the stabs debugging
6676 format.  You can select that format explicitly with the @code{g++}
6677 command-line options @samp{-gstabs} or @samp{-gstabs+}.  See
6678 @ref{Debugging Options,,Options for Debugging Your Program or @sc{gnu}
6679 CC, gcc.info, Using @sc{gnu} CC}, for more information.
6680
6681 @menu
6682 * C Operators::                 C and C@t{++} operators
6683 * C Constants::                 C and C@t{++} constants
6684 * C plus plus expressions::     C@t{++} expressions
6685 * C Defaults::                  Default settings for C and C@t{++}
6686 * C Checks::                    C and C@t{++} type and range checks
6687 * Debugging C::                 @value{GDBN} and C
6688 * Debugging C plus plus::       @value{GDBN} features for C@t{++}
6689 @end menu
6690
6691 @node C Operators
6692 @subsubsection C and C@t{++} operators
6693
6694 @cindex C and C@t{++} operators
6695
6696 Operators must be defined on values of specific types.  For instance,
6697 @code{+} is defined on numbers, but not on structures.  Operators are
6698 often defined on groups of types.
6699
6700 For the purposes of C and C@t{++}, the following definitions hold:
6701
6702 @itemize @bullet
6703
6704 @item
6705 @emph{Integral types} include @code{int} with any of its storage-class
6706 specifiers; @code{char}; @code{enum}; and, for C@t{++}, @code{bool}.
6707
6708 @item
6709 @emph{Floating-point types} include @code{float}, @code{double}, and
6710 @code{long double} (if supported by the target platform).
6711
6712 @item
6713 @emph{Pointer types} include all types defined as @code{(@var{type} *)}.
6714
6715 @item
6716 @emph{Scalar types} include all of the above.
6717
6718 @end itemize
6719
6720 @noindent
6721 The following operators are supported.  They are listed here
6722 in order of increasing precedence:
6723
6724 @table @code
6725 @item ,
6726 The comma or sequencing operator.  Expressions in a comma-separated list
6727 are evaluated from left to right, with the result of the entire
6728 expression being the last expression evaluated.
6729
6730 @item =
6731 Assignment.  The value of an assignment expression is the value
6732 assigned.  Defined on scalar types.
6733
6734 @item @var{op}=
6735 Used in an expression of the form @w{@code{@var{a} @var{op}= @var{b}}},
6736 and translated to @w{@code{@var{a} = @var{a op b}}}.
6737 @w{@code{@var{op}=}} and @code{=} have the same precedence.
6738 @var{op} is any one of the operators @code{|}, @code{^}, @code{&},
6739 @code{<<}, @code{>>}, @code{+}, @code{-}, @code{*}, @code{/}, @code{%}.
6740
6741 @item ?:
6742 The ternary operator.  @code{@var{a} ? @var{b} : @var{c}} can be thought
6743 of as:  if @var{a} then @var{b} else @var{c}.  @var{a} should be of an
6744 integral type.
6745
6746 @item ||
6747 Logical @sc{or}.  Defined on integral types.
6748
6749 @item &&
6750 Logical @sc{and}.  Defined on integral types.
6751
6752 @item |
6753 Bitwise @sc{or}.  Defined on integral types.
6754
6755 @item ^
6756 Bitwise exclusive-@sc{or}.  Defined on integral types.
6757
6758 @item &
6759 Bitwise @sc{and}.  Defined on integral types.
6760
6761 @item ==@r{, }!=
6762 Equality and inequality.  Defined on scalar types.  The value of these
6763 expressions is 0 for false and non-zero for true.
6764
6765 @item <@r{, }>@r{, }<=@r{, }>=
6766 Less than, greater than, less than or equal, greater than or equal.
6767 Defined on scalar types.  The value of these expressions is 0 for false
6768 and non-zero for true.
6769
6770 @item <<@r{, }>>
6771 left shift, and right shift.  Defined on integral types.
6772
6773 @item @@
6774 The @value{GDBN} ``artificial array'' operator (@pxref{Expressions, ,Expressions}).
6775
6776 @item +@r{, }-
6777 Addition and subtraction.  Defined on integral types, floating-point types and
6778 pointer types.
6779
6780 @item *@r{, }/@r{, }%
6781 Multiplication, division, and modulus.  Multiplication and division are
6782 defined on integral and floating-point types.  Modulus is defined on
6783 integral types.
6784
6785 @item ++@r{, }--
6786 Increment and decrement.  When appearing before a variable, the
6787 operation is performed before the variable is used in an expression;
6788 when appearing after it, the variable's value is used before the
6789 operation takes place.
6790
6791 @item *
6792 Pointer dereferencing.  Defined on pointer types.  Same precedence as
6793 @code{++}.
6794
6795 @item &
6796 Address operator.  Defined on variables.  Same precedence as @code{++}.
6797
6798 For debugging C@t{++}, @value{GDBN} implements a use of @samp{&} beyond what is
6799 allowed in the C@t{++} language itself: you can use @samp{&(&@var{ref})}
6800 (or, if you prefer, simply @samp{&&@var{ref}}) to examine the address
6801 where a C@t{++} reference variable (declared with @samp{&@var{ref}}) is
6802 stored.
6803
6804 @item -
6805 Negative.  Defined on integral and floating-point types.  Same
6806 precedence as @code{++}.
6807
6808 @item !
6809 Logical negation.  Defined on integral types.  Same precedence as
6810 @code{++}.
6811
6812 @item ~
6813 Bitwise complement operator.  Defined on integral types.  Same precedence as
6814 @code{++}.
6815
6816
6817 @item .@r{, }->
6818 Structure member, and pointer-to-structure member.  For convenience,
6819 @value{GDBN} regards the two as equivalent, choosing whether to dereference a
6820 pointer based on the stored type information.
6821 Defined on @code{struct} and @code{union} data.
6822
6823 @item .*@r{, }->*
6824 Dereferences of pointers to members.
6825
6826 @item []
6827 Array indexing.  @code{@var{a}[@var{i}]} is defined as
6828 @code{*(@var{a}+@var{i})}.  Same precedence as @code{->}.
6829
6830 @item ()
6831 Function parameter list.  Same precedence as @code{->}.
6832
6833 @item ::
6834 C@t{++} scope resolution operator.  Defined on @code{struct}, @code{union},
6835 and @code{class} types.
6836
6837 @item ::
6838 Doubled colons also represent the @value{GDBN} scope operator
6839 (@pxref{Expressions, ,Expressions}).  Same precedence as @code{::},
6840 above.
6841 @end table
6842
6843 If an operator is redefined in the user code, @value{GDBN} usually
6844 attempts to invoke the redefined version instead of using the operator's
6845 predefined meaning.
6846
6847 @menu
6848 * C Constants::
6849 @end menu
6850
6851 @node C Constants
6852 @subsubsection C and C@t{++} constants
6853
6854 @cindex C and C@t{++} constants
6855
6856 @value{GDBN} allows you to express the constants of C and C@t{++} in the
6857 following ways:
6858
6859 @itemize @bullet
6860 @item
6861 Integer constants are a sequence of digits.  Octal constants are
6862 specified by a leading @samp{0} (i.e. zero), and hexadecimal constants by
6863 a leading @samp{0x} or @samp{0X}.  Constants may also end with a letter
6864 @samp{l}, specifying that the constant should be treated as a
6865 @code{long} value.
6866
6867 @item
6868 Floating point constants are a sequence of digits, followed by a decimal
6869 point, followed by a sequence of digits, and optionally followed by an
6870 exponent.  An exponent is of the form:
6871 @samp{@w{e@r{[[}+@r{]|}-@r{]}@var{nnn}}}, where @var{nnn} is another
6872 sequence of digits.  The @samp{+} is optional for positive exponents.
6873 A floating-point constant may also end with a letter @samp{f} or
6874 @samp{F}, specifying that the constant should be treated as being of
6875 the @code{float} (as opposed to the default @code{double}) type; or with
6876 a letter @samp{l} or @samp{L}, which specifies a @code{long double}
6877 constant.
6878
6879 @item
6880 Enumerated constants consist of enumerated identifiers, or their
6881 integral equivalents.
6882
6883 @item
6884 Character constants are a single character surrounded by single quotes
6885 (@code{'}), or a number---the ordinal value of the corresponding character
6886 (usually its @sc{ascii} value).  Within quotes, the single character may
6887 be represented by a letter or by @dfn{escape sequences}, which are of
6888 the form @samp{\@var{nnn}}, where @var{nnn} is the octal representation
6889 of the character's ordinal value; or of the form @samp{\@var{x}}, where
6890 @samp{@var{x}} is a predefined special character---for example,
6891 @samp{\n} for newline.
6892
6893 @item
6894 String constants are a sequence of character constants surrounded by
6895 double quotes (@code{"}).  Any valid character constant (as described
6896 above) may appear.  Double quotes within the string must be preceded by
6897 a backslash, so for instance @samp{"a\"b'c"} is a string of five
6898 characters.
6899
6900 @item
6901 Pointer constants are an integral value.  You can also write pointers
6902 to constants using the C operator @samp{&}.
6903
6904 @item
6905 Array constants are comma-separated lists surrounded by braces @samp{@{}
6906 and @samp{@}}; for example, @samp{@{1,2,3@}} is a three-element array of
6907 integers, @samp{@{@{1,2@}, @{3,4@}, @{5,6@}@}} is a three-by-two array,
6908 and @samp{@{&"hi", &"there", &"fred"@}} is a three-element array of pointers.
6909 @end itemize
6910
6911 @menu
6912 * C plus plus expressions::
6913 * C Defaults::
6914 * C Checks::
6915
6916 * Debugging C::
6917 @end menu
6918
6919 @node C plus plus expressions
6920 @subsubsection C@t{++} expressions
6921
6922 @cindex expressions in C@t{++}
6923 @value{GDBN} expression handling can interpret most C@t{++} expressions.
6924
6925 @cindex C@t{++} support, not in @sc{coff}
6926 @cindex @sc{coff} versus C@t{++}
6927 @cindex C@t{++} and object formats
6928 @cindex object formats and C@t{++}
6929 @cindex a.out and C@t{++}
6930 @cindex @sc{ecoff} and C@t{++}
6931 @cindex @sc{xcoff} and C@t{++}
6932 @cindex @sc{elf}/stabs and C@t{++}
6933 @cindex @sc{elf}/@sc{dwarf} and C@t{++}
6934 @c FIXME!! GDB may eventually be able to debug C++ using DWARF; check
6935 @c periodically whether this has happened...
6936 @quotation
6937 @emph{Warning:} @value{GDBN} can only debug C@t{++} code if you use the
6938 proper compiler.  Typically, C@t{++} debugging depends on the use of
6939 additional debugging information in the symbol table, and thus requires
6940 special support.  In particular, if your compiler generates a.out, MIPS
6941 @sc{ecoff}, RS/6000 @sc{xcoff}, or @sc{elf} with stabs extensions to the
6942 symbol table, these facilities are all available.  (With @sc{gnu} CC,
6943 you can use the @samp{-gstabs} option to request stabs debugging
6944 extensions explicitly.)  Where the object code format is standard
6945 @sc{coff} or @sc{dwarf} in @sc{elf}, on the other hand, most of the C@t{++}
6946 support in @value{GDBN} does @emph{not} work.
6947 @end quotation
6948
6949 @enumerate
6950
6951 @cindex member functions
6952 @item
6953 Member function calls are allowed; you can use expressions like
6954
6955 @example
6956 count = aml->GetOriginal(x, y)
6957 @end example
6958
6959 @vindex this@r{, inside C@t{++} member functions}
6960 @cindex namespace in C@t{++}
6961 @item
6962 While a member function is active (in the selected stack frame), your
6963 expressions have the same namespace available as the member function;
6964 that is, @value{GDBN} allows implicit references to the class instance
6965 pointer @code{this} following the same rules as C@t{++}.
6966
6967 @cindex call overloaded functions
6968 @cindex overloaded functions, calling
6969 @cindex type conversions in C@t{++}
6970 @item
6971 You can call overloaded functions; @value{GDBN} resolves the function
6972 call to the right definition, with some restrictions.  @value{GDBN} does not
6973 perform overload resolution involving user-defined type conversions,
6974 calls to constructors, or instantiations of templates that do not exist
6975 in the program.  It also cannot handle ellipsis argument lists or
6976 default arguments.
6977
6978 It does perform integral conversions and promotions, floating-point
6979 promotions, arithmetic conversions, pointer conversions, conversions of
6980 class objects to base classes, and standard conversions such as those of
6981 functions or arrays to pointers; it requires an exact match on the
6982 number of function arguments.
6983
6984 Overload resolution is always performed, unless you have specified
6985 @code{set overload-resolution off}.  @xref{Debugging C plus plus,
6986 ,@value{GDBN} features for C@t{++}}.
6987
6988 You must specify @code{set overload-resolution off} in order to use an
6989 explicit function signature to call an overloaded function, as in
6990 @smallexample
6991 p 'foo(char,int)'('x', 13)
6992 @end smallexample
6993
6994 The @value{GDBN} command-completion facility can simplify this;
6995 see @ref{Completion, ,Command completion}.
6996
6997 @cindex reference declarations
6998 @item
6999 @value{GDBN} understands variables declared as C@t{++} references; you can use
7000 them in expressions just as you do in C@t{++} source---they are automatically
7001 dereferenced.
7002
7003 In the parameter list shown when @value{GDBN} displays a frame, the values of
7004 reference variables are not displayed (unlike other variables); this
7005 avoids clutter, since references are often used for large structures.
7006 The @emph{address} of a reference variable is always shown, unless
7007 you have specified @samp{set print address off}.
7008
7009 @item
7010 @value{GDBN} supports the C@t{++} name resolution operator @code{::}---your
7011 expressions can use it just as expressions in your program do.  Since
7012 one scope may be defined in another, you can use @code{::} repeatedly if
7013 necessary, for example in an expression like
7014 @samp{@var{scope1}::@var{scope2}::@var{name}}.  @value{GDBN} also allows
7015 resolving name scope by reference to source files, in both C and C@t{++}
7016 debugging (@pxref{Variables, ,Program variables}).
7017 @end enumerate
7018
7019 In addition, when used with HP's C@t{++} compiler, @value{GDBN} supports
7020 calling virtual functions correctly, printing out virtual bases of
7021 objects, calling functions in a base subobject, casting objects, and
7022 invoking user-defined operators.
7023
7024 @node C Defaults
7025 @subsubsection C and C@t{++} defaults
7026
7027 @cindex C and C@t{++} defaults
7028
7029 If you allow @value{GDBN} to set type and range checking automatically, they
7030 both default to @code{off} whenever the working language changes to
7031 C or C@t{++}.  This happens regardless of whether you or @value{GDBN}
7032 selects the working language.
7033
7034 If you allow @value{GDBN} to set the language automatically, it
7035 recognizes source files whose names end with @file{.c}, @file{.C}, or
7036 @file{.cc}, etc, and when @value{GDBN} enters code compiled from one of
7037 these files, it sets the working language to C or C@t{++}.
7038 @xref{Automatically, ,Having @value{GDBN} infer the source language},
7039 for further details.
7040
7041 @c Type checking is (a) primarily motivated by Modula-2, and (b)
7042 @c unimplemented.  If (b) changes, it might make sense to let this node
7043 @c appear even if Mod-2 does not, but meanwhile ignore it. roland 16jul93.
7044
7045 @node C Checks
7046 @subsubsection C and C@t{++} type and range checks
7047
7048 @cindex C and C@t{++} checks
7049
7050 By default, when @value{GDBN} parses C or C@t{++} expressions, type checking
7051 is not used.  However, if you turn type checking on, @value{GDBN}
7052 considers two variables type equivalent if:
7053
7054 @itemize @bullet
7055 @item
7056 The two variables are structured and have the same structure, union, or
7057 enumerated tag.
7058
7059 @item
7060 The two variables have the same type name, or types that have been
7061 declared equivalent through @code{typedef}.
7062
7063 @ignore
7064 @c leaving this out because neither J Gilmore nor R Pesch understand it.
7065 @c FIXME--beers?
7066 @item
7067 The two @code{struct}, @code{union}, or @code{enum} variables are
7068 declared in the same declaration.  (Note: this may not be true for all C
7069 compilers.)
7070 @end ignore
7071 @end itemize
7072
7073 Range checking, if turned on, is done on mathematical operations.  Array
7074 indices are not checked, since they are often used to index a pointer
7075 that is not itself an array.
7076
7077 @node Debugging C
7078 @subsubsection @value{GDBN} and C
7079
7080 The @code{set print union} and @code{show print union} commands apply to
7081 the @code{union} type.  When set to @samp{on}, any @code{union} that is
7082 inside a @code{struct} or @code{class} is also printed.  Otherwise, it
7083 appears as @samp{@{...@}}.
7084
7085 The @code{@@} operator aids in the debugging of dynamic arrays, formed
7086 with pointers and a memory allocation function.  @xref{Expressions,
7087 ,Expressions}.
7088
7089 @menu
7090 * Debugging C plus plus::
7091 @end menu
7092
7093 @node Debugging C plus plus
7094 @subsubsection @value{GDBN} features for C@t{++}
7095
7096 @cindex commands for C@t{++}
7097
7098 Some @value{GDBN} commands are particularly useful with C@t{++}, and some are
7099 designed specifically for use with C@t{++}.  Here is a summary:
7100
7101 @table @code
7102 @cindex break in overloaded functions
7103 @item @r{breakpoint menus}
7104 When you want a breakpoint in a function whose name is overloaded,
7105 @value{GDBN} breakpoint menus help you specify which function definition
7106 you want.  @xref{Breakpoint Menus,,Breakpoint menus}.
7107
7108 @cindex overloading in C@t{++}
7109 @item rbreak @var{regex}
7110 Setting breakpoints using regular expressions is helpful for setting
7111 breakpoints on overloaded functions that are not members of any special
7112 classes.
7113 @xref{Set Breaks, ,Setting breakpoints}.
7114
7115 @cindex C@t{++} exception handling
7116 @item catch throw
7117 @itemx catch catch
7118 Debug C@t{++} exception handling using these commands.  @xref{Set
7119 Catchpoints, , Setting catchpoints}.
7120
7121 @cindex inheritance
7122 @item ptype @var{typename}
7123 Print inheritance relationships as well as other information for type
7124 @var{typename}.
7125 @xref{Symbols, ,Examining the Symbol Table}.
7126
7127 @cindex C@t{++} symbol display
7128 @item set print demangle
7129 @itemx show print demangle
7130 @itemx set print asm-demangle
7131 @itemx show print asm-demangle
7132 Control whether C@t{++} symbols display in their source form, both when
7133 displaying code as C@t{++} source and when displaying disassemblies.
7134 @xref{Print Settings, ,Print settings}.
7135
7136 @item set print object
7137 @itemx show print object
7138 Choose whether to print derived (actual) or declared types of objects.
7139 @xref{Print Settings, ,Print settings}.
7140
7141 @item set print vtbl
7142 @itemx show print vtbl
7143 Control the format for printing virtual function tables.
7144 @xref{Print Settings, ,Print settings}.
7145 (The @code{vtbl} commands do not work on programs compiled with the HP
7146 ANSI C@t{++} compiler (@code{aCC}).)
7147
7148 @kindex set overload-resolution
7149 @cindex overloaded functions, overload resolution
7150 @item set overload-resolution on
7151 Enable overload resolution for C@t{++} expression evaluation.  The default
7152 is on.  For overloaded functions, @value{GDBN} evaluates the arguments
7153 and searches for a function whose signature matches the argument types,
7154 using the standard C@t{++} conversion rules (see @ref{C plus plus expressions, ,C@t{++}
7155 expressions}, for details).  If it cannot find a match, it emits a
7156 message.
7157
7158 @item set overload-resolution off
7159 Disable overload resolution for C@t{++} expression evaluation.  For
7160 overloaded functions that are not class member functions, @value{GDBN}
7161 chooses the first function of the specified name that it finds in the
7162 symbol table, whether or not its arguments are of the correct type.  For
7163 overloaded functions that are class member functions, @value{GDBN}
7164 searches for a function whose signature @emph{exactly} matches the
7165 argument types.
7166
7167 @item @r{Overloaded symbol names}
7168 You can specify a particular definition of an overloaded symbol, using
7169 the same notation that is used to declare such symbols in C@t{++}: type
7170 @code{@var{symbol}(@var{types})} rather than just @var{symbol}.  You can
7171 also use the @value{GDBN} command-line word completion facilities to list the
7172 available choices, or to finish the type list for you.
7173 @xref{Completion,, Command completion}, for details on how to do this.
7174 @end table
7175
7176 @node Modula-2
7177 @subsection Modula-2
7178
7179 @cindex Modula-2, @value{GDBN} support
7180
7181 The extensions made to @value{GDBN} to support Modula-2 only support
7182 output from the @sc{gnu} Modula-2 compiler (which is currently being
7183 developed).  Other Modula-2 compilers are not currently supported, and
7184 attempting to debug executables produced by them is most likely
7185 to give an error as @value{GDBN} reads in the executable's symbol
7186 table.
7187
7188 @cindex expressions in Modula-2
7189 @menu
7190 * M2 Operators::                Built-in operators
7191 * Built-In Func/Proc::          Built-in functions and procedures
7192 * M2 Constants::                Modula-2 constants
7193 * M2 Defaults::                 Default settings for Modula-2
7194 * Deviations::                  Deviations from standard Modula-2
7195 * M2 Checks::                   Modula-2 type and range checks
7196 * M2 Scope::                    The scope operators @code{::} and @code{.}
7197 * GDB/M2::                      @value{GDBN} and Modula-2
7198 @end menu
7199
7200 @node M2 Operators
7201 @subsubsection Operators
7202 @cindex Modula-2 operators
7203
7204 Operators must be defined on values of specific types.  For instance,
7205 @code{+} is defined on numbers, but not on structures.  Operators are
7206 often defined on groups of types.  For the purposes of Modula-2, the
7207 following definitions hold:
7208
7209 @itemize @bullet
7210
7211 @item
7212 @emph{Integral types} consist of @code{INTEGER}, @code{CARDINAL}, and
7213 their subranges.
7214
7215 @item
7216 @emph{Character types} consist of @code{CHAR} and its subranges.
7217
7218 @item
7219 @emph{Floating-point types} consist of @code{REAL}.
7220
7221 @item
7222 @emph{Pointer types} consist of anything declared as @code{POINTER TO
7223 @var{type}}.
7224
7225 @item
7226 @emph{Scalar types} consist of all of the above.
7227
7228 @item
7229 @emph{Set types} consist of @code{SET} and @code{BITSET} types.
7230
7231 @item
7232 @emph{Boolean types} consist of @code{BOOLEAN}.
7233 @end itemize
7234
7235 @noindent
7236 The following operators are supported, and appear in order of
7237 increasing precedence:
7238
7239 @table @code
7240 @item ,
7241 Function argument or array index separator.
7242
7243 @item :=
7244 Assignment.  The value of @var{var} @code{:=} @var{value} is
7245 @var{value}.
7246
7247 @item <@r{, }>
7248 Less than, greater than on integral, floating-point, or enumerated
7249 types.
7250
7251 @item <=@r{, }>=
7252 Less than or equal to, greater than or equal to
7253 on integral, floating-point and enumerated types, or set inclusion on
7254 set types.  Same precedence as @code{<}.
7255
7256 @item =@r{, }<>@r{, }#
7257 Equality and two ways of expressing inequality, valid on scalar types.
7258 Same precedence as @code{<}.  In @value{GDBN} scripts, only @code{<>} is
7259 available for inequality, since @code{#} conflicts with the script
7260 comment character.
7261
7262 @item IN
7263 Set membership.  Defined on set types and the types of their members.
7264 Same precedence as @code{<}.
7265
7266 @item OR
7267 Boolean disjunction.  Defined on boolean types.
7268
7269 @item AND@r{, }&
7270 Boolean conjunction.  Defined on boolean types.
7271
7272 @item @@
7273 The @value{GDBN} ``artificial array'' operator (@pxref{Expressions, ,Expressions}).
7274
7275 @item +@r{, }-
7276 Addition and subtraction on integral and floating-point types, or union
7277 and difference on set types.
7278
7279 @item *
7280 Multiplication on integral and floating-point types, or set intersection
7281 on set types.
7282
7283 @item /
7284 Division on floating-point types, or symmetric set difference on set
7285 types.  Same precedence as @code{*}.
7286
7287 @item DIV@r{, }MOD
7288 Integer division and remainder.  Defined on integral types.  Same
7289 precedence as @code{*}.
7290
7291 @item -
7292 Negative. Defined on @code{INTEGER} and @code{REAL} data.
7293
7294 @item ^
7295 Pointer dereferencing.  Defined on pointer types.
7296
7297 @item NOT
7298 Boolean negation.  Defined on boolean types.  Same precedence as
7299 @code{^}.
7300
7301 @item .
7302 @code{RECORD} field selector.  Defined on @code{RECORD} data.  Same
7303 precedence as @code{^}.
7304
7305 @item []
7306 Array indexing.  Defined on @code{ARRAY} data.  Same precedence as @code{^}.
7307
7308 @item ()
7309 Procedure argument list.  Defined on @code{PROCEDURE} objects.  Same precedence
7310 as @code{^}.
7311
7312 @item ::@r{, }.
7313 @value{GDBN} and Modula-2 scope operators.
7314 @end table
7315
7316 @quotation
7317 @emph{Warning:} Sets and their operations are not yet supported, so @value{GDBN}
7318 treats the use of the operator @code{IN}, or the use of operators
7319 @code{+}, @code{-}, @code{*}, @code{/}, @code{=}, , @code{<>}, @code{#},
7320 @code{<=}, and @code{>=} on sets as an error.
7321 @end quotation
7322
7323 @cindex Modula-2 built-ins
7324 @node Built-In Func/Proc
7325 @subsubsection Built-in functions and procedures
7326
7327 Modula-2 also makes available several built-in procedures and functions.
7328 In describing these, the following metavariables are used:
7329
7330 @table @var
7331
7332 @item a
7333 represents an @code{ARRAY} variable.
7334
7335 @item c
7336 represents a @code{CHAR} constant or variable.
7337
7338 @item i
7339 represents a variable or constant of integral type.
7340
7341 @item m
7342 represents an identifier that belongs to a set.  Generally used in the
7343 same function with the metavariable @var{s}.  The type of @var{s} should
7344 be @code{SET OF @var{mtype}} (where @var{mtype} is the type of @var{m}).
7345
7346 @item n
7347 represents a variable or constant of integral or floating-point type.
7348
7349 @item r
7350 represents a variable or constant of floating-point type.
7351
7352 @item t
7353 represents a type.
7354
7355 @item v
7356 represents a variable.
7357
7358 @item x
7359 represents a variable or constant of one of many types.  See the
7360 explanation of the function for details.
7361 @end table
7362
7363 All Modula-2 built-in procedures also return a result, described below.
7364
7365 @table @code
7366 @item ABS(@var{n})
7367 Returns the absolute value of @var{n}.
7368
7369 @item CAP(@var{c})
7370 If @var{c} is a lower case letter, it returns its upper case
7371 equivalent, otherwise it returns its argument.
7372
7373 @item CHR(@var{i})
7374 Returns the character whose ordinal value is @var{i}.
7375
7376 @item DEC(@var{v})
7377 Decrements the value in the variable @var{v} by one.  Returns the new value.
7378
7379 @item DEC(@var{v},@var{i})
7380 Decrements the value in the variable @var{v} by @var{i}.  Returns the
7381 new value.
7382
7383 @item EXCL(@var{m},@var{s})
7384 Removes the element @var{m} from the set @var{s}.  Returns the new
7385 set.
7386
7387 @item FLOAT(@var{i})
7388 Returns the floating point equivalent of the integer @var{i}.
7389
7390 @item HIGH(@var{a})
7391 Returns the index of the last member of @var{a}.
7392
7393 @item INC(@var{v})
7394 Increments the value in the variable @var{v} by one.  Returns the new value.
7395
7396 @item INC(@var{v},@var{i})
7397 Increments the value in the variable @var{v} by @var{i}.  Returns the
7398 new value.
7399
7400 @item INCL(@var{m},@var{s})
7401 Adds the element @var{m} to the set @var{s} if it is not already
7402 there.  Returns the new set.
7403
7404 @item MAX(@var{t})
7405 Returns the maximum value of the type @var{t}.
7406
7407 @item MIN(@var{t})
7408 Returns the minimum value of the type @var{t}.
7409
7410 @item ODD(@var{i})
7411 Returns boolean TRUE if @var{i} is an odd number.
7412
7413 @item ORD(@var{x})
7414 Returns the ordinal value of its argument.  For example, the ordinal
7415 value of a character is its @sc{ascii} value (on machines supporting the
7416 @sc{ascii} character set).  @var{x} must be of an ordered type, which include
7417 integral, character and enumerated types.
7418
7419 @item SIZE(@var{x})
7420 Returns the size of its argument.  @var{x} can be a variable or a type.
7421
7422 @item TRUNC(@var{r})
7423 Returns the integral part of @var{r}.
7424
7425 @item VAL(@var{t},@var{i})
7426 Returns the member of the type @var{t} whose ordinal value is @var{i}.
7427 @end table
7428
7429 @quotation
7430 @emph{Warning:}  Sets and their operations are not yet supported, so
7431 @value{GDBN} treats the use of procedures @code{INCL} and @code{EXCL} as
7432 an error.
7433 @end quotation
7434
7435 @cindex Modula-2 constants
7436 @node M2 Constants
7437 @subsubsection Constants
7438
7439 @value{GDBN} allows you to express the constants of Modula-2 in the following
7440 ways:
7441
7442 @itemize @bullet
7443
7444 @item
7445 Integer constants are simply a sequence of digits.  When used in an
7446 expression, a constant is interpreted to be type-compatible with the
7447 rest of the expression.  Hexadecimal integers are specified by a
7448 trailing @samp{H}, and octal integers by a trailing @samp{B}.
7449
7450 @item
7451 Floating point constants appear as a sequence of digits, followed by a
7452 decimal point and another sequence of digits.  An optional exponent can
7453 then be specified, in the form @samp{E@r{[}+@r{|}-@r{]}@var{nnn}}, where
7454 @samp{@r{[}+@r{|}-@r{]}@var{nnn}} is the desired exponent.  All of the
7455 digits of the floating point constant must be valid decimal (base 10)
7456 digits.
7457
7458 @item
7459 Character constants consist of a single character enclosed by a pair of
7460 like quotes, either single (@code{'}) or double (@code{"}).  They may
7461 also be expressed by their ordinal value (their @sc{ascii} value, usually)
7462 followed by a @samp{C}.
7463
7464 @item
7465 String constants consist of a sequence of characters enclosed by a
7466 pair of like quotes, either single (@code{'}) or double (@code{"}).
7467 Escape sequences in the style of C are also allowed.  @xref{C
7468 Constants, ,C and C@t{++} constants}, for a brief explanation of escape
7469 sequences.
7470
7471 @item
7472 Enumerated constants consist of an enumerated identifier.
7473
7474 @item
7475 Boolean constants consist of the identifiers @code{TRUE} and
7476 @code{FALSE}.
7477
7478 @item
7479 Pointer constants consist of integral values only.
7480
7481 @item
7482 Set constants are not yet supported.
7483 @end itemize
7484
7485 @node M2 Defaults
7486 @subsubsection Modula-2 defaults
7487 @cindex Modula-2 defaults
7488
7489 If type and range checking are set automatically by @value{GDBN}, they
7490 both default to @code{on} whenever the working language changes to
7491 Modula-2.  This happens regardless of whether you or @value{GDBN}
7492 selected the working language.
7493
7494 If you allow @value{GDBN} to set the language automatically, then entering
7495 code compiled from a file whose name ends with @file{.mod} sets the
7496 working language to Modula-2.  @xref{Automatically, ,Having @value{GDBN} set
7497 the language automatically}, for further details.
7498
7499 @node Deviations
7500 @subsubsection Deviations from standard Modula-2
7501 @cindex Modula-2, deviations from
7502
7503 A few changes have been made to make Modula-2 programs easier to debug.
7504 This is done primarily via loosening its type strictness:
7505
7506 @itemize @bullet
7507 @item
7508 Unlike in standard Modula-2, pointer constants can be formed by
7509 integers.  This allows you to modify pointer variables during
7510 debugging.  (In standard Modula-2, the actual address contained in a
7511 pointer variable is hidden from you; it can only be modified
7512 through direct assignment to another pointer variable or expression that
7513 returned a pointer.)
7514
7515 @item
7516 C escape sequences can be used in strings and characters to represent
7517 non-printable characters.  @value{GDBN} prints out strings with these
7518 escape sequences embedded.  Single non-printable characters are
7519 printed using the @samp{CHR(@var{nnn})} format.
7520
7521 @item
7522 The assignment operator (@code{:=}) returns the value of its right-hand
7523 argument.
7524
7525 @item
7526 All built-in procedures both modify @emph{and} return their argument.
7527 @end itemize
7528
7529 @node M2 Checks
7530 @subsubsection Modula-2 type and range checks
7531 @cindex Modula-2 checks
7532
7533 @quotation
7534 @emph{Warning:} in this release, @value{GDBN} does not yet perform type or
7535 range checking.
7536 @end quotation
7537 @c FIXME remove warning when type/range checks added
7538
7539 @value{GDBN} considers two Modula-2 variables type equivalent if:
7540
7541 @itemize @bullet
7542 @item
7543 They are of types that have been declared equivalent via a @code{TYPE
7544 @var{t1} = @var{t2}} statement
7545
7546 @item
7547 They have been declared on the same line.  (Note:  This is true of the
7548 @sc{gnu} Modula-2 compiler, but it may not be true of other compilers.)
7549 @end itemize
7550
7551 As long as type checking is enabled, any attempt to combine variables
7552 whose types are not equivalent is an error.
7553
7554 Range checking is done on all mathematical operations, assignment, array
7555 index bounds, and all built-in functions and procedures.
7556
7557 @node M2 Scope
7558 @subsubsection The scope operators @code{::} and @code{.}
7559 @cindex scope
7560 @cindex @code{.}, Modula-2 scope operator
7561 @cindex colon, doubled as scope operator
7562 @ifinfo
7563 @vindex colon-colon@r{, in Modula-2}
7564 @c Info cannot handle :: but TeX can.
7565 @end ifinfo
7566 @iftex
7567 @vindex ::@r{, in Modula-2}
7568 @end iftex
7569
7570 There are a few subtle differences between the Modula-2 scope operator
7571 (@code{.}) and the @value{GDBN} scope operator (@code{::}).  The two have
7572 similar syntax:
7573
7574 @example
7575
7576 @var{module} . @var{id}
7577 @var{scope} :: @var{id}
7578 @end example
7579
7580 @noindent
7581 where @var{scope} is the name of a module or a procedure,
7582 @var{module} the name of a module, and @var{id} is any declared
7583 identifier within your program, except another module.
7584
7585 Using the @code{::} operator makes @value{GDBN} search the scope
7586 specified by @var{scope} for the identifier @var{id}.  If it is not
7587 found in the specified scope, then @value{GDBN} searches all scopes
7588 enclosing the one specified by @var{scope}.
7589
7590 Using the @code{.} operator makes @value{GDBN} search the current scope for
7591 the identifier specified by @var{id} that was imported from the
7592 definition module specified by @var{module}.  With this operator, it is
7593 an error if the identifier @var{id} was not imported from definition
7594 module @var{module}, or if @var{id} is not an identifier in
7595 @var{module}.
7596
7597 @node GDB/M2
7598 @subsubsection @value{GDBN} and Modula-2
7599
7600 Some @value{GDBN} commands have little use when debugging Modula-2 programs.
7601 Five subcommands of @code{set print} and @code{show print} apply
7602 specifically to C and C@t{++}: @samp{vtbl}, @samp{demangle},
7603 @samp{asm-demangle}, @samp{object}, and @samp{union}.  The first four
7604 apply to C@t{++}, and the last to the C @code{union} type, which has no direct
7605 analogue in Modula-2.
7606
7607 The @code{@@} operator (@pxref{Expressions, ,Expressions}), while available
7608 with any language, is not useful with Modula-2.  Its
7609 intent is to aid the debugging of @dfn{dynamic arrays}, which cannot be
7610 created in Modula-2 as they can in C or C@t{++}.  However, because an
7611 address can be specified by an integral constant, the construct
7612 @samp{@{@var{type}@}@var{adrexp}} is still useful.
7613
7614 @cindex @code{#} in Modula-2
7615 In @value{GDBN} scripts, the Modula-2 inequality operator @code{#} is
7616 interpreted as the beginning of a comment.  Use @code{<>} instead.
7617
7618 @node Chill
7619 @subsection Chill
7620
7621 The extensions made to @value{GDBN} to support Chill only support output
7622 from the @sc{gnu} Chill compiler.  Other Chill compilers are not currently
7623 supported, and attempting to debug executables produced by them is most
7624 likely to give an error as @value{GDBN} reads in the executable's symbol
7625 table.
7626
7627 @c This used to say "... following Chill related topics ...", but since
7628 @c menus are not shown in the printed manual, it would look awkward.
7629 This section covers the Chill related topics and the features
7630 of @value{GDBN} which support these topics.
7631
7632 @menu
7633 * How modes are displayed::        How modes are displayed
7634 * Locations::                        Locations and their accesses
7635 * Values and their Operations:: Values and their Operations
7636 * Chill type and range checks::
7637 * Chill defaults::
7638 @end menu
7639
7640 @node How modes are displayed
7641 @subsubsection How modes are displayed
7642
7643 The Chill Datatype- (Mode) support of @value{GDBN} is directly related
7644 with the functionality of the @sc{gnu} Chill compiler, and therefore deviates
7645 slightly from the standard specification of the Chill language. The
7646 provided modes are:
7647
7648 @c FIXME: this @table's contents effectively disable @code by using @r
7649 @c on every @item.  So why does it need @code?
7650 @table @code
7651 @item @r{@emph{Discrete modes:}}
7652 @itemize @bullet
7653 @item
7654 @emph{Integer Modes} which are predefined by @code{BYTE, UBYTE, INT,
7655 UINT, LONG, ULONG},
7656 @item
7657 @emph{Boolean Mode} which is predefined by @code{BOOL},
7658 @item
7659 @emph{Character Mode} which is predefined by @code{CHAR},
7660 @item
7661 @emph{Set Mode} which is displayed by the keyword @code{SET}.
7662 @smallexample
7663 (@value{GDBP}) ptype x
7664 type = SET (karli = 10, susi = 20, fritzi = 100)
7665 @end smallexample
7666 If the type is an unnumbered set the set element values are omitted.
7667 @item
7668 @emph{Range Mode} which is displayed by
7669 @smallexample
7670 @code{type = <basemode>(<lower bound> : <upper bound>)}
7671 @end smallexample
7672 where @code{<lower bound>, <upper bound>} can be of any discrete literal
7673 expression (e.g. set element names).
7674 @end itemize
7675
7676 @item @r{@emph{Powerset Mode:}}
7677 A Powerset Mode is displayed by the keyword @code{POWERSET} followed by
7678 the member mode of the powerset.  The member mode can be any discrete mode.
7679 @smallexample
7680 (@value{GDBP}) ptype x
7681 type = POWERSET SET (egon, hugo, otto)
7682 @end smallexample
7683
7684 @item @r{@emph{Reference Modes:}}
7685 @itemize @bullet
7686 @item
7687 @emph{Bound Reference Mode} which is displayed by the keyword @code{REF}
7688 followed by the mode name to which the reference is bound.
7689 @item
7690 @emph{Free Reference Mode} which is displayed by the keyword @code{PTR}.
7691 @end itemize
7692
7693 @item @r{@emph{Procedure mode}}
7694 The procedure mode is displayed by @code{type = PROC(<parameter list>)
7695 <return mode> EXCEPTIONS (<exception list>)}. The @code{<parameter
7696 list>} is a list of the parameter modes.  @code{<return mode>} indicates
7697 the mode of the result of the procedure if any.  The exceptionlist lists
7698 all possible exceptions which can be raised by the procedure.
7699
7700 @ignore
7701 @item @r{@emph{Instance mode}}
7702 The instance mode is represented by a structure, which has a static
7703 type, and is therefore not really of interest.
7704 @end ignore
7705
7706 @item @r{@emph{Synchronization Modes:}}
7707 @itemize @bullet
7708 @item
7709 @emph{Event Mode} which is displayed by
7710 @smallexample
7711 @code{EVENT (<event length>)}
7712 @end smallexample
7713 where @code{(<event length>)} is optional.
7714 @item
7715 @emph{Buffer Mode} which is displayed by
7716 @smallexample
7717 @code{BUFFER (<buffer length>)<buffer element mode>}
7718 @end smallexample
7719 where @code{(<buffer length>)} is optional.
7720 @end itemize
7721
7722 @item @r{@emph{Timing Modes:}}
7723 @itemize @bullet
7724 @item
7725 @emph{Duration Mode} which is predefined by @code{DURATION}
7726 @item
7727 @emph{Absolute Time Mode} which is predefined by @code{TIME}
7728 @end itemize
7729
7730 @item @r{@emph{Real Modes:}}
7731 Real Modes are predefined with @code{REAL} and @code{LONG_REAL}.
7732
7733 @item @r{@emph{String Modes:}}
7734 @itemize @bullet
7735 @item
7736 @emph{Character String Mode} which is displayed by
7737 @smallexample
7738 @code{CHARS(<string length>)}
7739 @end smallexample
7740 followed by the keyword @code{VARYING} if the String Mode is a varying
7741 mode
7742 @item
7743 @emph{Bit String Mode} which is displayed by
7744 @smallexample
7745 @code{BOOLS(<string
7746 length>)}
7747 @end smallexample
7748 @end itemize
7749
7750 @item @r{@emph{Array Mode:}}
7751 The Array Mode is displayed by the keyword @code{ARRAY(<range>)}
7752 followed by the element mode (which may in turn be an array mode).
7753 @smallexample
7754 (@value{GDBP}) ptype x
7755 type = ARRAY (1:42)
7756           ARRAY (1:20)
7757              SET (karli = 10, susi = 20, fritzi = 100)
7758 @end smallexample
7759
7760 @item @r{@emph{Structure Mode}}
7761 The Structure mode is displayed by the keyword @code{STRUCT(<field
7762 list>)}.  The @code{<field list>} consists of names and modes of fields
7763 of the structure.  Variant structures have the keyword @code{CASE <field>
7764 OF <variant fields> ESAC} in their field list.  Since the current version
7765 of the GNU Chill compiler doesn't implement tag processing (no runtime
7766 checks of variant fields, and therefore no debugging info), the output
7767 always displays all variant fields.
7768 @smallexample
7769 (@value{GDBP}) ptype str
7770 type = STRUCT (
7771     as x,
7772     bs x,
7773     CASE bs OF
7774     (karli):
7775         cs a
7776     (ott):
7777         ds x
7778     ESAC
7779 )
7780 @end smallexample
7781 @end table
7782
7783 @node Locations
7784 @subsubsection Locations and their accesses
7785
7786 A location in Chill is an object which can contain values.
7787
7788 A value of a location is generally accessed by the (declared) name of
7789 the location.  The output conforms to the specification of values in
7790 Chill programs.  How values are specified
7791 is the topic of the next section, @ref{Values and their Operations}.
7792
7793 The pseudo-location @code{RESULT} (or @code{result}) can be used to
7794 display or change the result of a currently-active procedure:
7795
7796 @smallexample
7797 set result := EXPR
7798 @end smallexample
7799
7800 @noindent
7801 This does the same as the Chill action @code{RESULT EXPR} (which
7802 is not available in @value{GDBN}).
7803
7804 Values of reference mode locations are printed by @code{PTR(<hex
7805 value>)} in case of a free reference mode, and by @code{(REF <reference
7806 mode>) (<hex-value>)} in case of a bound reference.  @code{<hex value>}
7807 represents the address where the reference points to.  To access the
7808 value of the location referenced by the pointer, use the dereference
7809 operator @samp{->}.
7810
7811 Values of procedure mode locations are displayed by
7812 @smallexample
7813 @code{@{ PROC
7814 (<argument modes> ) <return mode> @} <address> <name of procedure
7815 location>}
7816 @end smallexample
7817 @code{<argument modes>} is a list of modes according to the parameter
7818 specification of the procedure and @code{<address>} shows the address of
7819 the entry point.
7820
7821 @ignore
7822 Locations of instance modes are displayed just like a structure with two
7823 fields specifying the @emph{process type} and the @emph{copy number} of
7824 the investigated instance location@footnote{This comes from the current
7825 implementation of instances.  They are implemented as a structure (no
7826 na).  The output should be something like @code{[<name of the process>;
7827 <instance number>]}.}.  The field names are @code{__proc_type} and
7828 @code{__proc_copy}.
7829
7830 Locations of synchronization modes are displayed like a structure with
7831 the field name @code{__event_data} in case of a event mode location, and
7832 like a structure with the field @code{__buffer_data} in case of a buffer
7833 mode location (refer to previous paragraph).
7834
7835 Structure Mode locations are printed by @code{[.<field name>: <value>,
7836 ...]}.  The @code{<field name>} corresponds to the structure mode
7837 definition and the layout of @code{<value>} varies depending of the mode
7838 of the field.  If the investigated structure mode location is of variant
7839 structure mode, the variant parts of the structure are enclosed in curled
7840 braces (@samp{@{@}}).  Fields enclosed by @samp{@{,@}} are residing
7841 on the same memory location and represent the current values of the
7842 memory location in their specific modes.  Since no tag processing is done
7843 all variants are displayed. A variant field is printed by
7844 @code{(<variant name>) = .<field name>: <value>}.  (who implements the
7845 stuff ???)
7846 @smallexample
7847 (@value{GDBP}) print str1 $4 = [.as: 0, .bs: karli, .<TAG>: { (karli) =
7848 [.cs: []], (susi) = [.ds: susi]}]
7849 @end smallexample
7850 @end ignore
7851
7852 Substructures of string mode-, array mode- or structure mode-values
7853 (e.g. array slices, fields of structure locations) are accessed using
7854 certain operations which are described in the next section, @ref{Values
7855 and their Operations}.
7856
7857 A location value may be interpreted as having a different mode using the
7858 location conversion.  This mode conversion is written as @code{<mode
7859 name>(<location>)}.  The user has to consider that the sizes of the modes
7860 have to be equal otherwise an error occurs.  Furthermore, no range
7861 checking of the location against the destination mode is performed, and
7862 therefore the result can be quite confusing.
7863
7864 @smallexample
7865 (@value{GDBP}) print int (s(3 up 4)) XXX TO be filled in !! XXX
7866 @end smallexample
7867
7868 @node Values and their Operations
7869 @subsubsection Values and their Operations
7870
7871 Values are used to alter locations, to investigate complex structures in
7872 more detail or to filter relevant information out of a large amount of
7873 data.  There are several (mode dependent) operations defined which enable
7874 such investigations.  These operations are not only applicable to
7875 constant values but also to locations, which can become quite useful
7876 when debugging complex structures.  During parsing the command line
7877 (e.g. evaluating an expression) @value{GDBN} treats location names as
7878 the values behind these locations.
7879
7880 This section describes how values have to be specified and which
7881 operations are legal to be used with such values.
7882
7883 @table @code
7884 @item Literal Values
7885 Literal values are specified in the same manner as in @sc{gnu} Chill programs.
7886 For detailed specification refer to the @sc{gnu} Chill implementation Manual
7887 chapter 1.5.
7888 @c FIXME: if the Chill Manual is a Texinfo documents, the above should
7889 @c be converted to a @ref.
7890
7891 @ignore
7892 @itemize @bullet
7893 @item
7894 @emph{Integer Literals} are specified in the same manner as in Chill
7895 programs (refer to the Chill Standard z200/88 chpt 5.2.4.2)
7896 @item
7897 @emph{Boolean Literals} are defined by @code{TRUE} and @code{FALSE}.
7898 @item
7899 @emph{Character Literals} are defined by @code{'<character>'}. (e.g.
7900 @code{'M'})
7901 @item
7902 @emph{Set Literals} are defined by a name which was specified in a set
7903 mode.  The value delivered by a Set Literal is the set value.  This is
7904 comparable to an enumeration in C/C@t{++} language.
7905 @item
7906 @emph{Emptiness Literal} is predefined by @code{NULL}.  The value of the
7907 emptiness literal delivers either the empty reference value, the empty
7908 procedure value or the empty instance value.
7909
7910 @item
7911 @emph{Character String Literals} are defined by a sequence of characters
7912 enclosed in single- or double quotes.  If a single- or double quote has
7913 to be part of the string literal it has to be stuffed (specified twice).
7914 @item
7915 @emph{Bitstring Literals} are specified in the same manner as in Chill
7916 programs (refer z200/88 chpt 5.2.4.8).
7917 @item
7918 @emph{Floating point literals} are specified in the same manner as in
7919 (gnu-)Chill programs (refer @sc{gnu} Chill implementation Manual chapter 1.5).
7920 @end itemize
7921 @end ignore
7922
7923 @item Tuple Values
7924 A tuple is specified by @code{<mode name>[<tuple>]}, where @code{<mode
7925 name>} can be omitted if the mode of the tuple is unambiguous.  This
7926 unambiguity is derived from the context of a evaluated expression.
7927 @code{<tuple>} can be one of the following:
7928
7929 @itemize @bullet
7930 @item @emph{Powerset Tuple}
7931 @item @emph{Array Tuple}
7932 @item @emph{Structure Tuple}
7933 Powerset tuples, array tuples and structure tuples are specified in the
7934 same manner as in Chill programs refer to z200/88 chpt 5.2.5.
7935 @end itemize
7936
7937 @item String Element Value
7938 A string element value is specified by
7939 @smallexample
7940 @code{<string value>(<index>)}
7941 @end smallexample
7942 where @code{<index>} is a integer expression.  It delivers a character
7943 value which is equivalent to the character indexed by @code{<index>} in
7944 the string.
7945
7946 @item String Slice Value
7947 A string slice value is specified by @code{<string value>(<slice
7948 spec>)}, where @code{<slice spec>} can be either a range of integer
7949 expressions or specified by @code{<start expr> up <size>}.
7950 @code{<size>} denotes the number of elements which the slice contains.
7951 The delivered value is a string value, which is part of the specified
7952 string.
7953
7954 @item Array Element Values
7955 An array element value is specified by @code{<array value>(<expr>)} and
7956 delivers a array element value of the mode of the specified array.
7957
7958 @item Array Slice Values
7959 An array slice is specified by @code{<array value>(<slice spec>)}, where
7960 @code{<slice spec>} can be either a range specified by expressions or by
7961 @code{<start expr> up <size>}.  @code{<size>} denotes the number of
7962 arrayelements the slice contains.  The delivered value is an array value
7963 which is part of the specified array.
7964
7965 @item Structure Field Values
7966 A structure field value is derived by @code{<structure value>.<field
7967 name>}, where @code{<field name>} indicates the name of a field specified
7968 in the mode definition of the structure.  The mode of the delivered value
7969 corresponds to this mode definition in the structure definition.
7970
7971 @item Procedure Call Value
7972 The procedure call value is derived from the return value of the
7973 procedure@footnote{If a procedure call is used for instance in an
7974 expression, then this procedure is called with all its side
7975 effects.  This can lead to confusing results if used carelessly.}.
7976
7977 Values of duration mode locations are represented by @code{ULONG} literals.
7978
7979 Values of time mode locations appear as
7980 @smallexample
7981 @code{TIME(<secs>:<nsecs>)}
7982 @end smallexample
7983
7984
7985 @ignore
7986 This is not implemented yet:
7987 @item Built-in Value
7988 @noindent
7989 The following built in functions are provided:
7990
7991 @table @code
7992 @item @code{ADDR()}
7993 @item @code{NUM()}
7994 @item @code{PRED()}
7995 @item @code{SUCC()}
7996 @item @code{ABS()}
7997 @item @code{CARD()}
7998 @item @code{MAX()}
7999 @item @code{MIN()}
8000 @item @code{SIZE()}
8001 @item @code{UPPER()}
8002 @item @code{LOWER()}
8003 @item @code{LENGTH()}
8004 @item @code{SIN()}
8005 @item @code{COS()}
8006 @item @code{TAN()}
8007 @item @code{ARCSIN()}
8008 @item @code{ARCCOS()}
8009 @item @code{ARCTAN()}
8010 @item @code{EXP()}
8011 @item @code{LN()}
8012 @item @code{LOG()}
8013 @item @code{SQRT()}
8014 @end table
8015
8016 For a detailed description refer to the GNU Chill implementation manual
8017 chapter 1.6.
8018 @end ignore
8019
8020 @item Zero-adic Operator Value
8021 The zero-adic operator value is derived from the instance value for the
8022 current active process.
8023
8024 @item Expression Values
8025 The value delivered by an expression is the result of the evaluation of
8026 the specified expression.  If there are error conditions (mode
8027 incompatibility, etc.) the evaluation of expressions is aborted with a
8028 corresponding error message.  Expressions may be parenthesised which
8029 causes the evaluation of this expression before any other expression
8030 which uses the result of the parenthesised expression.  The following
8031 operators are supported by @value{GDBN}:
8032
8033 @table @code
8034 @item @code{OR, ORIF, XOR}
8035 @itemx @code{AND, ANDIF}
8036 @itemx @code{NOT}
8037 Logical operators defined over operands of boolean mode.
8038
8039 @item @code{=, /=}
8040 Equality and inequality operators defined over all modes.
8041
8042 @item @code{>, >=}
8043 @itemx @code{<, <=}
8044 Relational operators defined over predefined modes.
8045
8046 @item @code{+, -}
8047 @itemx @code{*, /, MOD, REM}
8048 Arithmetic operators defined over predefined modes.
8049
8050 @item @code{-}
8051 Change sign operator.
8052
8053 @item @code{//}
8054 String concatenation operator.
8055
8056 @item @code{()}
8057 String repetition operator.
8058
8059 @item @code{->}
8060 Referenced location operator which can be used either to take the
8061 address of a location (@code{->loc}), or to dereference a reference
8062 location (@code{loc->}).
8063
8064 @item @code{OR, XOR}
8065 @itemx @code{AND}
8066 @itemx @code{NOT}
8067 Powerset and bitstring operators.
8068
8069 @item @code{>, >=}
8070 @itemx @code{<, <=}
8071 Powerset inclusion operators.
8072
8073 @item @code{IN}
8074 Membership operator.
8075 @end table
8076 @end table
8077
8078 @node Chill type and range checks
8079 @subsubsection Chill type and range checks
8080
8081 @value{GDBN} considers two Chill variables mode equivalent if the sizes
8082 of the two modes are equal.  This rule applies recursively to more
8083 complex datatypes which means that complex modes are treated
8084 equivalent if all element modes (which also can be complex modes like
8085 structures, arrays, etc.) have the same size.
8086
8087 Range checking is done on all mathematical operations, assignment, array
8088 index bounds and all built in procedures.
8089
8090 Strong type checks are forced using the @value{GDBN} command @code{set
8091 check strong}.  This enforces strong type and range checks on all
8092 operations where Chill constructs are used (expressions, built in
8093 functions, etc.) in respect to the semantics as defined in the z.200
8094 language specification.
8095
8096 All checks can be disabled by the @value{GDBN} command @code{set check
8097 off}.
8098
8099 @ignore
8100 @c Deviations from the Chill Standard Z200/88
8101 see last paragraph ?
8102 @end ignore
8103
8104 @node Chill defaults
8105 @subsubsection Chill defaults
8106
8107 If type and range checking are set automatically by @value{GDBN}, they
8108 both default to @code{on} whenever the working language changes to
8109 Chill.  This happens regardless of whether you or @value{GDBN}
8110 selected the working language.
8111
8112 If you allow @value{GDBN} to set the language automatically, then entering
8113 code compiled from a file whose name ends with @file{.ch} sets the
8114 working language to Chill.  @xref{Automatically, ,Having @value{GDBN} set
8115 the language automatically}, for further details.
8116
8117 @node Symbols
8118 @chapter Examining the Symbol Table
8119
8120 The commands described in this chapter allow you to inquire about the
8121 symbols (names of variables, functions and types) defined in your
8122 program.  This information is inherent in the text of your program and
8123 does not change as your program executes.  @value{GDBN} finds it in your
8124 program's symbol table, in the file indicated when you started @value{GDBN}
8125 (@pxref{File Options, ,Choosing files}), or by one of the
8126 file-management commands (@pxref{Files, ,Commands to specify files}).
8127
8128 @cindex symbol names
8129 @cindex names of symbols
8130 @cindex quoting names
8131 Occasionally, you may need to refer to symbols that contain unusual
8132 characters, which @value{GDBN} ordinarily treats as word delimiters.  The
8133 most frequent case is in referring to static variables in other
8134 source files (@pxref{Variables,,Program variables}).  File names
8135 are recorded in object files as debugging symbols, but @value{GDBN} would
8136 ordinarily parse a typical file name, like @file{foo.c}, as the three words
8137 @samp{foo} @samp{.} @samp{c}.  To allow @value{GDBN} to recognize
8138 @samp{foo.c} as a single symbol, enclose it in single quotes; for example,
8139
8140 @example
8141 p 'foo.c'::x
8142 @end example
8143
8144 @noindent
8145 looks up the value of @code{x} in the scope of the file @file{foo.c}.
8146
8147 @table @code
8148 @kindex info address
8149 @cindex address of a symbol
8150 @item info address @var{symbol}
8151 Describe where the data for @var{symbol} is stored.  For a register
8152 variable, this says which register it is kept in.  For a non-register
8153 local variable, this prints the stack-frame offset at which the variable
8154 is always stored.
8155
8156 Note the contrast with @samp{print &@var{symbol}}, which does not work
8157 at all for a register variable, and for a stack local variable prints
8158 the exact address of the current instantiation of the variable.
8159
8160 @kindex info symbol
8161 @cindex symbol from address
8162 @item info symbol @var{addr}
8163 Print the name of a symbol which is stored at the address @var{addr}.
8164 If no symbol is stored exactly at @var{addr}, @value{GDBN} prints the
8165 nearest symbol and an offset from it:
8166
8167 @example
8168 (@value{GDBP}) info symbol 0x54320
8169 _initialize_vx + 396 in section .text
8170 @end example
8171
8172 @noindent
8173 This is the opposite of the @code{info address} command.  You can use
8174 it to find out the name of a variable or a function given its address.
8175
8176 @kindex whatis
8177 @item whatis @var{expr}
8178 Print the data type of expression @var{expr}.  @var{expr} is not
8179 actually evaluated, and any side-effecting operations (such as
8180 assignments or function calls) inside it do not take place.
8181 @xref{Expressions, ,Expressions}.
8182
8183 @item whatis
8184 Print the data type of @code{$}, the last value in the value history.
8185
8186 @kindex ptype
8187 @item ptype @var{typename}
8188 Print a description of data type @var{typename}.  @var{typename} may be
8189 the name of a type, or for C code it may have the form @samp{class
8190 @var{class-name}}, @samp{struct @var{struct-tag}}, @samp{union
8191 @var{union-tag}} or @samp{enum @var{enum-tag}}.
8192
8193 @item ptype @var{expr}
8194 @itemx ptype
8195 Print a description of the type of expression @var{expr}.  @code{ptype}
8196 differs from @code{whatis} by printing a detailed description, instead
8197 of just the name of the type.
8198
8199 For example, for this variable declaration:
8200
8201 @example
8202 struct complex @{double real; double imag;@} v;
8203 @end example
8204
8205 @noindent
8206 the two commands give this output:
8207
8208 @example
8209 @group
8210 (@value{GDBP}) whatis v
8211 type = struct complex
8212 (@value{GDBP}) ptype v
8213 type = struct complex @{
8214     double real;
8215     double imag;
8216 @}
8217 @end group
8218 @end example
8219
8220 @noindent
8221 As with @code{whatis}, using @code{ptype} without an argument refers to
8222 the type of @code{$}, the last value in the value history.
8223
8224 @kindex info types
8225 @item info types @var{regexp}
8226 @itemx info types
8227 Print a brief description of all types whose names match @var{regexp}
8228 (or all types in your program, if you supply no argument).  Each
8229 complete typename is matched as though it were a complete line; thus,
8230 @samp{i type value} gives information on all types in your program whose
8231 names include the string @code{value}, but @samp{i type ^value$} gives
8232 information only on types whose complete name is @code{value}.
8233
8234 This command differs from @code{ptype} in two ways: first, like
8235 @code{whatis}, it does not print a detailed description; second, it
8236 lists all source files where a type is defined.
8237
8238 @kindex info scope
8239 @cindex local variables
8240 @item info scope @var{addr}
8241 List all the variables local to a particular scope.  This command
8242 accepts a location---a function name, a source line, or an address
8243 preceded by a @samp{*}, and prints all the variables local to the
8244 scope defined by that location.  For example:
8245
8246 @smallexample
8247 (@value{GDBP}) @b{info scope command_line_handler}
8248 Scope for command_line_handler:
8249 Symbol rl is an argument at stack/frame offset 8, length 4.
8250 Symbol linebuffer is in static storage at address 0x150a18, length 4.
8251 Symbol linelength is in static storage at address 0x150a1c, length 4.
8252 Symbol p is a local variable in register $esi, length 4.
8253 Symbol p1 is a local variable in register $ebx, length 4.
8254 Symbol nline is a local variable in register $edx, length 4.
8255 Symbol repeat is a local variable at frame offset -8, length 4.
8256 @end smallexample
8257
8258 @noindent
8259 This command is especially useful for determining what data to collect
8260 during a @dfn{trace experiment}, see @ref{Tracepoint Actions,
8261 collect}.
8262
8263 @kindex info source
8264 @item info source
8265 Show the name of the current source file---that is, the source file for
8266 the function containing the current point of execution---and the language
8267 it was written in.
8268
8269 @kindex info sources
8270 @item info sources
8271 Print the names of all source files in your program for which there is
8272 debugging information, organized into two lists: files whose symbols
8273 have already been read, and files whose symbols will be read when needed.
8274
8275 @kindex info functions
8276 @item info functions
8277 Print the names and data types of all defined functions.
8278
8279 @item info functions @var{regexp}
8280 Print the names and data types of all defined functions
8281 whose names contain a match for regular expression @var{regexp}.
8282 Thus, @samp{info fun step} finds all functions whose names
8283 include @code{step}; @samp{info fun ^step} finds those whose names
8284 start with @code{step}.
8285
8286 @kindex info variables
8287 @item info variables
8288 Print the names and data types of all variables that are declared
8289 outside of functions (i.e., excluding local variables).
8290
8291 @item info variables @var{regexp}
8292 Print the names and data types of all variables (except for local
8293 variables) whose names contain a match for regular expression
8294 @var{regexp}.
8295
8296 @ignore
8297 This was never implemented.
8298 @kindex info methods
8299 @item info methods
8300 @itemx info methods @var{regexp}
8301 The @code{info methods} command permits the user to examine all defined
8302 methods within C@t{++} program, or (with the @var{regexp} argument) a
8303 specific set of methods found in the various C@t{++} classes.  Many
8304 C@t{++} classes provide a large number of methods.  Thus, the output
8305 from the @code{ptype} command can be overwhelming and hard to use.  The
8306 @code{info-methods} command filters the methods, printing only those
8307 which match the regular-expression @var{regexp}.
8308 @end ignore
8309
8310 @cindex reloading symbols
8311 Some systems allow individual object files that make up your program to
8312 be replaced without stopping and restarting your program.  For example,
8313 in VxWorks you can simply recompile a defective object file and keep on
8314 running.  If you are running on one of these systems, you can allow
8315 @value{GDBN} to reload the symbols for automatically relinked modules:
8316
8317 @table @code
8318 @kindex set symbol-reloading
8319 @item set symbol-reloading on
8320 Replace symbol definitions for the corresponding source file when an
8321 object file with a particular name is seen again.
8322
8323 @item set symbol-reloading off
8324 Do not replace symbol definitions when encountering object files of the
8325 same name more than once.  This is the default state; if you are not
8326 running on a system that permits automatic relinking of modules, you
8327 should leave @code{symbol-reloading} off, since otherwise @value{GDBN}
8328 may discard symbols when linking large programs, that may contain
8329 several modules (from different directories or libraries) with the same
8330 name.
8331
8332 @kindex show symbol-reloading
8333 @item show symbol-reloading
8334 Show the current @code{on} or @code{off} setting.
8335 @end table
8336
8337 @kindex set opaque-type-resolution
8338 @item set opaque-type-resolution on
8339 Tell @value{GDBN} to resolve opaque types.  An opaque type is a type
8340 declared as a pointer to a @code{struct}, @code{class}, or
8341 @code{union}---for example, @code{struct MyType *}---that is used in one
8342 source file although the full declaration of @code{struct MyType} is in
8343 another source file.  The default is on.
8344
8345 A change in the setting of this subcommand will not take effect until
8346 the next time symbols for a file are loaded.
8347
8348 @item set opaque-type-resolution off
8349 Tell @value{GDBN} not to resolve opaque types.  In this case, the type
8350 is printed as follows:
8351 @smallexample
8352 @{<no data fields>@}
8353 @end smallexample
8354
8355 @kindex show opaque-type-resolution
8356 @item show opaque-type-resolution
8357 Show whether opaque types are resolved or not.
8358
8359 @kindex maint print symbols
8360 @cindex symbol dump
8361 @kindex maint print psymbols
8362 @cindex partial symbol dump
8363 @item maint print symbols @var{filename}
8364 @itemx maint print psymbols @var{filename}
8365 @itemx maint print msymbols @var{filename}
8366 Write a dump of debugging symbol data into the file @var{filename}.
8367 These commands are used to debug the @value{GDBN} symbol-reading code.  Only
8368 symbols with debugging data are included.  If you use @samp{maint print
8369 symbols}, @value{GDBN} includes all the symbols for which it has already
8370 collected full details: that is, @var{filename} reflects symbols for
8371 only those files whose symbols @value{GDBN} has read.  You can use the
8372 command @code{info sources} to find out which files these are.  If you
8373 use @samp{maint print psymbols} instead, the dump shows information about
8374 symbols that @value{GDBN} only knows partially---that is, symbols defined in
8375 files that @value{GDBN} has skimmed, but not yet read completely.  Finally,
8376 @samp{maint print msymbols} dumps just the minimal symbol information
8377 required for each object file from which @value{GDBN} has read some symbols.
8378 @xref{Files, ,Commands to specify files}, for a discussion of how
8379 @value{GDBN} reads symbols (in the description of @code{symbol-file}).
8380 @end table
8381
8382 @node Altering
8383 @chapter Altering Execution
8384
8385 Once you think you have found an error in your program, you might want to
8386 find out for certain whether correcting the apparent error would lead to
8387 correct results in the rest of the run.  You can find the answer by
8388 experiment, using the @value{GDBN} features for altering execution of the
8389 program.
8390
8391 For example, you can store new values into variables or memory
8392 locations, give your program a signal, restart it at a different
8393 address, or even return prematurely from a function.
8394
8395 @menu
8396 * Assignment::                  Assignment to variables
8397 * Jumping::                     Continuing at a different address
8398 * Signaling::                   Giving your program a signal
8399 * Returning::                   Returning from a function
8400 * Calling::                     Calling your program's functions
8401 * Patching::                    Patching your program
8402 @end menu
8403
8404 @node Assignment
8405 @section Assignment to variables
8406
8407 @cindex assignment
8408 @cindex setting variables
8409 To alter the value of a variable, evaluate an assignment expression.
8410 @xref{Expressions, ,Expressions}.  For example,
8411
8412 @example
8413 print x=4
8414 @end example
8415
8416 @noindent
8417 stores the value 4 into the variable @code{x}, and then prints the
8418 value of the assignment expression (which is 4).
8419 @xref{Languages, ,Using @value{GDBN} with Different Languages}, for more
8420 information on operators in supported languages.
8421
8422 @kindex set variable
8423 @cindex variables, setting
8424 If you are not interested in seeing the value of the assignment, use the
8425 @code{set} command instead of the @code{print} command.  @code{set} is
8426 really the same as @code{print} except that the expression's value is
8427 not printed and is not put in the value history (@pxref{Value History,
8428 ,Value history}).  The expression is evaluated only for its effects.
8429
8430 If the beginning of the argument string of the @code{set} command
8431 appears identical to a @code{set} subcommand, use the @code{set
8432 variable} command instead of just @code{set}.  This command is identical
8433 to @code{set} except for its lack of subcommands.  For example, if your
8434 program has a variable @code{width}, you get an error if you try to set
8435 a new value with just @samp{set width=13}, because @value{GDBN} has the
8436 command @code{set width}:
8437
8438 @example
8439 (@value{GDBP}) whatis width
8440 type = double
8441 (@value{GDBP}) p width
8442 $4 = 13
8443 (@value{GDBP}) set width=47
8444 Invalid syntax in expression.
8445 @end example
8446
8447 @noindent
8448 The invalid expression, of course, is @samp{=47}.  In
8449 order to actually set the program's variable @code{width}, use
8450
8451 @example
8452 (@value{GDBP}) set var width=47
8453 @end example
8454
8455 Because the @code{set} command has many subcommands that can conflict
8456 with the names of program variables, it is a good idea to use the
8457 @code{set variable} command instead of just @code{set}.  For example, if
8458 your program has a variable @code{g}, you run into problems if you try
8459 to set a new value with just @samp{set g=4}, because @value{GDBN} has
8460 the command @code{set gnutarget}, abbreviated @code{set g}:
8461
8462 @example
8463 @group
8464 (@value{GDBP}) whatis g
8465 type = double
8466 (@value{GDBP}) p g
8467 $1 = 1
8468 (@value{GDBP}) set g=4
8469 (@value{GDBP}) p g
8470 $2 = 1
8471 (@value{GDBP}) r
8472 The program being debugged has been started already.
8473 Start it from the beginning? (y or n) y
8474 Starting program: /home/smith/cc_progs/a.out
8475 "/home/smith/cc_progs/a.out": can't open to read symbols:
8476                                  Invalid bfd target.
8477 (@value{GDBP}) show g
8478 The current BFD target is "=4".
8479 @end group
8480 @end example
8481
8482 @noindent
8483 The program variable @code{g} did not change, and you silently set the
8484 @code{gnutarget} to an invalid value.  In order to set the variable
8485 @code{g}, use
8486
8487 @example
8488 (@value{GDBP}) set var g=4
8489 @end example
8490
8491 @value{GDBN} allows more implicit conversions in assignments than C; you can
8492 freely store an integer value into a pointer variable or vice versa,
8493 and you can convert any structure to any other structure that is the
8494 same length or shorter.
8495 @comment FIXME: how do structs align/pad in these conversions?
8496 @comment        /doc@cygnus.com 18dec1990
8497
8498 To store values into arbitrary places in memory, use the @samp{@{@dots{}@}}
8499 construct to generate a value of specified type at a specified address
8500 (@pxref{Expressions, ,Expressions}).  For example, @code{@{int@}0x83040} refers
8501 to memory location @code{0x83040} as an integer (which implies a certain size
8502 and representation in memory), and
8503
8504 @example
8505 set @{int@}0x83040 = 4
8506 @end example
8507
8508 @noindent
8509 stores the value 4 into that memory location.
8510
8511 @node Jumping
8512 @section Continuing at a different address
8513
8514 Ordinarily, when you continue your program, you do so at the place where
8515 it stopped, with the @code{continue} command.  You can instead continue at
8516 an address of your own choosing, with the following commands:
8517
8518 @table @code
8519 @kindex jump
8520 @item jump @var{linespec}
8521 Resume execution at line @var{linespec}.  Execution stops again
8522 immediately if there is a breakpoint there.  @xref{List, ,Printing
8523 source lines}, for a description of the different forms of
8524 @var{linespec}.  It is common practice to use the @code{tbreak} command
8525 in conjunction with @code{jump}.  @xref{Set Breaks, ,Setting
8526 breakpoints}.
8527
8528 The @code{jump} command does not change the current stack frame, or
8529 the stack pointer, or the contents of any memory location or any
8530 register other than the program counter.  If line @var{linespec} is in
8531 a different function from the one currently executing, the results may
8532 be bizarre if the two functions expect different patterns of arguments or
8533 of local variables.  For this reason, the @code{jump} command requests
8534 confirmation if the specified line is not in the function currently
8535 executing.  However, even bizarre results are predictable if you are
8536 well acquainted with the machine-language code of your program.
8537
8538 @item jump *@var{address}
8539 Resume execution at the instruction at address @var{address}.
8540 @end table
8541
8542 @c Doesn't work on HP-UX; have to set $pcoqh and $pcoqt.
8543 On many systems, you can get much the same effect as the @code{jump}
8544 command by storing a new value into the register @code{$pc}.  The
8545 difference is that this does not start your program running; it only
8546 changes the address of where it @emph{will} run when you continue.  For
8547 example,
8548
8549 @example
8550 set $pc = 0x485
8551 @end example
8552
8553 @noindent
8554 makes the next @code{continue} command or stepping command execute at
8555 address @code{0x485}, rather than at the address where your program stopped.
8556 @xref{Continuing and Stepping, ,Continuing and stepping}.
8557
8558 The most common occasion to use the @code{jump} command is to back
8559 up---perhaps with more breakpoints set---over a portion of a program
8560 that has already executed, in order to examine its execution in more
8561 detail.
8562
8563 @c @group
8564 @node Signaling
8565 @section Giving your program a signal
8566
8567 @table @code
8568 @kindex signal
8569 @item signal @var{signal}
8570 Resume execution where your program stopped, but immediately give it the
8571 signal @var{signal}.  @var{signal} can be the name or the number of a
8572 signal.  For example, on many systems @code{signal 2} and @code{signal
8573 SIGINT} are both ways of sending an interrupt signal.
8574
8575 Alternatively, if @var{signal} is zero, continue execution without
8576 giving a signal.  This is useful when your program stopped on account of
8577 a signal and would ordinary see the signal when resumed with the
8578 @code{continue} command; @samp{signal 0} causes it to resume without a
8579 signal.
8580
8581 @code{signal} does not repeat when you press @key{RET} a second time
8582 after executing the command.
8583 @end table
8584 @c @end group
8585
8586 Invoking the @code{signal} command is not the same as invoking the
8587 @code{kill} utility from the shell.  Sending a signal with @code{kill}
8588 causes @value{GDBN} to decide what to do with the signal depending on
8589 the signal handling tables (@pxref{Signals}).  The @code{signal} command
8590 passes the signal directly to your program.
8591
8592
8593 @node Returning
8594 @section Returning from a function
8595
8596 @table @code
8597 @cindex returning from a function
8598 @kindex return
8599 @item return
8600 @itemx return @var{expression}
8601 You can cancel execution of a function call with the @code{return}
8602 command.  If you give an
8603 @var{expression} argument, its value is used as the function's return
8604 value.
8605 @end table
8606
8607 When you use @code{return}, @value{GDBN} discards the selected stack frame
8608 (and all frames within it).  You can think of this as making the
8609 discarded frame return prematurely.  If you wish to specify a value to
8610 be returned, give that value as the argument to @code{return}.
8611
8612 This pops the selected stack frame (@pxref{Selection, ,Selecting a
8613 frame}), and any other frames inside of it, leaving its caller as the
8614 innermost remaining frame.  That frame becomes selected.  The
8615 specified value is stored in the registers used for returning values
8616 of functions.
8617
8618 The @code{return} command does not resume execution; it leaves the
8619 program stopped in the state that would exist if the function had just
8620 returned.  In contrast, the @code{finish} command (@pxref{Continuing
8621 and Stepping, ,Continuing and stepping}) resumes execution until the
8622 selected stack frame returns naturally.
8623
8624 @node Calling
8625 @section Calling program functions
8626
8627 @cindex calling functions
8628 @kindex call
8629 @table @code
8630 @item call @var{expr}
8631 Evaluate the expression @var{expr} without displaying @code{void}
8632 returned values.
8633 @end table
8634
8635 You can use this variant of the @code{print} command if you want to
8636 execute a function from your program, but without cluttering the output
8637 with @code{void} returned values.  If the result is not void, it
8638 is printed and saved in the value history.
8639
8640 For the A29K, a user-controlled variable @code{call_scratch_address},
8641 specifies the location of a scratch area to be used when @value{GDBN}
8642 calls a function in the target.  This is necessary because the usual
8643 method of putting the scratch area on the stack does not work in systems
8644 that have separate instruction and data spaces.
8645
8646 @node Patching
8647 @section Patching programs
8648
8649 @cindex patching binaries
8650 @cindex writing into executables
8651 @cindex writing into corefiles
8652
8653 By default, @value{GDBN} opens the file containing your program's
8654 executable code (or the corefile) read-only.  This prevents accidental
8655 alterations to machine code; but it also prevents you from intentionally
8656 patching your program's binary.
8657
8658 If you'd like to be able to patch the binary, you can specify that
8659 explicitly with the @code{set write} command.  For example, you might
8660 want to turn on internal debugging flags, or even to make emergency
8661 repairs.
8662
8663 @table @code
8664 @kindex set write
8665 @item set write on
8666 @itemx set write off
8667 If you specify @samp{set write on}, @value{GDBN} opens executable and
8668 core files for both reading and writing; if you specify @samp{set write
8669 off} (the default), @value{GDBN} opens them read-only.
8670
8671 If you have already loaded a file, you must load it again (using the
8672 @code{exec-file} or @code{core-file} command) after changing @code{set
8673 write}, for your new setting to take effect.
8674
8675 @item show write
8676 @kindex show write
8677 Display whether executable files and core files are opened for writing
8678 as well as reading.
8679 @end table
8680
8681 @node GDB Files
8682 @chapter @value{GDBN} Files
8683
8684 @value{GDBN} needs to know the file name of the program to be debugged,
8685 both in order to read its symbol table and in order to start your
8686 program.  To debug a core dump of a previous run, you must also tell
8687 @value{GDBN} the name of the core dump file.
8688
8689 @menu
8690 * Files::                       Commands to specify files
8691 * Symbol Errors::               Errors reading symbol files
8692 @end menu
8693
8694 @node Files
8695 @section Commands to specify files
8696
8697 @cindex symbol table
8698 @cindex core dump file
8699
8700 You may want to specify executable and core dump file names.  The usual
8701 way to do this is at start-up time, using the arguments to
8702 @value{GDBN}'s start-up commands (@pxref{Invocation, , Getting In and
8703 Out of @value{GDBN}}).
8704
8705 Occasionally it is necessary to change to a different file during a
8706 @value{GDBN} session.  Or you may run @value{GDBN} and forget to specify
8707 a file you want to use.  In these situations the @value{GDBN} commands
8708 to specify new files are useful.
8709
8710 @table @code
8711 @cindex executable file
8712 @kindex file
8713 @item file @var{filename}
8714 Use @var{filename} as the program to be debugged.  It is read for its
8715 symbols and for the contents of pure memory.  It is also the program
8716 executed when you use the @code{run} command.  If you do not specify a
8717 directory and the file is not found in the @value{GDBN} working directory,
8718 @value{GDBN} uses the environment variable @code{PATH} as a list of
8719 directories to search, just as the shell does when looking for a program
8720 to run.  You can change the value of this variable, for both @value{GDBN}
8721 and your program, using the @code{path} command.
8722
8723 On systems with memory-mapped files, an auxiliary file named
8724 @file{@var{filename}.syms} may hold symbol table information for
8725 @var{filename}.  If so, @value{GDBN} maps in the symbol table from
8726 @file{@var{filename}.syms}, starting up more quickly.  See the
8727 descriptions of the file options @samp{-mapped} and @samp{-readnow}
8728 (available on the command line, and with the commands @code{file},
8729 @code{symbol-file}, or @code{add-symbol-file}, described below),
8730 for more information.
8731
8732 @item file
8733 @code{file} with no argument makes @value{GDBN} discard any information it
8734 has on both executable file and the symbol table.
8735
8736 @kindex exec-file
8737 @item exec-file @r{[} @var{filename} @r{]}
8738 Specify that the program to be run (but not the symbol table) is found
8739 in @var{filename}.  @value{GDBN} searches the environment variable @code{PATH}
8740 if necessary to locate your program.  Omitting @var{filename} means to
8741 discard information on the executable file.
8742
8743 @kindex symbol-file
8744 @item symbol-file @r{[} @var{filename} @r{]}
8745 Read symbol table information from file @var{filename}.  @code{PATH} is
8746 searched when necessary.  Use the @code{file} command to get both symbol
8747 table and program to run from the same file.
8748
8749 @code{symbol-file} with no argument clears out @value{GDBN} information on your
8750 program's symbol table.
8751
8752 The @code{symbol-file} command causes @value{GDBN} to forget the contents
8753 of its convenience variables, the value history, and all breakpoints and
8754 auto-display expressions.  This is because they may contain pointers to
8755 the internal data recording symbols and data types, which are part of
8756 the old symbol table data being discarded inside @value{GDBN}.
8757
8758 @code{symbol-file} does not repeat if you press @key{RET} again after
8759 executing it once.
8760
8761 When @value{GDBN} is configured for a particular environment, it
8762 understands debugging information in whatever format is the standard
8763 generated for that environment; you may use either a @sc{gnu} compiler, or
8764 other compilers that adhere to the local conventions.
8765 Best results are usually obtained from @sc{gnu} compilers; for example,
8766 using @code{@value{GCC}} you can generate debugging information for
8767 optimized code.
8768
8769 For most kinds of object files, with the exception of old SVR3 systems
8770 using COFF, the @code{symbol-file} command does not normally read the
8771 symbol table in full right away.  Instead, it scans the symbol table
8772 quickly to find which source files and which symbols are present.  The
8773 details are read later, one source file at a time, as they are needed.
8774
8775 The purpose of this two-stage reading strategy is to make @value{GDBN}
8776 start up faster.  For the most part, it is invisible except for
8777 occasional pauses while the symbol table details for a particular source
8778 file are being read.  (The @code{set verbose} command can turn these
8779 pauses into messages if desired.  @xref{Messages/Warnings, ,Optional
8780 warnings and messages}.)
8781
8782 We have not implemented the two-stage strategy for COFF yet.  When the
8783 symbol table is stored in COFF format, @code{symbol-file} reads the
8784 symbol table data in full right away.  Note that ``stabs-in-COFF''
8785 still does the two-stage strategy, since the debug info is actually
8786 in stabs format.
8787
8788 @kindex readnow
8789 @cindex reading symbols immediately
8790 @cindex symbols, reading immediately
8791 @kindex mapped
8792 @cindex memory-mapped symbol file
8793 @cindex saving symbol table
8794 @item symbol-file @var{filename} @r{[} -readnow @r{]} @r{[} -mapped @r{]}
8795 @itemx file @var{filename} @r{[} -readnow @r{]} @r{[} -mapped @r{]}
8796 You can override the @value{GDBN} two-stage strategy for reading symbol
8797 tables by using the @samp{-readnow} option with any of the commands that
8798 load symbol table information, if you want to be sure @value{GDBN} has the
8799 entire symbol table available.
8800
8801 If memory-mapped files are available on your system through the
8802 @code{mmap} system call, you can use another option, @samp{-mapped}, to
8803 cause @value{GDBN} to write the symbols for your program into a reusable
8804 file.  Future @value{GDBN} debugging sessions map in symbol information
8805 from this auxiliary symbol file (if the program has not changed), rather
8806 than spending time reading the symbol table from the executable
8807 program.  Using the @samp{-mapped} option has the same effect as
8808 starting @value{GDBN} with the @samp{-mapped} command-line option.
8809
8810 You can use both options together, to make sure the auxiliary symbol
8811 file has all the symbol information for your program.
8812
8813 The auxiliary symbol file for a program called @var{myprog} is called
8814 @samp{@var{myprog}.syms}.  Once this file exists (so long as it is newer
8815 than the corresponding executable), @value{GDBN} always attempts to use
8816 it when you debug @var{myprog}; no special options or commands are
8817 needed.
8818
8819 The @file{.syms} file is specific to the host machine where you run
8820 @value{GDBN}.  It holds an exact image of the internal @value{GDBN}
8821 symbol table.  It cannot be shared across multiple host platforms.
8822
8823 @c FIXME: for now no mention of directories, since this seems to be in
8824 @c flux.  13mar1992 status is that in theory GDB would look either in
8825 @c current dir or in same dir as myprog; but issues like competing
8826 @c GDB's, or clutter in system dirs, mean that in practice right now
8827 @c only current dir is used.  FFish says maybe a special GDB hierarchy
8828 @c (eg rooted in val of env var GDBSYMS) could exist for mappable symbol
8829 @c files.
8830
8831 @kindex core
8832 @kindex core-file
8833 @item core-file @r{[} @var{filename} @r{]}
8834 Specify the whereabouts of a core dump file to be used as the ``contents
8835 of memory''.  Traditionally, core files contain only some parts of the
8836 address space of the process that generated them; @value{GDBN} can access the
8837 executable file itself for other parts.
8838
8839 @code{core-file} with no argument specifies that no core file is
8840 to be used.
8841
8842 Note that the core file is ignored when your program is actually running
8843 under @value{GDBN}.  So, if you have been running your program and you
8844 wish to debug a core file instead, you must kill the subprocess in which
8845 the program is running.  To do this, use the @code{kill} command
8846 (@pxref{Kill Process, ,Killing the child process}).
8847
8848 @kindex add-symbol-file
8849 @cindex dynamic linking
8850 @item add-symbol-file @var{filename} @var{address}
8851 @itemx add-symbol-file @var{filename} @var{address} @r{[} -readnow @r{]} @r{[} -mapped @r{]}
8852 @itemx add-symbol-file @var{filename} @r{-s}@var{section} @var{address}
8853 The @code{add-symbol-file} command reads additional symbol table
8854 information from the file @var{filename}.  You would use this command
8855 when @var{filename} has been dynamically loaded (by some other means)
8856 into the program that is running.  @var{address} should be the memory
8857 address at which the file has been loaded; @value{GDBN} cannot figure
8858 this out for itself.  You can additionally specify an arbitrary number
8859 of @samp{@r{-s}@var{section} @var{address}} pairs, to give an explicit
8860 section name and base address for that section.  You can specify any
8861 @var{address} as an expression.
8862
8863 The symbol table of the file @var{filename} is added to the symbol table
8864 originally read with the @code{symbol-file} command.  You can use the
8865 @code{add-symbol-file} command any number of times; the new symbol data
8866 thus read keeps adding to the old.  To discard all old symbol data
8867 instead, use the @code{symbol-file} command without any arguments.
8868
8869 @code{add-symbol-file} does not repeat if you press @key{RET} after using it.
8870
8871 You can use the @samp{-mapped} and @samp{-readnow} options just as with
8872 the @code{symbol-file} command, to change how @value{GDBN} manages the symbol
8873 table information for @var{filename}.
8874
8875 @kindex add-shared-symbol-file
8876 @item add-shared-symbol-file
8877 The @code{add-shared-symbol-file} command can be used only under Harris' CXUX
8878 operating system for the Motorola 88k.  @value{GDBN} automatically looks for
8879 shared libraries, however if @value{GDBN} does not find yours, you can run
8880 @code{add-shared-symbol-file}.  It takes no arguments.
8881
8882 @kindex section
8883 @item section
8884 The @code{section} command changes the base address of section SECTION of
8885 the exec file to ADDR.  This can be used if the exec file does not contain
8886 section addresses, (such as in the a.out format), or when the addresses
8887 specified in the file itself are wrong.  Each section must be changed
8888 separately.  The @code{info files} command, described below, lists all
8889 the sections and their addresses.
8890
8891 @kindex info files
8892 @kindex info target
8893 @item info files
8894 @itemx info target
8895 @code{info files} and @code{info target} are synonymous; both print the
8896 current target (@pxref{Targets, ,Specifying a Debugging Target}),
8897 including the names of the executable and core dump files currently in
8898 use by @value{GDBN}, and the files from which symbols were loaded.  The
8899 command @code{help target} lists all possible targets rather than
8900 current ones.
8901
8902 @end table
8903
8904 All file-specifying commands allow both absolute and relative file names
8905 as arguments.  @value{GDBN} always converts the file name to an absolute file
8906 name and remembers it that way.
8907
8908 @cindex shared libraries
8909 @value{GDBN} supports HP-UX, SunOS, SVr4, Irix 5, and IBM RS/6000 shared
8910 libraries.
8911
8912 @value{GDBN} automatically loads symbol definitions from shared libraries
8913 when you use the @code{run} command, or when you examine a core file.
8914 (Before you issue the @code{run} command, @value{GDBN} does not understand
8915 references to a function in a shared library, however---unless you are
8916 debugging a core file).
8917
8918 On HP-UX, if the program loads a library explicitly, @value{GDBN}
8919 automatically loads the symbols at the time of the @code{shl_load} call.
8920
8921 @c FIXME: some @value{GDBN} release may permit some refs to undef
8922 @c FIXME...symbols---eg in a break cmd---assuming they are from a shared
8923 @c FIXME...lib; check this from time to time when updating manual
8924
8925 @table @code
8926 @kindex info sharedlibrary
8927 @kindex info share
8928 @item info share
8929 @itemx info sharedlibrary
8930 Print the names of the shared libraries which are currently loaded.
8931
8932 @kindex sharedlibrary
8933 @kindex share
8934 @item sharedlibrary @var{regex}
8935 @itemx share @var{regex}
8936 Load shared object library symbols for files matching a
8937 Unix regular expression.
8938 As with files loaded automatically, it only loads shared libraries
8939 required by your program for a core file or after typing @code{run}.  If
8940 @var{regex} is omitted all shared libraries required by your program are
8941 loaded.
8942 @end table
8943
8944 On HP-UX systems, @value{GDBN} detects the loading of a shared library
8945 and automatically reads in symbols from the newly loaded library, up to
8946 a threshold that is initially set but that you can modify if you wish.
8947
8948 Beyond that threshold, symbols from shared libraries must be explicitly
8949 loaded.  To load these symbols, use the command @code{sharedlibrary
8950 @var{filename}}.  The base address of the shared library is determined
8951 automatically by @value{GDBN} and need not be specified.
8952
8953 To display or set the threshold, use the commands:
8954
8955 @table @code
8956 @kindex set auto-solib-add
8957 @item set auto-solib-add @var{threshold}
8958 Set the autoloading size threshold, in megabytes.  If @var{threshold} is
8959 nonzero, symbols from all shared object libraries will be loaded
8960 automatically when the inferior begins execution or when the dynamic
8961 linker informs @value{GDBN} that a new library has been loaded, until
8962 the symbol table of the program and libraries exceeds this threshold.
8963 Otherwise, symbols must be loaded manually, using the
8964 @code{sharedlibrary} command.  The default threshold is 100 megabytes.
8965
8966 @kindex show auto-solib-add
8967 @item show auto-solib-add
8968 Display the current autoloading size threshold, in megabytes.
8969 @end table
8970
8971 @node Symbol Errors
8972 @section Errors reading symbol files
8973
8974 While reading a symbol file, @value{GDBN} occasionally encounters problems,
8975 such as symbol types it does not recognize, or known bugs in compiler
8976 output.  By default, @value{GDBN} does not notify you of such problems, since
8977 they are relatively common and primarily of interest to people
8978 debugging compilers.  If you are interested in seeing information
8979 about ill-constructed symbol tables, you can either ask @value{GDBN} to print
8980 only one message about each such type of problem, no matter how many
8981 times the problem occurs; or you can ask @value{GDBN} to print more messages,
8982 to see how many times the problems occur, with the @code{set
8983 complaints} command (@pxref{Messages/Warnings, ,Optional warnings and
8984 messages}).
8985
8986 The messages currently printed, and their meanings, include:
8987
8988 @table @code
8989 @item inner block not inside outer block in @var{symbol}
8990
8991 The symbol information shows where symbol scopes begin and end
8992 (such as at the start of a function or a block of statements).  This
8993 error indicates that an inner scope block is not fully contained
8994 in its outer scope blocks.
8995
8996 @value{GDBN} circumvents the problem by treating the inner block as if it had
8997 the same scope as the outer block.  In the error message, @var{symbol}
8998 may be shown as ``@code{(don't know)}'' if the outer block is not a
8999 function.
9000
9001 @item block at @var{address} out of order
9002
9003 The symbol information for symbol scope blocks should occur in
9004 order of increasing addresses.  This error indicates that it does not
9005 do so.
9006
9007 @value{GDBN} does not circumvent this problem, and has trouble
9008 locating symbols in the source file whose symbols it is reading.  (You
9009 can often determine what source file is affected by specifying
9010 @code{set verbose on}.  @xref{Messages/Warnings, ,Optional warnings and
9011 messages}.)
9012
9013 @item bad block start address patched
9014
9015 The symbol information for a symbol scope block has a start address
9016 smaller than the address of the preceding source line.  This is known
9017 to occur in the SunOS 4.1.1 (and earlier) C compiler.
9018
9019 @value{GDBN} circumvents the problem by treating the symbol scope block as
9020 starting on the previous source line.
9021
9022 @item bad string table offset in symbol @var{n}
9023
9024 @cindex foo
9025 Symbol number @var{n} contains a pointer into the string table which is
9026 larger than the size of the string table.
9027
9028 @value{GDBN} circumvents the problem by considering the symbol to have the
9029 name @code{foo}, which may cause other problems if many symbols end up
9030 with this name.
9031
9032 @item unknown symbol type @code{0x@var{nn}}
9033
9034 The symbol information contains new data types that @value{GDBN} does
9035 not yet know how to read.  @code{0x@var{nn}} is the symbol type of the
9036 uncomprehended information, in hexadecimal.
9037
9038 @value{GDBN} circumvents the error by ignoring this symbol information.
9039 This usually allows you to debug your program, though certain symbols
9040 are not accessible.  If you encounter such a problem and feel like
9041 debugging it, you can debug @code{@value{GDBP}} with itself, breakpoint
9042 on @code{complain}, then go up to the function @code{read_dbx_symtab}
9043 and examine @code{*bufp} to see the symbol.
9044
9045 @item stub type has NULL name
9046
9047 @value{GDBN} could not find the full definition for a struct or class.
9048
9049 @item const/volatile indicator missing (ok if using g++ v1.x), got@dots{}
9050 The symbol information for a C@t{++} member function is missing some
9051 information that recent versions of the compiler should have output for
9052 it.
9053
9054 @item info mismatch between compiler and debugger
9055
9056 @value{GDBN} could not parse a type specification output by the compiler.
9057
9058 @end table
9059
9060 @node Targets
9061 @chapter Specifying a Debugging Target
9062
9063 @cindex debugging target
9064 @kindex target
9065
9066 A @dfn{target} is the execution environment occupied by your program.
9067
9068 Often, @value{GDBN} runs in the same host environment as your program;
9069 in that case, the debugging target is specified as a side effect when
9070 you use the @code{file} or @code{core} commands.  When you need more
9071 flexibility---for example, running @value{GDBN} on a physically separate
9072 host, or controlling a standalone system over a serial port or a
9073 realtime system over a TCP/IP connection---you can use the @code{target}
9074 command to specify one of the target types configured for @value{GDBN}
9075 (@pxref{Target Commands, ,Commands for managing targets}).
9076
9077 @menu
9078 * Active Targets::              Active targets
9079 * Target Commands::             Commands for managing targets
9080 * Byte Order::                  Choosing target byte order
9081 * Remote::                      Remote debugging
9082 * KOD::                         Kernel Object Display
9083
9084 @end menu
9085
9086 @node Active Targets
9087 @section Active targets
9088
9089 @cindex stacking targets
9090 @cindex active targets
9091 @cindex multiple targets
9092
9093 There are three classes of targets: processes, core files, and
9094 executable files.  @value{GDBN} can work concurrently on up to three
9095 active targets, one in each class.  This allows you to (for example)
9096 start a process and inspect its activity without abandoning your work on
9097 a core file.
9098
9099 For example, if you execute @samp{gdb a.out}, then the executable file
9100 @code{a.out} is the only active target.  If you designate a core file as
9101 well---presumably from a prior run that crashed and coredumped---then
9102 @value{GDBN} has two active targets and uses them in tandem, looking
9103 first in the corefile target, then in the executable file, to satisfy
9104 requests for memory addresses.  (Typically, these two classes of target
9105 are complementary, since core files contain only a program's
9106 read-write memory---variables and so on---plus machine status, while
9107 executable files contain only the program text and initialized data.)
9108
9109 When you type @code{run}, your executable file becomes an active process
9110 target as well.  When a process target is active, all @value{GDBN}
9111 commands requesting memory addresses refer to that target; addresses in
9112 an active core file or executable file target are obscured while the
9113 process target is active.
9114
9115 Use the @code{core-file} and @code{exec-file} commands to select a new
9116 core file or executable target (@pxref{Files, ,Commands to specify
9117 files}).  To specify as a target a process that is already running, use
9118 the @code{attach} command (@pxref{Attach, ,Debugging an already-running
9119 process}).
9120
9121 @node Target Commands
9122 @section Commands for managing targets
9123
9124 @table @code
9125 @item target @var{type} @var{parameters}
9126 Connects the @value{GDBN} host environment to a target machine or
9127 process.  A target is typically a protocol for talking to debugging
9128 facilities.  You use the argument @var{type} to specify the type or
9129 protocol of the target machine.
9130
9131 Further @var{parameters} are interpreted by the target protocol, but
9132 typically include things like device names or host names to connect
9133 with, process numbers, and baud rates.
9134
9135 The @code{target} command does not repeat if you press @key{RET} again
9136 after executing the command.
9137
9138 @kindex help target
9139 @item help target
9140 Displays the names of all targets available.  To display targets
9141 currently selected, use either @code{info target} or @code{info files}
9142 (@pxref{Files, ,Commands to specify files}).
9143
9144 @item help target @var{name}
9145 Describe a particular target, including any parameters necessary to
9146 select it.
9147
9148 @kindex set gnutarget
9149 @item set gnutarget @var{args}
9150 @value{GDBN} uses its own library BFD to read your files.  @value{GDBN}
9151 knows whether it is reading an @dfn{executable},
9152 a @dfn{core}, or a @dfn{.o} file; however, you can specify the file format
9153 with the @code{set gnutarget} command.  Unlike most @code{target} commands,
9154 with @code{gnutarget} the @code{target} refers to a program, not a machine.
9155
9156 @quotation
9157 @emph{Warning:} To specify a file format with @code{set gnutarget},
9158 you must know the actual BFD name.
9159 @end quotation
9160
9161 @noindent
9162 @xref{Files, , Commands to specify files}.
9163
9164 @kindex show gnutarget
9165 @item show gnutarget
9166 Use the @code{show gnutarget} command to display what file format
9167 @code{gnutarget} is set to read.  If you have not set @code{gnutarget},
9168 @value{GDBN} will determine the file format for each file automatically,
9169 and @code{show gnutarget} displays @samp{The current BDF target is "auto"}.
9170 @end table
9171
9172 Here are some common targets (available, or not, depending on the GDB
9173 configuration):
9174
9175 @table @code
9176 @kindex target exec
9177 @item target exec @var{program}
9178 An executable file.  @samp{target exec @var{program}} is the same as
9179 @samp{exec-file @var{program}}.
9180
9181 @kindex target core
9182 @item target core @var{filename}
9183 A core dump file.  @samp{target core @var{filename}} is the same as
9184 @samp{core-file @var{filename}}.
9185
9186 @kindex target remote
9187 @item target remote @var{dev}
9188 Remote serial target in GDB-specific protocol.  The argument @var{dev}
9189 specifies what serial device to use for the connection (e.g.
9190 @file{/dev/ttya}). @xref{Remote, ,Remote debugging}.  @code{target remote}
9191 supports the @code{load} command.  This is only useful if you have
9192 some other way of getting the stub to the target system, and you can put
9193 it somewhere in memory where it won't get clobbered by the download.
9194
9195 @kindex target sim
9196 @item target sim
9197 Builtin CPU simulator.  @value{GDBN} includes simulators for most architectures.
9198 In general,
9199 @example
9200         target sim
9201         load
9202         run
9203 @end example
9204 @noindent
9205 works; however, you cannot assume that a specific memory map, device
9206 drivers, or even basic I/O is available, although some simulators do
9207 provide these.  For info about any processor-specific simulator details,
9208 see the appropriate section in @ref{Embedded Processors, ,Embedded
9209 Processors}.
9210
9211 @end table
9212
9213 Some configurations may include these targets as well:
9214
9215 @table @code
9216
9217 @kindex target nrom
9218 @item target nrom @var{dev}
9219 NetROM ROM emulator.  This target only supports downloading.
9220
9221 @end table
9222
9223 Different targets are available on different configurations of @value{GDBN};
9224 your configuration may have more or fewer targets.
9225
9226 Many remote targets require you to download the executable's code
9227 once you've successfully established a connection.
9228
9229 @table @code
9230
9231 @kindex load @var{filename}
9232 @item load @var{filename}
9233 Depending on what remote debugging facilities are configured into
9234 @value{GDBN}, the @code{load} command may be available.  Where it exists, it
9235 is meant to make @var{filename} (an executable) available for debugging
9236 on the remote system---by downloading, or dynamic linking, for example.
9237 @code{load} also records the @var{filename} symbol table in @value{GDBN}, like
9238 the @code{add-symbol-file} command.
9239
9240 If your @value{GDBN} does not have a @code{load} command, attempting to
9241 execute it gets the error message ``@code{You can't do that when your
9242 target is @dots{}}''
9243
9244 The file is loaded at whatever address is specified in the executable.
9245 For some object file formats, you can specify the load address when you
9246 link the program; for other formats, like a.out, the object file format
9247 specifies a fixed address.
9248 @c FIXME! This would be a good place for an xref to the GNU linker doc.
9249
9250 @code{load} does not repeat if you press @key{RET} again after using it.
9251 @end table
9252
9253 @node Byte Order
9254 @section Choosing target byte order
9255
9256 @cindex choosing target byte order
9257 @cindex target byte order
9258
9259 Some types of processors, such as the MIPS, PowerPC, and Hitachi SH,
9260 offer the ability to run either big-endian or little-endian byte
9261 orders.  Usually the executable or symbol will include a bit to
9262 designate the endian-ness, and you will not need to worry about
9263 which to use.  However, you may still find it useful to adjust
9264 @value{GDBN}'s idea of processor endian-ness manually.
9265
9266 @table @code
9267 @kindex set endian big
9268 @item set endian big
9269 Instruct @value{GDBN} to assume the target is big-endian.
9270
9271 @kindex set endian little
9272 @item set endian little
9273 Instruct @value{GDBN} to assume the target is little-endian.
9274
9275 @kindex set endian auto
9276 @item set endian auto
9277 Instruct @value{GDBN} to use the byte order associated with the
9278 executable.
9279
9280 @item show endian
9281 Display @value{GDBN}'s current idea of the target byte order.
9282
9283 @end table
9284
9285 Note that these commands merely adjust interpretation of symbolic
9286 data on the host, and that they have absolutely no effect on the
9287 target system.
9288
9289 @node Remote
9290 @section Remote debugging
9291 @cindex remote debugging
9292
9293 If you are trying to debug a program running on a machine that cannot run
9294 @value{GDBN} in the usual way, it is often useful to use remote debugging.
9295 For example, you might use remote debugging on an operating system kernel,
9296 or on a small system which does not have a general purpose operating system
9297 powerful enough to run a full-featured debugger.
9298
9299 Some configurations of @value{GDBN} have special serial or TCP/IP interfaces
9300 to make this work with particular debugging targets.  In addition,
9301 @value{GDBN} comes with a generic serial protocol (specific to @value{GDBN},
9302 but not specific to any particular target system) which you can use if you
9303 write the remote stubs---the code that runs on the remote system to
9304 communicate with @value{GDBN}.
9305
9306 Other remote targets may be available in your
9307 configuration of @value{GDBN}; use @code{help target} to list them.
9308
9309 @menu
9310 * Remote Serial::               @value{GDBN} remote serial protocol
9311 @end menu
9312
9313 @node Remote Serial
9314 @subsection The @value{GDBN} remote serial protocol
9315
9316 @cindex remote serial debugging, overview
9317 To debug a program running on another machine (the debugging
9318 @dfn{target} machine), you must first arrange for all the usual
9319 prerequisites for the program to run by itself.  For example, for a C
9320 program, you need:
9321
9322 @enumerate
9323 @item
9324 A startup routine to set up the C runtime environment; these usually
9325 have a name like @file{crt0}.  The startup routine may be supplied by
9326 your hardware supplier, or you may have to write your own.
9327
9328 @item
9329 A C subroutine library to support your program's
9330 subroutine calls, notably managing input and output.
9331
9332 @item
9333 A way of getting your program to the other machine---for example, a
9334 download program.  These are often supplied by the hardware
9335 manufacturer, but you may have to write your own from hardware
9336 documentation.
9337 @end enumerate
9338
9339 The next step is to arrange for your program to use a serial port to
9340 communicate with the machine where @value{GDBN} is running (the @dfn{host}
9341 machine).  In general terms, the scheme looks like this:
9342
9343 @table @emph
9344 @item On the host,
9345 @value{GDBN} already understands how to use this protocol; when everything
9346 else is set up, you can simply use the @samp{target remote} command
9347 (@pxref{Targets,,Specifying a Debugging Target}).
9348
9349 @item On the target,
9350 you must link with your program a few special-purpose subroutines that
9351 implement the @value{GDBN} remote serial protocol.  The file containing these
9352 subroutines is called  a @dfn{debugging stub}.
9353
9354 On certain remote targets, you can use an auxiliary program
9355 @code{gdbserver} instead of linking a stub into your program.
9356 @xref{Server,,Using the @code{gdbserver} program}, for details.
9357 @end table
9358
9359 The debugging stub is specific to the architecture of the remote
9360 machine; for example, use @file{sparc-stub.c} to debug programs on
9361 @sc{sparc} boards.
9362
9363 @cindex remote serial stub list
9364 These working remote stubs are distributed with @value{GDBN}:
9365
9366 @table @code
9367
9368 @item i386-stub.c
9369 @cindex @file{i386-stub.c}
9370 @cindex Intel
9371 @cindex i386
9372 For Intel 386 and compatible architectures.
9373
9374 @item m68k-stub.c
9375 @cindex @file{m68k-stub.c}
9376 @cindex Motorola 680x0
9377 @cindex m680x0
9378 For Motorola 680x0 architectures.
9379
9380 @item sh-stub.c
9381 @cindex @file{sh-stub.c}
9382 @cindex Hitachi
9383 @cindex SH
9384 For Hitachi SH architectures.
9385
9386 @item sparc-stub.c
9387 @cindex @file{sparc-stub.c}
9388 @cindex Sparc
9389 For @sc{sparc} architectures.
9390
9391 @item sparcl-stub.c
9392 @cindex @file{sparcl-stub.c}
9393 @cindex Fujitsu
9394 @cindex SparcLite
9395 For Fujitsu @sc{sparclite} architectures.
9396
9397 @end table
9398
9399 The @file{README} file in the @value{GDBN} distribution may list other
9400 recently added stubs.
9401
9402 @menu
9403 * Stub Contents::       What the stub can do for you
9404 * Bootstrapping::       What you must do for the stub
9405 * Debug Session::       Putting it all together
9406 * Protocol::            Definition of the communication protocol
9407 * Server::                Using the `gdbserver' program
9408 * NetWare::                Using the `gdbserve.nlm' program
9409 @end menu
9410
9411 @node Stub Contents
9412 @subsubsection What the stub can do for you
9413
9414 @cindex remote serial stub
9415 The debugging stub for your architecture supplies these three
9416 subroutines:
9417
9418 @table @code
9419 @item set_debug_traps
9420 @kindex set_debug_traps
9421 @cindex remote serial stub, initialization
9422 This routine arranges for @code{handle_exception} to run when your
9423 program stops.  You must call this subroutine explicitly near the
9424 beginning of your program.
9425
9426 @item handle_exception
9427 @kindex handle_exception
9428 @cindex remote serial stub, main routine
9429 This is the central workhorse, but your program never calls it
9430 explicitly---the setup code arranges for @code{handle_exception} to
9431 run when a trap is triggered.
9432
9433 @code{handle_exception} takes control when your program stops during
9434 execution (for example, on a breakpoint), and mediates communications
9435 with @value{GDBN} on the host machine.  This is where the communications
9436 protocol is implemented; @code{handle_exception} acts as the @value{GDBN}
9437 representative on the target machine.  It begins by sending summary
9438 information on the state of your program, then continues to execute,
9439 retrieving and transmitting any information @value{GDBN} needs, until you
9440 execute a @value{GDBN} command that makes your program resume; at that point,
9441 @code{handle_exception} returns control to your own code on the target
9442 machine.
9443
9444 @item breakpoint
9445 @cindex @code{breakpoint} subroutine, remote
9446 Use this auxiliary subroutine to make your program contain a
9447 breakpoint.  Depending on the particular situation, this may be the only
9448 way for @value{GDBN} to get control.  For instance, if your target
9449 machine has some sort of interrupt button, you won't need to call this;
9450 pressing the interrupt button transfers control to
9451 @code{handle_exception}---in effect, to @value{GDBN}.  On some machines,
9452 simply receiving characters on the serial port may also trigger a trap;
9453 again, in that situation, you don't need to call @code{breakpoint} from
9454 your own program---simply running @samp{target remote} from the host
9455 @value{GDBN} session gets control.
9456
9457 Call @code{breakpoint} if none of these is true, or if you simply want
9458 to make certain your program stops at a predetermined point for the
9459 start of your debugging session.
9460 @end table
9461
9462 @node Bootstrapping
9463 @subsubsection What you must do for the stub
9464
9465 @cindex remote stub, support routines
9466 The debugging stubs that come with @value{GDBN} are set up for a particular
9467 chip architecture, but they have no information about the rest of your
9468 debugging target machine.
9469
9470 First of all you need to tell the stub how to communicate with the
9471 serial port.
9472
9473 @table @code
9474 @item int getDebugChar()
9475 @kindex getDebugChar
9476 Write this subroutine to read a single character from the serial port.
9477 It may be identical to @code{getchar} for your target system; a
9478 different name is used to allow you to distinguish the two if you wish.
9479
9480 @item void putDebugChar(int)
9481 @kindex putDebugChar
9482 Write this subroutine to write a single character to the serial port.
9483 It may be identical to @code{putchar} for your target system; a
9484 different name is used to allow you to distinguish the two if you wish.
9485 @end table
9486
9487 @cindex control C, and remote debugging
9488 @cindex interrupting remote targets
9489 If you want @value{GDBN} to be able to stop your program while it is
9490 running, you need to use an interrupt-driven serial driver, and arrange
9491 for it to stop when it receives a @code{^C} (@samp{\003}, the control-C
9492 character).  That is the character which @value{GDBN} uses to tell the
9493 remote system to stop.
9494
9495 Getting the debugging target to return the proper status to @value{GDBN}
9496 probably requires changes to the standard stub; one quick and dirty way
9497 is to just execute a breakpoint instruction (the ``dirty'' part is that
9498 @value{GDBN} reports a @code{SIGTRAP} instead of a @code{SIGINT}).
9499
9500 Other routines you need to supply are:
9501
9502 @table @code
9503 @item void exceptionHandler (int @var{exception_number}, void *@var{exception_address})
9504 @kindex exceptionHandler
9505 Write this function to install @var{exception_address} in the exception
9506 handling tables.  You need to do this because the stub does not have any
9507 way of knowing what the exception handling tables on your target system
9508 are like (for example, the processor's table might be in @sc{rom},
9509 containing entries which point to a table in @sc{ram}).
9510 @var{exception_number} is the exception number which should be changed;
9511 its meaning is architecture-dependent (for example, different numbers
9512 might represent divide by zero, misaligned access, etc).  When this
9513 exception occurs, control should be transferred directly to
9514 @var{exception_address}, and the processor state (stack, registers,
9515 and so on) should be just as it is when a processor exception occurs.  So if
9516 you want to use a jump instruction to reach @var{exception_address}, it
9517 should be a simple jump, not a jump to subroutine.
9518
9519 For the 386, @var{exception_address} should be installed as an interrupt
9520 gate so that interrupts are masked while the handler runs.  The gate
9521 should be at privilege level 0 (the most privileged level).  The
9522 @sc{sparc} and 68k stubs are able to mask interrupts themselves without
9523 help from @code{exceptionHandler}.
9524
9525 @item void flush_i_cache()
9526 @kindex flush_i_cache
9527 On @sc{sparc} and @sc{sparclite} only, write this subroutine to flush the
9528 instruction cache, if any, on your target machine.  If there is no
9529 instruction cache, this subroutine may be a no-op.
9530
9531 On target machines that have instruction caches, @value{GDBN} requires this
9532 function to make certain that the state of your program is stable.
9533 @end table
9534
9535 @noindent
9536 You must also make sure this library routine is available:
9537
9538 @table @code
9539 @item void *memset(void *, int, int)
9540 @kindex memset
9541 This is the standard library function @code{memset} that sets an area of
9542 memory to a known value.  If you have one of the free versions of
9543 @code{libc.a}, @code{memset} can be found there; otherwise, you must
9544 either obtain it from your hardware manufacturer, or write your own.
9545 @end table
9546
9547 If you do not use the GNU C compiler, you may need other standard
9548 library subroutines as well; this varies from one stub to another,
9549 but in general the stubs are likely to use any of the common library
9550 subroutines which @code{@value{GCC}} generates as inline code.
9551
9552
9553 @node Debug Session
9554 @subsubsection Putting it all together
9555
9556 @cindex remote serial debugging summary
9557 In summary, when your program is ready to debug, you must follow these
9558 steps.
9559
9560 @enumerate
9561 @item
9562 Make sure you have defined the supporting low-level routines
9563 (@pxref{Bootstrapping,,What you must do for the stub}):
9564 @display
9565 @code{getDebugChar}, @code{putDebugChar},
9566 @code{flush_i_cache}, @code{memset}, @code{exceptionHandler}.
9567 @end display
9568
9569 @item
9570 Insert these lines near the top of your program:
9571
9572 @example
9573 set_debug_traps();
9574 breakpoint();
9575 @end example
9576
9577 @item
9578 For the 680x0 stub only, you need to provide a variable called
9579 @code{exceptionHook}.  Normally you just use:
9580
9581 @example
9582 void (*exceptionHook)() = 0;
9583 @end example
9584
9585 @noindent
9586 but if before calling @code{set_debug_traps}, you set it to point to a
9587 function in your program, that function is called when
9588 @code{@value{GDBN}} continues after stopping on a trap (for example, bus
9589 error).  The function indicated by @code{exceptionHook} is called with
9590 one parameter: an @code{int} which is the exception number.
9591
9592 @item
9593 Compile and link together: your program, the @value{GDBN} debugging stub for
9594 your target architecture, and the supporting subroutines.
9595
9596 @item
9597 Make sure you have a serial connection between your target machine and
9598 the @value{GDBN} host, and identify the serial port on the host.
9599
9600 @item
9601 @c The "remote" target now provides a `load' command, so we should
9602 @c document that.  FIXME.
9603 Download your program to your target machine (or get it there by
9604 whatever means the manufacturer provides), and start it.
9605
9606 @item
9607 To start remote debugging, run @value{GDBN} on the host machine, and specify
9608 as an executable file the program that is running in the remote machine.
9609 This tells @value{GDBN} how to find your program's symbols and the contents
9610 of its pure text.
9611
9612 @item
9613 @cindex serial line, @code{target remote}
9614 Establish communication using the @code{target remote} command.
9615 Its argument specifies how to communicate with the target
9616 machine---either via a devicename attached to a direct serial line, or a
9617 TCP port (usually to a terminal server which in turn has a serial line
9618 to the target).  For example, to use a serial line connected to the
9619 device named @file{/dev/ttyb}:
9620
9621 @example
9622 target remote /dev/ttyb
9623 @end example
9624
9625 @cindex TCP port, @code{target remote}
9626 To use a TCP connection, use an argument of the form
9627 @code{@var{host}:port}.  For example, to connect to port 2828 on a
9628 terminal server named @code{manyfarms}:
9629
9630 @example
9631 target remote manyfarms:2828
9632 @end example
9633 @end enumerate
9634
9635 Now you can use all the usual commands to examine and change data and to
9636 step and continue the remote program.
9637
9638 To resume the remote program and stop debugging it, use the @code{detach}
9639 command.
9640
9641 @cindex interrupting remote programs
9642 @cindex remote programs, interrupting
9643 Whenever @value{GDBN} is waiting for the remote program, if you type the
9644 interrupt character (often @key{C-C}), @value{GDBN} attempts to stop the
9645 program.  This may or may not succeed, depending in part on the hardware
9646 and the serial drivers the remote system uses.  If you type the
9647 interrupt character once again, @value{GDBN} displays this prompt:
9648
9649 @example
9650 Interrupted while waiting for the program.
9651 Give up (and stop debugging it)?  (y or n)
9652 @end example
9653
9654 If you type @kbd{y}, @value{GDBN} abandons the remote debugging session.
9655 (If you decide you want to try again later, you can use @samp{target
9656 remote} again to connect once more.)  If you type @kbd{n}, @value{GDBN}
9657 goes back to waiting.
9658
9659 @node Protocol
9660 @subsubsection Communication protocol
9661
9662 @cindex debugging stub, example
9663 @cindex remote stub, example
9664 @cindex stub example, remote debugging
9665 The stub files provided with @value{GDBN} implement the target side of the
9666 communication protocol, and the @value{GDBN} side is implemented in the
9667 @value{GDBN} source file @file{remote.c}.  Normally, you can simply allow
9668 these subroutines to communicate, and ignore the details.  (If you're
9669 implementing your own stub file, you can still ignore the details: start
9670 with one of the existing stub files.  @file{sparc-stub.c} is the best
9671 organized, and therefore the easiest to read.)
9672
9673 However, there may be occasions when you need to know something about
9674 the protocol---for example, if there is only one serial port to your
9675 target machine, you might want your program to do something special if
9676 it recognizes a packet meant for @value{GDBN}.
9677
9678 In the examples below, @samp{<-} and @samp{->} are used to indicate
9679 transmitted and received data respectfully.
9680
9681 @cindex protocol, @value{GDBN} remote serial
9682 @cindex serial protocol, @value{GDBN} remote
9683 @cindex remote serial protocol
9684 All @value{GDBN} commands and responses (other than acknowledgments) are
9685 sent as a @var{packet}.  A @var{packet} is introduced with the character
9686 @samp{$}, the actual @var{packet-data}, and the terminating character
9687 @samp{#} followed by a two-digit @var{checksum}:
9688
9689 @example
9690 @code{$}@var{packet-data}@code{#}@var{checksum}
9691 @end example
9692 @noindent
9693
9694 @cindex checksum, for @value{GDBN} remote
9695 @noindent
9696 The two-digit @var{checksum} is computed as the modulo 256 sum of all
9697 characters between the leading @samp{$} and the trailing @samp{#} (an
9698 eight bit unsigned checksum).
9699
9700 Implementors should note that prior to @value{GDBN} 5.0 the protocol
9701 specification also included an optional two-digit @var{sequence-id}:
9702
9703 @example
9704 @code{$}@var{sequence-id}@code{:}@var{packet-data}@code{#}@var{checksum}
9705 @end example
9706
9707 @cindex sequence-id, for @value{GDBN} remote
9708 @noindent
9709 That @var{sequence-id} was appended to the acknowledgment.  @value{GDBN}
9710 has never output @var{sequence-id}s.  Stubs that handle packets added
9711 since @value{GDBN} 5.0 must not accept @var{sequence-id}.
9712
9713 @cindex acknowledgment, for @value{GDBN} remote
9714 When either the host or the target machine receives a packet, the first
9715 response expected is an acknowledgment: either @samp{+} (to indicate
9716 the package was received correctly) or @samp{-} (to request
9717 retransmission):
9718
9719 @example
9720 <- @code{$}@var{packet-data}@code{#}@var{checksum}
9721 -> @code{+}
9722 @end example
9723 @noindent
9724
9725 The host (@value{GDBN}) sends @var{command}s, and the target (the
9726 debugging stub incorporated in your program) sends a @var{response}.  In
9727 the case of step and continue @var{command}s, the response is only sent
9728 when the operation has completed (the target has again stopped).
9729
9730 @var{packet-data} consists of a sequence of characters with the
9731 exception of @samp{#} and @samp{$} (see @samp{X} packet for additional
9732 exceptions).
9733
9734 Fields within the packet should be separated using @samp{,} @samp{;} or
9735 @samp{:}.  Except where otherwise noted all numbers are represented in
9736 HEX with leading zeros suppressed.
9737
9738 Implementors should note that prior to @value{GDBN} 5.0, the character
9739 @samp{:} could not appear as the third character in a packet (as it
9740 would potentially conflict with the @var{sequence-id}).
9741
9742 Response @var{data} can be run-length encoded to save space.  A @samp{*}
9743 means that the next character is an @sc{ascii} encoding giving a repeat count
9744 which stands for that many repetitions of the character preceding the
9745 @samp{*}.  The encoding is @code{n+29}, yielding a printable character
9746 where @code{n >=3} (which is where rle starts to win).  The printable
9747 characters @samp{$}, @samp{#}, @samp{+} and @samp{-} or with a numeric
9748 value greater than 126 should not be used.
9749
9750 Some remote systems have used a different run-length encoding mechanism
9751 loosely refered to as the cisco encoding.  Following the @samp{*}
9752 character are two hex digits that indicate the size of the packet.
9753
9754 So:
9755 @example
9756 "@code{0* }"
9757 @end example
9758 @noindent
9759 means the same as "0000".
9760
9761 The error response returned for some packets includes a two character
9762 error number.  That number is not well defined.
9763
9764 For any @var{command} not supported by the stub, an empty response
9765 (@samp{$#00}) should be returned.  That way it is possible to extend the
9766 protocol.  A newer @value{GDBN} can tell if a packet is supported based
9767 on that response.
9768
9769 A stub is required to support the @samp{g}, @samp{G}, @samp{m}, @samp{M}, 
9770 @samp{c}, and @samp{s} @var{command}s.  All other @var{command}s are 
9771 optional.
9772
9773 Below is a complete list of all currently defined @var{command}s and
9774 their corresponding response @var{data}:
9775 @page
9776 @multitable @columnfractions .30 .30 .40
9777 @item Packet
9778 @tab Request
9779 @tab Description
9780
9781 @item extended mode
9782 @tab @code{!}
9783 @tab
9784 Enable extended mode.  In extended mode, the remote server is made
9785 persistent.  The @samp{R} packet is used to restart the program being
9786 debugged.
9787 @item
9788 @tab reply @samp{OK}
9789 @tab
9790 The remote target both supports and has enabled extended mode.
9791
9792 @item last signal
9793 @tab @code{?}
9794 @tab
9795 Indicate the reason the target halted.  The reply is the same as for step
9796 and continue.
9797 @item
9798 @tab reply
9799 @tab see below
9800
9801
9802 @item reserved
9803 @tab @code{a}
9804 @tab Reserved for future use
9805
9806 @item set program arguments @strong{(reserved)}
9807 @tab @code{A}@var{arglen}@code{,}@var{argnum}@code{,}@var{arg}@code{,...}
9808 @tab
9809 @item
9810 @tab
9811 @tab
9812 Initialized @samp{argv[]} array passed into program. @var{arglen}
9813 specifies the number of bytes in the hex encoded byte stream @var{arg}.
9814 See @file{gdbserver} for more details.
9815 @item
9816 @tab reply @code{OK}
9817 @item
9818 @tab reply @code{E}@var{NN}
9819
9820 @item set baud @strong{(deprecated)}
9821 @tab @code{b}@var{baud}
9822 @tab
9823 Change the serial line speed to @var{baud}.  JTC: @emph{When does the
9824 transport layer state change?  When it's received, or after the ACK is
9825 transmitted.  In either case, there are problems if the command or the
9826 acknowledgment packet is dropped.} Stan: @emph{If people really wanted
9827 to add something like this, and get it working for the first time, they
9828 ought to modify ser-unix.c to send some kind of out-of-band message to a
9829 specially-setup stub and have the switch happen "in between" packets, so
9830 that from remote protocol's point of view, nothing actually
9831 happened.}
9832
9833 @item set breakpoint @strong{(deprecated)}
9834 @tab @code{B}@var{addr},@var{mode}
9835 @tab
9836 Set (@var{mode} is @samp{S}) or clear (@var{mode} is @samp{C}) a
9837 breakpoint at @var{addr}.  @emph{This has been replaced by the @samp{Z} and
9838 @samp{z} packets.}
9839
9840 @item continue
9841 @tab @code{c}@var{addr}
9842 @tab
9843 @var{addr} is address to resume. If @var{addr} is omitted, resume at
9844 current address.
9845 @item
9846 @tab reply
9847 @tab see below
9848
9849 @item continue with signal
9850 @tab @code{C}@var{sig}@code{;}@var{addr}
9851 @tab
9852 Continue with signal @var{sig} (hex signal number).  If
9853 @code{;}@var{addr} is omitted, resume at same address.
9854 @item
9855 @tab reply
9856 @tab see below
9857
9858 @item toggle debug @strong{(deprecated)}
9859 @tab @code{d}
9860 @tab
9861 toggle debug flag.
9862
9863 @item detach
9864 @tab @code{D}
9865 @tab
9866 Detach @value{GDBN} from the remote system.  Sent to the remote target before
9867 @value{GDBN} disconnects.
9868 @item
9869 @tab reply @emph{no response}
9870 @tab
9871 @value{GDBN} does not check for any response after sending this packet.
9872
9873 @item reserved
9874 @tab @code{e}
9875 @tab Reserved for future use
9876
9877 @item reserved
9878 @tab @code{E}
9879 @tab Reserved for future use
9880
9881 @item reserved
9882 @tab @code{f}
9883 @tab Reserved for future use
9884
9885 @item reserved
9886 @tab @code{F}
9887 @tab Reserved for future use
9888
9889 @item read registers
9890 @tab @code{g}
9891 @tab Read general registers.
9892 @item
9893 @tab reply @var{XX...}
9894 @tab
9895 Each byte of register data is described by two hex digits.  The bytes
9896 with the register are transmitted in target byte order.  The size of
9897 each register and their position within the @samp{g} @var{packet} are
9898 determined by the @value{GDBN} internal macros @var{REGISTER_RAW_SIZE} and
9899 @var{REGISTER_NAME} macros.  The specification of several standard
9900 @code{g} packets is specified below.
9901 @item
9902 @tab @code{E}@var{NN}
9903 @tab for an error.
9904
9905 @item write regs
9906 @tab @code{G}@var{XX...}
9907 @tab
9908 See @samp{g} for a description of the @var{XX...} data.
9909 @item
9910 @tab reply @code{OK}
9911 @tab for success
9912 @item
9913 @tab reply @code{E}@var{NN}
9914 @tab for an error
9915
9916 @item reserved
9917 @tab @code{h}
9918 @tab Reserved for future use
9919
9920 @item set thread 
9921 @tab @code{H}@var{c}@var{t...}
9922 @tab
9923 Set thread for subsequent operations (@samp{m}, @samp{M}, @samp{g},
9924 @samp{G}, et.al.).  @var{c} = @samp{c} for thread used in step and
9925 continue; @var{t...} can be -1 for all threads.  @var{c} = @samp{g} for
9926 thread used in other operations.  If zero, pick a thread, any thread.
9927 @item
9928 @tab reply @code{OK}
9929 @tab for success
9930 @item
9931 @tab reply @code{E}@var{NN}
9932 @tab for an error
9933
9934 @c FIXME: JTC:
9935 @c   'H': How restrictive (or permissive) is the thread model.  If a
9936 @c        thread is selected and stopped, are other threads allowed
9937 @c        to continue to execute?  As I mentioned above, I think the
9938 @c        semantics of each command when a thread is selected must be
9939 @c        described.  For example:
9940 @c
9941 @c        'g':    If the stub supports threads and a specific thread is
9942 @c                selected, returns the register block from that thread;
9943 @c                otherwise returns current registers.
9944 @c
9945 @c        'G'     If the stub supports threads and a specific thread is
9946 @c                selected, sets the registers of the register block of
9947 @c                that thread; otherwise sets current registers.
9948
9949 @item cycle step @strong{(draft)}
9950 @tab @code{i}@var{addr}@code{,}@var{nnn}
9951 @tab
9952 Step the remote target by a single clock cycle.  If @code{,}@var{nnn} is
9953 present, cycle step @var{nnn} cycles.  If @var{addr} is present, cycle
9954 step starting at that address.
9955
9956 @item signal then cycle step @strong{(reserved)}
9957 @tab @code{I}
9958 @tab
9959 See @samp{i} and @samp{S} for likely syntax and semantics.
9960
9961 @item reserved
9962 @tab @code{j}
9963 @tab Reserved for future use
9964
9965 @item reserved
9966 @tab @code{J}
9967 @tab Reserved for future use
9968
9969 @item kill request
9970 @tab @code{k}
9971 @tab
9972 FIXME: @emph{There is no description of how operate when a specific
9973 thread context has been selected (ie. does 'k' kill only that thread?)}.
9974
9975 @item reserved
9976 @tab @code{l}
9977 @tab Reserved for future use
9978
9979 @item reserved
9980 @tab @code{L}
9981 @tab Reserved for future use
9982
9983 @item read memory
9984 @tab @code{m}@var{addr}@code{,}@var{length}
9985 @tab
9986 Read @var{length} bytes of memory starting at address @var{addr}.
9987 Neither @value{GDBN} nor the stub assume that sized memory transfers are assumed
9988 using word alligned accesses. FIXME: @emph{A word aligned memory
9989 transfer mechanism is needed.}
9990 @item
9991 @tab reply @var{XX...}
9992 @tab
9993 @var{XX...} is mem contents. Can be fewer bytes than requested if able
9994 to read only part of the data.  Neither @value{GDBN} nor the stub assume that
9995 sized memory transfers are assumed using word alligned accesses. FIXME:
9996 @emph{A word aligned memory transfer mechanism is needed.}
9997 @item
9998 @tab reply @code{E}@var{NN}
9999 @tab @var{NN} is errno
10000
10001 @item write mem
10002 @tab @code{M}@var{addr},@var{length}@code{:}@var{XX...}
10003 @tab
10004 Write @var{length} bytes of memory starting at address @var{addr}.
10005 @var{XX...} is the data.
10006 @item
10007 @tab reply @code{OK}
10008 @tab for success
10009 @item
10010 @tab reply @code{E}@var{NN}
10011 @tab
10012 for an error (this includes the case where only part of the data was
10013 written).
10014
10015 @item reserved
10016 @tab @code{n}
10017 @tab Reserved for future use
10018
10019 @item reserved
10020 @tab @code{N}
10021 @tab Reserved for future use
10022
10023 @item reserved
10024 @tab @code{o}
10025 @tab Reserved for future use
10026
10027 @item reserved
10028 @tab @code{O}
10029 @tab Reserved for future use
10030
10031 @item read reg @strong{(reserved)}
10032 @tab @code{p}@var{n...}
10033 @tab
10034 See write register.
10035 @item
10036 @tab return @var{r....}
10037 @tab The hex encoded value of the register in target byte order.
10038
10039 @item write reg
10040 @tab @code{P}@var{n...}@code{=}@var{r...}
10041 @tab
10042 Write register @var{n...} with value @var{r...}, which contains two hex
10043 digits for each byte in the register (target byte order).
10044 @item
10045 @tab reply @code{OK}
10046 @tab for success
10047 @item
10048 @tab reply @code{E}@var{NN}
10049 @tab for an error
10050
10051 @item general query
10052 @tab @code{q}@var{query}
10053 @tab
10054 Request info about @var{query}.  In general @value{GDBN} queries
10055 have a leading upper case letter.  Custom vendor queries should use a
10056 company prefix (in lower case) ex: @samp{qfsf.var}.  @var{query} may
10057 optionally be followed by a @samp{,} or @samp{;} separated list.  Stubs
10058 must ensure that they match the full @var{query} name.
10059 @item
10060 @tab reply @code{XX...}
10061 @tab Hex encoded data from query.  The reply can not be empty.
10062 @item
10063 @tab reply @code{E}@var{NN}
10064 @tab error reply
10065 @item
10066 @tab reply @samp{}
10067 @tab Indicating an unrecognized @var{query}.
10068
10069 @item general set
10070 @tab @code{Q}@var{var}@code{=}@var{val}
10071 @tab
10072 Set value of @var{var} to @var{val}.  See @samp{q} for a discussing of
10073 naming conventions.
10074
10075 @item reset @strong{(deprecated)}
10076 @tab @code{r}
10077 @tab
10078 Reset the entire system.
10079
10080 @item remote restart
10081 @tab @code{R}@var{XX}
10082 @tab
10083 Restart the program being debugged.  @var{XX}, while needed, is ignored.
10084 This packet is only available in extended mode.
10085 @item
10086 @tab
10087 no reply
10088 @tab
10089 The @samp{R} packet has no reply.
10090
10091 @item step
10092 @tab @code{s}@var{addr}
10093 @tab
10094 @var{addr} is address to resume.  If @var{addr} is omitted, resume at
10095 same address.
10096 @item
10097 @tab reply
10098 @tab see below
10099
10100 @item step with signal
10101 @tab @code{S}@var{sig}@code{;}@var{addr}
10102 @tab
10103 Like @samp{C} but step not continue.
10104 @item
10105 @tab reply
10106 @tab see below
10107
10108 @item search 
10109 @tab @code{t}@var{addr}@code{:}@var{PP}@code{,}@var{MM}
10110 @tab
10111 Search backwards starting at address @var{addr} for a match with pattern
10112 @var{PP} and mask @var{MM}.  @var{PP} and @var{MM} are 4
10113 bytes.  @var{addr} must be at least 3 digits.
10114
10115 @item thread alive
10116 @tab @code{T}@var{XX}
10117 @tab Find out if the thread XX is alive.
10118 @item
10119 @tab reply @code{OK}
10120 @tab thread is still alive
10121 @item
10122 @tab reply @code{E}@var{NN}
10123 @tab thread is dead
10124
10125 @item reserved
10126 @tab @code{u}
10127 @tab Reserved for future use
10128
10129 @item reserved
10130 @tab @code{U}
10131 @tab Reserved for future use
10132
10133 @item reserved
10134 @tab @code{v}
10135 @tab Reserved for future use
10136
10137 @item reserved
10138 @tab @code{V}
10139 @tab Reserved for future use
10140
10141 @item reserved
10142 @tab @code{w}
10143 @tab Reserved for future use
10144
10145 @item reserved
10146 @tab @code{W}
10147 @tab Reserved for future use
10148
10149 @item reserved
10150 @tab @code{x}
10151 @tab Reserved for future use
10152
10153 @item write mem (binary)
10154 @tab @code{X}@var{addr}@code{,}@var{length}@var{:}@var{XX...}
10155 @tab
10156 @var{addr} is address, @var{length} is number of bytes, @var{XX...} is
10157 binary data.  The characters @code{$}, @code{#}, and @code{0x7d} are
10158 escaped using @code{0x7d}.
10159 @item
10160 @tab reply @code{OK}
10161 @tab for success
10162 @item
10163 @tab reply @code{E}@var{NN}
10164 @tab for an error
10165
10166 @item reserved
10167 @tab @code{y}
10168 @tab Reserved for future use
10169
10170 @item reserved
10171 @tab @code{Y}
10172 @tab Reserved for future use
10173
10174 @item remove break or watchpoint @strong{(draft)}
10175 @tab @code{z}@var{t}@code{,}@var{addr}@code{,}@var{length}
10176 @tab
10177 See @samp{Z}.
10178
10179 @item insert break or watchpoint @strong{(draft)}
10180 @tab @code{Z}@var{t}@code{,}@var{addr}@code{,}@var{length}
10181 @tab
10182 @var{t} is type: @samp{0} - software breakpoint, @samp{1} - hardware
10183 breakpoint, @samp{2} - write watchpoint, @samp{3} - read watchpoint,
10184 @samp{4} - access watchpoint; @var{addr} is address; @var{length} is in
10185 bytes.  For a software breakpoint, @var{length} specifies the size of
10186 the instruction to be patched.  For hardware breakpoints and watchpoints
10187 @var{length} specifies the memory region to be monitored.  To avoid
10188 potential problems with duplicate packets, the operations should be
10189 implemented in an idempotent way.
10190 @item
10191 @tab reply @code{E}@var{NN}
10192 @tab for an error
10193 @item
10194 @tab reply @code{OK}
10195 @tab for success
10196 @item
10197 @tab @samp{}
10198 @tab If not supported.
10199
10200 @item reserved
10201 @tab <other>
10202 @tab Reserved for future use
10203
10204 @end multitable
10205
10206 The @samp{C}, @samp{c}, @samp{S}, @samp{s} and @samp{?} packets can
10207 receive any of the below as a reply.  In the case of the @samp{C},
10208 @samp{c}, @samp{S} and @samp{s} packets, that reply is only returned
10209 when the target halts.  In the below the exact meaning of @samp{signal
10210 number} is poorly defined.  In general one of the UNIX signal numbering
10211 conventions is used.
10212
10213 @multitable @columnfractions .4 .6
10214
10215 @item @code{S}@var{AA}
10216 @tab @var{AA} is the signal number
10217
10218 @item @code{T}@var{AA}@var{n...}@code{:}@var{r...}@code{;}@var{n...}@code{:}@var{r...}@code{;}@var{n...}@code{:}@var{r...}@code{;}
10219 @tab
10220 @var{AA} = two hex digit signal number; @var{n...} = register number
10221 (hex), @var{r...}  = target byte ordered register contents, size defined
10222 by @code{REGISTER_RAW_SIZE}; @var{n...} = @samp{thread}, @var{r...} =
10223 thread process ID, this is a hex integer; @var{n...} = other string not
10224 starting with valid hex digit.  @value{GDBN} should ignore this
10225 @var{n...}, @var{r...} pair and go on to the next.  This way we can
10226 extend the protocol.
10227
10228 @item @code{W}@var{AA}
10229 @tab
10230 The process exited, and @var{AA} is the exit status.  This is only
10231 applicable for certains sorts of targets.
10232
10233 @item @code{X}@var{AA}
10234 @tab
10235 The process terminated with signal @var{AA}.
10236
10237 @item @code{N}@var{AA}@code{;}@var{t...}@code{;}@var{d...}@code{;}@var{b...} @strong{(obsolete)}
10238 @tab
10239 @var{AA} = signal number; @var{t...} = address of symbol "_start";
10240 @var{d...} = base of data section; @var{b...} = base of bss section.
10241 @emph{Note: only used by Cisco Systems targets.  The difference between
10242 this reply and the "qOffsets" query is that the 'N' packet may arrive
10243 spontaneously whereas the 'qOffsets' is a query initiated by the host
10244 debugger.}
10245
10246 @item @code{O}@var{XX...}
10247 @tab
10248 @var{XX...} is hex encoding of @sc{ascii} data.  This can happen at any time
10249 while the program is running and the debugger should continue to wait
10250 for 'W', 'T', etc.
10251
10252 @end multitable
10253
10254 The following set and query packets have already been defined.
10255
10256 @multitable @columnfractions .2 .2 .6
10257
10258 @item current thread
10259 @tab @code{q}@code{C}
10260 @tab Return the current thread id.
10261 @item
10262 @tab reply @code{QC}@var{pid}
10263 @tab
10264 Where @var{pid} is a HEX encoded 16 bit process id.
10265 @item
10266 @tab reply *
10267 @tab Any other reply implies the old pid.
10268
10269 @item all thread ids
10270 @tab @code{q}@code{fThreadInfo}
10271 @item
10272 @tab @code{q}@code{sThreadInfo}
10273 @tab
10274 Obtain a list of active thread ids from the target (OS).  Since there
10275 may be too many active threads to fit into one reply packet, this query
10276 works iteratively: it may require more than one query/reply sequence to
10277 obtain the entire list of threads.  The first query of the sequence will
10278 be the @code{qf}@code{ThreadInfo} query; subsequent queries in the
10279 sequence will be the @code{qs}@code{ThreadInfo} query.
10280 @item
10281 @tab
10282 @tab NOTE: replaces the @code{qL} query (see below).
10283 @item
10284 @tab reply @code{m}@var{<id>}
10285 @tab A single thread id
10286 @item
10287 @tab reply @code{m}@var{<id>},@var{<id>...}
10288 @tab a comma-separated list of thread ids
10289 @item
10290 @tab reply @code{l}
10291 @tab (lower case 'el') denotes end of list.
10292 @item
10293 @tab
10294 @tab
10295 In response to each query, the target will reply with a list of one
10296 or more thread ids, in big-endian hex, separated by commas.  GDB will
10297 respond to each reply with a request for more thread ids (using the
10298 @code{qs} form of the query), until the target responds with @code{l}
10299 (lower-case el, for @code{'last'}).
10300
10301 @item extra thread info
10302 @tab @code{q}@code{ThreadExtraInfo}@code{,}@var{id}
10303 @tab
10304 @item
10305 @tab
10306 @tab
10307 Where @var{<id>} is a thread-id in big-endian hex.
10308 Obtain a printable string description of a thread's attributes from
10309 the target OS.  This string may contain anything that the target OS
10310 thinks is interesting for @value{GDBN} to tell the user about the thread.
10311 The string is displayed in @value{GDBN}'s @samp{info threads} display.
10312 Some examples of possible thread extra info strings are "Runnable", or
10313 "Blocked on Mutex".
10314 @item
10315 @tab reply @var{XX...}
10316 @tab
10317 Where @var{XX...} is a hex encoding of @sc{ascii} data, comprising the
10318 printable string containing the extra information about the thread's
10319 attributes.
10320
10321 @item query @var{LIST} or @var{threadLIST} @strong{(deprecated)}
10322 @tab @code{q}@code{L}@var{startflag}@var{threadcount}@var{nextthread}
10323 @tab
10324 @item
10325 @tab
10326 @tab
10327 Obtain thread information from RTOS.  Where: @var{startflag} (one hex
10328 digit) is one to indicate the first query and zero to indicate a
10329 subsequent query; @var{threadcount} (two hex digits) is the maximum
10330 number of threads the response packet can contain; and @var{nextthread}
10331 (eight hex digits), for subsequent queries (@var{startflag} is zero), is
10332 returned in the response as @var{argthread}.
10333 @item
10334 @tab
10335 @tab NOTE: this query is replaced by the @code{q}@code{fThreadInfo}
10336 query (see above).
10337 @item
10338 @tab reply @code{q}@code{M}@var{count}@var{done}@var{argthread}@var{thread...}
10339 @tab
10340 @item
10341 @tab
10342 @tab
10343 Where: @var{count} (two hex digits) is the number of threads being
10344 returned; @var{done} (one hex digit) is zero to indicate more threads
10345 and one indicates no further threads; @var{argthreadid} (eight hex
10346 digits) is @var{nextthread} from the request packet; @var{thread...} is
10347 a sequence of thread IDs from the target.  @var{threadid} (eight hex
10348 digits).  See @code{remote.c:parse_threadlist_response()}.
10349
10350 @item compute CRC of memory block
10351 @tab @code{q}@code{CRC:}@var{addr}@code{,}@var{length}
10352 @tab
10353 @item
10354 @tab reply @code{E}@var{NN}
10355 @tab An error (such as memory fault)
10356 @item
10357 @tab reply @code{C}@var{CRC32}
10358 @tab A 32 bit cyclic redundancy check of the specified memory region.
10359
10360 @item query sect offs
10361 @tab @code{q}@code{Offsets}
10362 @tab
10363 Get section offsets that the target used when re-locating the downloaded
10364 image.  @emph{Note: while a @code{Bss} offset is included in the
10365 response, @value{GDBN} ignores this and instead applies the @code{Data}
10366 offset to the @code{Bss} section.}
10367 @item
10368 @tab reply @code{Text=}@var{xxx}@code{;Data=}@var{yyy}@code{;Bss=}@var{zzz}
10369
10370 @item thread info request
10371 @tab @code{q}@code{P}@var{mode}@var{threadid}
10372 @tab
10373 @item
10374 @tab
10375 @tab
10376 Returns information on @var{threadid}.  Where: @var{mode} is a hex
10377 encoded 32 bit mode; @var{threadid} is a hex encoded 64 bit thread ID.
10378 @item
10379 @tab reply *
10380 @tab
10381 See @code{remote.c:remote_unpack_thread_info_response()}.
10382
10383 @item remote command
10384 @tab @code{q}@code{Rcmd,}@var{COMMAND}
10385 @tab
10386 @item
10387 @tab
10388 @tab
10389 @var{COMMAND} (hex encoded) is passed to the local interpreter for
10390 execution.  Invalid commands should be reported using the output string.
10391 Before the final result packet, the target may also respond with a
10392 number of intermediate @code{O}@var{OUTPUT} console output
10393 packets.  @emph{Implementors should note that providing access to a
10394 stubs's interpreter may have security implications}.
10395 @item
10396 @tab reply @code{OK}
10397 @tab
10398 A command response with no output.
10399 @item
10400 @tab reply @var{OUTPUT}
10401 @tab
10402 A command response with the hex encoded output string @var{OUTPUT}.
10403 @item
10404 @tab reply @code{E}@var{NN}
10405 @tab
10406 Indicate a badly formed request.
10407
10408 @item
10409 @tab reply @samp{}
10410 @tab
10411 When @samp{q}@samp{Rcmd} is not recognized.
10412
10413 @item symbol lookup
10414 @tab @code{qSymbol::}
10415 @tab
10416 Notify the target that @value{GDBN} is prepared to serve symbol lookup
10417 requests.  Accept requests from the target for the values of symbols.
10418 @item
10419 @tab
10420 @tab
10421 @item
10422 @tab reply @code{OK}
10423 @tab
10424 The target does not need to look up any (more) symbols.
10425 @item
10426 @tab reply @code{qSymbol:}@var{sym_name}
10427 @tab
10428 The target requests the value of symbol @var{sym_name} (hex encoded).  
10429 @value{GDBN} may provide the value by using the 
10430 @code{qSymbol:}@var{sym_value}:@var{sym_name}
10431 message, described below.
10432
10433 @item symbol value
10434 @tab @code{qSymbol:}@var{sym_value}:@var{sym_name}
10435 @tab
10436 Set the value of SYM_NAME to SYM_VALUE.
10437 @item
10438 @tab
10439 @tab
10440 @var{sym_name} (hex encoded) is the name of a symbol whose value
10441 the target has previously requested.
10442 @item
10443 @tab
10444 @tab
10445 @var{sym_value} (hex) is the value for symbol @var{sym_name}.
10446 If @value{GDBN} cannot supply a value for @var{sym_name}, then this
10447 field will be empty.
10448 @item
10449 @tab reply @code{OK}
10450 @tab
10451 The target does not need to look up any (more) symbols.
10452 @item
10453 @tab reply @code{qSymbol:}@var{sym_name}
10454 @tab
10455 The target requests the value of a new symbol @var{sym_name} (hex encoded).
10456 @value{GDBN} will continue to supply the values of symbols (if available),
10457 until the target ceases to request them.
10458
10459 @end multitable
10460
10461 The following @samp{g}/@samp{G} packets have previously been defined.
10462 In the below, some thirty-two bit registers are transferred as sixty-four
10463 bits.  Those registers should be zero/sign extended (which?) to fill the
10464 space allocated.  Register bytes are transfered in target byte order.
10465 The two nibbles within a register byte are transfered most-significant -
10466 least-significant.
10467
10468 @multitable @columnfractions .5 .5
10469
10470 @item MIPS32
10471 @tab
10472 All registers are transfered as thirty-two bit quantities in the order:
10473 32 general-purpose; sr; lo; hi; bad; cause; pc; 32 floating-point
10474 registers; fsr; fir; fp.
10475
10476 @item MIPS64
10477 @tab
10478 All registers are transfered as sixty-four bit quantities (including
10479 thirty-two bit registers such as @code{sr}).  The ordering is the same
10480 as @code{MIPS32}.
10481
10482 @end multitable
10483
10484 Example sequence of a target being re-started.  Notice how the restart
10485 does not get any direct output:
10486
10487 @example
10488 <- @code{R00}
10489 -> @code{+}
10490 @emph{target restarts}
10491 <- @code{?}
10492 -> @code{+}
10493 -> @code{T001:1234123412341234}
10494 <- @code{+}
10495 @end example
10496
10497 Example sequence of a target being stepped by a single instruction:
10498
10499 @example
10500 <- @code{G1445...}
10501 -> @code{+}
10502 <- @code{s}
10503 -> @code{+}
10504 @emph{time passes}
10505 -> @code{T001:1234123412341234}
10506 <- @code{+}
10507 <- @code{g}
10508 -> @code{+}
10509 -> @code{1455...}
10510 <- @code{+}
10511 @end example
10512
10513 @node Server
10514 @subsubsection Using the @code{gdbserver} program
10515
10516 @kindex gdbserver
10517 @cindex remote connection without stubs
10518 @code{gdbserver} is a control program for Unix-like systems, which
10519 allows you to connect your program with a remote @value{GDBN} via
10520 @code{target remote}---but without linking in the usual debugging stub.
10521
10522 @code{gdbserver} is not a complete replacement for the debugging stubs,
10523 because it requires essentially the same operating-system facilities
10524 that @value{GDBN} itself does.  In fact, a system that can run
10525 @code{gdbserver} to connect to a remote @value{GDBN} could also run
10526 @value{GDBN} locally!  @code{gdbserver} is sometimes useful nevertheless,
10527 because it is a much smaller program than @value{GDBN} itself.  It is
10528 also easier to port than all of @value{GDBN}, so you may be able to get
10529 started more quickly on a new system by using @code{gdbserver}.
10530 Finally, if you develop code for real-time systems, you may find that
10531 the tradeoffs involved in real-time operation make it more convenient to
10532 do as much development work as possible on another system, for example
10533 by cross-compiling.  You can use @code{gdbserver} to make a similar
10534 choice for debugging.
10535
10536 @value{GDBN} and @code{gdbserver} communicate via either a serial line
10537 or a TCP connection, using the standard @value{GDBN} remote serial
10538 protocol.
10539
10540 @table @emph
10541 @item On the target machine,
10542 you need to have a copy of the program you want to debug.
10543 @code{gdbserver} does not need your program's symbol table, so you can
10544 strip the program if necessary to save space.  @value{GDBN} on the host
10545 system does all the symbol handling.
10546
10547 To use the server, you must tell it how to communicate with @value{GDBN};
10548 the name of your program; and the arguments for your program.  The
10549 syntax is:
10550
10551 @smallexample
10552 target> gdbserver @var{comm} @var{program} [ @var{args} @dots{} ]
10553 @end smallexample
10554
10555 @var{comm} is either a device name (to use a serial line) or a TCP
10556 hostname and portnumber.  For example, to debug Emacs with the argument
10557 @samp{foo.txt} and communicate with @value{GDBN} over the serial port
10558 @file{/dev/com1}:
10559
10560 @smallexample
10561 target> gdbserver /dev/com1 emacs foo.txt
10562 @end smallexample
10563
10564 @code{gdbserver} waits passively for the host @value{GDBN} to communicate
10565 with it.
10566
10567 To use a TCP connection instead of a serial line:
10568
10569 @smallexample
10570 target> gdbserver host:2345 emacs foo.txt
10571 @end smallexample
10572
10573 The only difference from the previous example is the first argument,
10574 specifying that you are communicating with the host @value{GDBN} via
10575 TCP.  The @samp{host:2345} argument means that @code{gdbserver} is to
10576 expect a TCP connection from machine @samp{host} to local TCP port 2345.
10577 (Currently, the @samp{host} part is ignored.)  You can choose any number
10578 you want for the port number as long as it does not conflict with any
10579 TCP ports already in use on the target system (for example, @code{23} is
10580 reserved for @code{telnet}).@footnote{If you choose a port number that
10581 conflicts with another service, @code{gdbserver} prints an error message
10582 and exits.}  You must use the same port number with the host @value{GDBN}
10583 @code{target remote} command.
10584
10585 @item On the @value{GDBN} host machine,
10586 you need an unstripped copy of your program, since @value{GDBN} needs
10587 symbols and debugging information.  Start up @value{GDBN} as usual,
10588 using the name of the local copy of your program as the first argument.
10589 (You may also need the @w{@samp{--baud}} option if the serial line is
10590 running at anything other than 9600@dmn{bps}.)  After that, use @code{target
10591 remote} to establish communications with @code{gdbserver}.  Its argument
10592 is either a device name (usually a serial device, like
10593 @file{/dev/ttyb}), or a TCP port descriptor in the form
10594 @code{@var{host}:@var{PORT}}.  For example:
10595
10596 @smallexample
10597 (@value{GDBP}) target remote /dev/ttyb
10598 @end smallexample
10599
10600 @noindent
10601 communicates with the server via serial line @file{/dev/ttyb}, and
10602
10603 @smallexample
10604 (@value{GDBP}) target remote the-target:2345
10605 @end smallexample
10606
10607 @noindent
10608 communicates via a TCP connection to port 2345 on host @w{@file{the-target}}.
10609 For TCP connections, you must start up @code{gdbserver} prior to using
10610 the @code{target remote} command.  Otherwise you may get an error whose
10611 text depends on the host system, but which usually looks something like
10612 @samp{Connection refused}.
10613 @end table
10614
10615 @node NetWare
10616 @subsubsection Using the @code{gdbserve.nlm} program
10617
10618 @kindex gdbserve.nlm
10619 @code{gdbserve.nlm} is a control program for NetWare systems, which
10620 allows you to connect your program with a remote @value{GDBN} via
10621 @code{target remote}.
10622
10623 @value{GDBN} and @code{gdbserve.nlm} communicate via a serial line,
10624 using the standard @value{GDBN} remote serial protocol.
10625
10626 @table @emph
10627 @item On the target machine,
10628 you need to have a copy of the program you want to debug.
10629 @code{gdbserve.nlm} does not need your program's symbol table, so you
10630 can strip the program if necessary to save space.  @value{GDBN} on the
10631 host system does all the symbol handling.
10632
10633 To use the server, you must tell it how to communicate with
10634 @value{GDBN}; the name of your program; and the arguments for your
10635 program.  The syntax is:
10636
10637 @smallexample
10638 load gdbserve [ BOARD=@var{board} ] [ PORT=@var{port} ]
10639               [ BAUD=@var{baud} ] @var{program} [ @var{args} @dots{} ]
10640 @end smallexample
10641
10642 @var{board} and @var{port} specify the serial line; @var{baud} specifies
10643 the baud rate used by the connection.  @var{port} and @var{node} default
10644 to 0, @var{baud} defaults to 9600@dmn{bps}.
10645
10646 For example, to debug Emacs with the argument @samp{foo.txt}and
10647 communicate with @value{GDBN} over serial port number 2 or board 1
10648 using a 19200@dmn{bps} connection:
10649
10650 @smallexample
10651 load gdbserve BOARD=1 PORT=2 BAUD=19200 emacs foo.txt
10652 @end smallexample
10653
10654 @item On the @value{GDBN} host machine,
10655 you need an unstripped copy of your program, since @value{GDBN} needs
10656 symbols and debugging information.  Start up @value{GDBN} as usual,
10657 using the name of the local copy of your program as the first argument.
10658 (You may also need the @w{@samp{--baud}} option if the serial line is
10659 running at anything other than 9600@dmn{bps}.  After that, use @code{target
10660 remote} to establish communications with @code{gdbserve.nlm}.  Its
10661 argument is a device name (usually a serial device, like
10662 @file{/dev/ttyb}).  For example:
10663
10664 @smallexample
10665 (@value{GDBP}) target remote /dev/ttyb
10666 @end smallexample
10667
10668 @noindent
10669 communications with the server via serial line @file{/dev/ttyb}.
10670 @end table
10671
10672 @node KOD
10673 @section Kernel Object Display
10674
10675 @cindex kernel object display
10676 @cindex kernel object
10677 @cindex KOD
10678
10679 Some targets support kernel object display.  Using this facility,
10680 @value{GDBN} communicates specially with the underlying operating system
10681 and can display information about operating system-level objects such as
10682 mutexes and other synchronization objects.  Exactly which objects can be
10683 displayed is determined on a per-OS basis.
10684
10685 Use the @code{set os} command to set the operating system.  This tells
10686 @value{GDBN} which kernel object display module to initialize:
10687
10688 @example
10689 (@value{GDBP}) set os cisco
10690 @end example
10691
10692 If @code{set os} succeeds, @value{GDBN} will display some information
10693 about the operating system, and will create a new @code{info} command
10694 which can be used to query the target.  The @code{info} command is named
10695 after the operating system:
10696
10697 @example
10698 (@value{GDBP}) info cisco
10699 List of Cisco Kernel Objects
10700 Object     Description
10701 any        Any and all objects
10702 @end example
10703
10704 Further subcommands can be used to query about particular objects known
10705 by the kernel.
10706
10707 There is currently no way to determine whether a given operating system
10708 is supported other than to try it.
10709
10710
10711 @node Configurations
10712 @chapter Configuration-Specific Information
10713
10714 While nearly all @value{GDBN} commands are available for all native and
10715 cross versions of the debugger, there are some exceptions.  This chapter
10716 describes things that are only available in certain configurations.
10717
10718 There are three major categories of configurations: native
10719 configurations, where the host and target are the same, embedded
10720 operating system configurations, which are usually the same for several
10721 different processor architectures, and bare embedded processors, which
10722 are quite different from each other.
10723
10724 @menu
10725 * Native::
10726 * Embedded OS::
10727 * Embedded Processors::
10728 * Architectures::
10729 @end menu
10730
10731 @node Native
10732 @section Native
10733
10734 This section describes details specific to particular native
10735 configurations.
10736
10737 @menu
10738 * HP-UX::                       HP-UX
10739 * SVR4 Process Information::    SVR4 process information
10740 @end menu
10741
10742 @node HP-UX
10743 @subsection HP-UX
10744
10745 On HP-UX systems, if you refer to a function or variable name that
10746 begins with a dollar sign, @value{GDBN} searches for a user or system
10747 name first, before it searches for a convenience variable.
10748
10749 @node SVR4 Process Information
10750 @subsection SVR4 process information
10751
10752 @kindex /proc
10753 @cindex process image
10754
10755 Many versions of SVR4 provide a facility called @samp{/proc} that can be
10756 used to examine the image of a running process using file-system
10757 subroutines.  If @value{GDBN} is configured for an operating system with
10758 this facility, the command @code{info proc} is available to report on
10759 several kinds of information about the process running your program.
10760 @code{info proc} works only on SVR4 systems that include the
10761 @code{procfs} code.  This includes OSF/1 (Digital Unix), Solaris, Irix,
10762 and Unixware, but not HP-UX or Linux, for example.
10763
10764 @table @code
10765 @kindex info proc
10766 @item info proc
10767 Summarize available information about the process.
10768
10769 @kindex info proc mappings
10770 @item info proc mappings
10771 Report on the address ranges accessible in the program, with information
10772 on whether your program may read, write, or execute each range.
10773
10774 @kindex info proc times
10775 @item info proc times
10776 Starting time, user CPU time, and system CPU time for your program and
10777 its children.
10778
10779 @kindex info proc id
10780 @item info proc id
10781 Report on the process IDs related to your program: its own process ID,
10782 the ID of its parent, the process group ID, and the session ID.
10783
10784 @kindex info proc status
10785 @item info proc status
10786 General information on the state of the process.  If the process is
10787 stopped, this report includes the reason for stopping, and any signal
10788 received.
10789
10790 @item info proc all
10791 Show all the above information about the process.
10792 @end table
10793
10794 @node Embedded OS
10795 @section Embedded Operating Systems
10796
10797 This section describes configurations involving the debugging of
10798 embedded operating systems that are available for several different
10799 architectures.
10800
10801 @menu
10802 * VxWorks::                     Using @value{GDBN} with VxWorks
10803 @end menu
10804
10805 @value{GDBN} includes the ability to debug programs running on
10806 various real-time operating systems.
10807
10808 @node VxWorks
10809 @subsection Using @value{GDBN} with VxWorks
10810
10811 @cindex VxWorks
10812
10813 @table @code
10814
10815 @kindex target vxworks
10816 @item target vxworks @var{machinename}
10817 A VxWorks system, attached via TCP/IP.  The argument @var{machinename}
10818 is the target system's machine name or IP address.
10819
10820 @end table
10821
10822 On VxWorks, @code{load} links @var{filename} dynamically on the
10823 current target system as well as adding its symbols in @value{GDBN}.
10824
10825 @value{GDBN} enables developers to spawn and debug tasks running on networked
10826 VxWorks targets from a Unix host.  Already-running tasks spawned from
10827 the VxWorks shell can also be debugged.  @value{GDBN} uses code that runs on
10828 both the Unix host and on the VxWorks target.  The program
10829 @code{@value{GDBP}} is installed and executed on the Unix host.  (It may be
10830 installed with the name @code{vxgdb}, to distinguish it from a
10831 @value{GDBN} for debugging programs on the host itself.)
10832
10833 @table @code
10834 @item VxWorks-timeout @var{args}
10835 @kindex vxworks-timeout
10836 All VxWorks-based targets now support the option @code{vxworks-timeout}.
10837 This option is set by the user, and  @var{args} represents the number of
10838 seconds @value{GDBN} waits for responses to rpc's.  You might use this if
10839 your VxWorks target is a slow software simulator or is on the far side
10840 of a thin network line.
10841 @end table
10842
10843 The following information on connecting to VxWorks was current when
10844 this manual was produced; newer releases of VxWorks may use revised
10845 procedures.
10846
10847 @kindex INCLUDE_RDB
10848 To use @value{GDBN} with VxWorks, you must rebuild your VxWorks kernel
10849 to include the remote debugging interface routines in the VxWorks
10850 library @file{rdb.a}.  To do this, define @code{INCLUDE_RDB} in the
10851 VxWorks configuration file @file{configAll.h} and rebuild your VxWorks
10852 kernel.  The resulting kernel contains @file{rdb.a}, and spawns the
10853 source debugging task @code{tRdbTask} when VxWorks is booted.  For more
10854 information on configuring and remaking VxWorks, see the manufacturer's
10855 manual.
10856 @c VxWorks, see the @cite{VxWorks Programmer's Guide}.
10857
10858 Once you have included @file{rdb.a} in your VxWorks system image and set
10859 your Unix execution search path to find @value{GDBN}, you are ready to
10860 run @value{GDBN}.  From your Unix host, run @code{@value{GDBP}} (or
10861 @code{vxgdb}, depending on your installation).
10862
10863 @value{GDBN} comes up showing the prompt:
10864
10865 @example
10866 (vxgdb)
10867 @end example
10868
10869 @menu
10870 * VxWorks Connection::          Connecting to VxWorks
10871 * VxWorks Download::            VxWorks download
10872 * VxWorks Attach::              Running tasks
10873 @end menu
10874
10875 @node VxWorks Connection
10876 @subsubsection Connecting to VxWorks
10877
10878 The @value{GDBN} command @code{target} lets you connect to a VxWorks target on the
10879 network.  To connect to a target whose host name is ``@code{tt}'', type:
10880
10881 @example
10882 (vxgdb) target vxworks tt
10883 @end example
10884
10885 @need 750
10886 @value{GDBN} displays messages like these:
10887
10888 @smallexample
10889 Attaching remote machine across net...
10890 Connected to tt.
10891 @end smallexample
10892
10893 @need 1000
10894 @value{GDBN} then attempts to read the symbol tables of any object modules
10895 loaded into the VxWorks target since it was last booted.  @value{GDBN} locates
10896 these files by searching the directories listed in the command search
10897 path (@pxref{Environment, ,Your program's environment}); if it fails
10898 to find an object file, it displays a message such as:
10899
10900 @example
10901 prog.o: No such file or directory.
10902 @end example
10903
10904 When this happens, add the appropriate directory to the search path with
10905 the @value{GDBN} command @code{path}, and execute the @code{target}
10906 command again.
10907
10908 @node VxWorks Download
10909 @subsubsection VxWorks download
10910
10911 @cindex download to VxWorks
10912 If you have connected to the VxWorks target and you want to debug an
10913 object that has not yet been loaded, you can use the @value{GDBN}
10914 @code{load} command to download a file from Unix to VxWorks
10915 incrementally.  The object file given as an argument to the @code{load}
10916 command is actually opened twice: first by the VxWorks target in order
10917 to download the code, then by @value{GDBN} in order to read the symbol
10918 table.  This can lead to problems if the current working directories on
10919 the two systems differ.  If both systems have NFS mounted the same
10920 filesystems, you can avoid these problems by using absolute paths.
10921 Otherwise, it is simplest to set the working directory on both systems
10922 to the directory in which the object file resides, and then to reference
10923 the file by its name, without any path.  For instance, a program
10924 @file{prog.o} may reside in @file{@var{vxpath}/vw/demo/rdb} in VxWorks
10925 and in @file{@var{hostpath}/vw/demo/rdb} on the host.  To load this
10926 program, type this on VxWorks:
10927
10928 @example
10929 -> cd "@var{vxpath}/vw/demo/rdb"
10930 @end example
10931
10932 @noindent
10933 Then, in @value{GDBN}, type:
10934
10935 @example
10936 (vxgdb) cd @var{hostpath}/vw/demo/rdb
10937 (vxgdb) load prog.o
10938 @end example
10939
10940 @value{GDBN} displays a response similar to this:
10941
10942 @smallexample
10943 Reading symbol data from wherever/vw/demo/rdb/prog.o... done.
10944 @end smallexample
10945
10946 You can also use the @code{load} command to reload an object module
10947 after editing and recompiling the corresponding source file.  Note that
10948 this makes @value{GDBN} delete all currently-defined breakpoints,
10949 auto-displays, and convenience variables, and to clear the value
10950 history.  (This is necessary in order to preserve the integrity of
10951 debugger's data structures that reference the target system's symbol
10952 table.)
10953
10954 @node VxWorks Attach
10955 @subsubsection Running tasks
10956
10957 @cindex running VxWorks tasks
10958 You can also attach to an existing task using the @code{attach} command as
10959 follows:
10960
10961 @example
10962 (vxgdb) attach @var{task}
10963 @end example
10964
10965 @noindent
10966 where @var{task} is the VxWorks hexadecimal task ID.  The task can be running
10967 or suspended when you attach to it.  Running tasks are suspended at
10968 the time of attachment.
10969
10970 @node Embedded Processors
10971 @section Embedded Processors
10972
10973 This section goes into details specific to particular embedded
10974 configurations.
10975
10976 @menu
10977 * A29K Embedded::               AMD A29K Embedded
10978 * ARM::                         ARM
10979 * H8/300::                      Hitachi H8/300
10980 * H8/500::                      Hitachi H8/500
10981 * i960::                        Intel i960
10982 * M32R/D::                      Mitsubishi M32R/D
10983 * M68K::                        Motorola M68K
10984 * M88K::                        Motorola M88K
10985 * MIPS Embedded::               MIPS Embedded
10986 * PA::                          HP PA Embedded
10987 * PowerPC:                      PowerPC
10988 * SH::                          Hitachi SH
10989 * Sparclet::                    Tsqware Sparclet
10990 * Sparclite::                   Fujitsu Sparclite
10991 * ST2000::                      Tandem ST2000
10992 * Z8000::                       Zilog Z8000
10993 @end menu
10994
10995 @node A29K Embedded
10996 @subsection AMD A29K Embedded
10997
10998 @menu
10999 * A29K UDI::
11000 * A29K EB29K::
11001 * Comms (EB29K)::               Communications setup
11002 * gdb-EB29K::                   EB29K cross-debugging
11003 * Remote Log::                  Remote log
11004 @end menu
11005
11006 @table @code
11007
11008 @kindex target adapt
11009 @item target adapt @var{dev}
11010 Adapt monitor for A29K.
11011
11012 @kindex target amd-eb
11013 @item target amd-eb @var{dev} @var{speed} @var{PROG}
11014 @cindex AMD EB29K
11015 Remote PC-resident AMD EB29K board, attached over serial lines.
11016 @var{dev} is the serial device, as for @code{target remote};
11017 @var{speed} allows you to specify the linespeed; and @var{PROG} is the
11018 name of the program to be debugged, as it appears to DOS on the PC.
11019 @xref{A29K EB29K, ,EBMON protocol for AMD29K}.
11020
11021 @end table
11022
11023 @node A29K UDI
11024 @subsubsection A29K UDI
11025
11026 @cindex UDI
11027 @cindex AMD29K via UDI
11028
11029 @value{GDBN} supports AMD's UDI (``Universal Debugger Interface'')
11030 protocol for debugging the a29k processor family.  To use this
11031 configuration with AMD targets running the MiniMON monitor, you need the
11032 program @code{MONTIP}, available from AMD at no charge.  You can also
11033 use @value{GDBN} with the UDI-conformant a29k simulator program
11034 @code{ISSTIP}, also available from AMD.
11035
11036 @table @code
11037 @item target udi @var{keyword}
11038 @kindex udi
11039 Select the UDI interface to a remote a29k board or simulator, where
11040 @var{keyword} is an entry in the AMD configuration file @file{udi_soc}.
11041 This file contains keyword entries which specify parameters used to
11042 connect to a29k targets.  If the @file{udi_soc} file is not in your
11043 working directory, you must set the environment variable @samp{UDICONF}
11044 to its pathname.
11045 @end table
11046
11047 @node A29K EB29K
11048 @subsubsection EBMON protocol for AMD29K
11049
11050 @cindex EB29K board
11051 @cindex running 29K programs
11052
11053 AMD distributes a 29K development board meant to fit in a PC, together
11054 with a DOS-hosted monitor program called @code{EBMON}.  As a shorthand
11055 term, this development system is called the ``EB29K''.  To use
11056 @value{GDBN} from a Unix system to run programs on the EB29K board, you
11057 must first connect a serial cable between the PC (which hosts the EB29K
11058 board) and a serial port on the Unix system.  In the following, we
11059 assume you've hooked the cable between the PC's @file{COM1} port and
11060 @file{/dev/ttya} on the Unix system.
11061
11062 @node Comms (EB29K)
11063 @subsubsection Communications setup
11064
11065 The next step is to set up the PC's port, by doing something like this
11066 in DOS on the PC:
11067
11068 @example
11069 C:\> MODE com1:9600,n,8,1,none
11070 @end example
11071
11072 @noindent
11073 This example---run on an MS DOS 4.0 system---sets the PC port to 9600
11074 bps, no parity, eight data bits, one stop bit, and no ``retry'' action;
11075 you must match the communications parameters when establishing the Unix
11076 end of the connection as well.
11077 @c FIXME: Who knows what this "no retry action" crud from the DOS manual may
11078 @c       mean?  It's optional; leave it out? ---doc@cygnus.com, 25feb91
11079 @c
11080 @c It's optional, but it's unwise to omit it: who knows what is the
11081 @c default value set when the DOS machines boots?  "No retry" means that
11082 @c the DOS serial device driver won't retry the operation if it fails;
11083 @c I understand that this is needed because the GDB serial protocol
11084 @c handles any errors and retransmissions itself. ---Eli Zaretskii, 3sep99
11085
11086 To give control of the PC to the Unix side of the serial line, type
11087 the following at the DOS console:
11088
11089 @example
11090 C:\> CTTY com1
11091 @end example
11092
11093 @noindent
11094 (Later, if you wish to return control to the DOS console, you can use
11095 the command @code{CTTY con}---but you must send it over the device that
11096 had control, in our example over the @file{COM1} serial line.)
11097
11098 From the Unix host, use a communications program such as @code{tip} or
11099 @code{cu} to communicate with the PC; for example,
11100
11101 @example
11102 cu -s 9600 -l /dev/ttya
11103 @end example
11104
11105 @noindent
11106 The @code{cu} options shown specify, respectively, the linespeed and the
11107 serial port to use.  If you use @code{tip} instead, your command line
11108 may look something like the following:
11109
11110 @example
11111 tip -9600 /dev/ttya
11112 @end example
11113
11114 @noindent
11115 Your system may require a different name where we show
11116 @file{/dev/ttya} as the argument to @code{tip}.  The communications
11117 parameters, including which port to use, are associated with the
11118 @code{tip} argument in the ``remote'' descriptions file---normally the
11119 system table @file{/etc/remote}.
11120 @c FIXME: What if anything needs doing to match the "n,8,1,none" part of
11121 @c the DOS side's comms setup?  cu can support -o (odd
11122 @c parity), -e (even parity)---apparently no settings for no parity or
11123 @c for character size.  Taken from stty maybe...?  John points out tip
11124 @c can set these as internal variables, eg ~s parity=none; man stty
11125 @c suggests that it *might* work to stty these options with stdin or
11126 @c stdout redirected... ---doc@cygnus.com, 25feb91
11127 @c
11128 @c There's nothing to be done for the "none" part of the DOS MODE
11129 @c command.  The rest of the parameters should be matched by the
11130 @c baudrate, bits, and parity used by the Unix side. ---Eli Zaretskii, 3Sep99
11131
11132 @kindex EBMON
11133 Using the @code{tip} or @code{cu} connection, change the DOS working
11134 directory to the directory containing a copy of your 29K program, then
11135 start the PC program @code{EBMON} (an EB29K control program supplied
11136 with your board by AMD).  You should see an initial display from
11137 @code{EBMON} similar to the one that follows, ending with the
11138 @code{EBMON} prompt @samp{#}---
11139
11140 @example
11141 C:\> G:
11142
11143 G:\> CD \usr\joe\work29k
11144
11145 G:\USR\JOE\WORK29K> EBMON
11146 Am29000 PC Coprocessor Board Monitor, version 3.0-18
11147 Copyright 1990 Advanced Micro Devices, Inc.
11148 Written by Gibbons and Associates, Inc.
11149
11150 Enter '?' or 'H' for help
11151
11152 PC Coprocessor Type   = EB29K
11153 I/O Base              = 0x208
11154 Memory Base           = 0xd0000
11155
11156 Data Memory Size      = 2048KB
11157 Available I-RAM Range = 0x8000 to 0x1fffff
11158 Available D-RAM Range = 0x80002000 to 0x801fffff
11159
11160 PageSize              = 0x400
11161 Register Stack Size   = 0x800
11162 Memory Stack Size     = 0x1800
11163
11164 CPU PRL               = 0x3
11165 Am29027 Available     = No
11166 Byte Write Available  = Yes
11167
11168 # ~.
11169 @end example
11170
11171 Then exit the @code{cu} or @code{tip} program (done in the example by
11172 typing @code{~.} at the @code{EBMON} prompt).  @code{EBMON} keeps
11173 running, ready for @value{GDBN} to take over.
11174
11175 For this example, we've assumed what is probably the most convenient
11176 way to make sure the same 29K program is on both the PC and the Unix
11177 system: a PC/NFS connection that establishes ``drive @file{G:}'' on the
11178 PC as a file system on the Unix host.  If you do not have PC/NFS or
11179 something similar connecting the two systems, you must arrange some
11180 other way---perhaps floppy-disk transfer---of getting the 29K program
11181 from the Unix system to the PC; @value{GDBN} does @emph{not} download it over the
11182 serial line.
11183
11184 @node gdb-EB29K
11185 @subsubsection EB29K cross-debugging
11186
11187 Finally, @code{cd} to the directory containing an image of your 29K
11188 program on the Unix system, and start @value{GDBN}---specifying as argument the
11189 name of your 29K program:
11190
11191 @example
11192 cd /usr/joe/work29k
11193 @value{GDBP} myfoo
11194 @end example
11195
11196 @need 500
11197 Now you can use the @code{target} command:
11198
11199 @example
11200 target amd-eb /dev/ttya 9600 MYFOO
11201 @c FIXME: test above 'target amd-eb' as spelled, with caps!  caps are meant to
11202 @c emphasize that this is the name as seen by DOS (since I think DOS is
11203 @c single-minded about case of letters).  ---doc@cygnus.com, 25feb91
11204 @end example
11205
11206 @noindent
11207 In this example, we've assumed your program is in a file called
11208 @file{myfoo}.  Note that the filename given as the last argument to
11209 @code{target amd-eb} should be the name of the program as it appears to DOS.
11210 In our example this is simply @code{MYFOO}, but in general it can include
11211 a DOS path, and depending on your transfer mechanism may not resemble
11212 the name on the Unix side.
11213
11214 At this point, you can set any breakpoints you wish; when you are ready
11215 to see your program run on the 29K board, use the @value{GDBN} command
11216 @code{run}.
11217
11218 To stop debugging the remote program, use the @value{GDBN} @code{detach}
11219 command.
11220
11221 To return control of the PC to its console, use @code{tip} or @code{cu}
11222 once again, after your @value{GDBN} session has concluded, to attach to
11223 @code{EBMON}.  You can then type the command @code{q} to shut down
11224 @code{EBMON}, returning control to the DOS command-line interpreter.
11225 Type @kbd{CTTY con} to return command input to the main DOS console,
11226 and type @kbd{~.} to leave @code{tip} or @code{cu}.
11227
11228 @node Remote Log
11229 @subsubsection Remote log
11230 @cindex @file{eb.log}, a log file for EB29K
11231 @cindex log file for EB29K
11232
11233 The @code{target amd-eb} command creates a file @file{eb.log} in the
11234 current working directory, to help debug problems with the connection.
11235 @file{eb.log} records all the output from @code{EBMON}, including echoes
11236 of the commands sent to it.  Running @samp{tail -f} on this file in
11237 another window often helps to understand trouble with @code{EBMON}, or
11238 unexpected events on the PC side of the connection.
11239
11240 @node ARM
11241 @subsection ARM
11242
11243 @table @code
11244
11245 @kindex target rdi
11246 @item target rdi @var{dev}
11247 ARM Angel monitor, via RDI library interface to ADP protocol.  You may
11248 use this target to communicate with both boards running the Angel
11249 monitor, or with the EmbeddedICE JTAG debug device.
11250
11251 @kindex target rdp
11252 @item target rdp @var{dev}
11253 ARM Demon monitor.
11254
11255 @end table
11256
11257 @node H8/300
11258 @subsection Hitachi H8/300
11259
11260 @table @code
11261
11262 @kindex target hms@r{, with H8/300}
11263 @item target hms @var{dev}
11264 A Hitachi SH, H8/300, or H8/500 board, attached via serial line to your host.
11265 Use special commands @code{device} and @code{speed} to control the serial
11266 line and the communications speed used.
11267
11268 @kindex target e7000@r{, with H8/300}
11269 @item target e7000 @var{dev}
11270 E7000 emulator for Hitachi H8 and SH.
11271
11272 @kindex target sh3@r{, with H8/300}
11273 @kindex target sh3e@r{, with H8/300}
11274 @item target sh3 @var{dev}
11275 @itemx target sh3e @var{dev}
11276 Hitachi SH-3 and SH-3E target systems.
11277
11278 @end table
11279
11280 @cindex download to H8/300 or H8/500
11281 @cindex H8/300 or H8/500 download
11282 @cindex download to Hitachi SH
11283 @cindex Hitachi SH download
11284 When you select remote debugging to a Hitachi SH, H8/300, or H8/500
11285 board, the @code{load} command downloads your program to the Hitachi
11286 board and also opens it as the current executable target for
11287 @value{GDBN} on your host (like the @code{file} command).
11288
11289 @value{GDBN} needs to know these things to talk to your
11290 Hitachi SH, H8/300, or H8/500:
11291
11292 @enumerate
11293 @item
11294 that you want to use @samp{target hms}, the remote debugging interface
11295 for Hitachi microprocessors, or @samp{target e7000}, the in-circuit
11296 emulator for the Hitachi SH and the Hitachi 300H.  (@samp{target hms} is
11297 the default when @value{GDBN} is configured specifically for the Hitachi SH,
11298 H8/300, or H8/500.)
11299
11300 @item
11301 what serial device connects your host to your Hitachi board (the first
11302 serial device available on your host is the default).
11303
11304 @item
11305 what speed to use over the serial device.
11306 @end enumerate
11307
11308 @menu
11309 * Hitachi Boards::      Connecting to Hitachi boards.
11310 * Hitachi ICE::         Using the E7000 In-Circuit Emulator.
11311 * Hitachi Special::     Special @value{GDBN} commands for Hitachi micros.
11312 @end menu
11313
11314 @node Hitachi Boards
11315 @subsubsection Connecting to Hitachi boards
11316
11317 @c only for Unix hosts
11318 @kindex device
11319 @cindex serial device, Hitachi micros
11320 Use the special @code{@value{GDBN}} command @samp{device @var{port}} if you
11321 need to explicitly set the serial device.  The default @var{port} is the
11322 first available port on your host.  This is only necessary on Unix
11323 hosts, where it is typically something like @file{/dev/ttya}.
11324
11325 @kindex speed
11326 @cindex serial line speed, Hitachi micros
11327 @code{@value{GDBN}} has another special command to set the communications
11328 speed: @samp{speed @var{bps}}.  This command also is only used from Unix
11329 hosts; on DOS hosts, set the line speed as usual from outside @value{GDBN} with
11330 the DOS @code{mode} command (for instance,
11331 @w{@kbd{mode com2:9600,n,8,1,p}} for a 9600@dmn{bps} connection).
11332
11333 The @samp{device} and @samp{speed} commands are available only when you
11334 use a Unix host to debug your Hitachi microprocessor programs.  If you
11335 use a DOS host,
11336 @value{GDBN} depends on an auxiliary terminate-and-stay-resident program
11337 called @code{asynctsr} to communicate with the development board
11338 through a PC serial port.  You must also use the DOS @code{mode} command
11339 to set up the serial port on the DOS side.
11340
11341 The following sample session illustrates the steps needed to start a
11342 program under @value{GDBN} control on an H8/300.  The example uses a
11343 sample H8/300 program called @file{t.x}.  The procedure is the same for
11344 the Hitachi SH and the H8/500.
11345
11346 First hook up your development board.  In this example, we use a
11347 board attached to serial port @code{COM2}; if you use a different serial
11348 port, substitute its name in the argument of the @code{mode} command.
11349 When you call @code{asynctsr}, the auxiliary comms program used by the
11350 debugger, you give it just the numeric part of the serial port's name;
11351 for example, @samp{asyncstr 2} below runs @code{asyncstr} on
11352 @code{COM2}.
11353
11354 @example
11355 C:\H8300\TEST> asynctsr 2
11356 C:\H8300\TEST> mode com2:9600,n,8,1,p
11357
11358 Resident portion of MODE loaded
11359
11360 COM2: 9600, n, 8, 1, p
11361
11362 @end example
11363
11364 @quotation
11365 @emph{Warning:} We have noticed a bug in PC-NFS that conflicts with
11366 @code{asynctsr}.  If you also run PC-NFS on your DOS host, you may need to
11367 disable it, or even boot without it, to use @code{asynctsr} to control
11368 your development board.
11369 @end quotation
11370
11371 @kindex target hms@r{, and serial protocol}
11372 Now that serial communications are set up, and the development board is
11373 connected, you can start up @value{GDBN}.  Call @code{@value{GDBP}} with
11374 the name of your program as the argument.  @code{@value{GDBN}} prompts
11375 you, as usual, with the prompt @samp{(@value{GDBP})}.  Use two special
11376 commands to begin your debugging session: @samp{target hms} to specify
11377 cross-debugging to the Hitachi board, and the @code{load} command to
11378 download your program to the board.  @code{load} displays the names of
11379 the program's sections, and a @samp{*} for each 2K of data downloaded.
11380 (If you want to refresh @value{GDBN} data on symbols or on the
11381 executable file without downloading, use the @value{GDBN} commands
11382 @code{file} or @code{symbol-file}.  These commands, and @code{load}
11383 itself, are described in @ref{Files,,Commands to specify files}.)
11384
11385 @smallexample
11386 (eg-C:\H8300\TEST) @value{GDBP} t.x
11387 @value{GDBN} is free software and you are welcome to distribute copies
11388  of it under certain conditions; type "show copying" to see
11389  the conditions.
11390 There is absolutely no warranty for @value{GDBN}; type "show warranty"
11391 for details.
11392 @value{GDBN} @value{GDBVN}, Copyright 1992 Free Software Foundation, Inc...
11393 (@value{GDBP}) target hms
11394 Connected to remote H8/300 HMS system.
11395 (@value{GDBP}) load t.x
11396 .text   : 0x8000 .. 0xabde ***********
11397 .data   : 0xabde .. 0xad30 *
11398 .stack  : 0xf000 .. 0xf014 *
11399 @end smallexample
11400
11401 At this point, you're ready to run or debug your program.  From here on,
11402 you can use all the usual @value{GDBN} commands.  The @code{break} command
11403 sets breakpoints; the @code{run} command starts your program;
11404 @code{print} or @code{x} display data; the @code{continue} command
11405 resumes execution after stopping at a breakpoint.  You can use the
11406 @code{help} command at any time to find out more about @value{GDBN} commands.
11407
11408 Remember, however, that @emph{operating system} facilities aren't
11409 available on your development board; for example, if your program hangs,
11410 you can't send an interrupt---but you can press the @sc{reset} switch!
11411
11412 Use the @sc{reset} button on the development board
11413 @itemize @bullet
11414 @item
11415 to interrupt your program (don't use @kbd{ctl-C} on the DOS host---it has
11416 no way to pass an interrupt signal to the development board); and
11417
11418 @item
11419 to return to the @value{GDBN} command prompt after your program finishes
11420 normally.  The communications protocol provides no other way for @value{GDBN}
11421 to detect program completion.
11422 @end itemize
11423
11424 In either case, @value{GDBN} sees the effect of a @sc{reset} on the
11425 development board as a ``normal exit'' of your program.
11426
11427 @node Hitachi ICE
11428 @subsubsection Using the E7000 in-circuit emulator
11429
11430 @kindex target e7000@r{, with Hitachi ICE}
11431 You can use the E7000 in-circuit emulator to develop code for either the
11432 Hitachi SH or the H8/300H.  Use one of these forms of the @samp{target
11433 e7000} command to connect @value{GDBN} to your E7000:
11434
11435 @table @code
11436 @item target e7000 @var{port} @var{speed}
11437 Use this form if your E7000 is connected to a serial port.  The
11438 @var{port} argument identifies what serial port to use (for example,
11439 @samp{com2}).  The third argument is the line speed in bits per second
11440 (for example, @samp{9600}).
11441
11442 @item target e7000 @var{hostname}
11443 If your E7000 is installed as a host on a TCP/IP network, you can just
11444 specify its hostname; @value{GDBN} uses @code{telnet} to connect.
11445 @end table
11446
11447 @node Hitachi Special
11448 @subsubsection Special @value{GDBN} commands for Hitachi micros
11449
11450 Some @value{GDBN} commands are available only for the H8/300:
11451
11452 @table @code
11453
11454 @kindex set machine
11455 @kindex show machine
11456 @item set machine h8300
11457 @itemx set machine h8300h
11458 Condition @value{GDBN} for one of the two variants of the H8/300
11459 architecture with @samp{set machine}.  You can use @samp{show machine}
11460 to check which variant is currently in effect.
11461
11462 @end table
11463
11464 @node H8/500
11465 @subsection H8/500
11466
11467 @table @code
11468
11469 @kindex set memory @var{mod}
11470 @cindex memory models, H8/500
11471 @item set memory @var{mod}
11472 @itemx show memory
11473 Specify which H8/500 memory model (@var{mod}) you are using with
11474 @samp{set memory}; check which memory model is in effect with @samp{show
11475 memory}.  The accepted values for @var{mod} are @code{small},
11476 @code{big}, @code{medium}, and @code{compact}.
11477
11478 @end table
11479
11480 @node i960
11481 @subsection Intel i960
11482
11483 @table @code
11484
11485 @kindex target mon960
11486 @item target mon960 @var{dev}
11487 MON960 monitor for Intel i960.
11488
11489 @kindex target nindy
11490 @item target nindy @var{devicename}
11491 An Intel 960 board controlled by a Nindy Monitor.  @var{devicename} is
11492 the name of the serial device to use for the connection, e.g.
11493 @file{/dev/ttya}.
11494
11495 @end table
11496
11497 @cindex Nindy
11498 @cindex i960
11499 @dfn{Nindy} is a ROM Monitor program for Intel 960 target systems.  When
11500 @value{GDBN} is configured to control a remote Intel 960 using Nindy, you can
11501 tell @value{GDBN} how to connect to the 960 in several ways:
11502
11503 @itemize @bullet
11504 @item
11505 Through command line options specifying serial port, version of the
11506 Nindy protocol, and communications speed;
11507
11508 @item
11509 By responding to a prompt on startup;
11510
11511 @item
11512 By using the @code{target} command at any point during your @value{GDBN}
11513 session.  @xref{Target Commands, ,Commands for managing targets}.
11514
11515 @end itemize
11516
11517 @cindex download to Nindy-960
11518 With the Nindy interface to an Intel 960 board, @code{load}
11519 downloads @var{filename} to the 960 as well as adding its symbols in
11520 @value{GDBN}.
11521
11522 @menu
11523 * Nindy Startup::               Startup with Nindy
11524 * Nindy Options::               Options for Nindy
11525 * Nindy Reset::                 Nindy reset command
11526 @end menu
11527
11528 @node Nindy Startup
11529 @subsubsection Startup with Nindy
11530
11531 If you simply start @code{@value{GDBP}} without using any command-line
11532 options, you are prompted for what serial port to use, @emph{before} you
11533 reach the ordinary @value{GDBN} prompt:
11534
11535 @example
11536 Attach /dev/ttyNN -- specify NN, or "quit" to quit:
11537 @end example
11538
11539 @noindent
11540 Respond to the prompt with whatever suffix (after @samp{/dev/tty})
11541 identifies the serial port you want to use.  You can, if you choose,
11542 simply start up with no Nindy connection by responding to the prompt
11543 with an empty line.  If you do this and later wish to attach to Nindy,
11544 use @code{target} (@pxref{Target Commands, ,Commands for managing targets}).
11545
11546 @node Nindy Options
11547 @subsubsection Options for Nindy
11548
11549 These are the startup options for beginning your @value{GDBN} session with a
11550 Nindy-960 board attached:
11551
11552 @table @code
11553 @item -r @var{port}
11554 Specify the serial port name of a serial interface to be used to connect
11555 to the target system.  This option is only available when @value{GDBN} is
11556 configured for the Intel 960 target architecture.  You may specify
11557 @var{port} as any of: a full pathname (e.g. @samp{-r /dev/ttya}), a
11558 device name in @file{/dev} (e.g. @samp{-r ttya}), or simply the unique
11559 suffix for a specific @code{tty} (e.g. @samp{-r a}).
11560
11561 @item -O
11562 (An uppercase letter ``O'', not a zero.)  Specify that @value{GDBN} should use
11563 the ``old'' Nindy monitor protocol to connect to the target system.
11564 This option is only available when @value{GDBN} is configured for the Intel 960
11565 target architecture.
11566
11567 @quotation
11568 @emph{Warning:} if you specify @samp{-O}, but are actually trying to
11569 connect to a target system that expects the newer protocol, the connection
11570 fails, appearing to be a speed mismatch.  @value{GDBN} repeatedly
11571 attempts to reconnect at several different line speeds.  You can abort
11572 this process with an interrupt.
11573 @end quotation
11574
11575 @item -brk
11576 Specify that @value{GDBN} should first send a @code{BREAK} signal to the target
11577 system, in an attempt to reset it, before connecting to a Nindy target.
11578
11579 @quotation
11580 @emph{Warning:} Many target systems do not have the hardware that this
11581 requires; it only works with a few boards.
11582 @end quotation
11583 @end table
11584
11585 The standard @samp{-b} option controls the line speed used on the serial
11586 port.
11587
11588 @c @group
11589 @node Nindy Reset
11590 @subsubsection Nindy reset command
11591
11592 @table @code
11593 @item reset
11594 @kindex reset
11595 For a Nindy target, this command sends a ``break'' to the remote target
11596 system; this is only useful if the target has been equipped with a
11597 circuit to perform a hard reset (or some other interesting action) when
11598 a break is detected.
11599 @end table
11600 @c @end group
11601
11602 @node M32R/D
11603 @subsection Mitsubishi M32R/D
11604
11605 @table @code
11606
11607 @kindex target m32r
11608 @item target m32r @var{dev}
11609 Mitsubishi M32R/D ROM monitor.
11610
11611 @end table
11612
11613 @node M68K
11614 @subsection M68k
11615
11616 The Motorola m68k configuration includes ColdFire support, and
11617 target command for the following ROM monitors.
11618
11619 @table @code
11620
11621 @kindex target abug
11622 @item target abug @var{dev}
11623 ABug ROM monitor for M68K.
11624
11625 @kindex target cpu32bug
11626 @item target cpu32bug @var{dev}
11627 CPU32BUG monitor, running on a CPU32 (M68K) board.
11628
11629 @kindex target dbug
11630 @item target dbug @var{dev}
11631 dBUG ROM monitor for Motorola ColdFire.
11632
11633 @kindex target est
11634 @item target est @var{dev}
11635 EST-300 ICE monitor, running on a CPU32 (M68K) board.
11636
11637 @kindex target rom68k
11638 @item target rom68k @var{dev}
11639 ROM 68K monitor, running on an M68K IDP board.
11640
11641 @end table
11642
11643 If @value{GDBN} is configured with @code{m68*-ericsson-*}, it will
11644 instead have only a single special target command:
11645
11646 @table @code
11647
11648 @kindex target es1800
11649 @item target es1800 @var{dev}
11650 ES-1800 emulator for M68K.
11651
11652 @end table
11653
11654 [context?]
11655
11656 @table @code
11657
11658 @kindex target rombug
11659 @item target rombug @var{dev}
11660 ROMBUG ROM monitor for OS/9000.
11661
11662 @end table
11663
11664 @node M88K
11665 @subsection M88K
11666
11667 @table @code
11668
11669 @kindex target bug
11670 @item target bug @var{dev}
11671 BUG monitor, running on a MVME187 (m88k) board.
11672
11673 @end table
11674
11675 @node MIPS Embedded
11676 @subsection MIPS Embedded
11677
11678 @cindex MIPS boards
11679 @value{GDBN} can use the MIPS remote debugging protocol to talk to a
11680 MIPS board attached to a serial line.  This is available when
11681 you configure @value{GDBN} with @samp{--target=mips-idt-ecoff}.
11682
11683 @need 1000
11684 Use these @value{GDBN} commands to specify the connection to your target board:
11685
11686 @table @code
11687 @item target mips @var{port}
11688 @kindex target mips @var{port}
11689 To run a program on the board, start up @code{@value{GDBP}} with the
11690 name of your program as the argument.  To connect to the board, use the
11691 command @samp{target mips @var{port}}, where @var{port} is the name of
11692 the serial port connected to the board.  If the program has not already
11693 been downloaded to the board, you may use the @code{load} command to
11694 download it.  You can then use all the usual @value{GDBN} commands.
11695
11696 For example, this sequence connects to the target board through a serial
11697 port, and loads and runs a program called @var{prog} through the
11698 debugger:
11699
11700 @example
11701 host$ @value{GDBP} @var{prog}
11702 @value{GDBN} is free software and @dots{}
11703 (@value{GDBP}) target mips /dev/ttyb
11704 (@value{GDBP}) load @var{prog}
11705 (@value{GDBP}) run
11706 @end example
11707
11708 @item target mips @var{hostname}:@var{portnumber}
11709 On some @value{GDBN} host configurations, you can specify a TCP
11710 connection (for instance, to a serial line managed by a terminal
11711 concentrator) instead of a serial port, using the syntax
11712 @samp{@var{hostname}:@var{portnumber}}.
11713
11714 @item target pmon @var{port}
11715 @kindex target pmon @var{port}
11716 PMON ROM monitor.
11717
11718 @item target ddb @var{port}
11719 @kindex target ddb @var{port}
11720 NEC's DDB variant of PMON for Vr4300.
11721
11722 @item target lsi @var{port}
11723 @kindex target lsi @var{port}
11724 LSI variant of PMON.
11725
11726 @kindex target r3900
11727 @item target r3900 @var{dev}
11728 Densan DVE-R3900 ROM monitor for Toshiba R3900 Mips.
11729
11730 @kindex target array
11731 @item target array @var{dev}
11732 Array Tech LSI33K RAID controller board.
11733
11734 @end table
11735
11736
11737 @noindent
11738 @value{GDBN} also supports these special commands for MIPS targets:
11739
11740 @table @code
11741 @item set processor @var{args}
11742 @itemx show processor
11743 @kindex set processor @var{args}
11744 @kindex show processor
11745 Use the @code{set processor} command to set the type of MIPS
11746 processor when you want to access processor-type-specific registers.
11747 For example, @code{set processor @var{r3041}} tells @value{GDBN}
11748 to use the CPU registers appropriate for the 3041 chip.
11749 Use the @code{show processor} command to see what MIPS processor @value{GDBN}
11750 is using.  Use the @code{info reg} command to see what registers
11751 @value{GDBN} is using.
11752
11753 @item set mipsfpu double
11754 @itemx set mipsfpu single
11755 @itemx set mipsfpu none
11756 @itemx show mipsfpu
11757 @kindex set mipsfpu
11758 @kindex show mipsfpu
11759 @cindex MIPS remote floating point
11760 @cindex floating point, MIPS remote
11761 If your target board does not support the MIPS floating point
11762 coprocessor, you should use the command @samp{set mipsfpu none} (if you
11763 need this, you may wish to put the command in your @value{GDBN} init
11764 file).  This tells @value{GDBN} how to find the return value of
11765 functions which return floating point values.  It also allows
11766 @value{GDBN} to avoid saving the floating point registers when calling
11767 functions on the board.  If you are using a floating point coprocessor
11768 with only single precision floating point support, as on the @sc{r4650}
11769 processor, use the command @samp{set mipsfpu single}.  The default
11770 double precision floating point coprocessor may be selected using
11771 @samp{set mipsfpu double}.
11772
11773 In previous versions the only choices were double precision or no
11774 floating point, so @samp{set mipsfpu on} will select double precision
11775 and @samp{set mipsfpu off} will select no floating point.
11776
11777 As usual, you can inquire about the @code{mipsfpu} variable with
11778 @samp{show mipsfpu}.
11779
11780 @item set remotedebug @var{n}
11781 @itemx show remotedebug
11782 @kindex set remotedebug@r{, MIPS protocol}
11783 @kindex show remotedebug@r{, MIPS protocol}
11784 @cindex @code{remotedebug}, MIPS protocol
11785 @cindex MIPS @code{remotedebug} protocol
11786 @c FIXME! For this to be useful, you must know something about the MIPS
11787 @c FIXME...protocol.  Where is it described?
11788 You can see some debugging information about communications with the board
11789 by setting the @code{remotedebug} variable.  If you set it to @code{1} using
11790 @samp{set remotedebug 1}, every packet is displayed.  If you set it
11791 to @code{2}, every character is displayed.  You can check the current value
11792 at any time with the command @samp{show remotedebug}.
11793
11794 @item set timeout @var{seconds}
11795 @itemx set retransmit-timeout @var{seconds}
11796 @itemx show timeout
11797 @itemx show retransmit-timeout
11798 @cindex @code{timeout}, MIPS protocol
11799 @cindex @code{retransmit-timeout}, MIPS protocol
11800 @kindex set timeout
11801 @kindex show timeout
11802 @kindex set retransmit-timeout
11803 @kindex show retransmit-timeout
11804 You can control the timeout used while waiting for a packet, in the MIPS
11805 remote protocol, with the @code{set timeout @var{seconds}} command.  The
11806 default is 5 seconds.  Similarly, you can control the timeout used while
11807 waiting for an acknowledgement of a packet with the @code{set
11808 retransmit-timeout @var{seconds}} command.  The default is 3 seconds.
11809 You can inspect both values with @code{show timeout} and @code{show
11810 retransmit-timeout}.  (These commands are @emph{only} available when
11811 @value{GDBN} is configured for @samp{--target=mips-idt-ecoff}.)
11812
11813 The timeout set by @code{set timeout} does not apply when @value{GDBN}
11814 is waiting for your program to stop.  In that case, @value{GDBN} waits
11815 forever because it has no way of knowing how long the program is going
11816 to run before stopping.
11817 @end table
11818
11819 @node PowerPC
11820 @subsection PowerPC
11821
11822 @table @code
11823
11824 @kindex target dink32
11825 @item target dink32 @var{dev}
11826 DINK32 ROM monitor.
11827
11828 @kindex target ppcbug
11829 @item target ppcbug @var{dev}
11830 @kindex target ppcbug1
11831 @item target ppcbug1 @var{dev}
11832 PPCBUG ROM monitor for PowerPC.
11833
11834 @kindex target sds
11835 @item target sds @var{dev}
11836 SDS monitor, running on a PowerPC board (such as Motorola's ADS).
11837
11838 @end table
11839
11840 @node PA
11841 @subsection HP PA Embedded
11842
11843 @table @code
11844
11845 @kindex target op50n
11846 @item target op50n @var{dev}
11847 OP50N monitor, running on an OKI HPPA board.
11848
11849 @kindex target w89k
11850 @item target w89k @var{dev}
11851 W89K monitor, running on a Winbond HPPA board.
11852
11853 @end table
11854
11855 @node SH
11856 @subsection Hitachi SH
11857
11858 @table @code
11859
11860 @kindex target hms@r{, with Hitachi SH}
11861 @item target hms @var{dev}
11862 A Hitachi SH board attached via serial line to your host.  Use special
11863 commands @code{device} and @code{speed} to control the serial line and
11864 the communications speed used.
11865
11866 @kindex target e7000@r{, with Hitachi SH}
11867 @item target e7000 @var{dev}
11868 E7000 emulator for Hitachi SH.
11869
11870 @kindex target sh3@r{, with SH}
11871 @kindex target sh3e@r{, with SH}
11872 @item target sh3 @var{dev}
11873 @item target sh3e @var{dev}
11874 Hitachi SH-3 and SH-3E target systems.
11875
11876 @end table
11877
11878 @node Sparclet
11879 @subsection Tsqware Sparclet
11880
11881 @cindex Sparclet
11882
11883 @value{GDBN} enables developers to debug tasks running on
11884 Sparclet targets from a Unix host.
11885 @value{GDBN} uses code that runs on
11886 both the Unix host and on the Sparclet target.  The program
11887 @code{@value{GDBP}} is installed and executed on the Unix host.
11888
11889 @table @code
11890 @item remotetimeout @var{args}
11891 @kindex remotetimeout
11892 @value{GDBN} supports the option @code{remotetimeout}.
11893 This option is set by the user, and  @var{args} represents the number of
11894 seconds @value{GDBN} waits for responses.
11895 @end table
11896
11897 @cindex compiling, on Sparclet
11898 When compiling for debugging, include the options @samp{-g} to get debug
11899 information and @samp{-Ttext} to relocate the program to where you wish to
11900 load it on the target.  You may also want to add the options @samp{-n} or
11901 @samp{-N} in order to reduce the size of the sections.  Example:
11902
11903 @example
11904 sparclet-aout-gcc prog.c -Ttext 0x12010000 -g -o prog -N
11905 @end example
11906
11907 You can use @code{objdump} to verify that the addresses are what you intended:
11908
11909 @example
11910 sparclet-aout-objdump --headers --syms prog
11911 @end example
11912
11913 @cindex running, on Sparclet
11914 Once you have set
11915 your Unix execution search path to find @value{GDBN}, you are ready to
11916 run @value{GDBN}.  From your Unix host, run @code{@value{GDBP}}
11917 (or @code{sparclet-aout-gdb}, depending on your installation).
11918
11919 @value{GDBN} comes up showing the prompt:
11920
11921 @example
11922 (gdbslet)
11923 @end example
11924
11925 @menu
11926 * Sparclet File::                Setting the file to debug
11927 * Sparclet Connection::          Connecting to Sparclet
11928 * Sparclet Download::            Sparclet download
11929 * Sparclet Execution::           Running and debugging
11930 @end menu
11931
11932 @node Sparclet File
11933 @subsubsection Setting file to debug
11934
11935 The @value{GDBN} command @code{file} lets you choose with program to debug.
11936
11937 @example
11938 (gdbslet) file prog
11939 @end example
11940
11941 @need 1000
11942 @value{GDBN} then attempts to read the symbol table of @file{prog}.
11943 @value{GDBN} locates
11944 the file by searching the directories listed in the command search
11945 path.
11946 If the file was compiled with debug information (option "-g"), source
11947 files will be searched as well.
11948 @value{GDBN} locates
11949 the source files by searching the directories listed in the directory search
11950 path (@pxref{Environment, ,Your program's environment}).
11951 If it fails
11952 to find a file, it displays a message such as:
11953
11954 @example
11955 prog: No such file or directory.
11956 @end example
11957
11958 When this happens, add the appropriate directories to the search paths with
11959 the @value{GDBN} commands @code{path} and @code{dir}, and execute the
11960 @code{target} command again.
11961
11962 @node Sparclet Connection
11963 @subsubsection Connecting to Sparclet
11964
11965 The @value{GDBN} command @code{target} lets you connect to a Sparclet target.
11966 To connect to a target on serial port ``@code{ttya}'', type:
11967
11968 @example
11969 (gdbslet) target sparclet /dev/ttya
11970 Remote target sparclet connected to /dev/ttya
11971 main () at ../prog.c:3
11972 @end example
11973
11974 @need 750
11975 @value{GDBN} displays messages like these:
11976
11977 @example
11978 Connected to ttya.
11979 @end example
11980
11981 @node Sparclet Download
11982 @subsubsection Sparclet download
11983
11984 @cindex download to Sparclet
11985 Once connected to the Sparclet target,
11986 you can use the @value{GDBN}
11987 @code{load} command to download the file from the host to the target.
11988 The file name and load offset should be given as arguments to the @code{load}
11989 command.
11990 Since the file format is aout, the program must be loaded to the starting
11991 address.  You can use @code{objdump} to find out what this value is.  The load
11992 offset is an offset which is added to the VMA (virtual memory address)
11993 of each of the file's sections.
11994 For instance, if the program
11995 @file{prog} was linked to text address 0x1201000, with data at 0x12010160
11996 and bss at 0x12010170, in @value{GDBN}, type:
11997
11998 @example
11999 (gdbslet) load prog 0x12010000
12000 Loading section .text, size 0xdb0 vma 0x12010000
12001 @end example
12002
12003 If the code is loaded at a different address then what the program was linked
12004 to, you may need to use the @code{section} and @code{add-symbol-file} commands
12005 to tell @value{GDBN} where to map the symbol table.
12006
12007 @node Sparclet Execution
12008 @subsubsection Running and debugging
12009
12010 @cindex running and debugging Sparclet programs
12011 You can now begin debugging the task using @value{GDBN}'s execution control
12012 commands, @code{b}, @code{step}, @code{run}, etc.  See the @value{GDBN}
12013 manual for the list of commands.
12014
12015 @example
12016 (gdbslet) b main
12017 Breakpoint 1 at 0x12010000: file prog.c, line 3.
12018 (gdbslet) run
12019 Starting program: prog
12020 Breakpoint 1, main (argc=1, argv=0xeffff21c) at prog.c:3
12021 3        char *symarg = 0;
12022 (gdbslet) step
12023 4        char *execarg = "hello!";
12024 (gdbslet)
12025 @end example
12026
12027 @node Sparclite
12028 @subsection Fujitsu Sparclite
12029
12030 @table @code
12031
12032 @kindex target sparclite
12033 @item target sparclite @var{dev}
12034 Fujitsu sparclite boards, used only for the purpose of loading.
12035 You must use an additional command to debug the program.
12036 For example: target remote @var{dev} using @value{GDBN} standard
12037 remote protocol.
12038
12039 @end table
12040
12041 @node ST2000
12042 @subsection Tandem ST2000
12043
12044 @value{GDBN} may be used with a Tandem ST2000 phone switch, running Tandem's
12045 STDBUG protocol.
12046
12047 To connect your ST2000 to the host system, see the manufacturer's
12048 manual.  Once the ST2000 is physically attached, you can run:
12049
12050 @example
12051 target st2000 @var{dev} @var{speed}
12052 @end example
12053
12054 @noindent
12055 to establish it as your debugging environment.  @var{dev} is normally
12056 the name of a serial device, such as @file{/dev/ttya}, connected to the
12057 ST2000 via a serial line.  You can instead specify @var{dev} as a TCP
12058 connection (for example, to a serial line attached via a terminal
12059 concentrator) using the syntax @code{@var{hostname}:@var{portnumber}}.
12060
12061 The @code{load} and @code{attach} commands are @emph{not} defined for
12062 this target; you must load your program into the ST2000 as you normally
12063 would for standalone operation.  @value{GDBN} reads debugging information
12064 (such as symbols) from a separate, debugging version of the program
12065 available on your host computer.
12066 @c FIXME!! This is terribly vague; what little content is here is
12067 @c basically hearsay.
12068
12069 @cindex ST2000 auxiliary commands
12070 These auxiliary @value{GDBN} commands are available to help you with the ST2000
12071 environment:
12072
12073 @table @code
12074 @item st2000 @var{command}
12075 @kindex st2000 @var{cmd}
12076 @cindex STDBUG commands (ST2000)
12077 @cindex commands to STDBUG (ST2000)
12078 Send a @var{command} to the STDBUG monitor.  See the manufacturer's
12079 manual for available commands.
12080
12081 @item connect
12082 @cindex connect (to STDBUG)
12083 Connect the controlling terminal to the STDBUG command monitor.  When
12084 you are done interacting with STDBUG, typing either of two character
12085 sequences gets you back to the @value{GDBN} command prompt:
12086 @kbd{@key{RET}~.} (Return, followed by tilde and period) or
12087 @kbd{@key{RET}~@key{C-d}} (Return, followed by tilde and control-D).
12088 @end table
12089
12090 @node Z8000
12091 @subsection Zilog Z8000
12092
12093 @cindex Z8000
12094 @cindex simulator, Z8000
12095 @cindex Zilog Z8000 simulator
12096
12097 When configured for debugging Zilog Z8000 targets, @value{GDBN} includes
12098 a Z8000 simulator.
12099
12100 For the Z8000 family, @samp{target sim} simulates either the Z8002 (the
12101 unsegmented variant of the Z8000 architecture) or the Z8001 (the
12102 segmented variant).  The simulator recognizes which architecture is
12103 appropriate by inspecting the object code.
12104
12105 @table @code
12106 @item target sim @var{args}
12107 @kindex sim
12108 @kindex target sim@r{, with Z8000}
12109 Debug programs on a simulated CPU.  If the simulator supports setup
12110 options, specify them via @var{args}.
12111 @end table
12112
12113 @noindent
12114 After specifying this target, you can debug programs for the simulated
12115 CPU in the same style as programs for your host computer; use the
12116 @code{file} command to load a new program image, the @code{run} command
12117 to run your program, and so on.
12118
12119 As well as making available all the usual machine registers
12120 (@pxref{Registers, ,Registers}), the Z8000 simulator provides three
12121 additional items of information as specially named registers:
12122
12123 @table @code
12124
12125 @item cycles
12126 Counts clock-ticks in the simulator.
12127
12128 @item insts
12129 Counts instructions run in the simulator.
12130
12131 @item time
12132 Execution time in 60ths of a second.
12133
12134 @end table
12135
12136 You can refer to these values in @value{GDBN} expressions with the usual
12137 conventions; for example, @w{@samp{b fputc if $cycles>5000}} sets a
12138 conditional breakpoint that suspends only after at least 5000
12139 simulated clock ticks.
12140
12141 @node Architectures
12142 @section Architectures
12143
12144 This section describes characteristics of architectures that affect
12145 all uses of @value{GDBN} with the architecture, both native and cross.
12146
12147 @menu
12148 * A29K::
12149 * Alpha::
12150 * MIPS::
12151 @end menu
12152
12153 @node A29K
12154 @subsection A29K
12155
12156 @table @code
12157
12158 @kindex set rstack_high_address
12159 @cindex AMD 29K register stack
12160 @cindex register stack, AMD29K
12161 @item set rstack_high_address @var{address}
12162 On AMD 29000 family processors, registers are saved in a separate
12163 @dfn{register stack}.  There is no way for @value{GDBN} to determine the
12164 extent of this stack.  Normally, @value{GDBN} just assumes that the
12165 stack is ``large enough''.  This may result in @value{GDBN} referencing
12166 memory locations that do not exist.  If necessary, you can get around
12167 this problem by specifying the ending address of the register stack with
12168 the @code{set rstack_high_address} command.  The argument should be an
12169 address, which you probably want to precede with @samp{0x} to specify in
12170 hexadecimal.
12171
12172 @kindex show rstack_high_address
12173 @item show rstack_high_address
12174 Display the current limit of the register stack, on AMD 29000 family
12175 processors.
12176
12177 @end table
12178
12179 @node Alpha
12180 @subsection Alpha
12181
12182 See the following section.
12183
12184 @node MIPS
12185 @subsection MIPS
12186
12187 @cindex stack on Alpha
12188 @cindex stack on MIPS
12189 @cindex Alpha stack
12190 @cindex MIPS stack
12191 Alpha- and MIPS-based computers use an unusual stack frame, which
12192 sometimes requires @value{GDBN} to search backward in the object code to
12193 find the beginning of a function.
12194
12195 @cindex response time, MIPS debugging
12196 To improve response time (especially for embedded applications, where
12197 @value{GDBN} may be restricted to a slow serial line for this search)
12198 you may want to limit the size of this search, using one of these
12199 commands:
12200
12201 @table @code
12202 @cindex @code{heuristic-fence-post} (Alpha, MIPS)
12203 @item set heuristic-fence-post @var{limit}
12204 Restrict @value{GDBN} to examining at most @var{limit} bytes in its
12205 search for the beginning of a function.  A value of @var{0} (the
12206 default) means there is no limit.  However, except for @var{0}, the
12207 larger the limit the more bytes @code{heuristic-fence-post} must search
12208 and therefore the longer it takes to run.
12209
12210 @item show heuristic-fence-post
12211 Display the current limit.
12212 @end table
12213
12214 @noindent
12215 These commands are available @emph{only} when @value{GDBN} is configured
12216 for debugging programs on Alpha or MIPS processors.
12217
12218
12219 @node Controlling GDB
12220 @chapter Controlling @value{GDBN}
12221
12222 You can alter the way @value{GDBN} interacts with you by using the
12223 @code{set} command.  For commands controlling how @value{GDBN} displays
12224 data, see @ref{Print Settings, ,Print settings}.  Other settings are
12225 described here.
12226
12227 @menu
12228 * Prompt::                      Prompt
12229 * Editing::                     Command editing
12230 * History::                     Command history
12231 * Screen Size::                 Screen size
12232 * Numbers::                     Numbers
12233 * Messages/Warnings::           Optional warnings and messages
12234 * Debugging Output::            Optional messages about internal happenings
12235 @end menu
12236
12237 @node Prompt
12238 @section Prompt
12239
12240 @cindex prompt
12241
12242 @value{GDBN} indicates its readiness to read a command by printing a string
12243 called the @dfn{prompt}.  This string is normally @samp{(@value{GDBP})}.  You
12244 can change the prompt string with the @code{set prompt} command.  For
12245 instance, when debugging @value{GDBN} with @value{GDBN}, it is useful to change
12246 the prompt in one of the @value{GDBN} sessions so that you can always tell
12247 which one you are talking to.
12248
12249 @emph{Note:}  @code{set prompt} does not add a space for you after the
12250 prompt you set.  This allows you to set a prompt which ends in a space
12251 or a prompt that does not.
12252
12253 @table @code
12254 @kindex set prompt
12255 @item set prompt @var{newprompt}
12256 Directs @value{GDBN} to use @var{newprompt} as its prompt string henceforth.
12257
12258 @kindex show prompt
12259 @item show prompt
12260 Prints a line of the form: @samp{Gdb's prompt is: @var{your-prompt}}
12261 @end table
12262
12263 @node Editing
12264 @section Command editing
12265 @cindex readline
12266 @cindex command line editing
12267
12268 @value{GDBN} reads its input commands via the @dfn{readline} interface.  This
12269 @sc{gnu} library provides consistent behavior for programs which provide a
12270 command line interface to the user.  Advantages are @sc{gnu} Emacs-style
12271 or @dfn{vi}-style inline editing of commands, @code{csh}-like history
12272 substitution, and a storage and recall of command history across
12273 debugging sessions.
12274
12275 You may control the behavior of command line editing in @value{GDBN} with the
12276 command @code{set}.
12277
12278 @table @code
12279 @kindex set editing
12280 @cindex editing
12281 @item set editing
12282 @itemx set editing on
12283 Enable command line editing (enabled by default).
12284
12285 @item set editing off
12286 Disable command line editing.
12287
12288 @kindex show editing
12289 @item show editing
12290 Show whether command line editing is enabled.
12291 @end table
12292
12293 @node History
12294 @section Command history
12295
12296 @value{GDBN} can keep track of the commands you type during your
12297 debugging sessions, so that you can be certain of precisely what
12298 happened.  Use these commands to manage the @value{GDBN} command
12299 history facility.
12300
12301 @table @code
12302 @cindex history substitution
12303 @cindex history file
12304 @kindex set history filename
12305 @kindex GDBHISTFILE
12306 @item set history filename @var{fname}
12307 Set the name of the @value{GDBN} command history file to @var{fname}.
12308 This is the file where @value{GDBN} reads an initial command history
12309 list, and where it writes the command history from this session when it
12310 exits.  You can access this list through history expansion or through
12311 the history command editing characters listed below.  This file defaults
12312 to the value of the environment variable @code{GDBHISTFILE}, or to
12313 @file{./.gdb_history} (@file{./_gdb_history} on MS-DOS) if this variable
12314 is not set.
12315
12316 @cindex history save
12317 @kindex set history save
12318 @item set history save
12319 @itemx set history save on
12320 Record command history in a file, whose name may be specified with the
12321 @code{set history filename} command.  By default, this option is disabled.
12322
12323 @item set history save off
12324 Stop recording command history in a file.
12325
12326 @cindex history size
12327 @kindex set history size
12328 @item set history size @var{size}
12329 Set the number of commands which @value{GDBN} keeps in its history list.
12330 This defaults to the value of the environment variable
12331 @code{HISTSIZE}, or to 256 if this variable is not set.
12332 @end table
12333
12334 @cindex history expansion
12335 History expansion assigns special meaning to the character @kbd{!}.
12336 @ifset have-readline-appendices
12337 @xref{Event Designators}.
12338 @end ifset
12339
12340 Since @kbd{!} is also the logical not operator in C, history expansion
12341 is off by default. If you decide to enable history expansion with the
12342 @code{set history expansion on} command, you may sometimes need to
12343 follow @kbd{!} (when it is used as logical not, in an expression) with
12344 a space or a tab to prevent it from being expanded.  The readline
12345 history facilities do not attempt substitution on the strings
12346 @kbd{!=} and @kbd{!(}, even when history expansion is enabled.
12347
12348 The commands to control history expansion are:
12349
12350 @table @code
12351 @kindex set history expansion
12352 @item set history expansion on
12353 @itemx set history expansion
12354 Enable history expansion.  History expansion is off by default.
12355
12356 @item set history expansion off
12357 Disable history expansion.
12358
12359 The readline code comes with more complete documentation of
12360 editing and history expansion features.  Users unfamiliar with @sc{gnu} Emacs
12361 or @code{vi} may wish to read it.
12362 @ifset have-readline-appendices
12363 @xref{Command Line Editing}.
12364 @end ifset
12365
12366 @c @group
12367 @kindex show history
12368 @item show history
12369 @itemx show history filename
12370 @itemx show history save
12371 @itemx show history size
12372 @itemx show history expansion
12373 These commands display the state of the @value{GDBN} history parameters.
12374 @code{show history} by itself displays all four states.
12375 @c @end group
12376 @end table
12377
12378 @table @code
12379 @kindex shows
12380 @item show commands
12381 Display the last ten commands in the command history.
12382
12383 @item show commands @var{n}
12384 Print ten commands centered on command number @var{n}.
12385
12386 @item show commands +
12387 Print ten commands just after the commands last printed.
12388 @end table
12389
12390 @node Screen Size
12391 @section Screen size
12392 @cindex size of screen
12393 @cindex pauses in output
12394
12395 Certain commands to @value{GDBN} may produce large amounts of
12396 information output to the screen.  To help you read all of it,
12397 @value{GDBN} pauses and asks you for input at the end of each page of
12398 output.  Type @key{RET} when you want to continue the output, or @kbd{q}
12399 to discard the remaining output.  Also, the screen width setting
12400 determines when to wrap lines of output.  Depending on what is being
12401 printed, @value{GDBN} tries to break the line at a readable place,
12402 rather than simply letting it overflow onto the following line.
12403
12404 Normally @value{GDBN} knows the size of the screen from the terminal
12405 driver software.  For example, on Unix @value{GDBN} uses the termcap data base
12406 together with the value of the @code{TERM} environment variable and the
12407 @code{stty rows} and @code{stty cols} settings.  If this is not correct,
12408 you can override it with the @code{set height} and @code{set
12409 width} commands:
12410
12411 @table @code
12412 @kindex set height
12413 @kindex set width
12414 @kindex show width
12415 @kindex show height
12416 @item set height @var{lpp}
12417 @itemx show height
12418 @itemx set width @var{cpl}
12419 @itemx show width
12420 These @code{set} commands specify a screen height of @var{lpp} lines and
12421 a screen width of @var{cpl} characters.  The associated @code{show}
12422 commands display the current settings.
12423
12424 If you specify a height of zero lines, @value{GDBN} does not pause during
12425 output no matter how long the output is.  This is useful if output is to a
12426 file or to an editor buffer.
12427
12428 Likewise, you can specify @samp{set width 0} to prevent @value{GDBN}
12429 from wrapping its output.
12430 @end table
12431
12432 @node Numbers
12433 @section Numbers
12434 @cindex number representation
12435 @cindex entering numbers
12436
12437 You can always enter numbers in octal, decimal, or hexadecimal in
12438 @value{GDBN} by the usual conventions: octal numbers begin with
12439 @samp{0}, decimal numbers end with @samp{.}, and hexadecimal numbers
12440 begin with @samp{0x}.  Numbers that begin with none of these are, by
12441 default, entered in base 10; likewise, the default display for
12442 numbers---when no particular format is specified---is base 10.  You can
12443 change the default base for both input and output with the @code{set
12444 radix} command.
12445
12446 @table @code
12447 @kindex set input-radix
12448 @item set input-radix @var{base}
12449 Set the default base for numeric input.  Supported choices
12450 for @var{base} are decimal 8, 10, or 16.  @var{base} must itself be
12451 specified either unambiguously or using the current default radix; for
12452 example, any of
12453
12454 @smallexample
12455 set radix 012
12456 set radix 10.
12457 set radix 0xa
12458 @end smallexample
12459
12460 @noindent
12461 sets the base to decimal.  On the other hand, @samp{set radix 10}
12462 leaves the radix unchanged no matter what it was.
12463
12464 @kindex set output-radix
12465 @item set output-radix @var{base}
12466 Set the default base for numeric display.  Supported choices
12467 for @var{base} are decimal 8, 10, or 16.  @var{base} must itself be
12468 specified either unambiguously or using the current default radix.
12469
12470 @kindex show input-radix
12471 @item show input-radix
12472 Display the current default base for numeric input.
12473
12474 @kindex show output-radix
12475 @item show output-radix
12476 Display the current default base for numeric display.
12477 @end table
12478
12479 @node Messages/Warnings
12480 @section Optional warnings and messages
12481
12482 By default, @value{GDBN} is silent about its inner workings.  If you are
12483 running on a slow machine, you may want to use the @code{set verbose}
12484 command.  This makes @value{GDBN} tell you when it does a lengthy
12485 internal operation, so you will not think it has crashed.
12486
12487 Currently, the messages controlled by @code{set verbose} are those
12488 which announce that the symbol table for a source file is being read;
12489 see @code{symbol-file} in @ref{Files, ,Commands to specify files}.
12490
12491 @table @code
12492 @kindex set verbose
12493 @item set verbose on
12494 Enables @value{GDBN} output of certain informational messages.
12495
12496 @item set verbose off
12497 Disables @value{GDBN} output of certain informational messages.
12498
12499 @kindex show verbose
12500 @item show verbose
12501 Displays whether @code{set verbose} is on or off.
12502 @end table
12503
12504 By default, if @value{GDBN} encounters bugs in the symbol table of an
12505 object file, it is silent; but if you are debugging a compiler, you may
12506 find this information useful (@pxref{Symbol Errors, ,Errors reading
12507 symbol files}).
12508
12509 @table @code
12510
12511 @kindex set complaints
12512 @item set complaints @var{limit}
12513 Permits @value{GDBN} to output @var{limit} complaints about each type of
12514 unusual symbols before becoming silent about the problem.  Set
12515 @var{limit} to zero to suppress all complaints; set it to a large number
12516 to prevent complaints from being suppressed.
12517
12518 @kindex show complaints
12519 @item show complaints
12520 Displays how many symbol complaints @value{GDBN} is permitted to produce.
12521
12522 @end table
12523
12524 By default, @value{GDBN} is cautious, and asks what sometimes seems to be a
12525 lot of stupid questions to confirm certain commands.  For example, if
12526 you try to run a program which is already running:
12527
12528 @example
12529 (@value{GDBP}) run
12530 The program being debugged has been started already.
12531 Start it from the beginning? (y or n)
12532 @end example
12533
12534 If you are willing to unflinchingly face the consequences of your own
12535 commands, you can disable this ``feature'':
12536
12537 @table @code
12538
12539 @kindex set confirm
12540 @cindex flinching
12541 @cindex confirmation
12542 @cindex stupid questions
12543 @item set confirm off
12544 Disables confirmation requests.
12545
12546 @item set confirm on
12547 Enables confirmation requests (the default).
12548
12549 @kindex show confirm
12550 @item show confirm
12551 Displays state of confirmation requests.
12552
12553 @end table
12554
12555 @node Debugging Output
12556 @section Optional messages about internal happenings
12557 @table @code
12558 @kindex set debug arch
12559 @item set debug arch
12560 Turns on or off display of gdbarch debugging info. The default is off
12561 @kindex show debug arch
12562 @item show debug arch
12563 Displays the current state of displaying gdbarch debugging info.
12564 @kindex set debug event
12565 @item set debug event
12566 Turns on or off display of @value{GDBN} event debugging info. The
12567 default is off.
12568 @kindex show debug event
12569 @item show debug event
12570 Displays the current state of displaying @value{GDBN} event debugging
12571 info.
12572 @kindex set debug expression
12573 @item set debug expression
12574 Turns on or off display of @value{GDBN} expression debugging info. The
12575 default is off.
12576 @kindex show debug expression
12577 @item show debug expression
12578 Displays the current state of displaying @value{GDBN} expression
12579 debugging info.
12580 @kindex set debug overload
12581 @item set debug overload
12582 Turns on or off display of @value{GDBN} C@t{++} overload debugging
12583 info. This includes info such as ranking of functions, etc. The default
12584 is off.
12585 @kindex show debug overload
12586 @item show debug overload
12587 Displays the current state of displaying @value{GDBN} C@t{++} overload
12588 debugging info.
12589 @kindex set debug remote
12590 @cindex packets, reporting on stdout
12591 @cindex serial connections, debugging
12592 @item set debug remote
12593 Turns on or off display of reports on all packets sent back and forth across
12594 the serial line to the remote machine.  The info is printed on the
12595 @value{GDBN} standard output stream. The default is off.
12596 @kindex show debug remote
12597 @item show debug remote
12598 Displays the state of display of remote packets.
12599 @kindex set debug serial
12600 @item set debug serial
12601 Turns on or off display of @value{GDBN} serial debugging info. The
12602 default is off.
12603 @kindex show debug serial
12604 @item show debug serial
12605 Displays the current state of displaying @value{GDBN} serial debugging
12606 info.
12607 @kindex set debug target
12608 @item set debug target
12609 Turns on or off display of @value{GDBN} target debugging info. This info
12610 includes what is going on at the target level of GDB, as it happens. The
12611 default is off.
12612 @kindex show debug target
12613 @item show debug target
12614 Displays the current state of displaying @value{GDBN} target debugging
12615 info.
12616 @kindex set debug varobj
12617 @item set debug varobj
12618 Turns on or off display of @value{GDBN} variable object debugging
12619 info. The default is off.
12620 @kindex show debug varobj
12621 @item show debug varobj
12622 Displays the current state of displaying @value{GDBN} variable object
12623 debugging info.
12624 @end table
12625
12626 @node Sequences
12627 @chapter Canned Sequences of Commands
12628
12629 Aside from breakpoint commands (@pxref{Break Commands, ,Breakpoint
12630 command lists}), @value{GDBN} provides two ways to store sequences of
12631 commands for execution as a unit: user-defined commands and command
12632 files.
12633
12634 @menu
12635 * Define::                      User-defined commands
12636 * Hooks::                       User-defined command hooks
12637 * Command Files::               Command files
12638 * Output::                      Commands for controlled output
12639 @end menu
12640
12641 @node Define
12642 @section User-defined commands
12643
12644 @cindex user-defined command
12645 A @dfn{user-defined command} is a sequence of @value{GDBN} commands to
12646 which you assign a new name as a command.  This is done with the
12647 @code{define} command.  User commands may accept up to 10 arguments
12648 separated by whitespace.  Arguments are accessed within the user command
12649 via @var{$arg0@dots{}$arg9}.  A trivial example:
12650
12651 @smallexample
12652 define adder
12653   print $arg0 + $arg1 + $arg2
12654 @end smallexample
12655
12656 @noindent
12657 To execute the command use:
12658
12659 @smallexample
12660 adder 1 2 3
12661 @end smallexample
12662
12663 @noindent
12664 This defines the command @code{adder}, which prints the sum of
12665 its three arguments.  Note the arguments are text substitutions, so they may
12666 reference variables, use complex expressions, or even perform inferior
12667 functions calls.
12668
12669 @table @code
12670
12671 @kindex define
12672 @item define @var{commandname}
12673 Define a command named @var{commandname}.  If there is already a command
12674 by that name, you are asked to confirm that you want to redefine it.
12675
12676 The definition of the command is made up of other @value{GDBN} command lines,
12677 which are given following the @code{define} command.  The end of these
12678 commands is marked by a line containing @code{end}.
12679
12680 @kindex if
12681 @kindex else
12682 @item if
12683 Takes a single argument, which is an expression to evaluate.
12684 It is followed by a series of commands that are executed
12685 only if the expression is true (nonzero).
12686 There can then optionally be a line @code{else}, followed
12687 by a series of commands that are only executed if the expression
12688 was false.  The end of the list is marked by a line containing @code{end}.
12689
12690 @kindex while
12691 @item while
12692 The syntax is similar to @code{if}: the command takes a single argument,
12693 which is an expression to evaluate, and must be followed by the commands to
12694 execute, one per line, terminated by an @code{end}.
12695 The commands are executed repeatedly as long as the expression
12696 evaluates to true.
12697
12698 @kindex document
12699 @item document @var{commandname}
12700 Document the user-defined command @var{commandname}, so that it can be
12701 accessed by @code{help}.  The command @var{commandname} must already be
12702 defined.  This command reads lines of documentation just as @code{define}
12703 reads the lines of the command definition, ending with @code{end}.
12704 After the @code{document} command is finished, @code{help} on command
12705 @var{commandname} displays the documentation you have written.
12706
12707 You may use the @code{document} command again to change the
12708 documentation of a command.  Redefining the command with @code{define}
12709 does not change the documentation.
12710
12711 @kindex help user-defined
12712 @item help user-defined
12713 List all user-defined commands, with the first line of the documentation
12714 (if any) for each.
12715
12716 @kindex show user
12717 @item show user
12718 @itemx show user @var{commandname}
12719 Display the @value{GDBN} commands used to define @var{commandname} (but
12720 not its documentation).  If no @var{commandname} is given, display the
12721 definitions for all user-defined commands.
12722
12723 @end table
12724
12725 When user-defined commands are executed, the
12726 commands of the definition are not printed.  An error in any command
12727 stops execution of the user-defined command.
12728
12729 If used interactively, commands that would ask for confirmation proceed
12730 without asking when used inside a user-defined command.  Many @value{GDBN}
12731 commands that normally print messages to say what they are doing omit the
12732 messages when used in a user-defined command.
12733
12734 @node Hooks
12735 @section User-defined command hooks
12736 @cindex command hooks
12737 @cindex hooks, for commands
12738 @cindex hooks, pre-command
12739
12740 @kindex hook
12741 @kindex hook-
12742 You may define @dfn{hooks}, which are a special kind of user-defined
12743 command.  Whenever you run the command @samp{foo}, if the user-defined
12744 command @samp{hook-foo} exists, it is executed (with no arguments)
12745 before that command.
12746
12747 @cindex hooks, post-command
12748 @kindex hookpost
12749 @kindex hookpost-
12750 A hook may also be defined which is run after the command you executed.
12751 Whenever you run the command @samp{foo}, if the user-defined command
12752 @samp{hookpost-foo} exists, it is executed (with no arguments) after
12753 that command.  Post-execution hooks may exist simultaneously with
12754 pre-execution hooks, for the same command.
12755
12756 It is valid for a hook to call the command which it hooks.  If this
12757 occurs, the hook is not re-executed, thereby avoiding infinte recursion.
12758
12759 @c It would be nice if hookpost could be passed a parameter indicating
12760 @c if the command it hooks executed properly or not.  FIXME!
12761
12762 @kindex stop@r{, a pseudo-command}
12763 In addition, a pseudo-command, @samp{stop} exists.  Defining
12764 (@samp{hook-stop}) makes the associated commands execute every time
12765 execution stops in your program: before breakpoint commands are run,
12766 displays are printed, or the stack frame is printed.
12767
12768 For example, to ignore @code{SIGALRM} signals while
12769 single-stepping, but treat them normally during normal execution,
12770 you could define:
12771
12772 @example
12773 define hook-stop
12774 handle SIGALRM nopass
12775 end
12776
12777 define hook-run
12778 handle SIGALRM pass
12779 end
12780
12781 define hook-continue
12782 handle SIGLARM pass
12783 end
12784 @end example
12785
12786 As a further example, to hook at the begining and end of the @code{echo}
12787 command, and to add extra text to the beginning and end of the message, 
12788 you could define:
12789
12790 @example
12791 define hook-echo
12792 echo <<<---
12793 end
12794
12795 define hookpost-echo
12796 echo --->>>\n
12797 end
12798
12799 (@value{GDBP}) echo Hello World
12800 <<<---Hello World--->>>
12801 (@value{GDBP})
12802
12803 @end example
12804
12805 You can define a hook for any single-word command in @value{GDBN}, but
12806 not for command aliases; you should define a hook for the basic command
12807 name, e.g.  @code{backtrace} rather than @code{bt}.
12808 @c FIXME!  So how does Joe User discover whether a command is an alias
12809 @c or not?
12810 If an error occurs during the execution of your hook, execution of
12811 @value{GDBN} commands stops and @value{GDBN} issues a prompt
12812 (before the command that you actually typed had a chance to run).
12813
12814 If you try to define a hook which does not match any known command, you
12815 get a warning from the @code{define} command.
12816
12817 @node Command Files
12818 @section Command files
12819
12820 @cindex command files
12821 A command file for @value{GDBN} is a file of lines that are @value{GDBN}
12822 commands.  Comments (lines starting with @kbd{#}) may also be included.
12823 An empty line in a command file does nothing; it does not mean to repeat
12824 the last command, as it would from the terminal.
12825
12826 @cindex init file
12827 @cindex @file{.gdbinit}
12828 @cindex @file{gdb.ini}
12829 When you start @value{GDBN}, it automatically executes commands from its
12830 @dfn{init files}.  These are files named @file{.gdbinit} on Unix and
12831 @file{gdb.ini} on DOS/Windows.  During startup, @value{GDBN} does the
12832 following:
12833
12834 @enumerate
12835 @item
12836 Reads the init file (if any) in your home directory@footnote{On
12837 DOS/Windows systems, the home directory is the one pointed to by the
12838 @code{HOME} environment variable.}.
12839
12840 @item
12841 Processes command line options and operands.
12842
12843 @item
12844 Reads the init file (if any) in the current working directory.
12845
12846 @item
12847 Reads command files specified by the @samp{-x} option.
12848 @end enumerate
12849
12850 The init file in your home directory can set options (such as @samp{set
12851 complaints}) that affect subsequent processing of command line options
12852 and operands.  Init files are not executed if you use the @samp{-nx}
12853 option (@pxref{Mode Options, ,Choosing modes}).
12854
12855 @cindex init file name
12856 On some configurations of @value{GDBN}, the init file is known by a
12857 different name (these are typically environments where a specialized
12858 form of @value{GDBN} may need to coexist with other forms, hence a
12859 different name for the specialized version's init file).  These are the
12860 environments with special init file names:
12861
12862 @cindex @file{.vxgdbinit}
12863 @itemize @bullet
12864 @item
12865 VxWorks (Wind River Systems real-time OS): @file{.vxgdbinit}
12866
12867 @cindex @file{.os68gdbinit}
12868 @item
12869 OS68K (Enea Data Systems real-time OS): @file{.os68gdbinit}
12870
12871 @cindex @file{.esgdbinit}
12872 @item
12873 ES-1800 (Ericsson Telecom AB M68000 emulator): @file{.esgdbinit}
12874 @end itemize
12875
12876 You can also request the execution of a command file with the
12877 @code{source} command:
12878
12879 @table @code
12880 @kindex source
12881 @item source @var{filename}
12882 Execute the command file @var{filename}.
12883 @end table
12884
12885 The lines in a command file are executed sequentially.  They are not
12886 printed as they are executed.  An error in any command terminates execution
12887 of the command file.
12888
12889 Commands that would ask for confirmation if used interactively proceed
12890 without asking when used in a command file.  Many @value{GDBN} commands that
12891 normally print messages to say what they are doing omit the messages
12892 when called from command files.
12893
12894 @node Output
12895 @section Commands for controlled output
12896
12897 During the execution of a command file or a user-defined command, normal
12898 @value{GDBN} output is suppressed; the only output that appears is what is
12899 explicitly printed by the commands in the definition.  This section
12900 describes three commands useful for generating exactly the output you
12901 want.
12902
12903 @table @code
12904 @kindex echo
12905 @item echo @var{text}
12906 @c I do not consider backslash-space a standard C escape sequence
12907 @c because it is not in ANSI.
12908 Print @var{text}.  Nonprinting characters can be included in
12909 @var{text} using C escape sequences, such as @samp{\n} to print a
12910 newline.  @strong{No newline is printed unless you specify one.}
12911 In addition to the standard C escape sequences, a backslash followed
12912 by a space stands for a space.  This is useful for displaying a
12913 string with spaces at the beginning or the end, since leading and
12914 trailing spaces are otherwise trimmed from all arguments.
12915 To print @samp{@w{ }and foo =@w{ }}, use the command
12916 @samp{echo \@w{ }and foo = \@w{ }}.
12917
12918 A backslash at the end of @var{text} can be used, as in C, to continue
12919 the command onto subsequent lines.  For example,
12920
12921 @example
12922 echo This is some text\n\
12923 which is continued\n\
12924 onto several lines.\n
12925 @end example
12926
12927 produces the same output as
12928
12929 @example
12930 echo This is some text\n
12931 echo which is continued\n
12932 echo onto several lines.\n
12933 @end example
12934
12935 @kindex output
12936 @item output @var{expression}
12937 Print the value of @var{expression} and nothing but that value: no
12938 newlines, no @samp{$@var{nn} = }.  The value is not entered in the
12939 value history either.  @xref{Expressions, ,Expressions}, for more information
12940 on expressions.
12941
12942 @item output/@var{fmt} @var{expression}
12943 Print the value of @var{expression} in format @var{fmt}.  You can use
12944 the same formats as for @code{print}.  @xref{Output Formats,,Output
12945 formats}, for more information.
12946
12947 @kindex printf
12948 @item printf @var{string}, @var{expressions}@dots{}
12949 Print the values of the @var{expressions} under the control of
12950 @var{string}.  The @var{expressions} are separated by commas and may be
12951 either numbers or pointers.  Their values are printed as specified by
12952 @var{string}, exactly as if your program were to execute the C
12953 subroutine
12954 @c FIXME: the above implies that at least all ANSI C formats are
12955 @c supported, but it isn't true: %E and %G don't work (or so it seems).
12956 @c Either this is a bug, or the manual should document what formats are
12957 @c supported.
12958
12959 @example
12960 printf (@var{string}, @var{expressions}@dots{});
12961 @end example
12962
12963 For example, you can print two values in hex like this:
12964
12965 @smallexample
12966 printf "foo, bar-foo = 0x%x, 0x%x\n", foo, bar-foo
12967 @end smallexample
12968
12969 The only backslash-escape sequences that you can use in the format
12970 string are the simple ones that consist of backslash followed by a
12971 letter.
12972 @end table
12973
12974 @node Emacs
12975 @chapter Using @value{GDBN} under @sc{gnu} Emacs
12976
12977 @cindex Emacs
12978 @cindex @sc{gnu} Emacs
12979 A special interface allows you to use @sc{gnu} Emacs to view (and
12980 edit) the source files for the program you are debugging with
12981 @value{GDBN}.
12982
12983 To use this interface, use the command @kbd{M-x gdb} in Emacs.  Give the
12984 executable file you want to debug as an argument.  This command starts
12985 @value{GDBN} as a subprocess of Emacs, with input and output through a newly
12986 created Emacs buffer.
12987 @c (Do not use the @code{-tui} option to run @value{GDBN} from Emacs.)
12988
12989 Using @value{GDBN} under Emacs is just like using @value{GDBN} normally except for two
12990 things:
12991
12992 @itemize @bullet
12993 @item
12994 All ``terminal'' input and output goes through the Emacs buffer.
12995 @end itemize
12996
12997 This applies both to @value{GDBN} commands and their output, and to the input
12998 and output done by the program you are debugging.
12999
13000 This is useful because it means that you can copy the text of previous
13001 commands and input them again; you can even use parts of the output
13002 in this way.
13003
13004 All the facilities of Emacs' Shell mode are available for interacting
13005 with your program.  In particular, you can send signals the usual
13006 way---for example, @kbd{C-c C-c} for an interrupt, @kbd{C-c C-z} for a
13007 stop.
13008
13009 @itemize @bullet
13010 @item
13011 @value{GDBN} displays source code through Emacs.
13012 @end itemize
13013
13014 Each time @value{GDBN} displays a stack frame, Emacs automatically finds the
13015 source file for that frame and puts an arrow (@samp{=>}) at the
13016 left margin of the current line.  Emacs uses a separate buffer for
13017 source display, and splits the screen to show both your @value{GDBN} session
13018 and the source.
13019
13020 Explicit @value{GDBN} @code{list} or search commands still produce output as
13021 usual, but you probably have no reason to use them from Emacs.
13022
13023 @quotation
13024 @emph{Warning:} If the directory where your program resides is not your
13025 current directory, it can be easy to confuse Emacs about the location of
13026 the source files, in which case the auxiliary display buffer does not
13027 appear to show your source.  @value{GDBN} can find programs by searching your
13028 environment's @code{PATH} variable, so the @value{GDBN} input and output
13029 session proceeds normally; but Emacs does not get enough information
13030 back from @value{GDBN} to locate the source files in this situation.  To
13031 avoid this problem, either start @value{GDBN} mode from the directory where
13032 your program resides, or specify an absolute file name when prompted for the
13033 @kbd{M-x gdb} argument.
13034
13035 A similar confusion can result if you use the @value{GDBN} @code{file} command to
13036 switch to debugging a program in some other location, from an existing
13037 @value{GDBN} buffer in Emacs.
13038 @end quotation
13039
13040 By default, @kbd{M-x gdb} calls the program called @file{gdb}.  If
13041 you need to call @value{GDBN} by a different name (for example, if you keep
13042 several configurations around, with different names) you can set the
13043 Emacs variable @code{gdb-command-name}; for example,
13044
13045 @example
13046 (setq gdb-command-name "mygdb")
13047 @end example
13048
13049 @noindent
13050 (preceded by @kbd{M-:} or @kbd{ESC :}, or typed in the @code{*scratch*} buffer, or
13051 in your @file{.emacs} file) makes Emacs call the program named
13052 ``@code{mygdb}'' instead.
13053
13054 In the @value{GDBN} I/O buffer, you can use these special Emacs commands in
13055 addition to the standard Shell mode commands:
13056
13057 @table @kbd
13058 @item C-h m
13059 Describe the features of Emacs' @value{GDBN} Mode.
13060
13061 @item M-s
13062 Execute to another source line, like the @value{GDBN} @code{step} command; also
13063 update the display window to show the current file and location.
13064
13065 @item M-n
13066 Execute to next source line in this function, skipping all function
13067 calls, like the @value{GDBN} @code{next} command.  Then update the display window
13068 to show the current file and location.
13069
13070 @item M-i
13071 Execute one instruction, like the @value{GDBN} @code{stepi} command; update
13072 display window accordingly.
13073
13074 @item M-x gdb-nexti
13075 Execute to next instruction, using the @value{GDBN} @code{nexti} command; update
13076 display window accordingly.
13077
13078 @item C-c C-f
13079 Execute until exit from the selected stack frame, like the @value{GDBN}
13080 @code{finish} command.
13081
13082 @item M-c
13083 Continue execution of your program, like the @value{GDBN} @code{continue}
13084 command.
13085
13086 @emph{Warning:} In Emacs v19, this command is @kbd{C-c C-p}.
13087
13088 @item M-u
13089 Go up the number of frames indicated by the numeric argument
13090 (@pxref{Arguments, , Numeric Arguments, Emacs, The @sc{gnu} Emacs Manual}),
13091 like the @value{GDBN} @code{up} command.
13092
13093 @emph{Warning:} In Emacs v19, this command is @kbd{C-c C-u}.
13094
13095 @item M-d
13096 Go down the number of frames indicated by the numeric argument, like the
13097 @value{GDBN} @code{down} command.
13098
13099 @emph{Warning:} In Emacs v19, this command is @kbd{C-c C-d}.
13100
13101 @item C-x &
13102 Read the number where the cursor is positioned, and insert it at the end
13103 of the @value{GDBN} I/O buffer.  For example, if you wish to disassemble code
13104 around an address that was displayed earlier, type @kbd{disassemble};
13105 then move the cursor to the address display, and pick up the
13106 argument for @code{disassemble} by typing @kbd{C-x &}.
13107
13108 You can customize this further by defining elements of the list
13109 @code{gdb-print-command}; once it is defined, you can format or
13110 otherwise process numbers picked up by @kbd{C-x &} before they are
13111 inserted.  A numeric argument to @kbd{C-x &} indicates that you
13112 wish special formatting, and also acts as an index to pick an element of the
13113 list.  If the list element is a string, the number to be inserted is
13114 formatted using the Emacs function @code{format}; otherwise the number
13115 is passed as an argument to the corresponding list element.
13116 @end table
13117
13118 In any source file, the Emacs command @kbd{C-x SPC} (@code{gdb-break})
13119 tells @value{GDBN} to set a breakpoint on the source line point is on.
13120
13121 If you accidentally delete the source-display buffer, an easy way to get
13122 it back is to type the command @code{f} in the @value{GDBN} buffer, to
13123 request a frame display; when you run under Emacs, this recreates
13124 the source buffer if necessary to show you the context of the current
13125 frame.
13126
13127 The source files displayed in Emacs are in ordinary Emacs buffers
13128 which are visiting the source files in the usual way.  You can edit
13129 the files with these buffers if you wish; but keep in mind that @value{GDBN}
13130 communicates with Emacs in terms of line numbers.  If you add or
13131 delete lines from the text, the line numbers that @value{GDBN} knows cease
13132 to correspond properly with the code.
13133
13134 @c The following dropped because Epoch is nonstandard.  Reactivate
13135 @c if/when v19 does something similar. ---doc@cygnus.com 19dec1990
13136 @ignore
13137 @kindex Emacs Epoch environment
13138 @kindex Epoch
13139 @kindex inspect
13140
13141 Version 18 of @sc{gnu} Emacs has a built-in window system
13142 called the @code{epoch}
13143 environment.  Users of this environment can use a new command,
13144 @code{inspect} which performs identically to @code{print} except that
13145 each value is printed in its own window.
13146 @end ignore
13147
13148 @include annotate.texi
13149 @include gdbmi.texinfo
13150
13151 @node GDB Bugs
13152 @chapter Reporting Bugs in @value{GDBN}
13153 @cindex bugs in @value{GDBN}
13154 @cindex reporting bugs in @value{GDBN}
13155
13156 Your bug reports play an essential role in making @value{GDBN} reliable.
13157
13158 Reporting a bug may help you by bringing a solution to your problem, or it
13159 may not.  But in any case the principal function of a bug report is to help
13160 the entire community by making the next version of @value{GDBN} work better.  Bug
13161 reports are your contribution to the maintenance of @value{GDBN}.
13162
13163 In order for a bug report to serve its purpose, you must include the
13164 information that enables us to fix the bug.
13165
13166 @menu
13167 * Bug Criteria::                Have you found a bug?
13168 * Bug Reporting::               How to report bugs
13169 @end menu
13170
13171 @node Bug Criteria
13172 @section Have you found a bug?
13173 @cindex bug criteria
13174
13175 If you are not sure whether you have found a bug, here are some guidelines:
13176
13177 @itemize @bullet
13178 @cindex fatal signal
13179 @cindex debugger crash
13180 @cindex crash of debugger
13181 @item
13182 If the debugger gets a fatal signal, for any input whatever, that is a
13183 @value{GDBN} bug.  Reliable debuggers never crash.
13184
13185 @cindex error on valid input
13186 @item
13187 If @value{GDBN} produces an error message for valid input, that is a
13188 bug.  (Note that if you're cross debugging, the problem may also be
13189 somewhere in the connection to the target.)
13190
13191 @cindex invalid input
13192 @item
13193 If @value{GDBN} does not produce an error message for invalid input,
13194 that is a bug.  However, you should note that your idea of
13195 ``invalid input'' might be our idea of ``an extension'' or ``support
13196 for traditional practice''.
13197
13198 @item
13199 If you are an experienced user of debugging tools, your suggestions
13200 for improvement of @value{GDBN} are welcome in any case.
13201 @end itemize
13202
13203 @node Bug Reporting
13204 @section How to report bugs
13205 @cindex bug reports
13206 @cindex @value{GDBN} bugs, reporting
13207
13208 A number of companies and individuals offer support for @sc{gnu} products.
13209 If you obtained @value{GDBN} from a support organization, we recommend you
13210 contact that organization first.
13211
13212 You can find contact information for many support companies and
13213 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
13214 distribution.
13215 @c should add a web page ref...
13216
13217 In any event, we also recommend that you send bug reports for
13218 @value{GDBN} to this addresses:
13219
13220 @example
13221 bug-gdb@@gnu.org
13222 @end example
13223
13224 @strong{Do not send bug reports to @samp{info-gdb}, or to
13225 @samp{help-gdb}, or to any newsgroups.}  Most users of @value{GDBN} do
13226 not want to receive bug reports.  Those that do have arranged to receive
13227 @samp{bug-gdb}.
13228
13229 The mailing list @samp{bug-gdb} has a newsgroup @samp{gnu.gdb.bug} which
13230 serves as a repeater.  The mailing list and the newsgroup carry exactly
13231 the same messages.  Often people think of posting bug reports to the
13232 newsgroup instead of mailing them.  This appears to work, but it has one
13233 problem which can be crucial: a newsgroup posting often lacks a mail
13234 path back to the sender.  Thus, if we need to ask for more information,
13235 we may be unable to reach you.  For this reason, it is better to send
13236 bug reports to the mailing list.
13237
13238 As a last resort, send bug reports on paper to:
13239
13240 @example
13241 @sc{gnu} Debugger Bugs
13242 Free Software Foundation Inc.
13243 59 Temple Place - Suite 330
13244 Boston, MA 02111-1307
13245 USA
13246 @end example
13247
13248 The fundamental principle of reporting bugs usefully is this:
13249 @strong{report all the facts}.  If you are not sure whether to state a
13250 fact or leave it out, state it!
13251
13252 Often people omit facts because they think they know what causes the
13253 problem and assume that some details do not matter.  Thus, you might
13254 assume that the name of the variable you use in an example does not matter.
13255 Well, probably it does not, but one cannot be sure.  Perhaps the bug is a
13256 stray memory reference which happens to fetch from the location where that
13257 name is stored in memory; perhaps, if the name were different, the contents
13258 of that location would fool the debugger into doing the right thing despite
13259 the bug.  Play it safe and give a specific, complete example.  That is the
13260 easiest thing for you to do, and the most helpful.
13261
13262 Keep in mind that the purpose of a bug report is to enable us to fix the
13263 bug.  It may be that the bug has been reported previously, but neither
13264 you nor we can know that unless your bug report is complete and
13265 self-contained.
13266
13267 Sometimes people give a few sketchy facts and ask, ``Does this ring a
13268 bell?''  Those bug reports are useless, and we urge everyone to
13269 @emph{refuse to respond to them} except to chide the sender to report
13270 bugs properly.
13271
13272 To enable us to fix the bug, you should include all these things:
13273
13274 @itemize @bullet
13275 @item
13276 The version of @value{GDBN}.  @value{GDBN} announces it if you start
13277 with no arguments; you can also print it at any time using @code{show
13278 version}.
13279
13280 Without this, we will not know whether there is any point in looking for
13281 the bug in the current version of @value{GDBN}.
13282
13283 @item
13284 The type of machine you are using, and the operating system name and
13285 version number.
13286
13287 @item
13288 What compiler (and its version) was used to compile @value{GDBN}---e.g.
13289 ``@value{GCC}--2.8.1''.
13290
13291 @item
13292 What compiler (and its version) was used to compile the program you are
13293 debugging---e.g.  ``@value{GCC}--2.8.1'', or ``HP92453-01 A.10.32.03 HP
13294 C Compiler''.  For GCC, you can say @code{gcc --version} to get this
13295 information; for other compilers, see the documentation for those
13296 compilers.
13297
13298 @item
13299 The command arguments you gave the compiler to compile your example and
13300 observe the bug.  For example, did you use @samp{-O}?  To guarantee
13301 you will not omit something important, list them all.  A copy of the
13302 Makefile (or the output from make) is sufficient.
13303
13304 If we were to try to guess the arguments, we would probably guess wrong
13305 and then we might not encounter the bug.
13306
13307 @item
13308 A complete input script, and all necessary source files, that will
13309 reproduce the bug.
13310
13311 @item
13312 A description of what behavior you observe that you believe is
13313 incorrect.  For example, ``It gets a fatal signal.''
13314
13315 Of course, if the bug is that @value{GDBN} gets a fatal signal, then we
13316 will certainly notice it.  But if the bug is incorrect output, we might
13317 not notice unless it is glaringly wrong.  You might as well not give us
13318 a chance to make a mistake.
13319
13320 Even if the problem you experience is a fatal signal, you should still
13321 say so explicitly.  Suppose something strange is going on, such as, your
13322 copy of @value{GDBN} is out of synch, or you have encountered a bug in
13323 the C library on your system.  (This has happened!)  Your copy might
13324 crash and ours would not.  If you told us to expect a crash, then when
13325 ours fails to crash, we would know that the bug was not happening for
13326 us.  If you had not told us to expect a crash, then we would not be able
13327 to draw any conclusion from our observations.
13328
13329 @item
13330 If you wish to suggest changes to the @value{GDBN} source, send us context
13331 diffs.  If you even discuss something in the @value{GDBN} source, refer to
13332 it by context, not by line number.
13333
13334 The line numbers in our development sources will not match those in your
13335 sources.  Your line numbers would convey no useful information to us.
13336
13337 @end itemize
13338
13339 Here are some things that are not necessary:
13340
13341 @itemize @bullet
13342 @item
13343 A description of the envelope of the bug.
13344
13345 Often people who encounter a bug spend a lot of time investigating
13346 which changes to the input file will make the bug go away and which
13347 changes will not affect it.
13348
13349 This is often time consuming and not very useful, because the way we
13350 will find the bug is by running a single example under the debugger
13351 with breakpoints, not by pure deduction from a series of examples.
13352 We recommend that you save your time for something else.
13353
13354 Of course, if you can find a simpler example to report @emph{instead}
13355 of the original one, that is a convenience for us.  Errors in the
13356 output will be easier to spot, running under the debugger will take
13357 less time, and so on.
13358
13359 However, simplification is not vital; if you do not want to do this,
13360 report the bug anyway and send us the entire test case you used.
13361
13362 @item
13363 A patch for the bug.
13364
13365 A patch for the bug does help us if it is a good one.  But do not omit
13366 the necessary information, such as the test case, on the assumption that
13367 a patch is all we need.  We might see problems with your patch and decide
13368 to fix the problem another way, or we might not understand it at all.
13369
13370 Sometimes with a program as complicated as @value{GDBN} it is very hard to
13371 construct an example that will make the program follow a certain path
13372 through the code.  If you do not send us the example, we will not be able
13373 to construct one, so we will not be able to verify that the bug is fixed.
13374
13375 And if we cannot understand what bug you are trying to fix, or why your
13376 patch should be an improvement, we will not install it.  A test case will
13377 help us to understand.
13378
13379 @item
13380 A guess about what the bug is or what it depends on.
13381
13382 Such guesses are usually wrong.  Even we cannot guess right about such
13383 things without first using the debugger to find the facts.
13384 @end itemize
13385
13386 @c The readline documentation is distributed with the readline code
13387 @c and consists of the two following files:
13388 @c     rluser.texinfo
13389 @c     inc-hist.texinfo
13390 @c Use -I with makeinfo to point to the appropriate directory,
13391 @c environment var TEXINPUTS with TeX.
13392 @include rluser.texinfo
13393 @include inc-hist.texinfo
13394
13395
13396 @node Formatting Documentation
13397 @appendix Formatting Documentation
13398
13399 @cindex @value{GDBN} reference card
13400 @cindex reference card
13401 The @value{GDBN} 4 release includes an already-formatted reference card, ready
13402 for printing with PostScript or Ghostscript, in the @file{gdb}
13403 subdirectory of the main source directory@footnote{In
13404 @file{gdb-@value{GDBVN}/gdb/refcard.ps} of the version @value{GDBVN}
13405 release.}.  If you can use PostScript or Ghostscript with your printer,
13406 you can print the reference card immediately with @file{refcard.ps}.
13407
13408 The release also includes the source for the reference card.  You
13409 can format it, using @TeX{}, by typing:
13410
13411 @example
13412 make refcard.dvi
13413 @end example
13414
13415 The @value{GDBN} reference card is designed to print in @dfn{landscape}
13416 mode on US ``letter'' size paper;
13417 that is, on a sheet 11 inches wide by 8.5 inches
13418 high.  You will need to specify this form of printing as an option to
13419 your @sc{dvi} output program.
13420
13421 @cindex documentation
13422
13423 All the documentation for @value{GDBN} comes as part of the machine-readable
13424 distribution.  The documentation is written in Texinfo format, which is
13425 a documentation system that uses a single source file to produce both
13426 on-line information and a printed manual.  You can use one of the Info
13427 formatting commands to create the on-line version of the documentation
13428 and @TeX{} (or @code{texi2roff}) to typeset the printed version.
13429
13430 @value{GDBN} includes an already formatted copy of the on-line Info
13431 version of this manual in the @file{gdb} subdirectory.  The main Info
13432 file is @file{gdb-@value{GDBVN}/gdb/gdb.info}, and it refers to
13433 subordinate files matching @samp{gdb.info*} in the same directory.  If
13434 necessary, you can print out these files, or read them with any editor;
13435 but they are easier to read using the @code{info} subsystem in @sc{gnu}
13436 Emacs or the standalone @code{info} program, available as part of the
13437 @sc{gnu} Texinfo distribution.
13438
13439 If you want to format these Info files yourself, you need one of the
13440 Info formatting programs, such as @code{texinfo-format-buffer} or
13441 @code{makeinfo}.
13442
13443 If you have @code{makeinfo} installed, and are in the top level
13444 @value{GDBN} source directory (@file{gdb-@value{GDBVN}}, in the case of
13445 version @value{GDBVN}), you can make the Info file by typing:
13446
13447 @example
13448 cd gdb
13449 make gdb.info
13450 @end example
13451
13452 If you want to typeset and print copies of this manual, you need @TeX{},
13453 a program to print its @sc{dvi} output files, and @file{texinfo.tex}, the
13454 Texinfo definitions file.
13455
13456 @TeX{} is a typesetting program; it does not print files directly, but
13457 produces output files called @sc{dvi} files.  To print a typeset
13458 document, you need a program to print @sc{dvi} files.  If your system
13459 has @TeX{} installed, chances are it has such a program.  The precise
13460 command to use depends on your system; @kbd{lpr -d} is common; another
13461 (for PostScript devices) is @kbd{dvips}.  The @sc{dvi} print command may
13462 require a file name without any extension or a @samp{.dvi} extension.
13463
13464 @TeX{} also requires a macro definitions file called
13465 @file{texinfo.tex}.  This file tells @TeX{} how to typeset a document
13466 written in Texinfo format.  On its own, @TeX{} cannot either read or
13467 typeset a Texinfo file.  @file{texinfo.tex} is distributed with GDB
13468 and is located in the @file{gdb-@var{version-number}/texinfo}
13469 directory.
13470
13471 If you have @TeX{} and a @sc{dvi} printer program installed, you can
13472 typeset and print this manual.  First switch to the the @file{gdb}
13473 subdirectory of the main source directory (for example, to
13474 @file{gdb-@value{GDBVN}/gdb}) and type:
13475
13476 @example
13477 make gdb.dvi
13478 @end example
13479
13480 Then give @file{gdb.dvi} to your @sc{dvi} printing program.
13481
13482 @node Installing GDB
13483 @appendix Installing @value{GDBN}
13484 @cindex configuring @value{GDBN}
13485 @cindex installation
13486
13487 @value{GDBN} comes with a @code{configure} script that automates the process
13488 of preparing @value{GDBN} for installation; you can then use @code{make} to
13489 build the @code{gdb} program.
13490 @iftex
13491 @c irrelevant in info file; it's as current as the code it lives with.
13492 @footnote{If you have a more recent version of @value{GDBN} than @value{GDBVN},
13493 look at the @file{README} file in the sources; we may have improved the
13494 installation procedures since publishing this manual.}
13495 @end iftex
13496
13497 The @value{GDBN} distribution includes all the source code you need for
13498 @value{GDBN} in a single directory, whose name is usually composed by
13499 appending the version number to @samp{gdb}.
13500
13501 For example, the @value{GDBN} version @value{GDBVN} distribution is in the
13502 @file{gdb-@value{GDBVN}} directory.  That directory contains:
13503
13504 @table @code
13505 @item gdb-@value{GDBVN}/configure @r{(and supporting files)}
13506 script for configuring @value{GDBN} and all its supporting libraries
13507
13508 @item gdb-@value{GDBVN}/gdb
13509 the source specific to @value{GDBN} itself
13510
13511 @item gdb-@value{GDBVN}/bfd
13512 source for the Binary File Descriptor library
13513
13514 @item gdb-@value{GDBVN}/include
13515 @sc{gnu} include files
13516
13517 @item gdb-@value{GDBVN}/libiberty
13518 source for the @samp{-liberty} free software library
13519
13520 @item gdb-@value{GDBVN}/opcodes
13521 source for the library of opcode tables and disassemblers
13522
13523 @item gdb-@value{GDBVN}/readline
13524 source for the @sc{gnu} command-line interface
13525
13526 @item gdb-@value{GDBVN}/glob
13527 source for the @sc{gnu} filename pattern-matching subroutine
13528
13529 @item gdb-@value{GDBVN}/mmalloc
13530 source for the @sc{gnu} memory-mapped malloc package
13531 @end table
13532
13533 The simplest way to configure and build @value{GDBN} is to run @code{configure}
13534 from the @file{gdb-@var{version-number}} source directory, which in
13535 this example is the @file{gdb-@value{GDBVN}} directory.
13536
13537 First switch to the @file{gdb-@var{version-number}} source directory
13538 if you are not already in it; then run @code{configure}.  Pass the
13539 identifier for the platform on which @value{GDBN} will run as an
13540 argument.
13541
13542 For example:
13543
13544 @example
13545 cd gdb-@value{GDBVN}
13546 ./configure @var{host}
13547 make
13548 @end example
13549
13550 @noindent
13551 where @var{host} is an identifier such as @samp{sun4} or
13552 @samp{decstation}, that identifies the platform where @value{GDBN} will run.
13553 (You can often leave off @var{host}; @code{configure} tries to guess the
13554 correct value by examining your system.)
13555
13556 Running @samp{configure @var{host}} and then running @code{make} builds the
13557 @file{bfd}, @file{readline}, @file{mmalloc}, and @file{libiberty}
13558 libraries, then @code{gdb} itself.  The configured source files, and the
13559 binaries, are left in the corresponding source directories.
13560
13561 @need 750
13562 @code{configure} is a Bourne-shell (@code{/bin/sh}) script; if your
13563 system does not recognize this automatically when you run a different
13564 shell, you may need to run @code{sh} on it explicitly:
13565
13566 @example
13567 sh configure @var{host}
13568 @end example
13569
13570 If you run @code{configure} from a directory that contains source
13571 directories for multiple libraries or programs, such as the
13572 @file{gdb-@value{GDBVN}} source directory for version @value{GDBVN}, @code{configure}
13573 creates configuration files for every directory level underneath (unless
13574 you tell it not to, with the @samp{--norecursion} option).
13575
13576 You can run the @code{configure} script from any of the
13577 subordinate directories in the @value{GDBN} distribution if you only want to
13578 configure that subdirectory, but be sure to specify a path to it.
13579
13580 For example, with version @value{GDBVN}, type the following to configure only
13581 the @code{bfd} subdirectory:
13582
13583 @example
13584 @group
13585 cd gdb-@value{GDBVN}/bfd
13586 ../configure @var{host}
13587 @end group
13588 @end example
13589
13590 You can install @code{@value{GDBP}} anywhere; it has no hardwired paths.
13591 However, you should make sure that the shell on your path (named by
13592 the @samp{SHELL} environment variable) is publicly readable.  Remember
13593 that @value{GDBN} uses the shell to start your program---some systems refuse to
13594 let @value{GDBN} debug child processes whose programs are not readable.
13595
13596 @menu
13597 * Separate Objdir::             Compiling @value{GDBN} in another directory
13598 * Config Names::                Specifying names for hosts and targets
13599 * Configure Options::           Summary of options for configure
13600 @end menu
13601
13602 @node Separate Objdir
13603 @section Compiling @value{GDBN} in another directory
13604
13605 If you want to run @value{GDBN} versions for several host or target machines,
13606 you need a different @code{gdb} compiled for each combination of
13607 host and target.  @code{configure} is designed to make this easy by
13608 allowing you to generate each configuration in a separate subdirectory,
13609 rather than in the source directory.  If your @code{make} program
13610 handles the @samp{VPATH} feature (@sc{gnu} @code{make} does), running
13611 @code{make} in each of these directories builds the @code{gdb}
13612 program specified there.
13613
13614 To build @code{gdb} in a separate directory, run @code{configure}
13615 with the @samp{--srcdir} option to specify where to find the source.
13616 (You also need to specify a path to find @code{configure}
13617 itself from your working directory.  If the path to @code{configure}
13618 would be the same as the argument to @samp{--srcdir}, you can leave out
13619 the @samp{--srcdir} option; it is assumed.)
13620
13621 For example, with version @value{GDBVN}, you can build @value{GDBN} in a
13622 separate directory for a Sun 4 like this:
13623
13624 @example
13625 @group
13626 cd gdb-@value{GDBVN}
13627 mkdir ../gdb-sun4
13628 cd ../gdb-sun4
13629 ../gdb-@value{GDBVN}/configure sun4
13630 make
13631 @end group
13632 @end example
13633
13634 When @code{configure} builds a configuration using a remote source
13635 directory, it creates a tree for the binaries with the same structure
13636 (and using the same names) as the tree under the source directory.  In
13637 the example, you'd find the Sun 4 library @file{libiberty.a} in the
13638 directory @file{gdb-sun4/libiberty}, and @value{GDBN} itself in
13639 @file{gdb-sun4/gdb}.
13640
13641 One popular reason to build several @value{GDBN} configurations in separate
13642 directories is to configure @value{GDBN} for cross-compiling (where
13643 @value{GDBN} runs on one machine---the @dfn{host}---while debugging
13644 programs that run on another machine---the @dfn{target}).
13645 You specify a cross-debugging target by
13646 giving the @samp{--target=@var{target}} option to @code{configure}.
13647
13648 When you run @code{make} to build a program or library, you must run
13649 it in a configured directory---whatever directory you were in when you
13650 called @code{configure} (or one of its subdirectories).
13651
13652 The @code{Makefile} that @code{configure} generates in each source
13653 directory also runs recursively.  If you type @code{make} in a source
13654 directory such as @file{gdb-@value{GDBVN}} (or in a separate configured
13655 directory configured with @samp{--srcdir=@var{dirname}/gdb-@value{GDBVN}}), you
13656 will build all the required libraries, and then build GDB.
13657
13658 When you have multiple hosts or targets configured in separate
13659 directories, you can run @code{make} on them in parallel (for example,
13660 if they are NFS-mounted on each of the hosts); they will not interfere
13661 with each other.
13662
13663 @node Config Names
13664 @section Specifying names for hosts and targets
13665
13666 The specifications used for hosts and targets in the @code{configure}
13667 script are based on a three-part naming scheme, but some short predefined
13668 aliases are also supported.  The full naming scheme encodes three pieces
13669 of information in the following pattern:
13670
13671 @example
13672 @var{architecture}-@var{vendor}-@var{os}
13673 @end example
13674
13675 For example, you can use the alias @code{sun4} as a @var{host} argument,
13676 or as the value for @var{target} in a @code{--target=@var{target}}
13677 option.  The equivalent full name is @samp{sparc-sun-sunos4}.
13678
13679 The @code{configure} script accompanying @value{GDBN} does not provide
13680 any query facility to list all supported host and target names or
13681 aliases.  @code{configure} calls the Bourne shell script
13682 @code{config.sub} to map abbreviations to full names; you can read the
13683 script, if you wish, or you can use it to test your guesses on
13684 abbreviations---for example:
13685
13686 @smallexample
13687 % sh config.sub i386-linux
13688 i386-pc-linux-gnu
13689 % sh config.sub alpha-linux
13690 alpha-unknown-linux-gnu
13691 % sh config.sub hp9k700
13692 hppa1.1-hp-hpux
13693 % sh config.sub sun4
13694 sparc-sun-sunos4.1.1
13695 % sh config.sub sun3
13696 m68k-sun-sunos4.1.1
13697 % sh config.sub i986v
13698 Invalid configuration `i986v': machine `i986v' not recognized
13699 @end smallexample
13700
13701 @noindent
13702 @code{config.sub} is also distributed in the @value{GDBN} source
13703 directory (@file{gdb-@value{GDBVN}}, for version @value{GDBVN}).
13704
13705 @node Configure Options
13706 @section @code{configure} options
13707
13708 Here is a summary of the @code{configure} options and arguments that
13709 are most often useful for building @value{GDBN}.  @code{configure} also has
13710 several other options not listed here.  @inforef{What Configure
13711 Does,,configure.info}, for a full explanation of @code{configure}.
13712
13713 @example
13714 configure @r{[}--help@r{]}
13715           @r{[}--prefix=@var{dir}@r{]}
13716           @r{[}--exec-prefix=@var{dir}@r{]}
13717           @r{[}--srcdir=@var{dirname}@r{]}
13718           @r{[}--norecursion@r{]} @r{[}--rm@r{]}
13719           @r{[}--target=@var{target}@r{]}
13720           @var{host}
13721 @end example
13722
13723 @noindent
13724 You may introduce options with a single @samp{-} rather than
13725 @samp{--} if you prefer; but you may abbreviate option names if you use
13726 @samp{--}.
13727
13728 @table @code
13729 @item --help
13730 Display a quick summary of how to invoke @code{configure}.
13731
13732 @item --prefix=@var{dir}
13733 Configure the source to install programs and files under directory
13734 @file{@var{dir}}.
13735
13736 @item --exec-prefix=@var{dir}
13737 Configure the source to install programs under directory
13738 @file{@var{dir}}.
13739
13740 @c avoid splitting the warning from the explanation:
13741 @need 2000
13742 @item --srcdir=@var{dirname}
13743 @strong{Warning: using this option requires @sc{gnu} @code{make}, or another
13744 @code{make} that implements the @code{VPATH} feature.}@*
13745 Use this option to make configurations in directories separate from the
13746 @value{GDBN} source directories.  Among other things, you can use this to
13747 build (or maintain) several configurations simultaneously, in separate
13748 directories.  @code{configure} writes configuration specific files in
13749 the current directory, but arranges for them to use the source in the
13750 directory @var{dirname}.  @code{configure} creates directories under
13751 the working directory in parallel to the source directories below
13752 @var{dirname}.
13753
13754 @item --norecursion
13755 Configure only the directory level where @code{configure} is executed; do not
13756 propagate configuration to subdirectories.
13757
13758 @item --target=@var{target}
13759 Configure @value{GDBN} for cross-debugging programs running on the specified
13760 @var{target}.  Without this option, @value{GDBN} is configured to debug
13761 programs that run on the same machine (@var{host}) as @value{GDBN} itself.
13762
13763 There is no convenient way to generate a list of all available targets.
13764
13765 @item @var{host} @dots{}
13766 Configure @value{GDBN} to run on the specified @var{host}.
13767
13768 There is no convenient way to generate a list of all available hosts.
13769 @end table
13770
13771 There are many other options available as well, but they are generally
13772 needed for special purposes only.
13773
13774 @node Index
13775 @unnumbered Index
13776
13777 @printindex cp
13778
13779 @tex
13780 % I think something like @colophon should be in texinfo.  In the
13781 % meantime:
13782 \long\def\colophon{\hbox to0pt{}\vfill
13783 \centerline{The body of this manual is set in}
13784 \centerline{\fontname\tenrm,}
13785 \centerline{with headings in {\bf\fontname\tenbf}}
13786 \centerline{and examples in {\tt\fontname\tentt}.}
13787 \centerline{{\it\fontname\tenit\/},}
13788 \centerline{{\bf\fontname\tenbf}, and}
13789 \centerline{{\sl\fontname\tensl\/}}
13790 \centerline{are used for emphasis.}\vfill}
13791 \page\colophon
13792 % Blame: doc@cygnus.com, 1991.
13793 @end tex
13794
13795 @c TeX can handle the contents at the start but makeinfo 3.12 can not
13796 @ifinfo
13797 @contents
13798 @end ifinfo
13799 @ifhtml
13800 @contents
13801 @end ifhtml
13802
13803 @bye